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.
/admin/tool/usertours/classes/local/filter/ -> course.php (source)

[Source view]

Course filter.

Copyright: 2017 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 117 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course:: (5 methods):
  get_filter_name()
  add_filter_to_form()
  filter_matches()
  prepare_filter_values_for_form()
  save_filter_values_from_form()


Class: course  - X-Ref

Course filter.

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

return: string

add_filter_to_form(\MoodleQuickForm &$mform)   X-Ref
Overrides the base add form element with a course selector.

param: \MoodleQuickForm $mform

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

prepare_filter_values_for_form(tour $tour, \stdClass $data)   X-Ref
Overrides the base prepare the filter values for the form with an integer value.

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
Overrides the base 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