Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
core_user\output\unified_filter Class Reference

Class containing the filter options data for rendering the unified filter autocomplete element for the course participants page. More...

Inheritance diagram for core_user\output\unified_filter:
renderable templatable

Public Member Functions

 __construct ($filteroptions, $selectedoptions, $baseurl=null)
 unified_filter constructor. More...
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template. More...
 

Protected Attributes

moodle_url string $baseurl
 $baseurl The url with params needed to call up this page.
 
array $filteroptions
 $filteroptions The filter options.
 
array $selectedoptions
 $selectedoptions The list of selected filter option values.
 

Detailed Description

Class containing the filter options data for rendering the unified filter autocomplete element for the course participants page.

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

Constructor & Destructor Documentation

◆ __construct()

core_user\output\unified_filter::__construct (   $filteroptions,
  $selectedoptions,
  $baseurl = null 
)

unified_filter constructor.

Parameters
array$filteroptionsThe filter options.
array$selectedoptionsThe list of selected filter option values.
string | moodle_url$baseurlThe url with params needed to call up this page.

Member Function Documentation

◆ export_for_template()

core_user\output\unified_filter::export_for_template ( renderer_base  $output)

Function to export the renderer data in a format that is suitable for a mustache template.

Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implements templatable.


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