enrol_user_button Class Reference

Inheritance diagram for enrol_user_button:

Collaboration diagram for enrol_user_button:

Public Member Functions
	__construct (moodle_url $url, $label, $method= 'post')
	require_yui_module ($modules, $function, array $arguments=null, $galleryversion= '2010.04.08-12-35', $ondomready=false)
	require_js_init_call ($function, array $extraarguments=null, $ondomready=false, array $module=null)
	strings_for_js ($identifiers, $component= 'moodle', $a=null)
	initialise_js (moodle_page $page)
Protected Attributes
	$jsyuimodules = array()
	$jsinitcalls = array()
	$jsstrings = array()

---

Detailed Description

A button that is used to enrol users in a course

Copyright:

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

Definition at line 1002 of file locallib.php.

---

Constructor & Destructor Documentation

__construct	(	moodle_url $	url,
		$	label,
		$	method = 'post'
	)

Initialises the new enrol_user_button

int $count The number of enrol user buttons already created

Parameters:

moodle_url	$url
string	$label	The text to display in the button
string	$method	Either post or get

Reimplemented from single_button.

Definition at line 1030 of file locallib.php.

---

Member Function Documentation

initialise_js

(

moodle_page $

page

)

Initialises the JS that is required by this button

Parameters:

moodle_page

$page

Definition at line 1094 of file locallib.php.

Here is the caller graph for this function:

require_js_init_call	(	$	function,
		array $	extraarguments = null,
		$	ondomready = false,
		array $	module = null
	)

Adds a JS initialisation call to the page when the button is used.

Parameters:

string	$function	The function to call
array	$extraarguments	An array of arguments to pass to the function
bool	$ondomready	If true the call is postponed until the DOM is finished loading
array	$module	A module definition

Definition at line 1065 of file locallib.php.

require_yui_module	(	$	modules,
		$	function,
		array $	arguments = null,
		$	galleryversion = '2010.04.08-12-35',
		$	ondomready = false
	)

Adds a YUI module call that will be added to the page when the button is used.

Parameters:

string | array	$modules	One or more modules to require
string	$function	The JS function to call
array	$arguments	An array of arguments to pass to the function
string	$galleryversion	The YUI gallery version of any modules required
bool	$ondomready	If true the call is postponed until the DOM is finished loading

Definition at line 1047 of file locallib.php.

strings_for_js	(	$	identifiers,
		$	component = 'moodle',
		$	a = null
	)

Requires strings for JS that will be loaded when the button is used.

Parameters:

type	$identifiers
string	$component
mixed	$a

Definition at line 1081 of file locallib.php.

---

Field Documentation

$jsinitcalls = array() [protected]

Definition at line 1014 of file locallib.php.

$jsstrings = array() [protected]

Definition at line 1020 of file locallib.php.

$jsyuimodules = array() [protected]

Definition at line 1008 of file locallib.php.

---

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

• C:/xampp/htdocs/moodle/enrol/locallib.php