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
 * Course user report viewed event.
19
 *
20
 * @package    core
21
 * @copyright  2014 Adrian Greeve <adrian@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace core\event;
26
defined('MOODLE_INTERNAL') || die();
27
 
28
/**
29
 * Course user report viewed event class.
30
 *
31
 * Class for event to be triggered when a course user report is viewed.
32
 *
33
 * @property-read array $other {
34
 *      Extra information about the event.
35
 *
36
 *      - string mode: Mode is used to show the user different data.
37
 * }
38
 *
39
 * @package    core
40
 * @since      Moodle 2.7
41
 * @copyright  2014 Adrian Greeve <adrian@moodle.com>
42
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43
 */
44
class course_user_report_viewed extends base {
45
 
46
    /**
47
     * Init method.
48
     *
49
     * @return void
50
     */
51
    protected function init() {
52
        $this->data['crud'] = 'r';
53
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
54
    }
55
 
56
    /**
57
     * Returns description of what happened.
58
     *
59
     * @return string
60
     */
61
    public function get_description() {
62
        return "The user with id '$this->userid' viewed the user report for the course with id '$this->courseid' " .
63
            "for user with id '$this->relateduserid'.";
64
    }
65
 
66
    /**
67
     * Return localised event name.
68
     *
69
     * @return string
70
     */
71
    public static function get_name() {
72
        return get_string('eventcourseuserreportviewed', 'core');
73
    }
74
 
75
    /**
76
     * Get URL related to the action.
77
     *
78
     * @return \moodle_url
79
     */
80
    public function get_url() {
81
        return new \moodle_url("/course/user.php", array('id' => $this->courseid, 'user' => $this->relateduserid,
82
                'mode' => $this->other['mode']));
83
    }
84
 
85
    /**
86
     * Custom validation.
87
     *
88
     * @throws \coding_exception
89
     * @return void
90
     */
91
    protected function validate_data() {
92
        parent::validate_data();
93
 
94
        if ($this->contextlevel != CONTEXT_COURSE) {
95
            throw new \coding_exception('Context passed must be course context.');
96
        }
97
 
98
        if (empty($this->relateduserid)) {
99
            throw new \coding_exception('The \'relateduserid\' must be set.');
100
        }
101
 
102
        // Make sure this class is never used without proper object details.
103
        if (!isset($this->other['mode'])) {
104
            throw new \coding_exception('The \'mode\' value must be set in other.');
105
        }
106
    }
107
 
108
    public static function get_other_mapping() {
109
        // Nothing to map.
110
        return false;
111
    }
112
}