user_filter_profilefield Class Reference

Inheritance diagram for user_filter_profilefield:

Collaboration diagram for user_filter_profilefield:

Public Member Functions
	user_filter_profilefield ($name, $label, $advanced)
	get_operators ()
	get_profile_fields ()
	setupForm (&$mform)
	check_data ($formdata)
	get_sql_filter ($data)
	get_label ($data)

---

Detailed Description

User filter based on values of custom profile fields.

Definition at line 8 of file profilefield.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 75 of file profilefield.php.

Here is the call 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 175 of file profilefield.php.

Here is the call graph for this function:

get_operators

(

)

Returns an array of comparison operators

Returns:

array of comparison operators

Definition at line 24 of file profilefield.php.

Here is the caller graph for this function:

get_profile_fields

(

)

Returns an array of custom profile fields

Returns:

array of profile fields

Definition at line 39 of file profilefield.php.

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 102 of file profilefield.php.

Here is the call graph for this function:

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 55 of file profilefield.php.

Here is the call graph for this function:

user_filter_profilefield	(	$	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 16 of file profilefield.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/profilefield.php