Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

(no description)

File Size: 152 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

select:: (6 methods):
  get_operators()
  get_select_options()
  setup_form()
  get_sql_filter()
  validate_filter_values()
  get_sample_values()


Class: select  - X-Ref

Select report filter

The options for the select are defined when creating the filter by calling {@see set_options} or {@see set_options_callback}

To extend this class in your own filter (e.g. to pre-populate available options), you should override the {@see get_operators}
and/or {@see get_select_options} methods

get_operators()   X-Ref
Returns an array of comparison operators

return: array

get_select_options()   X-Ref
Return the options for the filter as an array, to be used to populate the select input field

return: array

setup_form(MoodleQuickForm $mform)   X-Ref
Adds controls specific to this filter in the form.

param: MoodleQuickForm $mform

get_sql_filter(array $values)   X-Ref
Return filter SQL

Note that operators must be of type integer, while values can be integer or string.

param: array $values
return: array array of two elements - SQL query and named parameters

validate_filter_values(?int $operator, $value)   X-Ref
Validate filter form values

param: int|null $operator
param: mixed|null $value
return: bool

get_sample_values()   X-Ref
Return sample filter values

return: array