|
static | create (filter $filter) |
| Creates an instance of a filter type, based on supplied report filter instance.
|
|
|
int const | ANY_VALUE = 0 |
| Any value.
|
|
int const | EMPTY = 3 |
| Tags are not present.
|
|
int const | EQUAL_TO = 2 |
| Filter for selected tags.
|
|
int const | NOT_EMPTY = 1 |
| Tags are present.
|
|
int const | NOT_EQUAL_TO = 4 |
| Filter for excluded tags.
|
|
|
filter | $filter |
| $filter
|
|
string | $name |
| $name
|
|
◆ applies_to_values()
core_reportbuilder\local\filters\base::applies_to_values |
( |
array | $values | ) |
|
|
inherited |
Given an array of current filter values for the report, determine whether the filter would apply to the report (i.e.
user has configured it from it's initial "Any value" state). A filter would typically be considered applied if it returns SQL filter clauses, but child classes may override this method if they use different logic
- Parameters
-
- Return values
-
◆ create()
static core_reportbuilder\local\filters\base::create |
( |
filter | $filter | ) |
|
|
staticfinalinherited |
Creates an instance of a filter type, based on supplied report filter instance.
The report filter instance is used by reports/entities to define what should be filtered against, e.g. a SQL fragment
- Parameters
-
filter | $filter | The report filter instance |
- Return values
-
◆ get_entity_name()
core_reportbuilder\local\filters\base::get_entity_name |
( |
| ) |
|
|
finalinherited |
Returns the filter's entity name.
- Return values
-
◆ get_filter_persistent()
core_reportbuilder\local\filters\base::get_filter_persistent |
( |
| ) |
|
|
finalinherited |
Returns the filter persistent.
Note that filters for system reports don't store a persistent and will return null.
- Return values
-
◆ get_header()
core_reportbuilder\local\filters\base::get_header |
( |
| ) |
|
|
finalinherited |
Returns the filter header.
- Return values
-
◆ get_sample_values()
core_reportbuilder\local\filters\base::get_sample_values |
( |
| ) |
|
|
inherited |
Return sample filter values, that when applied to a report would activate the filter - that is, cause the filter to return SQL snippet.
Should be overridden in child classes, to ensure compatibility with stress tests of reports
- Return values
-
Reimplemented in core_reportbuilder\local\filters\autocomplete, core_reportbuilder\local\filters\boolean_select, core_reportbuilder\local\filters\category, core_reportbuilder\local\filters\cohort, core_reportbuilder\local\filters\course_selector, core_reportbuilder\local\filters\date, core_reportbuilder\local\filters\duration, core_reportbuilder\local\filters\filesize, core_reportbuilder\local\filters\number, core_reportbuilder\local\filters\select, core_reportbuilder\local\filters\text, and core_reportbuilder\local\filters\user.
◆ get_sql_filter()
core_reportbuilder\local\filters\tags::get_sql_filter |
( |
array | $values | ) |
|
◆ setup_form()
core_reportbuilder\local\filters\tags::setup_form |
( |
MoodleQuickForm | $mform | ) |
|
The documentation for this class was generated from the following file:
- reportbuilder/classes/local/filters/tags.php