existing_role_holders Class Reference

Inheritance diagram for existing_role_holders:

Collaboration diagram for existing_role_holders:

Public Member Functions
	__construct ($name, $options)
	find_users ($search)
Protected Member Functions
	this_con_group_name ($search, $numusers)
	parent_con_group_name ($search, $contextid)

---

Detailed Description

User selector subclass for the list of users who already have the role in question on the assign roles page.

Definition at line 1134 of file lib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	options
	)

Parameters:

string	$name	control name
array	$options	should have two elements with keys groupid and courseid.

Reimplemented from role_assign_user_selector_base.

Definition at line 1136 of file lib.php.

---

Member Function Documentation

find_users

(

$

search

)

Search the database for users matching the $search string, and any other conditions that apply. The SQL for testing whether a user matches the search string should be obtained by calling the search_sql method.

This method is used both when getting the list of choices to display to the user, and also when validating a list of users that was selected.

When preparing a list of users to choose from ($this->is_validating() return false) you should probably have an maximum number of users you will return, and if more users than this match your search, you should instead return a message generated by the too_many_results() method. However, you should not do this when validating.

If you are writing a new user_selector subclass, I strongly recommend you look at some of the subclasses later in this file and in admin/roles/lib.php. They should help you see exactly what you have to do.

Parameters:

string

$search

the search string.

Returns:

array An array of arrays of users. The array keys of the outer array should be the string names of optgroups. The keys of the inner arrays should be userids, and the values should be user objects containing at least the list of fields returned by the method required_fields_sql(). If a user object has a ->disabled property that is true, then that option will be displayed greyed out, and will not be returned by get_selected_users.

Reimplemented from user_selector_base.

Definition at line 1140 of file lib.php.

Here is the call graph for this function:

parent_con_group_name	(	$	search,
		$	contextid
	)		[protected]

Definition at line 1237 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

this_con_group_name	(	$	search,
		$	numusers
	)		[protected]

Definition at line 1209 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• C:/xampp/htdocs/moodle/admin/roles/lib.php