core\report_helper Class Reference

A helper class with static methods to help report plugins. More...

Static Public Member Functions
static	get_group_filter (stdClass $filterparams)
	Retrieve the right SQL / params for the group filter depending on the filterparams, course and group settings.
static	print_report_selector (string $pluginname)
	Print the selector dropdown.
static	save_selected_report (int $id, moodle_url $url)
	Save the last selected report in the session.

Detailed Description

A helper class with static methods to help report plugins.

Copyright

2021 Sujith Haridasan

License

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

Member Function Documentation

get_group_filter()

static core\report_helper::get_group_filter ( stdClass $filterparams )

static

Retrieve the right SQL / params for the group filter depending on the filterparams, course and group settings.

Addionnaly, it will return the list of users visible by the current user so it can be used to filter out records that are not visible. This is mainly because we cannot use joins as the log tables can be in two different databases.

Parameters

stdClass

$filterparams

Return values

array

print_report_selector()

static core\report_helper::print_report_selector ( string $pluginname )

static

Print the selector dropdown.

Parameters

string

$pluginname

The report plugin where the header is modified

Return values

void

save_selected_report()

static core\report_helper::save_selected_report ( int $id, moodle_url $url )

static

Save the last selected report in the session.

Deprecated

since Moodle 4.0

Parameters

int	$id	The course id
moodle_url	$url	The moodle url

Return values

void

---

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

• lib/classes/report_helper.php