Simple javascript output class.
More...
|
static | event_handler ($selector, $event, $function, array $arguments=null) |
| Writes event handler attaching code.
|
|
static | function_call ($function, array $arguments=null, $delay=0) |
| Returns javascript code calling the function.
|
|
static | function_call_with_Y ($function, array $extraarguments=null) |
| Special function which adds Y as first argument of function call.
|
|
static | object_init ($var, $class, array $arguments=null, array $requirements=null, $delay=0) |
| Returns JavaScript code to initialise a new object.
|
|
static | set_variable ($name, $value, $usevar=true) |
| Returns code setting value to variable.
|
|
Simple javascript output class.
- Copyright
- 2010 Petr Skoda
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- Since
- Moodle 2.0
◆ event_handler()
static js_writer::event_handler |
( |
| $selector, |
|
|
| $event, |
|
|
| $function, |
|
|
array | $arguments = null ) |
|
static |
Writes event handler attaching code.
- Parameters
-
array | string | $selector | standard YUI selector for elements, may be array or string, element id is in the form "#idvalue" |
string | $event | A valid DOM event (click, mousedown, change etc.) |
string | $function | The name of the function to call |
array | $arguments | An optional array of argument parameters to pass to the function |
- Return values
-
◆ function_call()
static js_writer::function_call |
( |
| $function, |
|
|
array | $arguments = null, |
|
|
| $delay = 0 ) |
|
static |
Returns javascript code calling the function.
- Parameters
-
string | $function | function name, can be complex like Y.Event.purgeElement |
array | $arguments | parameters |
int | $delay | execution delay in seconds |
- Return values
-
◆ function_call_with_Y()
static js_writer::function_call_with_Y |
( |
| $function, |
|
|
array | $extraarguments = null ) |
|
static |
Special function which adds Y as first argument of function call.
- Parameters
-
string | $function | The function to call |
array | $extraarguments | Any arguments to pass to it |
- Return values
-
◆ object_init()
static js_writer::object_init |
( |
| $var, |
|
|
| $class, |
|
|
array | $arguments = null, |
|
|
array | $requirements = null, |
|
|
| $delay = 0 ) |
|
static |
Returns JavaScript code to initialise a new object.
- Parameters
-
string | $var | If it is null then no var is assigned the new object. |
string | $class | The class to initialise an object for. |
array | $arguments | An array of args to pass to the init method. |
array | $requirements | Any modules required for this class. |
int | $delay | The delay before initialisation. 0 = no delay. |
- Return values
-
◆ set_variable()
static js_writer::set_variable |
( |
| $name, |
|
|
| $value, |
|
|
| $usevar = true ) |
|
static |
Returns code setting value to variable.
- Parameters
-
string | $name | |
mixed | $value | json serialised value |
bool | $usevar | add var definition, ignored for nested properties |
- Return values
-
The documentation for this class was generated from the following file: