[Summary view]

Differences Between: [Versions 310 and 311] [Versions 39 and 311]

   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   * Config log created.
  19   *
  20   * @package    core
  21   * @copyright  2017 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\event;
  25  
  26  use moodle_url;
  27  
  28  /**
  29   * Event class for when an admin config log is created.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string name: name of config setting
  35   *      - string plugin: name of plugin
  36   *      - string oldvalue: previous value
  37   *      - string value: new value
  38   * }
  39   *
  40   * @package    core
  41   * @copyright  2017 Damyon Wiese
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class config_log_created extends base {
  45  
  46      /**
  47       * Initialise required event data properties.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'config_log';
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_OTHER;
  53      }
  54  
  55      /**
  56       * Returns localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventconfiglogcreated');
  62      }
  63  
  64      /**
  65       * Returns non-localised event description with id's for admin use only.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          $name = $this->other['name'];
  71          $plugin = isset($this->other['plugin']) ? $this->other['plugin'] : 'core';
  72          $value = isset($this->other['value']) ? $this->other['value'] : 'Not set';
  73          $oldvalue = isset($this->other['oldvalue']) ? $this->other['oldvalue'] : 'Not set';
  74          return "The user with id '$this->userid' changed the config setting '$name' for component '$plugin' " .
  75                 "from '$oldvalue' to '$value'.";
  76      }
  77  
  78      /**
  79       * Returns relevant URL.
  80       *
  81       * @return moodle_url
  82       */
  83      public function get_url() {
  84          return new moodle_url('/report/configlog/index.php', [
  85              'search' => $this->other['name'],
  86          ]);
  87      }
  88  
  89      /**
  90       * Custom validation.
  91       *
  92       * @throws \coding_exception
  93       * @return void
  94       */
  95      protected function validate_data() {
  96          parent::validate_data();
  97  
  98          if (!isset($this->other['name'])) {
  99              throw new \coding_exception('The \'name\' value must be set in other.');
 100          }
 101          if (!array_key_exists('plugin', $this->other)) {
 102              throw new \coding_exception('The \'plugin\' value must be set in other.');
 103          }
 104          if (!array_key_exists('oldvalue', $this->other)) {
 105              throw new \coding_exception('The \'oldvalue\' value must be set in other.');
 106          }
 107          if (!array_key_exists('value', $this->other)) {
 108              throw new \coding_exception('The \'value\' value must be set in other.');
 109          }
 110      }
 111  
 112      public static function get_objectid_mapping() {
 113          // Config log is not mappable.
 114          return array('db' => 'config_log', 'restore' => base::NOT_MAPPED);
 115      }
 116  
 117      public static function get_other_mapping() {
 118          return false;
 119      }
 120  }