forumreport_summary\output\filters Class Reference

Forum summary report filters renderable. More...

Inheritance diagram for forumreport_summary\output\filters:

Public Member Functions
	__construct (stdClass $course, array $cms, moodle_url $actionurl, array $filterdata=[])
	Builds renderable filter data.
	export_for_template (renderer_base $renderer)
	Export data for use as the context of a mustache template.

Protected Member Functions
	prepare_groups_data (array $groupsdata)
	Prepares groups data and sets relevant property values.

Protected Attributes
moodle_url	$actionurl
	Moodle URL used as the form action on the generate button.
array	$cms
	Course modules the report relates to.
int	$courseid
	Course ID where the report is being generated.
string	$datesbuttontext
	Text to display on the dates filter button.
array	$datesdata = []
	HTML for dates filter.
array	$discussionids = []
	IDs of discussions required for export links.
array	$groupsavailable = []
	Details of groups available for filtering.
array	$groupsselected = []
	IDs of groups selected for filtering.

Detailed Description

Forum summary report filters renderable.

Copyright

2019 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()

forumreport_summary\output\filters::__construct	(	stdClass	$course,
		array	$cms,
		moodle_url	$actionurl,
		array	$filterdata = [] )

Builds renderable filter data.

Parameters

stdClass	$course	The course object.
array	$cms	Array of course module objects.
moodle_url	$actionurl	The form action URL.
array	$filterdata	(optional) Associative array of data that has been set on available filters, if any, in the format filtertype => [values]

Member Function Documentation

export_for_template()

forumreport_summary\output\filters::export_for_template

(

renderer_base

$renderer

)

Export data for use as the context of a mustache template.

Parameters

renderer_base

$renderer

The renderer to be used to display report filters.

Return values

array

Data in a format compatible with a mustache template.

prepare_groups_data()

forumreport_summary\output\filters::prepare_groups_data ( array $groupsdata )

protected

Prepares groups data and sets relevant property values.

Parameters

array

$groupsdata

Groups selected for filtering.

Return values

void.

Member Data Documentation

$actionurl

moodle_url forumreport_summary\output\filters::$actionurl

protected

Moodle URL used as the form action on the generate button.

$actionurl

$cms

array forumreport_summary\output\filters::$cms

protected

Course modules the report relates to.

Array of stdClass objects

$cms

$courseid

int forumreport_summary\output\filters::$courseid

protected

Course ID where the report is being generated.

$courseid

$datesbuttontext

string forumreport_summary\output\filters::$datesbuttontext

protected

Text to display on the dates filter button.

$datesbuttontext

$datesdata

array forumreport_summary\output\filters::$datesdata = []

protected

HTML for dates filter.

$datesdata

$discussionids

array forumreport_summary\output\filters::$discussionids = []

protected

IDs of discussions required for export links.

If a subset of groups available are selected, this will include the discussion IDs within that group in the forum. If all groups are selected, or no groups mode is enabled, this will be empty as no discussion filtering is required in the export.

$discussionids

$groupsavailable

array forumreport_summary\output\filters::$groupsavailable = []

protected

Details of groups available for filtering.

Stored in the format groupid => groupname.

$groupsavailable

$groupsselected

array forumreport_summary\output\filters::$groupsselected = []

protected

IDs of groups selected for filtering.

$groupsselected

---

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

• mod/forum/report/summary/classes/output/filters.php