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_data template viewed event.
19
 *
20
 * @package    mod_data
21
 * @copyright  2014 Mark Nelson <markn@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace mod_data\event;
26
 
27
defined('MOODLE_INTERNAL') || die();
28
 
29
/**
30
 * The mod_data template viewed event class.
31
 *
32
 * @property-read array $other {
33
 *      Extra information about event.
34
 *
35
 *      - int dataid the id of the data activity.
36
 * }
37
 *
38
 * @package    mod_data
39
 * @since      Moodle 2.7
40
 * @copyright  2014 Mark Nelson <markn@moodle.com>
41
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42
 */
43
class template_viewed extends \core\event\base {
44
 
45
    /**
46
     * Init method.
47
     *
48
     * @return void
49
     */
50
    protected function init() {
51
        $this->data['crud'] = 'r';
52
        $this->data['edulevel'] = self::LEVEL_OTHER;
53
    }
54
 
55
    /**
56
     * Return localised event name.
57
     *
58
     * @return string
59
     */
60
    public static function get_name() {
61
        return get_string('eventtemplateviewed', 'mod_data');
62
    }
63
 
64
    /**
65
     * Returns description of what happened.
66
     *
67
     * @return string
68
     */
69
    public function get_description() {
70
        return "The user with id '$this->userid' viewed the template for the data activity with course module " .
71
            "id '$this->contextinstanceid'.";
72
    }
73
 
74
    /**
75
     * Get URL related to the action.
76
     *
77
     * @return \moodle_url
78
     */
79
    public function get_url() {
80
        return new \moodle_url('/mod/data/templates.php', array('d' => $this->other['dataid']));
81
    }
82
 
83
    /**
84
     * Custom validation.
85
     *
86
     * @throws \coding_exception when validation does not pass.
87
     * @return void
88
     */
89
    protected function validate_data() {
90
        parent::validate_data();
91
 
92
        if (!isset($this->other['dataid'])) {
93
            throw new \coding_exception('The \'dataid\' value must be set in other.');
94
        }
95
    }
96
 
97
    public static function get_other_mapping() {
98
        $othermapped = array();
99
        $othermapped['dataid'] = array('db' => 'data', 'restore' => 'data');
100
 
101
        return $othermapped;
102
    }
103
}