Docs For Class AjaxRequest

Class AjaxRequest

Description

«JavaScript» Ajax handling class

Purpose of this class is to send http-requests to a server-side script and output the result to an element in the current document, identified by it's id.

Simple example of usage:

// create new instance
$http = new AjaxRequest('index.php');
// choose where to put the result
$http.setTarget('id_of_html_tag');
// provide a function to handle the returned result
$http.setHandler(function ($httpResponse, $htmlNode)
{
$htmlNode.innerHTML = $httpResponse.responseText;
// this will re-initialize the page (when needed)
if (document.body.onload) {
document.body.onload();
}
});
// send request to server
$http.send('action=' + 'function_name' + '&' + $arguments);

Note: if you use the Yana SDK to create code for a new plug-in, it will automatically provide you with a ready-to-use implementation of a mock object that provides all your available PHP functions via AJAX. Also note that you don't have to change your PHP code to make it "AJAX-ready". A basic AJAX-functionality is already provided by the framework itself, so you don't necessarily need to care about this issue.

Variable Summary

function $customHandler

XMLHttpRequest $http

array $instances

bool $isAsynchronous

bool $isReady

string $url

Method Summary

AjaxRequest AjaxRequest ([string $url = null], [bool $synchron = false])
void send (string $args)
void setHandler (function $newHandler)
void setTarget (string $id)

Variables

function $customHandler = null

Custom callback function

Will be called when a request is ready

access: public

XMLHttpRequest $http = null

Request object of current request (if any)

access: public

array $instances = array()

array containing references to all instances of this class

This is required for the internal dispatcher to notify objects on new events.

access: public

bool $isAsynchronous = true

transfer mode

True = send asynchronous request. False = send synchronous request.

access: public

bool $isReady = false

Ready to send new request

True, when the latest request has already been handled. False, when a recently issued request is still pending.

access: public

string $url = ""

URL of server-side (PHP-)script to handle requests

access: public

Methods

create a new instance

AjaxRequest AjaxRequest (

[string $url = null], [bool $synchron = false]

)

List of parameters:

Name	Type	Description
$url	string	server-side script that handles the request
$synchron	bool	set transfer mode

Description:

The argument $url is the URL to the server-side (PHP-)script that will handle the AJAX-request(s).

send a request

void send (

string $args

)

List of parameters:

Name	Type	Description
$args	string	will be appended to url

Description:

This will send an asynchronous request to the server.

Note: this function does not return a result. Instead the previously specified callback function will be called when the result is finished.

To specify a callback function use AjaxRequest::setHandler().

access: public
name: AjaxRequest::send()

set the function to handle the response

void setHandler (

function $newHandler

)

List of parameters:

Name	Type	Description
$newHandler	function

Description:

access: public
name: AjaxRequest::setHandler()

set the id of the document node to ouput the response text to

void setTarget (

string $id

)

List of parameters:

Name	Type	Description
$id	string

Description:

By default the result text of the request is copied to the innerHTML property of the node, identified by the id set via this function. However, you may overwrite this behaviour by setting up your own event handler via AjaxRequest::setHandler(). In this case you may use the id-property as a hint for where you intended the output to be placed.

access: public
name: AjaxRequest::setTarget()

Documentation generated on Sat, 03 Jan 2009 22:22:12 +0100 by phpDocumentor 1.4.0

yana author: Thomas Meyer Homepage: www.yanaframework.net