MDL-66074 core_grade: Documentation
authorMathew May <mathewm@hotmail.co.nz>
Mon, 28 Oct 2019 04:57:22 +0000 (12:57 +0800)
committerMathew May <mathewm@hotmail.co.nz>
Wed, 30 Oct 2019 05:03:59 +0000 (13:03 +0800)
grade/classes/component_gradeitem.php
grade/classes/grades/grader/gradingpanel/point/external/fetch.php
grade/classes/grades/grader/gradingpanel/point/external/store.php
grade/classes/grades/grader/gradingpanel/scale/external/fetch.php
grade/classes/grades/grader/gradingpanel/scale/external/store.php
grade/grading/form/lib.php
grade/grading/tests/coverage.php
grade/templates/grades/grader/gradingpanel/scale.mustache
grade/tests/coverage.php

index 115d61d..a8f6b34 100644 (file)
@@ -58,6 +58,14 @@ abstract class component_gradeitem {
     /** @var int The grade itemnumber */
     protected $itemnumber;
 
+    /**
+     * component_gradeitem constructor.
+     *
+     * @param string $component
+     * @param context $context
+     * @param string $itemname
+     * @throws \coding_exception
+     */
     final protected function __construct(string $component, context $context, string $itemname) {
         $this->component = $component;
         $this->context = $context;
@@ -364,6 +372,7 @@ abstract class component_gradeitem {
      *
      * @param int $gradeid
      * @return stdClass
+     * @throws \dml_exception
      */
     public function get_grade(int $gradeid): stdClass {
         global $DB;
@@ -385,7 +394,6 @@ abstract class component_gradeitem {
     /**
      * Get grades for all users for the specified gradeitem.
      *
-     * @param int $itemnumber The specific grade item to fetch for the user
      * @return stdClass[] The grades
      */
     abstract public function get_all_grades(): array;
index 6326008..b8332e5 100644 (file)
@@ -89,6 +89,11 @@ class fetch extends external_api {
      * @param string $itemname
      * @param int $gradeduserid
      * @return array
+     * @throws \dml_exception
+     * @throws \invalid_parameter_exception
+     * @throws \restricted_context_exception
+     * @throws coding_exception
+     * @throws moodle_exception
      * @since Moodle 3.8
      */
     public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array {
@@ -132,7 +137,7 @@ class fetch extends external_api {
     /**
      * Get the data to be fetched.
      *
-     * @param component_gradeitem $gradeitem
+     * @param stdClass $grade
      * @return array
      */
     public static function get_fetch_data(stdClass $grade): array {
index 4f54a33..3649e53 100644 (file)
@@ -92,7 +92,13 @@ class store extends external_api {
      * @param int $contextid
      * @param string $itemname
      * @param int $gradeduserid
+     * @param string $formdata
      * @return array
+     * @throws \dml_exception
+     * @throws \invalid_parameter_exception
+     * @throws \restricted_context_exception
+     * @throws coding_exception
+     * @throws moodle_exception
      * @since Moodle 3.8
      */
     public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, string $formdata): array {
index 3e88e4c..dfd9acd 100644 (file)
@@ -89,6 +89,11 @@ class fetch extends external_api {
      * @param string $itemname
      * @param int $gradeduserid
      * @return array
+     * @throws \dml_exception
+     * @throws \invalid_parameter_exception
+     * @throws \restricted_context_exception
+     * @throws coding_exception
+     * @throws moodle_exception
      * @since Moodle 3.8
      */
     public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array {
@@ -130,7 +135,8 @@ class fetch extends external_api {
     /**
      * Get the data to be fetched.
      *
-     * @param component_gradeitem $gradeitem
+     * @param gradeitem $gradeitem
+     * @param stdClass $gradeduser
      * @return array
      */
     public static function get_fetch_data(gradeitem $gradeitem, stdClass $gradeduser): array {
index 2a5fd7b..6c7fa5b 100644 (file)
@@ -92,7 +92,13 @@ class store extends external_api {
      * @param int $contextid
      * @param string $itemname
      * @param int $gradeduserid
+     * @param string $formdata
      * @return array
+     * @throws \dml_exception
+     * @throws \invalid_parameter_exception
+     * @throws \restricted_context_exception
+     * @throws coding_exception
+     * @throws moodle_exception
      * @since Moodle 3.8
      */
     public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, string $formdata): array {
index a0653e8..9c94f0d 100644 (file)
@@ -521,6 +521,7 @@ abstract class gradingform_controller {
      * @param int $raterid
      * @param int $itemid
      * @return gradingform_instance
+     * @throws dml_exception
      */
     public function get_or_create_instance($instanceid, $raterid, $itemid) {
         if (!is_numeric($instanceid)) {
@@ -538,10 +539,11 @@ abstract class gradingform_controller {
      *
      * If the instanceid is falsey, or no instance was found, then create a new instance for the specified rater and item.
      *
-     * @param int $instanceid
      * @param int $raterid
      * @param int $itemid
+     * @param int $instanceid
      * @return gradingform_instance
+     * @throws dml_exception
      */
     public function fetch_instance(int $raterid, int $itemid, ?int $instanceid): gradingform_instance {
         global $DB;
index 97c219b..9b2b565 100644 (file)
@@ -14,8 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Coverage information for the core_grading subsystem.
  *
@@ -25,6 +23,8 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Coverage information for the core_grading subsystem.
  *
@@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 return new class extends phpunit_coverage_info {
-    /** @var array The list of folders relative to the plugin root to whitelist in coverage generation. */
+    // Array The list of folders relative to the plugin root to whitelist in coverage generation.
     protected $whitelistfolders = [
         'classes',
         'tests/generator',
index 6c6ef78..fdac05d 100644 (file)
     along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
-    @template core_grades/grades/grader/gradingpanel/point
+    @template core_grades/grades/grader/gradingpanel/scale
 
-    Point-based grading template for use in the grading panel.
+    Scale-based grading template for use in the grading panel.
 
     Context variables required for this template:
 
     Example context (json):
     {
-      "grade": 47
+        "value": 1,
+        "selected": true,
+        "title": "Motivational"
     }
 }}
 <form>
index 187e453..7480fcc 100644 (file)
@@ -14,8 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Coverage information for the grades component.
  *
@@ -25,6 +23,8 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Coverage information for the core_grades subsystem.
  *
@@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 return new class extends phpunit_coverage_info {
-    /** @var array The list of folders relative to the plugin root to whitelist in coverage generation. */
+    // Array The list of folders relative to the plugin root to whitelist in coverage generation.
     protected $whitelistfolders = [
         'classes',
     ];