See Release Notes
Long Term Support Release
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 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 report viewed event class. 30 * 31 * @property-read array $other { 32 * Extra information about event properties. 33 * 34 * - int scormid: The ID of the scorm. 35 * - string mode: Mode of the report viewed. 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 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 report '{$this->other['mode']}' for the scorm with " . 60 "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('eventreportviewed', 'mod_scorm'); 70 } 71 72 /** 73 * Get URL related to the action 74 * 75 * @return \moodle_url 76 */ 77 public function get_url() { 78 return new \moodle_url('/mod/scorm/report.php', array('id' => $this->contextinstanceid, 'mode' => $this->other['mode'])); 79 } 80 81 /** 82 * Replace add_to_log() statement. 83 * 84 * @return array of parameters to be passed to legacy add_to_log() function. 85 */ 86 protected function get_legacy_logdata() { 87 return array($this->courseid, 'scorm', 'report', 'report.php?id=' . $this->contextinstanceid . 88 '&mode=' . $this->other['mode'], $this->other['scormid'], $this->contextinstanceid); 89 } 90 91 /** 92 * Custom validation. 93 * 94 * @throws \coding_exception 95 * @return void 96 */ 97 protected function validate_data() { 98 parent::validate_data(); 99 100 if (empty($this->other['scormid'])) { 101 throw new \coding_exception('The \'scormid\' value must be set in other.'); 102 } 103 104 if (empty($this->other['mode'])) { 105 throw new \coding_exception('The \'mode\' value must be set in other.'); 106 } 107 } 108 109 public static function get_other_mapping() { 110 $othermapped = array(); 111 $othermapped['scormid'] = array('db' => 'scorm', 'restore' => 'scorm'); 112 113 return $othermapped; 114 } 115 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body