MDL-84981 core_grades: Show penalty exemption icon

Author: Fragonite

grade/classes/output/penalty_indicator.php

@@ -0,0 +1,87 @@
+<?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/>.
+
+namespace core_grades\output;
+
+use core\output\renderer_base;
+use core\output\templatable;
+use core\output\renderable;
+use core_grades\penalty_exemption;
+use grade_grade;
+
+/**
+ * The base class for the action bar in the gradebook pages.
+ *
+ * @package    core_grades
+ * @copyright  2024 Catalyst IT Australia Pty Ltd
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class penalty_status implements renderable, templatable {
+    /**
+     * The class constructor.
+     *
+     * @param grade_grade $grade The user grade.
+     * @param int $decimals The number of decimal places to show in the grade.
+     * @param bool $showexemptions Whether to show exemptions in the status.
+     */
+    public function __construct(
+        /** @var grade_grade $grade The user grade. */
+        protected grade_grade $grade,
+
+        /** @var int $decimals The number of decimal places to show in the grade. */
+        protected int $decimals = 2,
+
+        /** @var bool $showexemptions Whether to show exemptions in the status. */
+        protected bool $showexemptions = true,
+    ) {
+    }
+
+    /**
+     * Returns the template for the actions bar.
+     *
+     * @return string
+     */
+    public function get_template(): string {
+        return 'core_grades/penalty_status';
+    }
+
+    #[\Override]
+    public function export_for_template(renderer_base $output): array {
+        if ($this->showexemptions && penalty_exemption::is_user_exempt($this->grade->userid, $this->grade->get_context()->id)) {
+            return [
+                'isexempt' => true,
+                'penaltyapplied' => false,
+                'exemptionicon' => ['name' => 'i/shield', 'component' => 'core'],
+                'exemptioninfo' => get_string('gradepenalty_exemption_info', 'core_grades'),
+            ];
+        }
+
+        if ($this->grade->is_penalty_applied_to_final_grade()) {
+            $penalty = format_float($this->grade->deductedmark, $this->decimals);
+            return [
+                'isexempt' => false,
+                'penaltyapplied' => true,
+                'penaltyicon' => ['name' => 'i/risk_xss', 'component' => 'core'],
+                'penaltyinfo' => get_string('gradepenalty_indicator_info', 'core_grades', $penalty),
+            ];
+        }
+
+        return [
+            'isexempt' => false,
+            'penaltyapplied' => false,
+        ];
+    }
+}

grade/classes/output/penalty_status.php

@@ -16,6 +16,7 @@
 
 namespace core_grades;
 
+use cm_info;
 use core\context;
 use core\plugininfo\gradepenalty;
 use core\url;
