[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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 user report 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 user report 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 user_report_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 scorm user report for the user with id '$this->relateduserid'.";
  60      }
  61  
  62      /**
  63       * Returns localised general event name.
  64       *
  65       * @return string
  66       */
  67      public static function get_name() {
  68          return get_string('eventuserreportviewed', 'mod_scorm');
  69      }
  70  
  71      /**
  72       * Get URL related to the action
  73       *
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          $params = array(
  78              'id' => $this->contextinstanceid,
  79              'user' => $this->relateduserid,
  80              'attempt' => $this->other['attemptid']
  81          );
  82          return new \moodle_url('/mod/scorm/userreport.php', $params);
  83      }
  84  
  85      /**
  86       * Return the legacy event log data.
  87       *
  88       * @return array
  89       */
  90      protected function get_legacy_logdata() {
  91          return array($this->courseid, 'scorm', 'userreport', 'report/userreport.php?id=' .
  92                  $this->contextinstanceid . '&user=' . $this->relateduserid . '&attempt=' . $this->other['attemptid'],
  93                  $this->other['instanceid'], $this->contextinstanceid);
  94      }
  95  
  96      /**
  97       * Custom validation.
  98       *
  99       * @throws \coding_exception
 100       * @return void
 101       */
 102      protected function validate_data() {
 103          parent::validate_data();
 104  
 105          if (!isset($this->relateduserid)) {
 106              throw new \coding_exception('The \'relateduserid\' must be set.');
 107          }
 108          if (empty($this->other['attemptid'])) {
 109              throw new \coding_exception('The \'attemptid\' value must be set in other.');
 110          }
 111          if (empty($this->other['instanceid'])) {
 112              throw new \coding_exception('The \'instanceid\' value must be set in other.');
 113          }
 114      }
 115  
 116      public static function get_other_mapping() {
 117          $othermapped = array();
 118          $othermapped['instanceid'] = array('db' => 'scorm', 'restore' => 'scorm');
 119  
 120          return $othermapped;
 121      }
 122  }