[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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 flagged 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 flagged 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_flagged extends base {
  45  
  46      /**
  47       * Initialise the event data.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'tag';
  51          $this->data['crud'] = 'u';
  52          $this->data['edulevel'] = self::LEVEL_OTHER;
  53      }
  54  
  55      /**
  56       * Returns localised general event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventtagflagged', 'tag');
  62      }
  63  
  64      /**
  65       * Returns non-localised description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' flagged the tag with id '$this->objectid'.";
  71      }
  72  
  73      /**
  74       * Return legacy data for add_to_log().
  75       *
  76       * @return array
  77       */
  78      protected function get_legacy_logdata() {
  79          return array(SITEID, 'tag', 'flag', 'index.php?id='. $this->objectid, $this->objectid, '', $this->userid);
  80      }
  81  
  82      /**
  83       * Custom validation.
  84       *
  85       * @throws \coding_exception
  86       * @return void
  87       */
  88      protected function validate_data() {
  89          parent::validate_data();
  90  
  91          if (!isset($this->other['name'])) {
  92              throw new \coding_exception('The \'name\' value must be set in other.');
  93          }
  94  
  95          if (!isset($this->other['rawname'])) {
  96              throw new \coding_exception('The \'rawname\' value must be set in other.');
  97          }
  98      }
  99  
 100      public static function get_objectid_mapping() {
 101          // Tags cannot be mapped.
 102          return array('db' => 'tag', 'restore' => base::NOT_MAPPED);
 103      }
 104  
 105      public static function get_other_mapping() {
 106          return false;
 107      }
 108  }