[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   * Message viewed 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   * Message viewed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int messageid: the id of the message.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Mark Nelson <markn@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class message_viewed extends base {
  44  
  45      /**
  46       * Init method.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'message_user_actions';
  50          $this->data['crud'] = 'c';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52      }
  53  
  54      /**
  55       * Returns localised general event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventmessageviewed', 'message');
  61      }
  62  
  63      /**
  64       * Returns relevant URL.
  65       *
  66       * @return \moodle_url
  67       */
  68      public function get_url() {
  69          return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
  70      }
  71  
  72      /**
  73       * Returns description of what happened.
  74       *
  75       * @return string
  76       */
  77      public function get_description() {
  78          return "The user with id '$this->userid' read a message from the user with id '$this->relateduserid'.";
  79      }
  80  
  81      /**
  82       * Custom validation.
  83       *
  84       * @throws \coding_exception
  85       * @return void
  86       */
  87      protected function validate_data() {
  88          parent::validate_data();
  89  
  90          if (!isset($this->relateduserid)) {
  91              throw new \coding_exception('The \'relateduserid\' must be set.');
  92          }
  93  
  94          if (!isset($this->other['messageid'])) {
  95              throw new \coding_exception('The \'messageid\' value must be set in other.');
  96          }
  97      }
  98  
  99      public static function get_objectid_mapping() {
 100          return array('db' => 'message_user_actions', 'restore' => base::NOT_MAPPED);
 101      }
 102  
 103      public static function get_other_mapping() {
 104          // Messages are not backed up, so no need to map them on restore.
 105          $othermapped = array();
 106          $othermapped['messageid'] = array('db' => 'messages', 'restore' => base::NOT_MAPPED);
 107          return $othermapped;
 108      }
 109  }