admin_setting_configmulticheckbox Class Reference

Inheritance diagram for admin_setting_configmulticheckbox:

Collaboration diagram for admin_setting_configmulticheckbox:

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

---

Detailed Description

Multiple checkboxes, each represents different value, stored in csv format

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

Definition at line 2165 of file adminlib.php.

---

Constructor & Destructor Documentation

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

Constructor: uses parent::__construct

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
array	$choices	array of $value=>$label for each checkbox

Definition at line 2178 of file adminlib.php.

---

Member Function Documentation

get_setting

(

)

Returns the current setting if it is set

Returns:

mixed null if null, else an array

Reimplemented from admin_setting.

Reimplemented in admin_setting_configmulticheckbox2.

Definition at line 2227 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 on related, false on not or failure

Reimplemented from admin_setting.

Definition at line 2205 of file adminlib.php.

Here is the call graph for this function:

load_choices

(

)

This public function may be used in ancestors for lazy loading of choices

Todo:

Check if this function is still required content commented out only returns true

Returns:

bool true if loaded, false if error

Reimplemented in admin_setting_special_gradeexport, admin_setting_pickroles, and admin_setting_special_backupdays.

Definition at line 2189 of file adminlib.php.

Here is the caller graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns XHTML field(s) as required by choices

Relies on data being an array should data ever be another valid vartype with acceptable value this may cause a warning/error if (!is_array($data)) would fix the problem

Todo:

Add vartype handling to ensure $data is an array

Parameters:

array	$data	An array of checked values
string	$query

Returns:

string XHTML field

Reimplemented from admin_setting.

Definition at line 2280 of file adminlib.php.

Here is the call graph for this function:

write_setting

(

$

data

)

Saves the setting(s) provided in $data

Parameters:

array

$data

An array of data, if not array returns empty str

Returns:

mixed empty string on useless data or bool true=success, false=failed

Reimplemented from admin_setting.

Reimplemented in admin_setting_configmulticheckbox2.

Definition at line 2250 of file adminlib.php.

Here is the call graph for this function:

---

Field Documentation

$choices

Definition at line 2167 of file adminlib.php.

---

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

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