[Summary view]

Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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 tracks 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 tracks 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   *      - int scoid: Sco Id for which the trackes are viewed.
  37   * }
  38   *
  39   * @package    mod_scorm
  40   * @since      Moodle 2.7
  41   * @copyright  2013 onwards Ankit Agarwal
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class tracks_viewed extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_TEACHING;
  52      }
  53  
  54      /**
  55       * Returns non-localised description of what happened.
  56       *
  57       * @return string
  58       */
  59      public function get_description() {
  60          return "The user with id '$this->userid' viewed the tracks for the user with id '$this->relateduserid' " .
  61              "for the scorm activity with course module id '$this->contextinstanceid'.";
  62      }
  63  
  64      /**
  65       * Returns localised general event name.
  66       *
  67       * @return string
  68       */
  69      public static function get_name() {
  70          return get_string('eventtracksviewed', 'mod_scorm');
  71      }
  72  
  73      /**
  74       * Get URL related to the action
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          $params = array(
  80              'id' => $this->contextinstanceid,
  81              'user' => $this->relateduserid,
  82              'attempt' => $this->other['attemptid'],
  83              'scoid' => $this->other['scoid']
  84          );
  85          return new \moodle_url('/mod/scorm/userreporttracks.php', $params);
  86      }
  87  
  88      /**
  89       * Return the legacy event log data.
  90       *
  91       * @return array
  92       */
  93      protected function get_legacy_logdata() {
  94          return array($this->courseid, 'scorm', 'userreporttracks', 'report/userreporttracks.php?id=' . $this->contextinstanceid
  95              . '&user=' . $this->relateduserid . '&attempt=' . $this->other['attemptid'] . '&scoid=' . $this->other['scoid'],
  96              $this->other['instanceid'], $this->contextinstanceid);
  97      }
  98  
  99      /**
 100       * Custom validation.
 101       *
 102       * @throws \coding_exception
 103       * @return void
 104       */
 105      protected function validate_data() {
 106          parent::validate_data();
 107  
 108          if (!isset($this->relateduserid)) {
 109              throw new \coding_exception('The \'relateduserid\' must be set.');
 110          }
 111          if (empty($this->other['attemptid'])) {
 112              throw new \coding_exception('The \'attemptid\' value must be set in other.');
 113          }
 114          if (empty($this->other['instanceid'])) {
 115              throw new \coding_exception('The \'instanceid\' value must be set in other.');
 116          }
 117          if (empty($this->other['scoid'])) {
 118              throw new \coding_exception('The \'scoid\' value must be set in other.');
 119          }
 120      }
 121  
 122      public static function get_other_mapping() {
 123          $othermapped = array();
 124          $othermapped['instanceid'] = array('db' => 'scorm', 'restore' => 'scorm');
 125          $othermapped['scoid'] = array('db' => 'scorm_scoes', 'restore' => 'scorm_scoe');
 126  
 127          return $othermapped;
 128      }
 129  }