Class: HTML_AJAX

Source Location: /HTML_AJAX-0.5.5/AJAX.php

Class Overview

OO AJAX Implementation for PHP

Author(s):

Elizabeth Smith <auroraeosrose at gmail.com>
Arpad Ray <arpad at php.net>
Joshua Eichorn <josh at bluga.net>
David Coallier <davidc at php.net>

Version:

Release: 0.5.5

Copyright:

2005 Joshua Eichorn, Arpad Ray, David Coallier, Elizabeth Smith

Inherited Variables

Inherited Methods

Class Details

[line 28]
OO AJAX Implementation for PHP

Author: Elizabeth Smith <auroraeosrose@gmail.com>
Author: Arpad Ray <arpad@php.net>
Author: Joshua Eichorn <josh@bluga.net>
Author: David Coallier <davidc@php.net>
Version: Release: 0.5.5
Copyright: 2005 Joshua Eichorn, Arpad Ray, David Coallier, Elizabeth Smith
Link: http://pear.php.net/package/HTML_AJAX
License: LGPL

[ Top ]

Class Variables

$contentTypeMap = array(
            'JSON'  => 'application/json',
            'XML'   => 'application/xml',
            'Null'  => 'text/plain',
            'Error' => 'application/error',
            'PHP'   => 'application/php-serialized',
            'Urlencoded' => 'application/x-www-form-urlencoded'
        )

[line 72]

Content-type map

Used in to automatically choose serializers as needed

Type:

mixed

[ Top ]

$debug =

[line 87]

This is the debug variable that we will be passing the HTML_AJAX_Debug instance to.

Type:

mixed

[ Top ]

$debugEnabled = false

[line 93]

This is to tell if debug is enabled or not. If so, then debug is called, instantiated then saves the file and such.

Type:

mixed

[ Top ]

$debugSession = false

[line 101]

This puts the error into a session variable is set to true.

set to false by default.

Access: public

Type:

mixed

[ Top ]

$jsonLooseType = true

[line 65]

Option to use loose typing for JSON encoding

Access: public

Type:

bool

[ Top ]

$packJavaScript = false

[line 126]

Automatically pack all generated JavaScript making it smaller

If your using output compression this might not make sense

Type:

mixed

[ Top ]

$php4CompatCase = false

[line 119]

Make Generated code compatible with php4 by lowercasing all class/method names before exporting to JavaScript If you have code that works on php4 but not on php5 then setting this flag can fix the problem.

The recommended solution is too specify the class and method names when registering the class letting you have function case in php4 as well

Access: public

Type:

boolean

[ Top ]

$sendContentLength = true

[line 109]

If the Content-Length header should be sent, if your using a gzip handler on an output buffer, or run into any compatability problems, try disabling this.

Access: public

Type:

boolean

[ Top ]

$serializer = 'JSON'

[line 52]

What encoding your going to use for serializing data from php being sent to javascript

Var: JSON|PHP|Null

Type:

string

[ Top ]

$serverUrl = false

[line 46]

Set the server url in the generated stubs to this value

If set to false, serverUrl will not be set

Type:

false|string

[ Top ]

$unserializer = 'JSON'

[line 58]

What encoding your going to use for unserializing data sent from javascript

Var: JSON|PHP|Null

Type:

string

[ Top ]

Method Detail

addAllowedClasses [line 801]

void addAllowedClasses(
mixed
$classes)

Add a class or classes to those allowed to be unserialized

Access: public

Parameters:

mixed $classes — the class or array of classes to add

[ Top ]

generateClassStub [line 247]

string generateClassStub(
string
$name)

Return the stub for a class

Return: javascript proxy stub code for a single class

Parameters:

string $name — name of the class to generated the stub for, note that this is the exported name not the php class name

[ Top ]

generateJavaScriptClient [line 230]

string generateJavaScriptClient(
)

Generate the client Javascript code

Return: generated javascript client code

[ Top ]

handleRequest [line 336]

boolean handleRequest(
)

Handle a ajax request if needed

The current check is if GET variables c (class) and m (method) are set, more options may be available in the future

Return: true if an ajax call was handled, false otherwise
Todo: is it worth it to figure out howto use just 1 instance if the type is the same for serialize and unserialize

[ Top ]

packJavaScript [line 850]

void packJavaScript(

$input)

Make JavaScript code smaller

Currently just strips whitespace and comments, needs to remain fast Strips comments only if they are not preceeded by code Strips /*-style comments only if they span over more than one line Since strings cannot span over multiple lines, it cannot be defeated by a string containing /*

Parameters:

$input —

[ Top ]

registerClass [line 175]

void registerClass(

&$instance, [mixed
$exportedName = false], [mixed
$exportedMethods = false], object
$instance)

Set a class to handle requests

Parameters:

object	`$instance`	—
mixed	`$exportedName`	—	Name used for the javascript class, if false the name of the php class is used
mixed	`$exportedMethods`	—	If false all functions without a _ prefix are exported, if an array only the methods listed in the array are exported
	`&$instance`	—

[ Top ]

registerPhpCallback [line 836]

void registerPhpCallback(
callback
$callback)

Access: public

Parameters:

callback $callback — the callback to register

[ Top ]

setInterceptor [line 919]

void setInterceptor(

$instance)

Set an intercptor class

An interceptor class runs during the process of handling a request, it allows you to run security checks globally It also allows you to rewrite parameters

You can throw errors and exceptions in your intercptor methods and they will be passed to javascript

You can add interceptors are 3 levels For a particular class/method, this is done by add a method to you class named ClassName_MethodName($params) For a particular class, method ClassName($methodName,$params) Globally, method intercept($className,$methodName,$params)

Only one match is done, using the most specific interceptor

All methods have to return $params, if you want to empty all of the parameters return an empty array

Todo: handle php callbacks

Parameters:

$instance —

[ Top ]

Class: HTML_AJAX

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$contentTypeMap = array( 'JSON' => 'application/json', 'XML' => 'application/xml', 'Null' => 'text/plain', 'Error' => 'application/error', 'PHP' => 'application/php-serialized', 'Urlencoded' => 'application/x-www-form-urlencoded' )

$debug =

$debugEnabled = false

$debugSession = false

$jsonLooseType = true

$packJavaScript = false

$php4CompatCase = false

$sendContentLength = true

$serializer = 'JSON'

$serverUrl = false

$unserializer = 'JSON'

Method Detail

addAllowedClasses [line 801]

Parameters:

generateClassStub [line 247]

Parameters:

generateJavaScriptClient [line 230]

handleRequest [line 336]

packJavaScript [line 850]

Parameters:

registerClass [line 175]

Parameters:

registerPhpCallback [line 836]

Parameters:

setInterceptor [line 919]

Parameters:

$contentTypeMap = array(
'JSON' => 'application/json',
'XML' => 'application/xml',
'Null' => 'text/plain',
'Error' => 'application/error',
'PHP' => 'application/php-serialized',
'Urlencoded' => 'application/x-www-form-urlencoded'
)