core_user\output\participants_filter Class Reference

Class for rendering user filters on the course participants page. More...

Inheritance diagram for core_user\output\participants_filter:

Public Member Functions
	export_for_template (renderer_base $output)
	Export the renderer data in a mustache template friendly format.

Public Attributes
int const	JOINTYPE_ALL = 2
	All of the following match.
int const	JOINTYPE_ANY = 1
	Any of the following match.
int const	JOINTYPE_NONE = 0
	None of the following match.

Protected Member Functions
	get_accesssince_filter ()
	Get data for the accesssince filter.
	get_country_filter ()
	Get data for the country filter.
	get_enrolments_filter ()
	Get data for the roles filter.
	get_enrolmentstatus_filter ()
	Get data for the enrolment status filter.
	get_filter_object (string $name, string $title, bool $custom, bool $multiple, ?string $filterclass, array $values, bool $allowempty=false, ?stdClass $filteroptions=null, bool $required=false, array $joinlist=[self::JOINTYPE_NONE, self::JOINTYPE_ANY, self::JOINTYPE_ALL])
	Get a standardised filter object.
	get_filtertypes ()
	Get data for all filter types.
	get_groups_filter ()
	Get data for the groups filter.
	get_keyword_filter ()
	Get data for the keywords filter.
	get_roles_filter ()
	Get data for the roles filter.

Protected Attributes
context	$context
	$context The context where the filters are being rendered.
stdClass	$course
	$course The course shown
string	$tableregionid
	$tableregionid Container of the table to be updated by this filter, is used to retrieve the table

Detailed Description

Class for rendering user filters on the course participants page.

Copyright

2020 Michael Hawkins micha.nosp@m.elh@.nosp@m.moodl.nosp@m.e.co.nosp@m.m

License

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

Member Function Documentation

export_for_template()

core_user\output\participants_filter::export_for_template

(

renderer_base

$output

)

Export the renderer data in a mustache template friendly format.

Parameters

renderer_base

$output

Unused.

Return values

stdClass

Data in a format compatible with a mustache template.

Implements templatable.

get_accesssince_filter()

core_user\output\participants_filter::get_accesssince_filter ( )

protected

Get data for the accesssince filter.

Return values

stdClass|null

get_country_filter()

core_user\output\participants_filter::get_country_filter ( )

protected

Get data for the country filter.

Return values

stdClass|null

get_enrolments_filter()

core_user\output\participants_filter::get_enrolments_filter ( )

protected

Get data for the roles filter.

Return values

stdClass|null

get_enrolmentstatus_filter()

core_user\output\participants_filter::get_enrolmentstatus_filter ( )

protected

Get data for the enrolment status filter.

Return values

stdClass|null

get_filter_object()

core\output\datafilter::get_filter_object ( string $name, string $title, bool $custom, bool $multiple, ?string $filterclass, array $values, bool $allowempty = false, ?stdClass $filteroptions = null, bool $required = false, array $joinlist = [self::JOINTYPE_NONE, self::JOINTYPE_ANY, self::JOINTYPE_ALL] )

protectedinherited

Get a standardised filter object.

Parameters

string	$name
string	$title
bool	$custom
bool	$multiple
string | null	$filterclass
array	$values
bool	$allowempty

Return values

stdClass|null

get_filtertypes()

core_user\output\participants_filter::get_filtertypes ( )

protected

Get data for all filter types.

Return values

array

Reimplemented from core\output\datafilter.

get_groups_filter()

core_user\output\participants_filter::get_groups_filter ( )

protected

Get data for the groups filter.

Return values

stdClass|null

get_keyword_filter()

core_user\output\participants_filter::get_keyword_filter ( )

protected

Get data for the keywords filter.

Return values

stdClass|null

get_roles_filter()

core_user\output\participants_filter::get_roles_filter ( )

protected

Get data for the roles filter.

Return values

stdClass|null

---

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

• user/classes/output/participants_filter.php