[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * The database text field content replaced event.
  19   *
  20   * @package   core
  21   * @copyright 2020 Mark Nelson <mdjnelson@gmail.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The database text field content replaced event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - string search: The value being searched for.
  36   *      - string replace: The replacement value that replaces found search value.
  37   * }
  38   *
  39   * @package   core
  40   * @copyright 2020 Mark Nelson <mdjnelson@gmail.com>
  41   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class database_text_field_content_replaced extends \core\event\base {
  44  
  45      /**
  46       * Init method.
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'u';
  50          $this->data['edulevel'] = self::LEVEL_OTHER;
  51      }
  52  
  53      /**
  54       * Returns localised general event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventdatabasetextfieldcontentreplaced');
  60      }
  61  
  62      /**
  63       * Returns description of what happened.
  64       *
  65       * @return string
  66       */
  67      public function get_description() {
  68          return "The user with id '$this->userid' replaced the string '" . $this->other['search'] . "' " .
  69              "with the string '" . $this->other['replace'] . "' in the database.";
  70      }
  71  
  72      /**
  73       * Custom validation.
  74       */
  75      protected function validate_data() {
  76          parent::validate_data();
  77  
  78          if (!isset($this->other['search'])) {
  79              throw new \coding_exception('The \'search\' value must be set in other.');
  80          }
  81          if (!isset($this->other['replace'])) {
  82              throw new \coding_exception('The \'replace\' value must be set in other.');
  83          }
  84      }
  85  }