Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

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

Renderer for the grade user report

Copyright: 2010 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 218 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

gradereport_user_renderer:: (5 methods):
  graded_users_selector()
  view_user_selector()
  users_selector()
  user_navigation()
  view_mode_selector()


Class: gradereport_user_renderer  - X-Ref

Custom renderer for the user grade report

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

graded_users_selector(string $report, stdClass $course, int $userid, ?int $groupid, bool $includeall)   X-Ref
Small rendering function that helps with outputting the relevant user selector.

param: string $report
param: stdClass $course
param: int $userid
param: null|int $groupid
param: bool $includeall
return: string The raw HTML to render.

view_user_selector(int $userid, int $userview)   X-Ref
Creates and renders the single select box for the user view.

param: int $userid The selected userid
param: int $userview The current view user setting constant
return: string

users_selector(object $course, ?int $userid = null, ?int $groupid = null)   X-Ref
Renders the user selector trigger element.

param: object $course The course object.
param: int|null $userid The user ID.
param: int|null $groupid The group ID.
return: string The raw HTML to render.

user_navigation(graded_users_iterator $gui, int $userid, int $courseid)   X-Ref
Creates and renders previous/next user navigation.

param: graded_users_iterator $gui Objects that is used to iterate over a list of gradable users in the course.
param: int $userid The ID of the current user.
param: int $courseid The course ID.
return: string The raw HTML to render.

view_mode_selector(int $userid, int $userview, int $courseid)   X-Ref
Creates and renders 'view report as' selector element.

param: int $userid The selected userid
param: int $userview The current view user setting constant
param: int $courseid The course ID.
return: string The raw HTML to render.