class Request extends Plugin

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 the javascript code for this plugin

from Plugin
string
generateHash()

Generate a unique hash for this plugin

from Plugin
boolean
isRequest()

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

boolean
isResponse()

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

from Plugin
string
getName()

Get the plugin name

from Plugin
mixed
register($aArgs)

Register a function, an event or an object.

boolean
canProcessRequest()

Check if this plugin can process the current request

boolean
processRequest()

Process the current request

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

in Plugin at line line 36
abstract string getScript()

Generate the javascript code for this plugin

Called by <Jaxon\Plugin\Manager> when the page's HTML is being sent to the browser. This code is either inserted right into the HTML code, or exported in an external file which is then included in the page.

Return Value

string

in Plugin at line line 43
abstract string generateHash()

Generate a unique hash for this plugin

Return Value

string

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

in Plugin at line line 73
abstract string getName()

Get the plugin name

Called by the <Jaxon\Plugin\Manager> when the user script requests a plugin. This name must match the plugin name requested in the called to <Jaxon\Response\Response->plugin>.

Return Value

string

at line line 40
abstract mixed register($aArgs)

Register a function, an event or an object.

Called by the <Jaxon\Plugin\Manager> when a user script when a function, event or callable object is to be registered. Additional plugins may support other registration types.

Parameters

$aArgs

Return Value

mixed

at line line 60
abstract boolean canProcessRequest()

Check if this plugin can process the current request

Called by the <Jaxon\Plugin\Manager> when a request has been received to determine if the request is destinated to this request plugin.

Return Value

boolean

at line line 71
abstract boolean processRequest()

Process the current request

Called by the <Jaxon\Plugin\Manager> when a request is being processed. This will only occur when has determined that the current request is a valid (registered) jaxon enabled function via canProcessRequest>.

Return Value

boolean