Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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 sco launched 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 sco launched event class.
30
 *
31
 * @property-read array $other {
32
 *      Extra information about event properties.
33
 *
34
 *      - string loadedcontent: A reference to the content loaded.
35
 *      - int instanceid: (optional) 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 sco_launched 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_PARTICIPATING;
51
        $this->data['objecttable'] = 'scorm_scoes';
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' launched the sco with id '$this->objectid' for the scorm with " .
61
            "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('eventscolaunched', 'mod_scorm');
71
    }
72
 
73
    /**
74
     * Get URL related to the action
75
     *
76
     * @return \moodle_url
77
     */
78
    public function get_url() {
79
        return new \moodle_url('/mod/scorm/player.php', array('cm' => $this->contextinstanceid, 'scoid' => $this->objectid));
80
    }
81
 
82
    /**
83
     * Custom validation.
84
     *
85
     * @throws \coding_exception
86
     * @return void
87
     */
88
    protected function validate_data() {
89
        parent::validate_data();
90
 
91
        if (empty($this->other['loadedcontent'])) {
92
            throw new \coding_exception('The \'loadedcontent\' value must be set in other.');
93
        }
94
    }
95
 
96
    public static function get_objectid_mapping() {
97
        return array('db' => 'scorm_scoes', 'restore' => 'scorm_sco');
98
    }
99
 
100
    public static function get_other_mapping() {
101
        $othermapped = array();
102
        $othermapped['instanceid'] = array('db' => 'scorm', 'restore' => 'scorm');
103
 
104
        return $othermapped;
105
    }
106
}