tool_usertours\local\clientside_filter\cssselector Class Reference

Course filter. More...

Inheritance diagram for tool_usertours\local\clientside_filter\cssselector:

Static Public Member Functions
static	add_filter_to_form (\MoodleQuickForm &$mform)
	Overrides the base add form element with a selector text box.
static	filter_matches (tour $tour, context $context)
	Check whether the filter matches the specified tour and/or context.
static	get_client_side_values (tour $tour)
	Returns the filter values needed for client side filtering.
static	get_filter_name ()
	The name of the filter.
static	get_filter_options ()
	Retrieve the list of available filter options.
static	prepare_filter_values_for_form (tour $tour, stdClass $data)
	Prepare the filter values for the form.
static	save_filter_values_from_form (tour $tour, stdClass $data)
	Save the filter values from the form to the tour.

Public Attributes
const	ANYVALUE = '__ANYVALUE__'
	Any Value.

Detailed Description

Course filter.

Copyright

2020 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\clientside_filter\cssselector::add_filter_to_form ( \MoodleQuickForm & $mform )

static

Overrides the base add form element with a selector text box.

Parameters

MoodleQuickForm

$mform

Reimplemented from tool_usertours\local\filter\base.

filter_matches()

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

staticinherited

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 in tool_usertours\local\filter\accessdate, tool_usertours\local\filter\category, tool_usertours\local\filter\course, tool_usertours\local\filter\courseformat, tool_usertours\local\filter\role, and tool_usertours\local\filter\theme.

get_client_side_values()

static tool_usertours\local\clientside_filter\cssselector::get_client_side_values ( tour $tour )

static

Returns the filter values needed for client side filtering.

Parameters

tour

$tour

The tour to find the filter values for

Return values

stdClass

Reimplemented from tool_usertours\local\clientside_filter\clientside_filter.

get_filter_name()

static tool_usertours\local\clientside_filter\cssselector::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\base::get_filter_options ( )

staticinherited

Retrieve the list of available filter options.

Return values

array

An array whose keys are the valid options

Reimplemented in tool_usertours\local\filter\accessdate, tool_usertours\local\filter\category, tool_usertours\local\filter\courseformat, tool_usertours\local\filter\role, and tool_usertours\local\filter\theme.

prepare_filter_values_for_form()

static tool_usertours\local\clientside_filter\cssselector::prepare_filter_values_for_form ( tour $tour, stdClass $data )

static

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 from tool_usertours\local\filter\base.

save_filter_values_from_form()

static tool_usertours\local\clientside_filter\cssselector::save_filter_values_from_form ( tour $tour, stdClass $data )

static

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 from tool_usertours\local\filter\base.

---

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

• admin/tool/usertours/classes/local/clientside_filter/cssselector.php