admin_setting_configtext_with_advanced Class Reference

Inheritance diagram for admin_setting_configtext_with_advanced:

Collaboration diagram for admin_setting_configtext_with_advanced:

Public Member Functions
	__construct ($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null)
	get_setting ()
	write_setting ($data)
	output_html ($data, $query='')

---

Detailed Description

Text field with an advanced checkbox, that controls a additional $name.'_adv' setting.

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

Definition at line 3926 of file adminlib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	visiblename,
		$	description,
		$	defaultsetting,
		$	paramtype = PARAM_RAW,
		$	size = null
	)

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, '__construct'=>bool)
mixed	$paramtype	int means PARAM_XXX type, string is a allowed format in regex
int	$size	default field size

Reimplemented from admin_setting_configtext.

Definition at line 3936 of file adminlib.php.

---

Member Function Documentation

get_setting

(

)

Loads the current setting and returns array

Returns:

array Returns array value=>xx, __construct=>xx

Reimplemented from admin_setting_configtext.

Definition at line 3945 of file adminlib.php.

Here is the call graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Return XHTML for the control

Parameters:

array	$data	Default data array
string	$query

Returns:

string XHTML to display control

Reimplemented from admin_setting_configtext.

Definition at line 3977 of file adminlib.php.

Here is the call graph for this function:

write_setting

(

$

data

)

Saves the new settings passed in $data

Todo:

Add vartype handling to ensure $data is an array

Parameters:

array

$data

Returns:

mixed string or Array

Reimplemented from admin_setting_configtext.

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