user_filter_event extends user_filter_type
Table of Contents
Properties
- $_advanced : mixed
- $_label : mixed
- $_name : mixed
- $options : mixed
Methods
- __construct() : mixed
- Constructor, initalize user_filter_type.
- check_data() : mixed
- get_label() : string
- Returns a human friendly description of the filter used as label.
- get_sql_filter() : array<string|int, mixed>|string
- Returns the condition to be used with SQL where.
- setupForm() : void
- Adds controls specific to this filter in the form.
Properties
$_advanced
public
mixed
$_advanced
$_label
public
mixed
$_label
$_name
public
mixed
$_name
$options
protected
mixed
$options
= []
Methods
__construct()
Constructor, initalize user_filter_type.
public
__construct(string $name, string $label, bool $advanced[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $name : string
-
the name of the filter instance
- $label : string
-
the label of the filter instance
- $advanced : bool
-
advanced form element flag
- $options : array<string|int, mixed> = []
check_data()
public
check_data(mixed $formdata) : mixed
Parameters
- $formdata : mixed
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>|string
Parameters
- $data : array<string|int, mixed>
-
filter settings
Return values
array<string|int, mixed>|string —sql string and $params
setupForm()
Adds controls specific to this filter in the form.
public
setupForm(moodleform &$mform) : void
Parameters
- $mform : moodleform
-
a MoodleQuickForm object in which element will be added