class Armada

Traits

Methods

HTTP
httpResponse($code = '200')

Wrap the Jaxon response into an HTTP response.

Response
ajaxResponse()

Get the Jaxon response.

from Armada
void
addViewRenderer(string $sId, Closure $xClosure)

Add a view renderer with an id

from Armada
Facade
view()

Get the view renderer

from Armada
Session
session()

Get the session manager

from Armada
void
register(array $aOptions = array())

Register the Jaxon classes.

from Armada
object
request(string $classname)

Get a Jaxon request to a given class.

from Armada
object
plugin(string $name)

Get a plugin instance.

from Armada
void
registerClass(string $sClassName, array $aOptions = array())

Register a specified Jaxon class.

from Armada
string
script($bIncludeJs = false, $bIncludeCss = false)

Get the javascript code to be sent to the browser.

from Armada
string
js()

Get the HTML tags to include Jaxon javascript files into the page.

from Armada
string
css()

Get the HTML tags to include Jaxon CSS code and files into the page.

from Armada
void
onInit(callable $callable)

Set the init callback, used to initialise controllers.

from Armada
void
onBefore(callable $callable)

Set the pre-request processing callback.

from Armada
void
onAfter(callable $callable)

Set the post-request processing callback.

from Armada
void
onInvalid(callable $callable)

Set the processing error callback.

from Armada
void
onError(callable $callable)

Set the processing exception callback.

from Armada
boolean
canProcessRequest()

Check if the current request is a Jaxon request.

from Armada
void
processRequest()

Process the current Jaxon request.

from Armada
array
getUploadedFiles()

Get the uploaded files

from Armada
void
__construct()

Initialise the Jaxon module.

void
config($sConfigFile)

Set the config file path.

Details

at line line 90
HTTP httpResponse($code = '200')

Wrap the Jaxon response into an HTTP response.

Parameters

$code The HTTP Response code

Return Value

HTTP Response

in Armada at line line 41
Response ajaxResponse()

Get the Jaxon response.

Return Value

Response

in Armada at line line 54
void addViewRenderer(string $sId, Closure $xClosure)

Add a view renderer with an id

Parameters

string $sId The unique identifier of the view renderer
Closure $xClosure A closure to create the view instance

Return Value

void

in Armada at line line 123
Facade view()

Get the view renderer

Return Value

Facade

in Armada at line line 134
Session session()

Get the session manager

Return Value

Session

in Armada at line line 147
void register(array $aOptions = array())

Register the Jaxon classes.

Parameters

array $aOptions The options to register the classes with

Return Value

void

in Armada at line line 179
object request(string $classname)

Get a Jaxon request to a given class.

Parameters

string $classname the class name

Return Value

object The request to the class

in Armada at line line 191
object plugin(string $name)

Get a plugin instance.

Parameters

string $name the plugin name

Return Value

object The plugin instance

in Armada at line line 204
void registerClass(string $sClassName, array $aOptions = array())

Register a specified Jaxon class.

Parameters

string $sClassName The name of the class to be registered
array $aOptions The options to register the class with

Return Value

void

in Armada at line line 215
string script($bIncludeJs = false, $bIncludeCss = false)

Get the javascript code to be sent to the browser.

Parameters

$bIncludeJs
$bIncludeCss

Return Value

string the javascript code

in Armada at line line 226
string js()

Get the HTML tags to include Jaxon javascript files into the page.

Return Value

string the javascript code

in Armada at line line 237
string css()

Get the HTML tags to include Jaxon CSS code and files into the page.

Return Value

string the javascript code

in Armada at line line 249
void onInit(callable $callable)

Set the init callback, used to initialise controllers.

Parameters

callable $callable The callback function

Return Value

void

in Armada at line line 260
void onBefore(callable $callable)

Set the pre-request processing callback.

Parameters

callable $callable The callback function

Return Value

void

in Armada at line line 272
void onAfter(callable $callable)

Set the post-request processing callback.

Parameters

callable $callable The callback function

Return Value

void

in Armada at line line 284
void onInvalid(callable $callable)

Set the processing error callback.

Parameters

callable $callable The callback function

Return Value

void

in Armada at line line 296
void onError(callable $callable)

Set the processing exception callback.

Parameters

callable $callable The callback function

Return Value

void

in Armada at line line 306
boolean canProcessRequest()

Check if the current request is a Jaxon request.

Return Value

boolean True if the request is Jaxon, false otherwise.

in Armada at line line 317
void processRequest()

Process the current Jaxon request.

Return Value

void

in Armada at line line 329
array getUploadedFiles()

Get the uploaded files

Return Value

array

at line line 21
void __construct()

Initialise the Jaxon module.

Return Value

void

at line line 29
void config($sConfigFile)

Set the config file path.

Parameters

$sConfigFile

Return Value

void