admin_setting_configcheckbox Class Reference

Inheritance diagram for admin_setting_configcheckbox:

Collaboration diagram for admin_setting_configcheckbox:

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

---

Detailed Description

Checkbox

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

Definition at line 2078 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
string	$defaultsetting
string	$yes	value used when checked
string	$no	value used when not checked

Reimplemented in admin_setting_configcheckbox_with_lock, and admin_setting_configcheckbox_with_advanced.

Definition at line 2093 of file adminlib.php.

Here is the caller graph for this function:

---

Member Function Documentation

get_setting

(

)

Retrieves the current setting using the objects name

Returns:

string

Reimplemented from admin_setting.

Reimplemented in admin_setting_enablemobileservice, admin_setting_configcheckbox_with_lock, admin_setting_configcheckbox_with_advanced, and admin_setting_sitesetcheckbox.

Definition at line 2104 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns an XHTML checkbox field

Parameters:

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

Returns:

string XHTML field

Reimplemented from admin_setting.

Reimplemented in admin_setting_enablemobileservice, admin_setting_configcheckbox_with_lock, and admin_setting_configcheckbox_with_advanced.

Definition at line 2133 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.

Reimplemented in admin_setting_enablemobileservice, admin_setting_special_gradelimiting, admin_setting_regradingcheckbox, admin_setting_configcheckbox_with_lock, admin_setting_configcheckbox_with_advanced, admin_setting_sitesetcheckbox, and admin_setting_special_adminseesall.

Definition at line 2117 of file adminlib.php.

Here is the call graph for this function:

---

Field Documentation

$no

Definition at line 2082 of file adminlib.php.

$yes

Definition at line 2080 of file adminlib.php.

---

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

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