MDL-68193 core: added new database_text_field_content_replaced event

lang/en/moodle.php

@@ -790,6 +790,7 @@ $string['eventcourseviewed'] = 'Course viewed';
 $string['eventdashboardreset'] = 'Dashboard reset';
 $string['eventdashboardsreset'] = 'Dashboards reset';
 $string['eventdashboardviewed'] = 'Dashboard viewed';
+$string['eventdatabasetextfieldcontentreplaced'] = 'Database global search and replace';
 $string['eventemailfailed'] = 'Email failed to send';
 $string['eventname'] = 'Event name';
 $string['eventrecentactivityviewed'] = 'Recent activity viewed';

lib/adminlib.php

@@ -8873,6 +8873,17 @@ function db_replace($search, $replace) {
         echo $OUTPUT->notification("...finished", 'notifysuccess');
     }
 
+    // Trigger an event.
+    $eventargs = [
+        'context' => context_system::instance(),
+        'other' => [
+            'search' => $search,
+            'replace' => $replace
+        ]
+    ];
+    $event = \core\event\database_text_field_content_replaced::create($eventargs);
+    $event->trigger();
+
     purge_all_caches();
 
     return true;

lib/classes/event/database_text_field_content_replaced.php

@@ -0,0 +1,85 @@
+<?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/>.
+
+/**
+ * The database text field content replaced event.
+ *
+ * @package   core
+ * @copyright 2020 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The database text field content replaced event class.
+ *
+ * @property-read array $other {
+ *      Extra information about the event.
+ *
+ *      - string search: The value being searched for.
+ *      - string replace: The replacement value that replaces found search value.
+ * }
+ *
+ * @package   core
+ * @copyright 2020 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class database_text_field_content_replaced extends \core\event\base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'u';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventdatabasetextfieldcontentreplaced');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' replaced the string '" . $this->other['search'] . "' " .
+            "with the string '" . $this->other['replace'] . "' in the database.";
+    }
+
+    /**
+     * Custom validation.
+     */
+    protected function validate_data() {
+        parent::validate_data();
+
+        if (!isset($this->other['search'])) {
+            throw new \coding_exception('The \'search\' value must be set in other.');
+        }
+        if (!isset($this->other['replace'])) {
+            throw new \coding_exception('The \'replace\' value must be set in other.');
+        }
+    }
+}

lib/tests/events_test.php

@@ -371,4 +371,27 @@ class core_events_testcase extends advanced_testcase {
         $this->assertEquals($event->userid, $user->id);
         $this->assertEventContextNotUsed($event);
     }
+
+    /**
+     * Test the database text field content replaced event.
+     */
+    public function test_database_text_field_content_replaced() {
+        global $CFG;
+
+        require_once($CFG->dirroot . '/lib/adminlib.php');
+
+        // Trigger and capture the event for finding and replacing strings in the database.
+        $sink = $this->redirectEvents();
+        ob_start();
+        db_replace('searchstring', 'replacestring');
+        ob_end_clean();
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\core\event\database_text_field_content_replaced', $event);
+        $this->assertEquals(context_system::instance(), $event->get_context());
+        $this->assertEquals('searchstring', $event->other['search']);
+        $this->assertEquals('replacestring', $event->other['replace']);
+    }
 }