user_filter_heading extends user_filter_type
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor.
- check_data() : mixed
- Retrieves data from the form data.
- get_label() : string
- Returns a human friendly description of the filter used as label.
- get_sql_filter() : array<string|int, mixed>
- Returns the condition to be used with SQL where.
- setupForm() : void
- Adds controls specific to this filter in the form.
- user_filter_heading() : void
- Old syntax of class constructor. Deprecated in PHP7.
Properties
$_label
public
mixed
$_label
$_name
public
mixed
$_name
Methods
__construct()
Constructor.
public
__construct() : mixed
check_data()
Retrieves data from the form data.
public
check_data(object $formdata) : mixed
Parameters
- $formdata : object
-
data submited with the form
Return values
mixed —array filter data or false when filter not set
get_label()
Returns a human friendly description of the filter used as label.
public
get_label(array<string|int, mixed> $data) : string
Parameters
- $data : array<string|int, mixed>
-
filter settings
Return values
string —active filter label
get_sql_filter()
Returns the condition to be used with SQL where.
public
get_sql_filter(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
filter settings
Return values
array<string|int, mixed> —sql string and $params
setupForm()
Adds controls specific to this filter in the form.
public
setupForm(object &$mform) : void
Parameters
- $mform : object
-
a MoodleForm object to setup
user_filter_heading()
Old syntax of class constructor. Deprecated in PHP7.
public
user_filter_heading(mixed $name, mixed $label, mixed $advanced, mixed $field) : void
Parameters
- $name : mixed
- $label : mixed
- $advanced : mixed
- $field : mixed