admin_setting_configtext Class Reference

Inheritance diagram for admin_setting_configtext:

Collaboration diagram for admin_setting_configtext:

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

---

Detailed Description

The most flexibly setting, user is typing text

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

Definition at line 1710 of file adminlib.php.

---

Constructor & Destructor Documentation

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

Config text 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
mixed	$paramtype	int means PARAM_XXX type, string is a allowed format in regex
int	$size	default field size

Reimplemented in admin_setting_configtext_with_advanced.

Definition at line 1727 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_configtext_with_advanced, and admin_setting_sitesettext.

Definition at line 1742 of file adminlib.php.

Here is the call graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Return an XHTML string for the setting

Returns:

string Returns an XHTML string

Reimplemented from admin_setting.

Reimplemented in admin_setting_configtext_with_advanced, admin_setting_configdirectory, admin_setting_configexecutable, admin_setting_configfile, admin_setting_configpasswordunmask, admin_setting_confightmleditor, and admin_setting_configtextarea.

Definition at line 1790 of file adminlib.php.

Here is the call graph for this function:

validate

(

$

data

)

Validate data before storage

Parameters:

string

data

Returns:

mixed true if ok string if error found

Reimplemented in admin_setting_sitesettext, and admin_setting_configiplist.

Definition at line 1764 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

write_setting

(

$

data

)

Store new setting

Parameters:

mixed

$data

string or array, must not be NULL

Returns:

string empty string if ok, string error message otherwise

Reimplemented from admin_setting.

Reimplemented in admin_setting_configtext_with_advanced, admin_setting_langlist, admin_setting_sitesettext, and admin_setting_configtext_trim_lower.

Definition at line 1746 of file adminlib.php.

Here is the call graph for this function:

---

Field Documentation

$paramtype

Definition at line 1713 of file adminlib.php.

$size

Definition at line 1715 of file adminlib.php.

---

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

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