class CallableObject extends Request

Traits

Methods

string
getVersion()

Get the Jaxon library version number

from Config
void
setOption(string $sName, mixed $sValue)

Set the value of a config option

from Config
void
setOptions(array $aOptions, string $sKeys = '')

Set the values of an array of config options

from Config
mixed
getOption(string $sName, mixed $xDefault = null)

Get the value of a config option

from Config
bool
hasOption(string $sName)

Check the presence of a config option

from Config
array
getOptionNames(string $sPrefix)

Get the names of the options matching a given prefix

from Config
Config
newConfig()

Create a new the config manager

from Config
string
getScript()

Generate client side javascript code for the registered callable objects

string
generateHash()

Generate a hash for the registered callable objects

boolean
isRequest()

Return true if the object is a request plugin. Always return true here.

from Request
boolean
isResponse()

Return true if the object is a response plugin. Always return false here.

from Plugin
string
getName()

Return the name of this plugin

mixed
register($aArgs)

Register a user defined callable object

boolean
canProcessRequest()

Check if this plugin can process the incoming Jaxon request

boolean
processRequest()

Process the incoming Jaxon request

object
getPluginManager()

Get the plugin manager

from Manager
plugin(string $sName)

Get a registered response plugin

from Manager
object
getRequestManager()

Get the request manager

from Manager
object
getResponseManager()

Get the response manager

from Manager
void
addEventListener(EventListener $xEventListener)

Register an event listener.

from Manager
object
getResponse()

Get the Global Response object

from Manager
newResponse()

Create a new Jaxon response object

from Manager
string
getValidatorMessage()

Get the last error message

from Validator
bool
validateFunction(string $sName)

Validate a function name

from Validator
bool
validateEvent(string $sName)

Validate an event name

from Validator
bool
validateClass(string $sName)

Validate a class name

from Validator
bool
validateMethod(string $sName)

Validate a method name

from Validator
bool
validateUploadedFile(string $sName, array $aUploadedFile)

Validate an uploaded file

from Validator
string
trans(string $sText, array $aPlaceHolders = array(), string $sLanguage = null)

Get a translated string

__construct()

No description

object
getCallableObject(string $sClassName)

Find a callable object by class name

object
getRegisteredObject(string $sClassName)

Find a user registered callable object by class name

Details

in Config at line line 24
string getVersion()

Get the Jaxon library version number

Return Value

string The version number

in Config at line line 37
void setOption(string $sName, mixed $sValue)

Set the value of a config option

Parameters

string $sName The option name
mixed $sValue The option value

Return Value

void

in Config at line line 50
void setOptions(array $aOptions, string $sKeys = '')

Set the values of an array of config options

Parameters

array $aOptions The config options
string $sKeys The keys of the options in the array

Return Value

void

in Config at line line 63
mixed getOption(string $sName, mixed $xDefault = null)

Get the value of a config option

Parameters

string $sName The option name
mixed $xDefault The default value, to be returned if the option is not defined

Return Value

mixed The option value, or null if the option is unknown

in Config at line line 75
bool hasOption(string $sName)

Check the presence of a config option

Parameters

string $sName The option name

Return Value

bool True if the option exists, and false if not

in Config at line line 87
array getOptionNames(string $sPrefix)

Get the names of the options matching a given prefix

Parameters

string $sPrefix The prefix to match

Return Value

array The options matching the prefix

in Config at line line 97
Config newConfig()

Create a new the config manager

Return Value

Config The config manager

at line line 192
string getScript()

Generate client side javascript code for the registered callable objects

Return Value

string

at line line 176
string generateHash()

Generate a hash for the registered callable objects

Return Value

string

in Request at line line 47
boolean isRequest()

Return true if the object is a request plugin. Always return true here.

Return Value

boolean

in Plugin at line line 60
boolean isResponse()

Return true if the object is a response plugin. Always return false here.

Return Value

boolean

at line line 93
string getName()

Return the name of this plugin

Return Value

string

at line line 105
mixed register($aArgs)

Register a user defined callable object

Parameters

$aArgs

Return Value

mixed

at line line 227
boolean canProcessRequest()

Check if this plugin can process the incoming Jaxon request

Return Value

boolean

at line line 249
boolean processRequest()

Process the incoming Jaxon request

Return Value

boolean

in Manager at line line 27
object getPluginManager()

Get the plugin manager

Return Value

object The plugin manager

in Manager at line line 39
Response plugin(string $sName)

Get a registered response plugin

Parameters

string $sName The name of the plugin

Return Value

Response

in Manager at line line 49
object getRequestManager()

Get the request manager

Return Value

object The request manager

in Manager at line line 59
object getResponseManager()

Get the response manager

Return Value

object The response manager

in Manager at line line 69
void addEventListener(EventListener $xEventListener)

Register an event listener.

Parameters

EventListener $xEventListener

Return Value

void

in Manager at line line 79
object getResponse()

Get the Global Response object

Return Value

object The Global Response object

in Manager at line line 89
Response newResponse()

Create a new Jaxon response object

Return Value

Response The new Jaxon response object

in Validator at line line 24
string getValidatorMessage()

Get the last error message

Return Value

string The last error message

in Validator at line line 36
bool validateFunction(string $sName)

Validate a function name

Parameters

string $sName The function name

Return Value

bool True if the function name is valid, and false if not

in Validator at line line 48
bool validateEvent(string $sName)

Validate an event name

Parameters

string $sName The event name

Return Value

bool True if the event name is valid, and false if not

in Validator at line line 60
bool validateClass(string $sName)

Validate a class name

Parameters

string $sName The class name

Return Value

bool True if the class name is valid, and false if not

in Validator at line line 72
bool validateMethod(string $sName)

Validate a method name

Parameters

string $sName The function name

Return Value

bool True if the method name is valid, and false if not

in Validator at line line 85
bool validateUploadedFile(string $sName, array $aUploadedFile)

Validate an uploaded file

Parameters

string $sName The uploaded file variable name
array $aUploadedFile The file data received in the $_FILES array

Return Value

bool True if the file data are valid, and false if not

in Translator at line line 30
string trans(string $sText, array $aPlaceHolders = array(), string $sLanguage = null)

Get a translated string

Parameters

string $sText The key of the translated string
array $aPlaceHolders The placeholders of the translated string
string $sLanguage The language of the translated string

Return Value

string The translated string

at line line 62
__construct()

at line line 283
object getCallableObject(string $sClassName)

Find a callable object by class name

Parameters

string $sClassName The class name of the callable object

Return Value

object

at line line 299
object getRegisteredObject(string $sClassName)

Find a user registered callable object by class name

Parameters

string $sClassName The class name of the callable object

Return Value

object