gradereport_user_renderer Class Reference

Custom renderer for the user grade report. More...

Inheritance diagram for gradereport_user_renderer:

Public Member Functions
	graded_users_selector (string $report, stdClass $course, int $userid, ?int $groupid, bool $includeall)
	Small rendering function that helps with outputting the relevant user selector.
	user_navigation (graded_users_iterator $gui, int $userid, int $courseid)
	Creates and renders previous/next user navigation.
	users_selector (object $course, ?int $userid=null, ?int $groupid=null, string $usersearch='')
	Renders the user selector trigger element.
	view_mode_selector (int $userid, int $userview, int $courseid)
	Creates and renders 'view report as' selector element.
	view_user_selector (int $userid, int $userview)
	Creates and renders the single select box for the user view.

Detailed Description

Custom renderer for the user grade report.

To get an instance of this use the following code: $renderer = $PAGE->get_renderer('gradereport_user');

Copyright

2010 Sam Hemelryk

License

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

Member Function Documentation

graded_users_selector()

gradereport_user_renderer::graded_users_selector	(	string	$report,
		stdClass	$course,
		int	$userid,
		?int	$groupid,
		bool	$includeall )

Small rendering function that helps with outputting the relevant user selector.

Parameters

string	$report
stdClass	$course
int	$userid
null | int	$groupid
bool	$includeall

Return values

string

The raw HTML to render.

Exceptions

coding_exception

user_navigation()

gradereport_user_renderer::user_navigation	(	graded_users_iterator	$gui,
		int	$userid,
		int	$courseid )

Creates and renders previous/next user navigation.

Parameters

graded_users_iterator	$gui	Objects that is used to iterate over a list of gradable users in the course.
int	$userid	The ID of the current user.
int	$courseid	The course ID.

Return values

string

The raw HTML to render.

users_selector()

gradereport_user_renderer::users_selector	(	object	$course,
		?int	$userid = null,
		?int	$groupid = null,
		string	$usersearch = '' )

Renders the user selector trigger element.

Parameters

object	$course	The course object.
int | null	$userid	The user ID.
int | null	$groupid	The group ID.
string	$usersearch	Search string.

Return values

string

The raw HTML to render.

Exceptions

coding_exception

Deprecated

since Moodle 4.5. See user_selector use in gradereport_user\output\action_bar\export_for_template.

view_mode_selector()

gradereport_user_renderer::view_mode_selector	(	int	$userid,
		int	$userview,
		int	$courseid )

Creates and renders 'view report as' selector element.

Parameters

int	$userid	The selected userid
int	$userview	The current view user setting constant
int	$courseid	The course ID.

Return values

string

The raw HTML to render.

Deprecated

since Moodle 4.5 See select_menu use in gradereport_user\output\action_bar\export_for_template.

view_user_selector()

gradereport_user_renderer::view_user_selector	(	int	$userid,
		int	$userview )

Creates and renders the single select box for the user view.

Parameters

int	$userid	The selected userid
int	$userview	The current view user setting constant

Return values

string

---

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

• grade/report/user/renderer.php