[Summary view]

Differences Between: [Versions 39 and 402] [Versions 39 and 403]

   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   * Tag updated event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Mark Nelson <markn@moodle.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   * Tag updated event.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string name: the name of the tag.
  36   *      - string rawname: the raw name of the tag.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class tag_updated extends base {
  45  
  46      /** @var array The legacy log data. */
  47      private $legacylogdata;
  48  
  49      /**
  50       * Initialise the event data.
  51       */
  52      protected function init() {
  53          $this->data['objecttable'] = 'tag';
  54          $this->data['crud'] = 'u';
  55          $this->data['edulevel'] = self::LEVEL_OTHER;
  56      }
  57  
  58      /**
  59       * Returns localised general event name.
  60       *
  61       * @return string
  62       */
  63      public static function get_name() {
  64          return get_string('eventtagupdated', 'tag');
  65      }
  66  
  67      /**
  68       * Returns non-localised description of what happened.
  69       *
  70       * @return string
  71       */
  72      public function get_description() {
  73          return "The user with id '$this->userid' updated the tag with id '$this->objectid'.";
  74      }
  75  
  76      /**
  77       * Set the legacy data used for add_to_log().
  78       *
  79       * @param array $logdata
  80       */
  81      public function set_legacy_logdata($logdata) {
  82          $this->legacylogdata = $logdata;
  83      }
  84  
  85      /**
  86       * Return legacy data for add_to_log().
  87       *
  88       * @return array
  89       */
  90      protected function get_legacy_logdata() {
  91          if (isset($this->legacylogdata)) {
  92              return $this->legacylogdata;
  93          }
  94  
  95          return array($this->courseid, 'tag', 'update', 'index.php?id='. $this->objectid, $this->other['name']);
  96      }
  97  
  98      /**
  99       * Custom validation.
 100       *
 101       * @throws \coding_exception
 102       * @return void
 103       */
 104      protected function validate_data() {
 105          parent::validate_data();
 106  
 107          if (!isset($this->other['name'])) {
 108              throw new \coding_exception('The \'name\' value must be set in other.');
 109          }
 110  
 111          if (!isset($this->other['rawname'])) {
 112              throw new \coding_exception('The \'rawname\' value must be set in other.');
 113          }
 114      }
 115  
 116      public static function get_objectid_mapping() {
 117          // Tags cannot be mapped.
 118          return array('db' => 'tag', 'restore' => base::NOT_MAPPED);
 119      }
 120  
 121      public static function get_other_mapping() {
 122          return false;
 123      }
 124  
 125  }