admin_setting_users_with_capability Class Reference

Inheritance diagram for admin_setting_users_with_capability:

Collaboration diagram for admin_setting_users_with_capability:

Public Member Functions
	__construct ($name, $visiblename, $description, $defaultsetting, $capability, $includeadmins=true)
	load_choices ()
	get_defaultsetting ()
	get_setting ()
	write_setting ($data)
Protected Attributes
	$capability
	$includeadmins

---

Detailed Description

An admin setting for selecting one or more users who have a capability in the system context

An admin setting for selecting one or more users, who have a particular capability in the system context. Warning, make sure the list will never be too long. There is no paging or searching of this list.

To correctly get a list of users from this config setting, you need to call the get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php.

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

Definition at line 2830 of file adminlib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	visiblename,
		$	description,
		$	defaultsetting,
		$	capability,
		$	includeadmins = true
	)

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 name
string	$description	localised long description
array	$defaultsetting	array of usernames
string	$capability	string capability name.
bool	$includeadmins	include administrators

Definition at line 2846 of file adminlib.php.

---

Member Function Documentation

get_defaultsetting

(

)

Returns the default setting for class

Returns:

mixed Array, or string. Empty string if no default

Reimplemented from admin_setting.

Definition at line 2886 of file adminlib.php.

Here is the call graph for this function:

get_setting

(

)

Returns the current setting

Returns:

mixed array or string

Reimplemented from admin_setting_configmultiselect.

Definition at line 2903 of file adminlib.php.

load_choices

(

)

Load all of the uses who have the capability into choice array

Returns:

bool Always returns true

Reimplemented from admin_setting_configselect.

Definition at line 2857 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

write_setting

(

$

data

)

Save the chosen setting provided as $data

Parameters:

array

$data

Returns:

mixed string or array

Reimplemented from admin_setting_configmultiselect.

Definition at line 2921 of file adminlib.php.

---

Field Documentation

$capability [protected]

Definition at line 2832 of file adminlib.php.

$includeadmins [protected]

Definition at line 2834 of file adminlib.php.

---

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

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