component_action Class Reference

Helper class used by other components that involve an action on the page (URL or JS). More...

Inheritance diagram for component_action:

Public Member Functions
	__construct ($event, $jsfunction, $jsfunctionargs=array())
	Constructor.
	export_for_template (renderer_base $output)
	Export for template.

Public Attributes
string	$event
	$event The DOM event that will trigger this action when caught
string	$jsfunction = false
	A function name to call when the button is clicked The JS function you create must have two arguments:
array	$jsfunctionargs = array()
	An array of arguments to pass to the JS function.

Detailed Description

Helper class used by other components that involve an action on the page (URL or JS).

Copyright

2009 Nicolas Connault

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since

Moodle 2.0

Constructor & Destructor Documentation

__construct()

component_action::__construct	(		$event,
			$jsfunction,
			$jsfunctionargs = array() )

Constructor.

Parameters

string	$event	DOM event
string	$jsfunction	An optional JS function. Required if jsfunctionargs is given
array	$jsfunctionargs	An array of arguments to pass to the jsfunction

Member Function Documentation

export_for_template()

component_action::export_for_template

(

renderer_base

$output

)

Export for template.

Parameters

renderer_base

$output

The renderer.

Return values

stdClass

Implements templatable.

Member Data Documentation

$jsfunction

string component_action::$jsfunction = false

A function name to call when the button is clicked The JS function you create must have two arguments:

1. The event object
2. An object/array of arguments ($jsfunctionargs)

---

The documentation for this class was generated from the following file:

• lib/outputactions.php