MDL-78815 qbank_tagquestion: Delete tags in event observer

2023-08-02 08:34:59 +01:00
parent a1d5d1b2f7
commit 36ab582177
5 changed files with 129 additions and 4 deletions
@@ -389,9 +389,6 @@ function question_delete_question($questionid): void {
    // Delete questiontype-specific data.
    question_bank::get_qtype($question->qtype, false)->delete_question($question->id, $questiondata->contextid);

-    // Delete all tag instances.
-    core_tag_tag::remove_all_item_tags('core_question', 'question', $question->id);
-
    // Delete the custom filed data for the question.
    $customfieldhandler = qbank_customfields\customfield\question_handler::create();
    $customfieldhandler->delete_instance($question->id);
@@ -0,0 +1,45 @@
+<?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 qbank_tagquestion\event;
+
+use core\context;
+use core\event\question_deleted;
+
+/**
+ * Event observer for question deletion
+ *
+ * @package   qbank_tagquestion
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_deleted_observer {
+
+    /**
+     * Delete any tags defined for the deleted question.
+     *
+     * This uses {@see \core_tag_tag::set_item_tags} rather than {@see \core_tag_tag::remove_all_item_tags} since the latter
+     * will always pass the system context, not the question context that the tag was set in.
+     *
+     * @param question_deleted $event
+     * @return void
+     */
+    public static function delete_question_tags(question_deleted $event): void {
+        $questioncontext = context::instance_by_id($event->contextid);
+        \core_tag_tag::set_item_tags('core_question', 'question', $event->objectid, $questioncontext, null, $event->userid);
+    }
+}
@@ -0,0 +1,33 @@
+<?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/>.
+
+/**
+ * Question tag events
+ *
+ * @package   qbank_tagquestion
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$observers = [
+    [
+        'eventname' => '\core\event\question_deleted',
+        'callback' => '\qbank_tagquestion\event\question_deleted_observer::delete_question_tags'
+    ]
+];
@@ -0,0 +1,50 @@
+<?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 qbank_tagquestion\event;
+
+/**
+ * Tests for question_deleted_observer
+ *
+ * @package   qbank_tagquestion
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers    \qbank_tagquestion\event\question_deleted_observer
+ */
+class question_deleted_observer_test extends \advanced_testcase {
+
+    /**
+     * Deleting a question with tags should also delete the tags.
+     *
+     * @return void
+     */
+    public function test_delete_question_with_tags(): void {
+        $this->resetAfterTest();
+        $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        [, , $qcat, $questions] = $questiongenerator->setup_course_and_questions();
+        $questioncontext = \context::instance_by_id($qcat->contextid);
+        $question = reset($questions);
+        $tag = random_string();
+        \core_tag_tag::add_item_tag('core_question', 'question', $question->id, $questioncontext, $tag);
+
+        $this->assertCount(1, \core_tag_tag::get_item_tags('core_question', 'question', $question->id));
+
+        question_delete_question($question->id);
+
+        $this->assertEmpty(\core_tag_tag::get_item_tags('core_question', 'question', $question->id));
+    }
+}
@@ -26,6 +26,6 @@
 defined('MOODLE_INTERNAL') || die();

 $plugin->component = 'qbank_tagquestion';
-$plugin->version   = 2023042400;
+$plugin->version   = 2023042401;
 $plugin->requires  = 2023041800;
 $plugin->maturity  = MATURITY_STABLE;