MDL-45837 Grades: Add events for grade letters

grade/edit/letter/index.php

@@ -184,21 +184,45 @@
                     // The letter has been assigned to another boundary, we update it.
                     $record->id = $pool[$boundary]->id;
                     $DB->update_record('grade_letters', $record);
+                    // Trigger the letter grade updated event.
+                    $event = \core\event\grade_letter_updated::create(array(
+                        'objectid' => $record->id,
+                        'context' => $context,
+                    ));
+                    $event->trigger();
                 }
                 unset($pool[$boundary]);    // Remove the letter from the pool.
             } else if ($candidate = array_pop($pool)) {
                 // The boundary is new, we update a random record from the pool.
                 $record->id = $candidate->id;
                 $DB->update_record('grade_letters', $record);
+                // Trigger the letter grade updated event.
+                $event = \core\event\grade_letter_updated::create(array(
+                    'objectid' => $record->id,
+                    'context' => $context,
+                ));
+                $event->trigger();
             } else {
                 // No records were found, this must be a new letter.
-                $DB->insert_record('grade_letters', $record);
+                $newid = $DB->insert_record('grade_letters', $record);
+                // Trigger the letter grade added event.
+                $event = \core\event\grade_letter_created::create(array(
+                    'objectid' => $newid,
+                    'context' => $context,
+                ));
+                $event->trigger();
             }
         }
 
         // Delete the unused records.
         foreach($pool as $leftover) {
             $DB->delete_records('grade_letters', array('id' => $leftover->id));
+            // Trigger the letter grade deleted event.
+            $event = \core\event\grade_letter_deleted::create(array(
+                'objectid' => $leftover->id,
+                'context' => $context,
+            ));
+            $event->trigger();
         }
 
         redirect($returnurl);

lang/en/grades.php

@@ -194,6 +194,9 @@
 $string['errorupdatinggradecategoryaggregation'] = 'Error updating the aggregation type of grade category ID {$a->id}';
 $string['errorupdatinggradeitemaggregationcoef'] = 'Error updating the aggregation coefficient (weight or extra credit) of grade item ID {$a->id}';
 $string['eventgradedeleted'] = 'Grade deleted';
+$string['eventgradelettercreated'] = 'Grade letter created';
+$string['eventgradeletterdeleted'] = 'Grade letter deleted';
+$string['eventgradeletterupdated'] = 'Grade letter updated';
 $string['eventgradeviewed'] = 'Grades were viewed in the gradebook';
 $string['eventscalecreated'] = 'Scale created';
 $string['eventscaledeleted'] = 'Scale deleted';

lib/classes/event/grade_letter_created.php

@@ -0,0 +1,93 @@
+<?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/>.
+
+/**
+ * Grade letter added created.
+ *
+ * @package    core
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Grade letter added event class.
+ *
+ * @package    core
+ * @since      Moodle 3.5
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grade_letter_created extends base {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'grade_letters';
+        $this->data['crud'] = 'c';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventgradelettercreated', 'core_grades');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        if ($this->courseid) {
+            return "The user with id '$this->userid' created the letter grade with id '$this->objectid'".
+                    " in the course in the id '".$this->courseid."'.";
+        } else {
+            return "The user with id '$this->userid' created the letter grade with id '$this->objectid'.";
+        }
+    }
+
+    /**
+     * Returns relevant URL.
+     * @return \moodle_url
+     */
+    public function get_url() {
+        $url = new \moodle_url('/grade/edit/letter/index.php');
+        if ($this->courseid) {
+            $url->param('id', $this->contextid);
+        }
+        return $url;
+    }
+
+    /**
+     * Used for mapping events on restore
+     * @return array
+     */
+    public static function get_objectid_mapping() {
+        return array('db' => 'grade_letters', 'restore' => 'grade_letters');
+    }
+
+}

lib/classes/event/grade_letter_deleted.php

@@ -0,0 +1,81 @@
+<?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/>.
+
+/**
+ * Grade letter deleted event.
+ *
+ * @package    core
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Grade letter deleted event class.
+ *
+ * @package    core
+ * @since      Moodle 3.5
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grade_letter_deleted extends base {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'grade_letters';
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventgradeletterdeleted', 'core_grades');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        if ($this->courseid) {
+            return "The user with id '$this->userid' deleted the letter grade with id '$this->objectid'".
+                    " from the course in the id '".$this->courseid."'.";
+        } else {
+            return "The user with id '$this->userid' deleted the letter grade with id '$this->objectid'.";
+        }
+    }
+
+    /**
+     * Used for mapping events on restore
+     * @return array
+     */
+    public static function get_objectid_mapping() {
+        return array('db' => 'grade_letters', 'restore' => 'grade_letters');
+    }
+
+}

lib/classes/event/grade_letter_updated.php

@@ -0,0 +1,93 @@
+<?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/>.
+
+/**
+ * Grade letter updated event.
+ *
+ * @package    core
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Grade letter added event class.
+ *
+ * @package    core
+ * @since      Moodle 3.5
+ * @copyright  2017 Stephen Bourget
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grade_letter_updated extends base {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'grade_letters';
+        $this->data['crud'] = 'u';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventgradeletterupdated', 'core_grades');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        if ($this->courseid) {
+            return "The user with id '$this->userid' updated the letter grade with id '$this->objectid'".
+                    " in the course in the id '".$this->courseid."'.";
+        } else {
+            return "The user with id '$this->userid' updated the letter grade with id '$this->objectid'.";
+        }
+    }
+
+    /**
+     * Returns relevant URL.
+     * @return \moodle_url
+     */
+    public function get_url() {
+        $url = new \moodle_url('/grade/edit/letter/index.php');
+        if ($this->courseid) {
+            $url->param('id', $this->contextid);
+        }
+        return $url;
+    }
+
+    /**
+     * Used for mapping events on restore
+     * @return array
+     */
+    public static function get_objectid_mapping() {
+        return array('db' => 'grade_letters', 'restore' => 'grade_letters');
+    }
+
+}