[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_survey course module viewed event.
  19   *
  20   * @package    mod_survey
  21   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_survey\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_survery course module viewed event.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - string viewed: what was viewed
  36   * }
  37   *
  38   * @package    mod_survey
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class course_module_viewed extends \core\event\course_module_viewed {
  44  
  45      /**
  46       * Set basic properties for the event.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'survey';
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52      }
  53  
  54      /**
  55       * Return the legacy event log data.
  56       *
  57       * @return array
  58       */
  59      protected function get_legacy_logdata() {
  60          return array($this->courseid, $this->objecttable, 'view '. $this->other['viewed'], 'view.php?id=' .
  61              $this->contextinstanceid, $this->objectid, $this->contextinstanceid);
  62      }
  63  
  64      /**
  65       * Custom validation.
  66       *
  67       * @throws \coding_exception
  68       * @return void
  69       */
  70      protected function validate_data() {
  71          parent::validate_data();
  72          if (empty($this->other['viewed'])) {
  73              throw new \coding_exception('Other must contain the key viewed.');
  74          }
  75      }
  76  
  77      public static function get_objectid_mapping() {
  78          return array('db' => 'survey', 'restore' => 'survey');
  79      }
  80  
  81      public static function get_other_mapping() {
  82          // No need to map 'viewed'.
  83          return false;
  84      }
  85  }