admin_setting_configcheckbox_with_lock Class Reference

Inheritance diagram for admin_setting_configcheckbox_with_lock:

Collaboration diagram for admin_setting_configcheckbox_with_lock:

Public Member Functions
	__construct ($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0')
	get_setting ()
	write_setting ($data)
	output_html ($data, $query='')

---

Detailed Description

Checkbox with an advanced checkbox that controls an additional $name.'_locked' config setting.

This is nearly a copy/paste of admin_setting_configcheckbox_with_adv

Copyright:

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

Definition at line 4121 of file adminlib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	visiblename,
		$	description,
		$	defaultsetting,
		$	yes = '1',
		$	no = '0'
	)

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	('value'=>string, 'locked'=>bool)
string	$yes	value used when checked
string	$no	value used when not checked

Reimplemented from admin_setting_configcheckbox.

Definition at line 4131 of file adminlib.php.

---

Member Function Documentation

get_setting

(

)

Loads the current setting and returns array

Returns:

array Returns array value=>xx, adv=>xx

Reimplemented from admin_setting_configcheckbox.

Definition at line 4140 of file adminlib.php.

Here is the call graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns an XHTML checkbox field and with extra locked checkbox

Parameters:

string	$data	If $data matches yes then checkbox is checked
string	$query

Returns:

string XHTML field

Reimplemented from admin_setting_configcheckbox.

Definition at line 4174 of file adminlib.php.

Here is the call graph for this function:

write_setting

(

$

data

)

Sets the value for the setting

Sets the value for the setting to either the yes or no values of the object by comparing $data to yes

Parameters:

mixed

$data

Gets converted to str for comparison against yes value

Returns:

string empty string or error

Reimplemented from admin_setting_configcheckbox.

Definition at line 4158 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