Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/admin/tool/usertours/classes/local/filter/ -> base.php (source)

[Source view]

Filter base.

Copyright: 2016 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 135 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

base:: (6 methods):
  get_filter_name()
  get_filter_options()
  filter_matches()
  add_filter_to_form()
  prepare_filter_values_for_form()
  save_filter_values_from_form()


Class: base  - X-Ref

Filter base.

get_filter_name()   X-Ref
The name of the filter.

return: string

get_filter_options()   X-Ref
Retrieve the list of available filter options.

return: array                   An array whose keys are the valid options

filter_matches(tour $tour, context $context)   X-Ref
Check whether the filter matches the specified tour and/or context.

param: tour        $tour       The tour to check
param: context     $context    The context to check
return: boolean

add_filter_to_form(\MoodleQuickForm &$mform)   X-Ref
Add the form elements for the filter to the supplied form.

param: MoodleQuickForm $mform      The form to add filter settings to.

prepare_filter_values_for_form(tour $tour, \stdClass $data)   X-Ref
Prepare the filter values for the form.

param: tour            $tour       The tour to prepare values from
param: stdClass        $data       The data value
return: stdClass

save_filter_values_from_form(tour $tour, \stdClass $data)   X-Ref
Save the filter values from the form to the tour.

param: tour            $tour       The tour to save values to
param: stdClass        $data       The data submitted in the form