$cache
$cache : \CJAX\Core\Cache
The cache property, stores a reference to the cache object.
The CJAX class that is the core public API used to create AJAX requests/events.
By default CJAX follows singleton pattern, which will be changed to DI in future. This class serves as the public API, it provides method used directly in client code.
$cache : \CJAX\Core\Cache
The cache property, stores a reference to the cache object.
$config : \CJAX\Core\Config|\CJAX\Core\Ext
The config property, specifies the configuration variables for CJAX.
$coreEvents : \CJAX\Core\CoreEvents
The coreEvents property, holds a reference to the core events object.
$domEvents : \CJAX\Core\DOMEvents
The domEvents property, stores a reference to the dom events object.
$pluginManager : \CJAX\Core\PluginManager
The pluginManager property, holds a reference to the plugin manager object.
$request : \CJAX\Core\Request
The request property, stores a reference to CJAX request object.
$CJAX : \CJAX\Core\CJAX
The CJAX property, stores the singleton instance of CJAX.
getInstance() : \CJAX\Core\CJAX
The static method getInstance, acquires the singleton instance for CJAX class.
This method will be deprecated in future and removed in CJAX 7.0.
click(string $elementId, array $actions = array()) : \CJAX\Core\XmlItem
The click method, assigns a click AJAX event to the given element.
| string | $elementId | |
| array | $actions |
change(string $elementId, array $actions) : \CJAX\Core\XmlItem
The change method, assigns a change AJAX event to the given element.
| string | $elementId | |
| array | $actions |
blur(string $elementId, array $actions) : \CJAX\Core\XmlItem
The blur method, assigns a blur AJAX event to the given element.
| string | $elementId | |
| array | $actions |
keyup(string $elementId, array $actions) : \CJAX\Core\XmlItem
The keyup method, assigns a keyup AJAX event to the given element.
| string | $elementId | |
| array | $actions |
keydown(string $elementId, array $actions) : \CJAX\Core\XmlItem
The keydown method, assigns a keydown AJAX event to the given element.
| string | $elementId | |
| array | $actions |
keypress(string $elementId, mixed $actions, string $key = null) : \CJAX\Core\XmlItem
The keypress method, assigns a keypress AJAX event to the given element.
KeyPress is a relatively complex event, it is handled by DomEvents class internally.
| string | $elementId | |
| mixed | $actions | |
| string | $key |
rightclick(string $elementId, array $actions) : \CJAX\Core\XmlItem
The rightclick method, assigns a rightclick AJAX event to the given element.
| string | $elementId | |
| array | $actions |
doubleclick(string $elementId, array $actions) : \CJAX\Core\XmlItem
The doubleclick method, assigns a doubleclick AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mouseover(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mouseover method, assigns a mouseover AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mouseout(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mouseout method, assigns a mouseout AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mouseenter(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mouseenter method, assigns a mouseenter AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mouseleave(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mouseleave method, assigns a mouseleave AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mousedown(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mousedown method, assigns a mousedown AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mouseup(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mouseup method, assigns a mouseup AJAX event to the given element.
| string | $elementId | |
| array | $actions |
mousemove(string $elementId, array $actions) : \CJAX\Core\XmlItem
The mousemove method, assigns a mousemove AJAX event to the given element.
| string | $elementId | |
| array | $actions |
drag(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The drag method, assigns a drag AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
dragend(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The dragend method, assigns a dragend AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
dragenter(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The dragenter method, assigns a dragenter AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
dragleave(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The dragleave method, assigns a dragleave AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
dragover(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The dragover method, assigns a dragover AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
dragstart(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The dragstart method, assigns a dragstart AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
drop(string $elementId, array $actions, $dataTransfer = null) : \CJAX\Core\XmlItem
The drop method, assigns a drop AJAX event to the given element.
| string | $elementId | |
| array | $actions | |
| $dataTransfer |
call(string $url, string $containerId = null, string $confirm = null) : \CJAX\Core\XmlItem
The call method, create Ajax calls with CJAX.
It provides a public API for singleton ajax object to call call method on DOMEvents object.
| string | $url | |
| string | $containerId | |
| string | $confirm |
dialog(string $content, string $title = null, array $options = array()) : \CJAX\Core\XmlItem
The dialog method, triggers a CJAX dialog with specified information.
| string | $content | |
| string | $title | |
| array | $options |
exec(string $selector, array $actions, string $event = "click") : \CJAX\Core\XmlItem
The exec method, binds any events to given elements.
It provides a public API for singleton ajax object to call exec method on CoreEvents object.
| string | $selector | |
| array | $actions | |
| string | $event |
form(string $url, string $formId = null, string $containerId = null, string $confirm = null) : \CJAX\Core\XmlItem
The form method, converts a form into AJAX form and submits this form.
It provides a public API for singleton ajax object to call form method on DOMEvents object.
| string | $url | |
| string | $formId | |
| string | $containerId | |
| string | $confirm |
get(string $setting, boolean $getAsObject = false) : mixed
The get method, acquires session or cookie value.
If the parameter $getAsObject is true, array values will be converted into objects. It provides a public API for singleton ajax object to call get method on CoreEvents object.
| string | $setting | |
| boolean | $getAsObject |
jsCode(string $data, boolean $tags = false, string $output = null) : string
The jsCode method, displays and formats javascript code.
It provides a public API for singleton ajax object to call jsCode method on CoreEvents object.
| string | $data | |
| boolean | $tags | |
| string | $output |
message(string $message, integer $seconds = 3, string $containerId = 'cjax_message') : integer
The message method, display a message in the middle of the screen.
If number of seconds is specified, the message will disappear after the time elapses.
| string | $message | |
| integer | $seconds | |
| string | $containerId |
overLay(string $url = null, array $options = array(), boolean $useCache = false) : \CJAX\Core\XmlItem
The overLay method, shows an overlay of resources from a given url.
It provides a public API for singleton ajax object to call overLay method on DOMEvents object.
| string | $url | |
| array | $options | |
| boolean | $useCache |
overlayContent(string $content = null, array $options = null) : \CJAX\Core\XmlItem
The overLay method, shows an overlay with supplied html content.
It provides a public API for singleton ajax object to call overLayContent method on DOMEvents object.
| string | $content | |
| array | $options |
plugin(string $pluginName, boolean $loadController = false) : \CJAX\Core\Plugin
The plugin method, loads a plugin given its name.
It provides a public API for singleton ajax object to call plugin method on PluginManager object.
| string | $pluginName | |
| boolean | $loadController |
post(string $url, array $vars = array()) : \CJAX\Core\XmlItem
The post method, it uses call() to post stuff.
It provides a public API for singleton ajax object to call post method on DOMEvents object.
| string | $url | |
| array | $vars |
process(string $msg = "Processing...", integer $seconds = 3) : integer
The process method, display a processing message in the middle of the screen.
If number of seconds is specified, the message will disappear after the time elapses.
| string | $msg | |
| integer | $seconds |
wait( $seconds, boolean $milliseconds = false, boolean $expand = true) : \CJAX\Core\CoreEvents
The wait method, it will execute a command in a specified amouth of time.
It provides a public API for singleton ajax object to call wait method on CoreEvents object.
| $seconds | ||
| boolean | $milliseconds | |
| boolean | $expand |