admin_setting_configselect Class Reference

Inheritance diagram for admin_setting_configselect:

Collaboration diagram for admin_setting_configselect:

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

---

Detailed Description

Select one value from list

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

Definition at line 2395 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
string | int	$defaultsetting
array	$choices	array of $value=>$label for each selection

Reimplemented in admin_setting_configselect_with_advanced, admin_settings_country_select, and admin_setting_configmultiselect.

Definition at line 2407 of file adminlib.php.

---

Member Function Documentation

get_setting

(

)

Return the setting

Returns:

mixed returns config if successful else null

Reimplemented from admin_setting.

Reimplemented in admin_setting_configselect_with_advanced, admin_setting_sitesetselect, admin_setting_special_selectsetup, admin_setting_users_with_capability, and admin_setting_configmultiselect.

Definition at line 2460 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

is_related

(

$

query

)

Check if this is $query is related to a choice

Parameters:

string

$query

Returns:

bool true if related, false if not

Reimplemented from admin_setting.

Reimplemented in admin_setting_configmultiselect.

Definition at line 2436 of file adminlib.php.

Here is the call graph for this function:

load_choices

(

)

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

Override this method if loading of choices is expensive, such as when it requires multiple db requests.

Returns:

bool true if loaded, false if error

Reimplemented in admin_setting_configmultiselect_modules, admin_setting_special_registerauth, admin_setting_grade_profilereport, admin_setting_question_behaviour, admin_setting_special_debug, admin_settings_coursecat_select, admin_settings_num_course_sections, admin_settings_country_select, admin_setting_users_with_capability, mod_quiz_admin_setting_browsersecurity, and mod_quiz_admin_setting_grademethod.

Definition at line 2420 of file adminlib.php.

Here is the caller graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns XHTML select field and wrapping div(s)

See also:

output_select_html()

Parameters:

string	$data	the option to show as selected
string	$query

Returns:

string XHTML field and wrapping div

Reimplemented from admin_setting.

Reimplemented in admin_setting_configselect_with_advanced, and admin_setting_configmultiselect.

Definition at line 2528 of file adminlib.php.

Here is the call graph for this function:

output_select_html	(	$	data,
		$	current,
		$	default,
		$	extraname = ''
	)

Returns XHTML select field

Ensure the options are loaded, and generate the XHTML for the select element and any warning message. Separating this out from output_html makes it easier to subclass this class.

Parameters:

string	$data	the option to show as selected.
string	$current	the currently selected option in the database, null if none.
string	$default	the default selected option.

Returns:

array the HTML for the select element, and a warning message.

Definition at line 2493 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

write_setting

(

$

data

)

Save a setting

Parameters:

string

$data

Returns:

string empty of error string

Reimplemented from admin_setting.

Reimplemented in admin_setting_configselect_with_advanced, admin_setting_bloglevel, admin_setting_sitesetselect, admin_setting_special_selectsetup, admin_setting_users_with_capability, and admin_setting_configmultiselect.

Definition at line 2470 of file adminlib.php.

Here is the call graph for this function:

---

Field Documentation

$choices

Definition at line 2397 of file adminlib.php.

---

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

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