@@ -250,20 +251,15 @@ private static function apply_penalty(
      * Returns the penalty indicator HTML code if a penalty is applied to the grade.
      * Otherwise, returns an empty string.
      *
-     * @param grade_grade $grade Grade object
-     * @return string HTML code for penalty indicator
+     * @param grade_grade $grade Grade object.
+     * @param bool $showexemptions Whether to show exemptions in the status.
+     * @return string HTML code for the penalty indicator or an empty string.
      */
-    public static function show_penalty_indicator(grade_grade $grade): string {
+    public static function render_penalty_status(grade_grade $grade, bool $showexemptions = true): string {
         global $PAGE;
-
-        // Show penalty indicator if penalty is greater than 0.
-        if ($grade->is_penalty_applied_to_final_grade()) {
-            $indicator = new \core_grades\output\penalty_indicator(2, $grade);
-            $renderer = $PAGE->get_renderer('core_grades');
-            return $renderer->render_penalty_indicator($indicator);
-        }
-
-        return '';
+        $indicator = new \core_grades\output\penalty_status($grade, 2, $showexemptions);
+        $renderer = $PAGE->get_renderer('core_grades');
+        return $renderer->render_penalty_status($indicator);
     }
 
     /**

grade/classes/penalty_manager.php

@@ -18,7 +18,7 @@
 
 use core\output\comboboxsearch;
 use core_grades\output\action_bar;
-use core_grades\output\penalty_indicator;
+use core_grades\output\penalty_status;
 use core_message\helper;
 use core_message\api;
 
@@ -241,11 +241,11 @@ public function user_heading(stdClass $user, int $courseid, bool $showbuttons =
     /**
      * Renders the penalty indicator.
      *
-     * @param penalty_indicator $penaltyindicator
+     * @param penalty_status $penaltystatus
      * @return string The HTML output
      */
-    public function render_penalty_indicator(penalty_indicator $penaltyindicator): string {
-        $data = $penaltyindicator->export_for_template($this);
-        return $this->render_from_template($penaltyindicator->get_template(), $data);
+    public function render_penalty_status(penalty_status $penaltystatus): string {
+        $data = $penaltystatus->export_for_template($this);
+        return $this->render_from_template($penaltystatus->get_template(), $data);
     }
 }

grade/renderer.php

@@ -1183,9 +1183,9 @@ public function get_right_rows(bool $displayaverages): array {
                         }
 
                         $context->extraclasses = 'gradevalue ' . $hidden . $gradepass;
-                        $context->text = grade_format_gradevalue($gradeval, $item, true,
+                        $context->text = penalty_manager::render_penalty_status($grade);
+                        $context->text .= grade_format_gradevalue($gradeval, $item, true,
                             $gradedisplaytype, null);
-                        $context->text .= penalty_manager::show_penalty_indicator($grade);
                     }
                 }
 

grade/report/grader/lib.php

@@ -703,7 +703,7 @@ private function fill_table_recursive(array &$element) {
                             $gradeitemdata['graderaw'] = $gradeval;
                             $data['grade']['content'] = grade_format_gradevalue($gradeval,
                                 $gradegrade->grade_item,
-                                true) . penalty_manager::show_penalty_indicator($gradegrade) . $gradestatus;
+                                true) . penalty_manager::render_penalty_status($gradegrade) . $gradestatus;
                         }
                     } else {
                         $gradestatusclass = '';
@@ -730,7 +730,7 @@ private function fill_table_recursive(array &$element) {
 
                         $data['grade']['class'] = "{$class} {$gradestatusclass}";
                         $data['grade']['content'] = $gradepassicon . grade_format_gradevalue($gradeval,
-                            $gradegrade->grade_item, true) . penalty_manager::show_penalty_indicator($gradegrade) . $gradestatus;
+                            $gradegrade->grade_item, true) . penalty_manager::render_penalty_status($gradegrade) . $gradestatus;
                         $gradeitemdata['graderaw'] = $gradeval;
                     }
                     $data['grade']['headers'] = "$headercat $headerrow grade$userid";

grade/report/user/classes/report/user.php

@@ -12,42 +12,37 @@
     along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
-    @template core_grades/penalty_indicator
-
-    This template is used to render the penalty indicator.
+    @template core_grades/penalty_status
 
+    This template is used to render the penalty status.
 
     Example context (json):
     {
-        "penalty": 20,
-        "finalgrade": 50,
-        "maxgrade": 100,
-        "info": "Late penalty applied -20 marks"
+        "isexempt": true,
+        "penaltyapplied": false,
+        "exemptionicon": {"name": "i/shield", "component": "core"},
+        "exemptioninfo": "Grade penalty exemption applied"
     }
 }}
 
-{{#icon}}
-    <span data-bs-toggle="tooltip" class="penalty-indicator-icon" title="{{info}}">
-        {{#pix}}{{name}}, {{component}}{{/pix}}
-    </span>
-{{/icon}}
-{{#finalgrade}}
-    <span class="penalty-indicator-value">
-        {{#grademax}}
-            {{finalgrade}} / {{grademax}}
-        {{/grademax}}
-        {{^grademax}}
-            {{finalgrade}}
-        {{/grademax}}
-    </span>
-{{/finalgrade}}
+{{#isexempt}}
+    <span class="gradepenaltystatus" data-bs-toggle="tooltip" title="{{exemptioninfo}}"><!-- Prevent whitespace
+    -->{{#pix}}{{exemptionicon.name}}, {{exemptionicon.component}}, {{exemptioninfo}}{{/pix}}</span>
+{{/isexempt}}
+{{^isexempt}}
+    {{#penaltyapplied}}
+        <span class="gradepenaltystatus" data-bs-toggle="tooltip" title="{{penaltyinfo}}"><!-- Prevent whitespace
+        -->{{#pix}}{{penaltyicon.name}}, {{penaltyicon.component}}, {{penaltyinfo}}{{/pix}}</span>
+    {{/penaltyapplied}}
+{{/isexempt}}
 
 {{#js}}
 require(['theme_boost/bootstrap/tooltip'], function(Tooltip) {
     // Re-init the tooltip to ensure those dynamically added through AJAX are initialized
-    document.querySelectorAll('.penalty-indicator-icon[data-bs-toggle="tooltip"]').forEach(tooltipElement => {
+    document.querySelectorAll('.gradepenaltystatus[data-bs-toggle="tooltip"]').forEach(tooltipElement => {
         Tooltip.getInstance(tooltipElement)?.dispose();
         new Tooltip(tooltipElement);
+        tooltipElement.querySelector('i[title]').removeAttribute('title');
     });
 });
 {{/js}}