Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

Class for rendering user filters on the course participants page.

Copyright: 2020 Michael Hawkins <michaelh@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 428 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: participants_filter  - X-Ref

Class for rendering user filters on the course participants page.

__construct(context_course $context, string $tableregionid)   X-Ref
Participants filter constructor.

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

get_filtertypes()   X-Ref
Get data for all filter types.

return: array

get_enrolmentstatus_filter()   X-Ref
Get data for the enrolment status filter.

return: stdClass|null

get_roles_filter()   X-Ref
Get data for the roles filter.

return: stdClass|null

get_enrolments_filter()   X-Ref
Get data for the roles filter.

return: stdClass|null

get_groups_filter()   X-Ref
Get data for the groups filter.

return: stdClass|null

get_accesssince_filter()   X-Ref
Get data for the accesssince filter.

return: stdClass|null

get_country_filter()   X-Ref
Get data for the country filter

return: stdClass|null

get_keyword_filter()   X-Ref
Get data for the keywords filter.

return: stdClass|null

export_for_template(renderer_base $output)   X-Ref
Export the renderer data in a mustache template friendly format.

param: renderer_base $output Unused.
return: stdClass Data in a format compatible with a mustache template.

get_filter_object(string $name,string $title,bool $custom,bool $multiple,?string $filterclass,array $values,bool $allowempty = false)   X-Ref
Get a standardised filter object.

param: string $name
param: string $title
param: bool $custom
param: bool $multiple
param: string|null $filterclass
param: array $values
param: bool $allowempty
return: stdClass|null