admin_setting_ldap_rolemapping Class Reference

Inheritance diagram for admin_setting_ldap_rolemapping:

Collaboration diagram for admin_setting_ldap_rolemapping:

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

---

Detailed Description

Definition at line 72 of file settingslib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	visiblename,
		$	description,
		$	defaultsetting
	)

Constructor: uses parent::__construct

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	default value for the setting (actually unused)

Reimplemented from admin_setting.

Definition at line 82 of file settingslib.php.

---

Member Function Documentation

get_setting

(

)

Returns the current setting if it is set

Returns:

mixed null if null, else an array

Reimplemented from admin_setting.

Definition at line 91 of file settingslib.php.

Here is the call graph for this function:

output_html	(	$	data,
		$	query = ''
	)

Returns XHTML field(s) as required by choices

Relies on data being an array should data ever be another valid vartype with acceptable value this may cause a warning/error if (!is_array($data)) would fix the problem

Todo:

Add vartype handling to ensure $data is an array

Parameters:

array	$data	An array of checked values
string	$query

Returns:

string XHTML field

Reimplemented from admin_setting.

Definition at line 141 of file settingslib.php.

Here is the call graph for this function:

write_setting

(

$

data

)

Saves the setting(s) provided in $data

Parameters:

array

$data

An array of data, if not array returns empty str

Returns:

mixed empty string on useless data or success, error string if failed

Reimplemented from admin_setting.

Definition at line 111 of file settingslib.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/enrol/ldap/settingslib.php