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.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Renderer for the grade single view report.
 *
 * @package   gradereport_singleview
 * @copyright 2022 Mihail Geshoski <mihail@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use gradereport_singleview\report\singleview;

/**
 * Custom renderer for the single view report.
 *
 * To get an instance of this use the following code:
 * $renderer = $PAGE->get_renderer('gradereport_singleview');
 *
 * @copyright 2022 Mihail Geshoski <mihail@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class gradereport_singleview_renderer extends plugin_renderer_base {

    /**
     * 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.
     */
    public function users_selector(object $course, ?int $userid = null, ?int $groupid = null): string {

        $data = [
> 'name' => 'userid',
'courseid' => $course->id, 'groupid' => $groupid ?? 0, ]; // If a particular user option is selected (not in zero state). if ($userid) { // A single user selected. $user = core_user::get_user($userid); $data['selectedoption'] = [ 'image' => $this->user_picture($user, ['size' => 40, 'link' => false]), 'text' => fullname($user), 'additionaltext' => $user->email, ];
> $data['userid'] = $userid;
} $this->page->requires->js_call_amd('gradereport_singleview/user', 'init'); return $this->render_from_template('core_grades/user_selector', $data); } /** * Renders the grade items selector trigger element. * * @param object $course The course object. * @param int|null $gradeitemid The grade item ID. * @return string The raw HTML to render. */ public function grade_items_selector(object $course, ?int $gradeitemid = null): string { $data = [
> 'name' => 'itemid',
'courseid' => $course->id, ]; // If a particular grade item option is selected (not in zero state). if ($gradeitemid) { $gradeitemname = grade_item::fetch(['id' => $gradeitemid])->get_name(true); $data['selectedoption'] = [ 'text' => $gradeitemname, ];
> $data['itemid'] = $gradeitemid;
} $this->page->requires->js_call_amd('gradereport_singleview/grade', 'init'); return $this->render_from_template('gradereport_singleview/grade_item_selector', $data); } /** * Creates and renders previous/next user/grade item navigation. * * @param object $gpr grade plugin return tracking object * @param int $courseid The course ID. * @param \context_course $context Context of the report. * @param singleview $report The single view report class. * @param int|null $groupid Group ID * @param string $itemtype User or Grade item type * @param int $itemid Either User ID or Grade item ID * @return string The raw HTML to render. * @throws moodle_exception */ public function report_navigation(object $gpr, int $courseid, \context_course $context, singleview $report, ?int $groupid, string $itemtype, int $itemid): string { $navigation = ''; $options = $report->screen->options(); $optionkeys = array_keys($options); $optionitemid = array_shift($optionkeys); $relreport = new gradereport_singleview\report\singleview( $courseid, $gpr, $context, $report->screen->item_type(), $optionitemid ); $reloptions = $relreport->screen->options(); $reloptionssorting = array_keys($relreport->screen->options()); $i = array_search($itemid, $reloptionssorting); $navparams = ['item' => $itemtype, 'id' => $courseid, 'group' => $groupid]; // Determine directionality so that icons can be modified to suit language. $previousarrow = right_to_left() ? 'right' : 'left'; $nextarrow = right_to_left() ? 'left' : 'right'; if ($i > 0) { $navparams['itemid'] = $reloptionssorting[$i - 1]; $link = (new moodle_url('/grade/report/singleview/index.php', $navparams)) ->out(false); $navigationdata['previoususer'] = [ 'name' => $reloptions[$navparams['itemid']], 'url' => $link, 'previousarrow' => $previousarrow ]; } if ($i < count($reloptionssorting) - 1) { $navparams['itemid'] = $reloptionssorting[$i + 1]; $link = (new moodle_url('/grade/report/singleview/index.php', $navparams)) ->out(false); $navigationdata['nextuser'] = [ 'name' => $reloptions[$navparams['itemid']], 'url' => $link, 'nextarrow' => $nextarrow ]; } if ($report->screen->supports_paging()) { $navigationdata['perpageselect'] = $report->screen->perpage_select(); $navigationdata['pager'] = $report->screen->pager(); } if (isset($navigationdata)) { $navigation = $this->render_from_template('gradereport_singleview/report_navigation', $navigationdata); } return $navigation; } }