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
	__construct (context_course $context, string $tableregionid)
	Participants filter constructor. More...
	export_for_template (renderer_base $output)
	Export the renderer data in a mustache template friendly format. More...

Protected Member Functions
	get_accesssince_filter ()
	Get data for the accesssince filter. More...
	get_enrolments_filter ()
	Get data for the roles filter. More...
	get_enrolmentstatus_filter ()
	Get data for the enrolment status filter. More...
	get_filter_object (string $name, string $title, bool $custom, bool $multiple, ?string $filterclass, array $values, bool $allowempty=false)
	Get a standardised filter object. More...
	get_filtertypes ()
	Get data for all filter types. More...
	get_groups_filter ()
	Get data for the groups filter. More...
	get_keyword_filter ()
	Get data for the keywords filter. More...
	get_roles_filter ()
	Get data for the roles filter. More...

Protected Attributes
context_course	$context
	$context The context where the filters are being rendered.
stdClass	$course
	$course The course shown
string	$tableregionid
	$tableregionid The table to be updated by this filter

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

Constructor & Destructor Documentation

__construct()

core_user\output\participants_filter::__construct	(	context_course	$context,
		string	$tableregionid
	)

Participants filter constructor.

Parameters

context_course	$context	The context where the filters are being rendered.
string	$tableregionid	The table to be updated by this filter

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_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_user\output\participants_filter::get_filter_object ( string  $name, string  $title, bool  $custom, bool  $multiple, ?string  $filterclass, array  $values, bool  $allowempty = false  )

protected

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

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