| 1 |
efrain |
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 status submitted event.
|
|
|
19 |
*
|
|
|
20 |
* @package mod_scorm
|
|
|
21 |
* @copyright 2016 onwards Matteo Scaramuccia
|
|
|
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 status submitted event class.
|
|
|
30 |
*
|
|
|
31 |
* @property-read array $other {
|
|
|
32 |
* Extra information about event properties.
|
|
|
33 |
*
|
|
|
34 |
* - int attemptid: Attempt id.
|
|
|
35 |
* - string cmielement: CMI element representing a status.
|
|
|
36 |
* - string cmivalue: CMI value.
|
|
|
37 |
* }
|
|
|
38 |
*
|
|
|
39 |
* @package mod_scorm
|
|
|
40 |
* @since Moodle 3.1
|
|
|
41 |
* @copyright 2016 onwards Matteo Scaramuccia
|
|
|
42 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
43 |
*/
|
|
|
44 |
class status_submitted extends cmielement_submitted {
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Returns localised general event name.
|
|
|
48 |
*
|
|
|
49 |
* @return string
|
|
|
50 |
*/
|
|
|
51 |
public static function get_name() {
|
|
|
52 |
return get_string('eventstatussubmitted', 'mod_scorm');
|
|
|
53 |
}
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Custom validation.
|
|
|
57 |
*
|
|
|
58 |
* @throws \coding_exception
|
|
|
59 |
* @return void
|
|
|
60 |
*/
|
|
|
61 |
protected function validate_data() {
|
|
|
62 |
parent::validate_data();
|
|
|
63 |
|
|
|
64 |
if (!in_array($this->other['cmielement'],
|
|
|
65 |
array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))) {
|
|
|
66 |
throw new \coding_exception(
|
|
|
67 |
"The 'cmielement' must represents a valid CMI status element ({$this->other['cmielement']}).");
|
|
|
68 |
}
|
|
|
69 |
|
|
|
70 |
if (!in_array($this->other['cmivalue'],
|
|
|
71 |
array('passed', 'completed', 'failed', 'incomplete', 'browsed', 'not attempted', 'unknown'))) {
|
|
|
72 |
throw new \coding_exception(
|
|
|
73 |
"The 'cmivalue' must represents a valid CMI status value ({$this->other['cmivalue']}).");
|
|
|
74 |
}
|
|
|
75 |
}
|
|
|
76 |
}
|