Class: HTML_AJAX

Source Location: /HTML_AJAX-0.4.1/AJAX.php

Class Overview

OO AJAX Implementation for PHP

Author(s):

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

Version:

Release: @package_version@

Copyright:

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

Inherited Variables

Inherited Methods

Class Details

[line 28]
OO AJAX Implementation for PHP

Version: Release: @package_version@
Link: http://pear.php.net/package/HTML_AJAX
Todo: Decide if its good thing to support get
Todo: Add some sort of debugging console
License: LGPL
Copyright: 2005 Joshua Eichorn, Arpad Ray, David Coallier, Elizabeth Smith
Author: Arpad Ray <mailto:arpad@php.net>
Author: David Coallier <mailto:davidc@php.net>
Author: Elizabeth Smith <mailto:auroraeosrose@gmail.com>
Author: Joshua Eichorn <mailto:josh@bluga.net>

[ Top ]

Class Variables

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

[line 83]

Content-type map

Used in to automatically choose serializers as needed

Type:

mixed

[ Top ]

$debug =

[line 97]

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

Type:

mixed

[ Top ]

$debugEnabled = false

[line 103]

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 111]

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

set to false by default.

Access: public

Type:

mixed

[ Top ]

$json_loose_type = true

[line 76]

Option to use loose typing for JSON encoding

Access: public

Type:

bool

[ Top ]

$php4CompatCase = false

[line 129]

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 119]

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 63]

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 57]

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 69]

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

Var: JSON|PHP|Null

Type:

string

[ Top ]

Method Detail

addAllowedClasses [line 776]

void addAllowedClasses(
mixed
$classes, 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 259]

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 228]

string generateJavaScriptClient(
)

Generate the client Javascript code

Return: generated javascript client code

[ Top ]

handleRequest [line 344]

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 ]

registerCallback [line 243]

void registerCallback(
mixed
$callback, [mixed
$type = 'headers'])

Registers callbacks for sending headers or retriving post/get vars

for better application integration

[ Top ]

registerClass [line 173]

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

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

[ Top ]

registerPhpCallback [line 811]

void registerPhpCallback(
mixed
$callback, callback
$callback
)

Access: public

Parameters:

callback $callback — the callback to register

[ 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', 'Null' => 'text/plain', 'Error' => 'application/error', 'PHP' => 'application/php-serialized', 'Urlencoded' => 'application/x-www-form-urlencoded' )

$debug =

$debugEnabled = false

$debugSession = false

$json_loose_type = true

$php4CompatCase = false

$sendContentLength = true

$serializer = 'JSON'

$serverUrl = false

$unserializer = 'JSON'

Method Detail

addAllowedClasses [line 776]

Parameters:

generateClassStub [line 259]

Parameters:

generateJavaScriptClient [line 228]

handleRequest [line 344]

registerCallback [line 243]

registerClass [line 173]

Parameters:

registerPhpCallback [line 811]

Parameters:

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