MDL-66809 core_grades: Implement scale-based marking
[moodle.git] / grade / classes / grades / grader / gradingpanel / scale / external / fetch.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Web service functions relating to scale grades and grading.
19  *
20  * @package    core_grades
21  * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 declare(strict_types = 1);
27 namespace core_grades\grades\grader\gradingpanel\scale\external;
29 use coding_exception;
30 use context;
31 use core_grades\component_gradeitem as gradeitem;
32 use core_grades\component_gradeitems;
33 use core_user;
34 use external_api;
35 use external_function_parameters;
36 use external_multiple_structure;
37 use external_single_structure;
38 use external_value;
39 use external_warnings;
40 use moodle_exception;
41 use required_capability_exception;
42 use stdClass;
44 /**
45  * External grading panel scale API
46  *
47  * @package    core_grades
48  * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
49  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
50  */
51 class fetch extends external_api {
53     /**
54      * Describes the parameters for fetching the grading panel for a simple grade.
55      *
56      * @return external_function_parameters
57      * @since Moodle 3.8
58      */
59     public static function execute_parameters(): external_function_parameters {
60         return new external_function_parameters ([
61             'component' => new external_value(
62                 PARAM_ALPHANUMEXT,
63                 'The name of the component',
64                 VALUE_REQUIRED
65             ),
66             'contextid' => new external_value(
67                 PARAM_INT,
68                 'The ID of the context being graded',
69                 VALUE_REQUIRED
70             ),
71             'itemname' => new external_value(
72                 PARAM_ALPHANUM,
73                 'The grade item itemname being graded',
74                 VALUE_REQUIRED
75             ),
76             'gradeduserid' => new external_value(
77                 PARAM_INT,
78                 'The ID of the user show',
79                 VALUE_REQUIRED
80             ),
81         ]);
82     }
84     /**
85      * Fetch the data required to build a grading panel for a simple grade.
86      *
87      * @param string $component
88      * @param int $contextid
89      * @param string $itemname
90      * @param int $gradeduserid
91      * @return array
92      * @since Moodle 3.8
93      */
94     public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array {
95         global $USER;
97         [
98             'component' => $component,
99             'contextid' => $contextid,
100             'itemname' => $itemname,
101             'gradeduserid' => $gradeduserid,
102         ] = self::validate_parameters(self::execute_parameters(), [
103             'component' => $component,
104             'contextid' => $contextid,
105             'itemname' => $itemname,
106             'gradeduserid' => $gradeduserid,
107         ]);
109         // Validate the context.
110         $context = context::instance_by_id($contextid);
111         self::validate_context($context);
113         // Validate that the supplied itemname is a gradable item.
114         if (!component_gradeitems::is_valid_itemname($component, $itemname)) {
115             throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component");
116         }
118         // Fetch the gradeitem instance.
119         $gradeitem = gradeitem::instance($component, $context, $itemname);
121         if (!$gradeitem->is_using_scale()) {
122             throw new moodle_exception("The {$itemname} item in {$component}/{$contextid} is not configured for grading with scales");
123         }
125         $gradeduser = \core_user::get_user($gradeduserid);
127         return self::get_fetch_data($gradeitem, $gradeduser);
128     }
130     /**
131      * Get the data to be fetched.
132      *
133      * @param component_gradeitem $gradeitem
134      * @return array
135      */
136     public static function get_fetch_data(gradeitem $gradeitem, stdClass $gradeduser): array {
137         global $USER;
139         $grade = $gradeitem->get_grade_for_user($gradeduser, $USER);
140         $currentgrade = (int) unformat_float($grade->grade);
142         $menu = $gradeitem->get_grade_menu();
143         $values = array_map(function($description, $value) use ($currentgrade) {
144             return [
145                 'value' => $value,
146                 'title' => $description,
147                 'selected' => ($value == $currentgrade),
148             ];
149         }, $menu, array_keys($menu));
151         return [
152             'templatename' => 'core_grades/grades/grader/gradingpanel/scale',
153             'grade' => [
154                 'options' => $values,
155                 'timecreated' => $grade->timecreated,
156                 'timemodified' => $grade->timemodified,
157             ],
158             'warnings' => [],
159         ];
160     }
162     /**
163      * Describes the data returned from the external function.
164      *
165      * @return external_single_structure
166      * @since Moodle 3.8
167      */
168     public static function execute_returns(): external_single_structure {
169         return new external_single_structure([
170             'templatename' => new external_value(PARAM_SAFEPATH, 'The template to use when rendering this data'),
171             'grade' => new external_single_structure([
172                 'options' => new external_multiple_structure(
173                     new external_single_structure([
174                         'value' => new external_value(PARAM_FLOAT, 'The grade value'),
175                         'title' => new external_value(PARAM_RAW, 'The description fo the option'),
176                         'selected' => new external_value(PARAM_BOOL, 'Whether this item is currently selected'),
177                     ]),
178                     'The description of the grade option'
179                 ),
180                 'timecreated' => new external_value(PARAM_INT, 'The time that the grade was created'),
181                 'timemodified' => new external_value(PARAM_INT, 'The time that the grade was last updated'),
182             ]),
183             'warnings' => new external_warnings(),
184         ]);
185     }