[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   * The tag added 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   * Event class for when a tag has been added to an item.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int tagid: the id of the tag.
  36   *      - string tagname: the name of the tag.
  37   *      - string tagrawname: the raw name of the tag.
  38   *      - int itemid: the id of the item tagged.
  39   *      - string itemtype: the type of item tagged.
  40   * }
  41   *
  42   * @package    core
  43   * @since      Moodle 2.7
  44   * @copyright  2014 Mark Nelson <markn@moodle.com>
  45   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  46   */
  47  class tag_added extends base {
  48  
  49      /**
  50       * Initialise the event data.
  51       */
  52      protected function init() {
  53          $this->data['objecttable'] = 'tag_instance';
  54          $this->data['crud'] = 'c';
  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('eventtagadded', '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' added the tag with id '{$this->other['tagid']}' to the item type '" .
  74              s($this->other['itemtype']) . "' with id '{$this->other['itemid']}'.";
  75      }
  76  
  77      /**
  78       * Creates an event from taginstance object
  79       *
  80       * @since Moodle 3.1
  81       * @param stdClass $taginstance
  82       * @param string $tagname
  83       * @param string $tagrawname
  84       * @param bool $addsnapshot trust that $taginstance has all necessary fields and add it as a record snapshot
  85       * @return tag_added
  86       */
  87      public static function create_from_tag_instance($taginstance, $tagname, $tagrawname, $addsnapshot = false) {
  88          $event = self::create(array(
  89              'objectid' => $taginstance->id,
  90              'contextid' => $taginstance->contextid,
  91              'other' => array(
  92                  'tagid' => $taginstance->tagid,
  93                  'tagname' => $tagname,
  94                  'tagrawname' => $tagrawname,
  95                  'itemid' => $taginstance->itemid,
  96                  'itemtype' => $taginstance->itemtype
  97              )
  98          ));
  99          if ($addsnapshot) {
 100              $event->add_record_snapshot('tag_instance', $taginstance);
 101          }
 102          return $event;
 103      }
 104  
 105      /**
 106       * Return legacy data for add_to_log().
 107       *
 108       * @return array
 109       */
 110      protected function get_legacy_logdata() {
 111          if ($this->other['itemtype'] === 'course') {
 112              $url = 'tag/search.php?query=' . urlencode($this->other['tagrawname']);
 113              return array($this->courseid, 'coursetags', 'add', $url, 'Course tagged');
 114          }
 115  
 116          return null;
 117      }
 118  
 119      /**
 120       * Custom validation.
 121       *
 122       * @throws \coding_exception when validation does not pass.
 123       * @return void
 124       */
 125      protected function validate_data() {
 126          parent::validate_data();
 127  
 128          if (!isset($this->other['tagid'])) {
 129              throw new \coding_exception('The \'tagid\' value must be set in other.');
 130          }
 131  
 132          if (!isset($this->other['itemid'])) {
 133              throw new \coding_exception('The \'itemid\' value must be set in other.');
 134          }
 135  
 136          if (!isset($this->other['itemtype'])) {
 137              throw new \coding_exception('The \'itemtype\' value must be set in other.');
 138          }
 139  
 140          if (!isset($this->other['tagname'])) {
 141              throw new \coding_exception('The \'tagname\' value must be set in other.');
 142          }
 143  
 144          if (!isset($this->other['tagrawname'])) {
 145              throw new \coding_exception('The \'tagrawname\' value must be set in other.');
 146          }
 147      }
 148  
 149      public static function get_objectid_mapping() {
 150          // Tags cannot be mapped.
 151          return array('db' => 'tag_instance', 'restore' => base::NOT_MAPPED);
 152      }
 153  
 154      public static function get_other_mapping() {
 155          $othermapped = array();
 156          $othermapped['tagid'] = array('db' => 'tag', 'restore' => base::NOT_MAPPED);
 157          $othermapped['itemid'] = base::NOT_MAPPED;
 158  
 159          return $othermapped;
 160      }
 161  }