user_filter_courserole Class Reference

Inheritance diagram for user_filter_courserole:

Collaboration diagram for user_filter_courserole:

Public Member Functions
	user_filter_courserole ($name, $label, $advanced)
	get_roles ()
	get_course_categories ()
	setupForm (&$mform)
	check_data ($formdata)
	get_sql_filter ($data)
	get_label ($data)

---

Detailed Description

User filter based on roles in a course identified by its shortname.

Definition at line 8 of file courserole.php.

---

Member Function Documentation

check_data

(

$

formdata

)

Retrieves data from the form data

Parameters:

object

$formdata

data submited with the form

Returns:

mixed array filter data or false when filter not set

Reimplemented from user_filter_type.

Definition at line 62 of file courserole.php.

get_course_categories

(

)

Returns an array of course categories

Returns:

array of course categories

Definition at line 33 of file courserole.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_label

(

$

data

)

Returns a human friendly description of the filter used as label.

Parameters:

array

$data

filter settings

Returns:

string active filter label

Reimplemented from user_filter_type.

Definition at line 125 of file courserole.php.

get_roles

(

)

Returns an array of available roles

Returns:

array of availble roles

Definition at line 23 of file courserole.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_sql_filter

(

$

data

)

Returns the condition to be used with SQL where

Parameters:

array

$data

filter settings

Returns:

array sql string and $params

Reimplemented from user_filter_type.

Definition at line 84 of file courserole.php.

setupForm

(

&$

mform

)

Adds controls specific to this filter in the form.

Parameters:

object

$mform

a MoodleForm object to setup

Reimplemented from user_filter_type.

Definition at line 46 of file courserole.php.

Here is the call graph for this function:

user_filter_courserole	(	$	name,
		$	label,
		$	advanced
	)

Constructor

Parameters:

string	$name	the name of the filter instance
string	$label	the label of the filter instance
boolean	$advanced	advanced form element flag

Definition at line 15 of file courserole.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/user/filters/courserole.php