[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_scorm interactions viewed event.
  19   *
  20   * @package    mod_scorm
  21   * @copyright  2013 onwards Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_scorm\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_scorm interactions viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event properties.
  33   *
  34   *      - int attemptid: Attempt id.
  35   *      - int instanceid: Instance id of the scorm activity.
  36   * }
  37   *
  38   * @package    mod_scorm
  39   * @since      Moodle 2.7
  40   * @copyright  2013 onwards Ankit Agarwal
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class interactions_viewed extends \core\event\base {
  44  
  45      /**
  46       * Init method.
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'r';
  50          $this->data['edulevel'] = self::LEVEL_TEACHING;
  51      }
  52  
  53      /**
  54       * Returns non-localised description of what happened.
  55       *
  56       * @return string
  57       */
  58      public function get_description() {
  59          return "The user with id '$this->userid' viewed the interactions for the user with id '$this->relateduserid' " .
  60              "for the scorm activity with course module id '$this->contextinstanceid'.";
  61      }
  62  
  63      /**
  64       * Returns localised general event name.
  65       *
  66       * @return string
  67       */
  68      public static function get_name() {
  69          return get_string('eventinteractionsviewed', 'mod_scorm');
  70      }
  71  
  72      /**
  73       * Get URL related to the action
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          $params = array(
  79              'id' => $this->contextinstanceid,
  80              'user' => $this->relateduserid,
  81              'attempt' => $this->other['attemptid']
  82          );
  83          return new \moodle_url('/mod/scorm/userreportinteractions.php', $params);
  84      }
  85  
  86      /**
  87       * Return the legacy event log data.
  88       *
  89       * @return array
  90       */
  91      protected function get_legacy_logdata() {
  92          return array($this->courseid, 'scorm', 'userreportinteractions', 'report/userreportinteractions.php?id=' .
  93                  $this->contextinstanceid . '&user=' . $this->relateduserid . '&attempt=' . $this->other['attemptid'],
  94                  $this->other['instanceid'], $this->contextinstanceid);
  95      }
  96  
  97      /**
  98       * Custom validation.
  99       *
 100       * @throws \coding_exception
 101       * @return void
 102       */
 103      protected function validate_data() {
 104          parent::validate_data();
 105  
 106          if (!isset($this->relateduserid)) {
 107              throw new \coding_exception('The \'relateduserid\' must be set.');
 108          }
 109  
 110          if (empty($this->other['attemptid'])) {
 111              throw new \coding_exception('The \'attemptid\' must be set in other.');
 112          }
 113  
 114          if (empty($this->other['instanceid'])) {
 115              throw new \coding_exception('The \'instanceid\' must be set in other.');
 116          }
 117      }
 118  
 119      public static function get_other_mapping() {
 120          $othermapped = array();
 121          $othermapped['instanceid'] = array('db' => 'scorm', 'restore' => 'scorm');
 122  
 123          return $othermapped;
 124      }
 125  }