MDL-78815 qbank_comment: Delete comments in event observer

2023-08-02 08:34:59 +01:00
parent a2c8eed5c8
commit 1055a2c1c2
6 changed files with 152 additions and 4 deletions
@@ -399,9 +399,6 @@ function question_delete_question($questionid): void {
        }
    }

-    // Delete question comments.
-    $DB->delete_records('comments', ['itemid' => $questionid, 'component' => 'qbank_comment',
-                                            'commentarea' => 'question']);
    // Finally delete the question record itself.
    $DB->delete_records('question', ['id' => $question->id]);
    $DB->delete_records('question_versions', ['id' => $questiondata->versionid]);
@@ -414,6 +411,7 @@ function question_delete_question($questionid): void {
    question_bank::notify_question_edited($question->id);

    // Log the deletion of this question.
+    // Any qbank plugins storing additional question data should observe this event and perform the necessary deletion.
    $question->category = $questiondata->categoryid;
    $question->contextid = $questiondata->contextid;
    $event = \core\event\question_deleted::create_from_question_instance($question);
@@ -54,6 +54,8 @@ information provided here is intended especially for developers.
 * New method moodleform::filter_shown_headers() is created to show some expanded headers only and hide the rest.
 * count_words() and count_letters() have a new optional parameter called $format to format the text before doing the counting.
 * New core_renderer::sr_text method to generate screen reader only inline texts without using html_writter.
+* Code calling to qbank plugins was moved from question_delete_question in questionlib.php into the plugins themselves. Any plugins
+  that need to perform processing when a question is deleted should observe the \core\event\question_deleted event instead.

 === 4.2 ===

@@ -0,0 +1,49 @@
+<?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_comment\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/comment/lib.php');
+
+use core\event\question_deleted;
+
+/**
+ * Event observer for question deletion
+ *
+ * @package   qbank_comment
+ * @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 comments for the deleted question.
+     *
+     * @param question_deleted $event
+     * @return void
+     */
+    public static function delete_question_comments(question_deleted $event): void {
+        \comment::delete_comments([
+            'contextid' => \context_system::instance()->id,
+            'component' => 'qbank_comment',
+            'commentarea' => 'question',
+            'itemid' => $event->objectid,
+        ]);
+    }
+}
@@ -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 custom fields events
+ *
+ * @package   qbank_comment
+ * @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_comment\event\question_deleted_observer::delete_question_comments',
+    ]
+];
@@ -0,0 +1,66 @@
+<?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_comment\event;
+
+/**
+ * Tests for question_deleted_observer
+ *
+ * @package   qbank_comment
+ * @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_comment\event\question_deleted_observer
+ */
+class question_deleted_observer_test extends \advanced_testcase {
+
+    /**
+     * Deleting a question with comments should also delete the comments
+     *
+     * @return void
+     */
+    public function test_delete_question_with_comments(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        [, , , $questions] = $questiongenerator->setup_course_and_questions();
+        $question = reset($questions);
+
+        $context = \context_system::instance();
+        $commentgenerator = $this->getDataGenerator()->get_plugin_generator('core_comment');
+        /** @var \comment $comment */
+        $comment = $commentgenerator->create_comment([
+            'context' => $context,
+            'component' => 'qbank_comment',
+            'area' => 'question',
+            'itemid' => $question->id,
+            'content' => random_string(),
+        ]);
+
+        $this->assertEquals(1, $comment->count());
+
+        question_delete_question($question->id);
+
+        $newcomment = new \comment((object)[
+            'context' => $context,
+            'component' => 'qbank_comment',
+            'area' => 'question',
+            'itemid' => $question->id,
+        ]);
+
+        $this->assertEquals(0, $newcomment->count());
+    }
+}
@@ -26,6 +26,6 @@
 defined('MOODLE_INTERNAL') || die();

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