[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   * Tag created 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 created event class.
  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_created extends base {
  45  
  46      /**
  47       * Initialise the event data.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'tag';
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_OTHER;
  53      }
  54  
  55      /**
  56       * Creates an event from tag object
  57       *
  58       * @since Moodle 3.1
  59       * @param \core_tag_tag|\stdClass $tag
  60       * @return tag_created
  61       */
  62      public static function create_from_tag($tag) {
  63          $event = self::create(array(
  64              'objectid' => $tag->id,
  65              'relateduserid' => $tag->userid,
  66              'context' => \context_system::instance(),
  67              'other' => array(
  68                  'name' => $tag->name,
  69                  'rawname' => $tag->rawname
  70              )
  71          ));
  72          return $event;
  73      }
  74  
  75      /**
  76       * Returns localised general event name.
  77       *
  78       * @return string
  79       */
  80      public static function get_name() {
  81          return get_string('eventtagcreated', 'tag');
  82      }
  83  
  84      /**
  85       * Returns non-localised description of what happened.
  86       *
  87       * @return string
  88       */
  89      public function get_description() {
  90          return "The user with id '$this->userid' created the tag with id '$this->objectid'.";
  91      }
  92  
  93      /**
  94       * Custom validation.
  95       *
  96       * @throws \coding_exception
  97       * @return void
  98       */
  99      protected function validate_data() {
 100          parent::validate_data();
 101  
 102          if (!isset($this->other['name'])) {
 103              throw new \coding_exception('The \'name\' value must be set in other.');
 104          }
 105  
 106          if (!isset($this->other['rawname'])) {
 107              throw new \coding_exception('The \'rawname\' value must be set in other.');
 108          }
 109      }
 110  
 111      public static function get_objectid_mapping() {
 112          // Tags cannot be mapped.
 113          return array('db' => 'tag', 'restore' => base::NOT_MAPPED);
 114      }
 115  
 116      public static function get_other_mapping() {
 117          return false;
 118      }
 119  }