[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 mod_chat sessions viewed event.
  19   *
  20   * @package    mod_chat
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_chat\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_chat sessions viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - int start: start of period.
  35   *      - int end: end of period.
  36   * }
  37   *
  38   * @package    mod_chat
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Frédéric Massart
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class sessions_viewed extends \core\event\base {
  44  
  45      /**
  46       * Returns description of what happened.
  47       *
  48       * @return string
  49       */
  50      public function get_description() {
  51          return "The user with id '$this->userid' has viewed the sessions of the chat with course module id
  52              '$this->contextinstanceid'.";
  53      }
  54  
  55      /**
  56       * Return the legacy event log data.
  57       *
  58       * @return array|null
  59       */
  60      protected function get_legacy_logdata() {
  61          return array($this->courseid, 'chat', 'report', 'report.php?id=' . $this->contextinstanceid,
  62              $this->objectid, $this->contextinstanceid);
  63      }
  64  
  65      /**
  66       * Return localised event name.
  67       *
  68       * @return string
  69       */
  70      public static function get_name() {
  71          return get_string('eventsessionsviewed', 'mod_chat');
  72      }
  73  
  74      /**
  75       * Get URL related to the action
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/mod/chat/report.php', array('id' => $this->contextinstanceid));
  81      }
  82  
  83      /**
  84       * Init method.
  85       *
  86       * @return void
  87       */
  88      protected function init() {
  89          $this->data['crud'] = 'r';
  90          $this->data['edulevel'] = self::LEVEL_OTHER;
  91          $this->data['objecttable'] = 'chat';
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception
  98       * @return void
  99       */
 100      protected function validate_data() {
 101          parent::validate_data();
 102          if (!isset($this->other['start'])) {
 103              throw new \coding_exception('The \'start\' value must be set in other.');
 104          }
 105          if (!isset($this->other['end'])) {
 106              throw new \coding_exception('The \'end\' value must be set in other.');
 107          }
 108      }
 109  
 110      public static function get_objectid_mapping() {
 111          return array('db' => 'chat', 'restore' => 'chat');
 112      }
 113  
 114      public static function get_other_mapping() {
 115          // Nothing to map.
 116          return false;
 117      }
 118  }