MDL-65923 core grades: Add a new event for when a grade item is deleted
authorTom Dickman <tomdickman@catalyst-au.net>
Tue, 9 Jun 2020 07:02:09 +0000 (17:02 +1000)
committerTom Dickman <tomdickman@catalyst-au.net>
Wed, 29 Jul 2020 22:18:59 +0000 (08:18 +1000)
lang/en/grades.php
lib/classes/event/grade_item_deleted.php [new file with mode: 0644]
lib/grade/grade_item.php
lib/tests/event/grade_item_deleted_test.php [new file with mode: 0644]

index 11d5b11..e6a73ae 100644 (file)
@@ -198,6 +198,7 @@ $string['errorupdatinggradecategoryaggregation'] = 'Error updating the aggregati
 $string['errorupdatinggradeitemaggregationcoef'] = 'Error updating the aggregation coefficient (weight or extra credit) of grade item ID {$a->id}';
 $string['eventgradedeleted'] = 'Grade deleted';
 $string['eventgradeitemcreated'] = 'Grade item created';
+$string['eventgradeitemdeleted'] = 'Grade item deleted';
 $string['eventgradeitemupdated'] = 'Grade item updated';
 $string['eventgradelettercreated'] = 'Grade letter created';
 $string['eventgradeletterdeleted'] = 'Grade letter deleted';
diff --git a/lib/classes/event/grade_item_deleted.php b/lib/classes/event/grade_item_deleted.php
new file mode 100644 (file)
index 0000000..484ceb2
--- /dev/null
@@ -0,0 +1,67 @@
+<?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 item deleted event.
+ *
+ * @package    core
+ * @copyright  2020 Tom Dickman <tomdickman@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+/**
+ * Grade item deleted event class.
+ *
+ * @package    core
+ * @copyright  2020 Tom Dickman <tomdickman@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grade_item_deleted extends grade_item_created {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'grade_items';
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventgradeitemdeleted', 'core_grades');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '" . $this->userid . "' deleted a grade item with id '" . $this->objectid . "'" .
+            " of type '" . $this->other['itemtype'] . "' and name '" . $this->other['itemname'] . "'" .
+            " from the course with the id '" . $this->courseid . "'.";
+    }
+
+}
index 1f21f76..511eb8b 100644 (file)
@@ -413,6 +413,12 @@ class grade_item extends grade_object {
         $this->delete_all_grades($source);
         $success = parent::delete($source);
         $transaction->allow_commit();
+
+        if ($success) {
+            $event = \core\event\grade_item_deleted::create_from_grade_item($this);
+            $event->trigger();
+        }
+
         return $success;
     }
 
diff --git a/lib/tests/event/grade_item_deleted_test.php b/lib/tests/event/grade_item_deleted_test.php
new file mode 100644 (file)
index 0000000..baf7250
--- /dev/null
@@ -0,0 +1,76 @@
+<?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 item deleted event tests.
+ *
+ * @package    core
+ * @category   test
+ * @copyright  2020 Tom Dickman <tomdickman@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+/**
+ * Test for grade item deleted event.
+ *
+ * @package    core
+ * @category   test
+ * @copyright  2020 Tom Dickman <tomdickman@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @coversDefaultClass \core\event\grade_item_deleted
+ */
+class grade_item_deleted_testcase extends \advanced_testcase {
+
+    /**
+     * Test the grade item deleted event.
+     *
+     * @covers ::create_from_grade_item
+     */
+    public function test_grade_item_deleted() {
+        global $DB;
+
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $gradeitemrecord = $this->getDataGenerator()->create_grade_item(['courseid' => $course->id]);
+        $gradeitem = \grade_item::fetch(['id' => $gradeitemrecord->id, 'courseid' => $course->id]);
+
+        $countgradeitems = $DB->count_records('grade_items');
+
+        // Trigger and capture the event for deleting a grade item.
+        $sink = $this->redirectEvents();
+        $gradeitem->delete();
+        $events = $sink->get_events();
+        $sink->close();
+
+        // Event should only be triggered once.
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Expect that the grade item was deleted and the event data is valid.
+        $this->assertEquals($countgradeitems - 1, $DB->count_records('grade_items'));
+        $this->assertInstanceOf('\core\event\grade_item_deleted', $event);
+        $eventdata = $event->get_data();
+        $this->assertEquals($gradeitem->id, $eventdata['objectid']);
+        $this->assertEquals($gradeitem->courseid, $eventdata['courseid']);
+        $this->assertEquals(\context_course::instance($gradeitem->courseid)->id, $eventdata['contextid']);
+        $this->assertEquals($gradeitem->itemname, $eventdata['other']['itemname']);
+        $this->assertEquals($gradeitem->itemtype, $eventdata['other']['itemtype']);
+        $this->assertEquals($gradeitem->itemmodule, $eventdata['other']['itemmodule']);
+    }
+}