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.
/reportbuilder/classes/local/filters/ -> text.php (source)

[Source view]

(no description)

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

Defines 1 class

text:: (5 methods):
  get_operators()
  setup_form()
  get_sql_filter()
  validate_filter_values()
  get_sample_values()


Class: text  - X-Ref

Text report filter

get_operators()   X-Ref
Return an array of operators available for this filter

return: array of comparison operators

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

Operator selector use the "$this->name . '_operator'" naming convention and the fields to enter custom values should
use "$this->name . '_value'" or _value1/_value2/... in case there is more than one field for their naming.

param: \MoodleQuickForm $mform

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

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

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

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

get_sample_values()   X-Ref
Return sample filter values

return: array