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/form/ -> filter.php (source)

[Source view]

(no description)

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

Defines 1 class

filter:: (7 methods):
  get_report()
  get_context_for_dynamic_submission()
  check_access_for_dynamic_submission()
  process_dynamic_submission()
  set_data_for_dynamic_submission()
  get_page_url_for_dynamic_submission()
  definition()


Class: filter  - X-Ref

Dynamic filter form

get_report()   X-Ref
Return instance of the system report using the filter form

return: base

get_context_for_dynamic_submission()   X-Ref
Return the context for the form, it should be that of the system report itself

return: context

check_access_for_dynamic_submission()   X-Ref
Ensure current user is able to use this form

A {@see \core_reportbuilder\report_access_exception} will be thrown if they can't

process_dynamic_submission()   X-Ref
Process the form submission

return: int Number of applied filter instances

set_data_for_dynamic_submission()   X-Ref
Load in existing data as form defaults


get_page_url_for_dynamic_submission()   X-Ref
URL of the page using this form

return: moodle_url

definition()   X-Ref
Filter form definition. It should provide necessary field itself, then allow all report filters to add their own elements