user_filter_type Class Reference

The base user filter class. More...

Inheritance diagram for user_filter_type:

Public Member Functions
	__construct ($name, $label, $advanced)
	Constructor.
	check_data ($formdata)
	Retrieves data from the form data.
	get_label ($data)
	Returns a human friendly description of the filter used as label.
	get_sql_filter ($data)
	Returns the condition to be used with SQL where.
	setupForm (&$mform)
	Adds controls specific to this filter in the form.
	user_filter_type ($name, $label, $advanced)
	Old syntax of class constructor.

Public Attributes
bool	$_advanced
	Advanced form element flag.
string	$_label
	The label of this filter instance.
string	$_name
	The name of this filter instance.

Detailed Description

The base user filter class.

All abstract classes must be implemented.

Copyright

1999 Martin Dougiamas http://dougiamas.com

License

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

Constructor & Destructor Documentation

__construct()

user_filter_type::__construct	(		$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

Reimplemented in user_filter_courserole, user_filter_globalrole, and user_filter_profilefield.

Member Function Documentation

check_data()

user_filter_type::check_data

(

$formdata

)

Retrieves data from the form data.

Parameters

stdClass

$formdata

data submited with the form

Return values

mixed

array filter data or false when filter not set

Reimplemented in user_filter_checkbox, user_filter_cohort, user_filter_courserole, user_filter_date, user_filter_globalrole, user_filter_profilefield, user_filter_select, user_filter_simpleselect, and user_filter_text.

get_label()

user_filter_type::get_label

(

$data

)

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

Parameters

array

$data

filter settings

Return values

string

active filter label

Reimplemented in user_filter_checkbox, user_filter_cohort, user_filter_courserole, user_filter_date, user_filter_globalrole, user_filter_profilefield, user_filter_select, user_filter_simpleselect, and user_filter_text.

get_sql_filter()

user_filter_type::get_sql_filter

(

$data

)

Returns the condition to be used with SQL where.

Parameters

array

$data

filter settings

Return values

string

the filtering condition or null if the filter is disabled

Reimplemented in user_filter_anycourses, user_filter_checkbox, user_filter_cohort, user_filter_courserole, user_filter_date, user_filter_globalrole, user_filter_profilefield, user_filter_select, user_filter_simpleselect, user_filter_text, and user_filter_yesno.

setupForm()

user_filter_type::setupForm

(

&

$mform

)

Adds controls specific to this filter in the form.

Parameters

moodleform

$mform

a MoodleForm object to setup

Reimplemented in user_filter_checkbox, user_filter_cohort, user_filter_courserole, user_filter_date, user_filter_globalrole, user_filter_profilefield, user_filter_select, user_filter_simpleselect, and user_filter_text.

user_filter_type()

user_filter_type::user_filter_type	(		$name,
			$label,
			$advanced )

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

---

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

• user/filters/lib.php