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_survey report downloaded event.
19
 *
20
 * @package    mod_survey
21
 * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace mod_survey\event;
26
 
27
defined('MOODLE_INTERNAL') || die();
28
 
29
/**
30
 * The mod_survey report downloaded event class.
31
 *
32
 * @property-read array $other {
33
 *      Extra information about the event.
34
 *
35
 *      - string type: Type of report format downloaded.
36
 *      - int groupid: (optional) report for groupid.
37
 * }
38
 *
39
 * @package    mod_survey
40
 * @since      Moodle 2.7
41
 * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
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
     * Set basic properties for the event.
48
     */
49
    protected function init() {
50
        $this->data['objecttable'] = 'survey';
51
        $this->data['crud'] = 'r';
52
        $this->data['edulevel'] = self::LEVEL_TEACHING;
53
    }
54
 
55
    /**
56
     * Return localised event name.
57
     *
58
     * @return string
59
     */
60
    public static function get_name() {
61
        return get_string('eventreportdownloaded', 'mod_survey');
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' downloaded the report for the survey with course module id '$this->contextinstanceid'.";
71
    }
72
 
73
    /**
74
     * Get URL related to the action.
75
     *
76
     * @return \moodle_url
77
     */
78
    public function get_url() {
79
        $params = array('id' => $this->contextinstanceid, 'type' => $this->other['type']);
80
        if (isset($this->other['groupid'])) {
81
            $params['group'] = $this->other['groupid'];
82
        }
83
        return new \moodle_url("/mod/survey/download.php", $params);
84
    }
85
 
86
    /**
87
     * Custom validation.
88
     *
89
     * @throws \coding_exception
90
     * @return void
91
     */
92
    protected function validate_data() {
93
        parent::validate_data();
94
        if (empty($this->other['type'])) {
95
            throw new \coding_exception('The \'type\' value must be set in other.');
96
        }
97
    }
98
 
99
    public static function get_objectid_mapping() {
100
        return array('db' => 'survey', 'restore' => 'survey');
101
    }
102
 
103
    public static function get_other_mapping() {
104
        $othermapped = array();
105
        $othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
106
 
107
        return $othermapped;
108
    }
109
}