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_choice report viewed event.
19
 *
20
 * @package mod_choice
21
 * @copyright 2016 Stephen Bourget
22
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace mod_choice\event;
26
defined('MOODLE_INTERNAL') || die();
27
 
28
/**
29
 * The mod_choice report viewed event class.
30
 *
31
 * @property-read array $other {
32
 *      Extra information about the event.
33
 *
34
 *      - string content: The content we are viewing.
35
 *      - string format: The report format
36
 *      - int choiced: The id of the choice
37
 * }
38
 *
39
 * @package    mod_choice
40
 * @since      Moodle 3.1
41
 * @copyright  2016 Stephen Bourget
42
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43
 */
44
class report_downloaded extends \core\event\base {
45
 
46
    /**
47
     * Init method.
48
     */
49
    protected function init() {
50
        $this->data['crud'] = 'r';
51
        $this->data['edulevel'] = self::LEVEL_TEACHING;
52
    }
53
 
54
    /**
55
     * Returns localised general event name.
56
     *
57
     * @return string
58
     */
59
    public static function get_name() {
60
        return get_string('eventreportdownloaded', 'mod_choice');
61
    }
62
 
63
    /**
64
     * Returns description of what happened.
65
     *
66
     * @return string
67
     */
68
    public function get_description() {
69
        return "The user with id '$this->userid' has downloaded the report in the '".$this->other['format']."' format for
70
            the choice activity with course module id '$this->contextinstanceid'";
71
    }
72
 
73
    /**
74
     * Returns relevant URL.
75
     * @return \moodle_url
76
     */
77
    public function get_url() {
78
        return new \moodle_url('/mod/choice/report.php', array('id' => $this->contextinstanceid));
79
    }
80
 
81
    /**
82
     * Custom validation.
83
     *
84
     * @throws \coding_exception
85
     * @return void
86
     */
87
    protected function validate_data() {
88
        parent::validate_data();
89
 
90
        // Report format downloaded.
91
        if (!isset($this->other['content'])) {
92
            throw new \coding_exception('The \'content\' value must be set in other.');
93
        }
94
        // Report format downloaded.
95
        if (!isset($this->other['format'])) {
96
            throw new \coding_exception('The \'format\' value must be set in other.');
97
        }
98
        // ID of the choice activity.
99
        if (!isset($this->other['choiceid'])) {
100
            throw new \coding_exception('The \'choiceid\' value must be set in other.');
101
        }
102
    }
103
 
104
    public static function get_objectid_mapping() {
105
        return false;
106
    }
107
 
108
    public static function get_other_mapping() {
109
        $othermapped = array();
110
        $othermapped['choiceid'] = array('db' => 'choice', 'restore' => 'choice');
111
 
112
        return $othermapped;
113
    }
114
}