groups_user_selector_base Class Reference

Inheritance diagram for groups_user_selector_base:

Collaboration diagram for groups_user_selector_base:

Public Member Functions
	__construct ($name, $options)
Protected Member Functions
	get_options ()
	convert_array_format ($roles, $search)
Protected Attributes
	$groupid
	$courseid

---

Detailed Description

Base class to avoid duplicating code.

Definition at line 669 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 user_selector_base.

Definition at line 677 of file lib.php.

Here is the call graph for this function:

---

Member Function Documentation

convert_array_format	(	$	roles,
		$	search
	)		[protected]

Parameters:

array

$roles

array in the format returned by groups_calculate_role_people.

Returns:

array array in the format find_users is supposed to return.

Definition at line 697 of file lib.php.

Here is the caller graph for this function:

get_options

(

)

[protected]

Note: this function must be implemented if you use the search ajax field (e.g. set $options['file'] = '/admin/filecontainingyourclass.php';)

Returns:

array the options needed to recreate this user_selector.

Reimplemented from user_selector_base.

Definition at line 686 of file lib.php.

---

Field Documentation

$courseid [protected]

Definition at line 671 of file lib.php.

$groupid [protected]

Definition at line 670 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/user/selector/lib.php