tool_usertours\local\filter\courseformat Class Reference

Course format filter. More...

Inheritance diagram for tool_usertours\local\filter\courseformat:

Static Public Member Functions
static	add_filter_to_form (\MoodleQuickForm &$mform)
	Add the form elements for the filter to the supplied form. More...
static	filter_matches (tour $tour, context $context)
	Check whether the filter matches the specified tour and/or context. More...
static	get_filter_name ()
	The name of the filter. More...
static	get_filter_options ()
	Retrieve the list of available filter options. More...
static	prepare_filter_values_for_form (tour $tour, stdClass $data)
	Prepare the filter values for the form. More...
static	save_filter_values_from_form (tour $tour, stdClass $data)
	Save the filter values from the form to the tour. More...

Public Attributes
const	ANYVALUE = '__ANYVALUE__'
	Any Value.

Detailed Description

Course format filter.

Copyright

2017 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

add_filter_to_form()

static tool_usertours\local\filter\base::add_filter_to_form ( \MoodleQuickForm &  $mform )

staticinherited

Add the form elements for the filter to the supplied form.

Parameters

MoodleQuickForm

$mform

The form to add filter settings to.

Reimplemented in tool_usertours\local\filter\course.

filter_matches()

static tool_usertours\local\filter\courseformat::filter_matches ( tour  $tour, context  $context  )

static

Check whether the filter matches the specified tour and/or context.

Parameters

tour	$tour	The tour to check
context	$context	The context to check

Return values

boolean

Reimplemented from tool_usertours\local\filter\base.

get_filter_name()

static tool_usertours\local\filter\courseformat::get_filter_name ( )

static

The name of the filter.

Return values

string

Reimplemented from tool_usertours\local\filter\base.

get_filter_options()

static tool_usertours\local\filter\courseformat::get_filter_options ( )

static

Retrieve the list of available filter options.

Return values

array

An array whose keys are the valid options And whose values are the values to display

Reimplemented from tool_usertours\local\filter\base.

prepare_filter_values_for_form()

static tool_usertours\local\filter\base::prepare_filter_values_for_form ( tour  $tour, stdClass  $data  )

staticinherited

Prepare the filter values for the form.

Parameters

tour	$tour	The tour to prepare values from
stdClass	$data	The data value

Return values

stdClass

Reimplemented in tool_usertours\local\filter\course.

save_filter_values_from_form()

static tool_usertours\local\filter\base::save_filter_values_from_form ( tour  $tour, stdClass  $data  )

staticinherited

Save the filter values from the form to the tour.

Parameters

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

Reimplemented in tool_usertours\local\filter\course.

---

The documentation for this class was generated from the following file:

• admin/tool/usertours/classes/local/filter/courseformat.php