admin_setting_configmultiselect Class Reference

Inheritance diagram for admin_setting_configmultiselect:

Collaboration diagram for admin_setting_configmultiselect:

Public Member Functions
	__construct ($name, $visiblename, $description, $defaultsetting, $choices)
	get_setting ()
	write_setting ($data)
	is_related ($query)
	output_html ($data, $query='')

---

Detailed Description

Select multiple items from list

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

Definition at line 2555 of file adminlib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	visiblename,
		$	description,
		$	defaultsetting,
		$	choices
	)

Constructor

Parameters:

string	$name	unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
string	$visiblename	localised
string	$description	long localised info
array	$defaultsetting	array of selected items
array	$choices	array of $value=>$label for each list item

Reimplemented from admin_setting_configselect.

Definition at line 2564 of file adminlib.php.

---

Member Function Documentation

get_setting

(

)

Returns the select setting(s)

Returns:

mixed null or array. Null if no settings else array of setting(s)

Reimplemented from admin_setting_configselect.

Reimplemented in admin_setting_users_with_capability.

Definition at line 2573 of file adminlib.php.

Here is the call graph for this function:

is_related

(

$

query

)

Is setting related to query text - used when searching

Parameters:

string

$query

Returns:

bool true if related, false if not

Reimplemented from admin_setting_configselect.

Definition at line 2619 of file adminlib.php.

Here is the call graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns XHTML multi-select field

Todo:

Add vartype handling to ensure $data is an array

Parameters:

array	$data	Array of values to select by default
string	$query

Returns:

string XHTML multi-select field

Reimplemented from admin_setting_configselect.

Definition at line 2644 of file adminlib.php.

Here is the call graph for this function:

write_setting

(

$

data

)

Saves setting(s) provided through $data

Potential bug in the works should anyone call with this function using a vartype that is not an array

Parameters:

array

$data

Reimplemented from admin_setting_configselect.

Reimplemented in admin_setting_users_with_capability.

Definition at line 2592 of file adminlib.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/lib/adminlib.php