xajaxArgumentManager. inc.php

Contains the xajaxArgumentManager class

Summary
Contains the xajaxArgumentManager class
Please see copyright.inc.php for a detailed description, copyright and license information.
This class processes the input arguments from the GET or POST data of the request.
An array of arguments received via the GET or POST parameter xjxargs.
A configuration option used to indicate whether input data should be UTF8 decoded automatically.
The character encoding in which the input data will be received.
Stores the method that was used to send the arguments from the client.
Stores the decoding sequence table.
Initializes configuration settings to their default values and reads the argument data from the GET or POST data.
Accepts configuration settings from the main xajax object.
Returns the method that was used to send the arguments from the client.
Returns the array of arguments that were extracted and parsed from the GET or POST data.

xajaxArgumentManager class

Please see copyright.inc.php for a detailed description, copyright and license information.

xajaxArgumentManager

This class processes the input arguments from the GET or POST data of the request.  If this is a request for the initial page load, no arguments will be processed.  During a xajax request, any arguments found in the GET or POST will be converted to a PHP array.

Summary
An array of arguments received via the GET or POST parameter xjxargs.
A configuration option used to indicate whether input data should be UTF8 decoded automatically.
The character encoding in which the input data will be received.
Stores the method that was used to send the arguments from the client.
Stores the decoding sequence table.
Initializes configuration settings to their default values and reads the argument data from the GET or POST data.
Accepts configuration settings from the main xajax object.
Returns the method that was used to send the arguments from the client.
Returns the array of arguments that were extracted and parsed from the GET or POST data.

Variables

aArgs

var $aArgs

An array of arguments received via the GET or POST parameter xjxargs.

bDecodeUTF8Input

var $bDecodeUTF8Input

A configuration option used to indicate whether input data should be UTF8 decoded automatically.

sCharacterEncoding

var $sCharacterEncoding

The character encoding in which the input data will be received.

nMethod

var $nMethod

Stores the method that was used to send the arguments from the client.  Will be one of: XAJAX_METHOD_UNKNOWN, XAJAX_METHOD_GET, XAJAX_METHOD_POST

aSequence

var $aSequence

Stores the decoding sequence table.

Functions

xajaxArgumentManager

function xajaxArgumentManager()

Initializes configuration settings to their default values and reads the argument data from the GET or POST data.

getInstance

function &getInstance()

Returns

objectA reference to an instance of this class.  This function is used to implement the singleton pattern.

configure

function configure($sName,
$mValue)

Accepts configuration settings from the main xajax object.

The xajaxArgumentManager tracks the following configuration settings

<decodeUTF8Input>(boolean): See xajaxArgumentManager->bDecodeUTF8Input
<characterEncoding>(string): See xajaxArgumentManager->sCharacterEncoding

getRequestMethod

function getRequestMethod()

Returns the method that was used to send the arguments from the client.

process

function process()

Returns the array of arguments that were extracted and parsed from the GET or POST data.

This file contains detailed information regarding the xajax project, current version, copyrights, licnese and documentation.
var $aArgs
An array of arguments received via the GET or POST parameter xjxargs.
var $bDecodeUTF8Input
A configuration option used to indicate whether input data should be UTF8 decoded automatically.
var $sCharacterEncoding
The character encoding in which the input data will be received.
var $nMethod
Stores the method that was used to send the arguments from the client.
var $aSequence
Stores the decoding sequence table.
function xajaxArgumentManager()
Initializes configuration settings to their default values and reads the argument data from the GET or POST data.
function &getInstance()
function configure($sName,
$mValue)
Accepts configuration settings from the main xajax object.
function getRequestMethod()
Returns the method that was used to send the arguments from the client.
function process()
Returns the array of arguments that were extracted and parsed from the GET or POST data.