← Back to branch summary

~ubuntu-branches/ubuntu/utopic/moodle/utopic

« back to all changes in this revision

Viewing changes to mod/feedback/classes/event/course_module_viewed.php

  • Committer: Package Import Robot
  • Author(s): Thijs Kinkhorst
  • Date: 2014-05-12 16:10:38 UTC
  • mfrom: (36.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20140512161038-puyqf65k4e0s8ytz
Tags: 2.6.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mod/feedback/classes/event/course_module_viewed.php
 
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
 * This file contains an event for when a feedback activity is viewed.
 
19
 *
 
20
 * @package    mod_feedback
 
21
 * @copyright  2013 Ankit Agarwal
 
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 
23
 */
 
24
 
 
25
namespace mod_feedback\event;
 
26
defined('MOODLE_INTERNAL') || die();
 
27
 
 
28
/**
 
29
 * Event for when a feedback activity is viewed.
 
30
 *
 
31
 * @package    mod_feedback
 
32
 * @since      Moodle 2.6
 
33
 * @copyright  2013 Ankit Agarwal
 
34
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 
35
 */
 
36
class course_module_viewed extends \core\event\content_viewed {
 
37
 
 
38
    /**
 
39
     * Init method.
 
40
     */
 
41
    protected function init() {
 
42
        $this->data['crud'] = 'r';
 
43
        $this->data['level'] = self::LEVEL_PARTICIPATING;
 
44
        $this->data['objecttable'] = 'feedback';
 
45
    }
 
46
 
 
47
    /**
 
48
     * Returns non-localised description of what happened.
 
49
     *
 
50
     * @return string
 
51
     */
 
52
    public function get_description() {
 
53
        return 'User with id ' . $this->userid . ' viewed feedback activity ' . $this->get_url();
 
54
    }
 
55
 
 
56
    /**
 
57
     * Returns localised general event name.
 
58
     *
 
59
     * @return string
 
60
     */
 
61
    public static function get_name() {
 
62
        return get_string('eventcoursemoduleviewed', 'mod_feedback');
 
63
    }
 
64
 
 
65
    /**
 
66
     * Get URL related to the action
 
67
     *
 
68
     * @return \moodle_url
 
69
     */
 
70
    public function get_url() {
 
71
        return new \moodle_url('/mod/feedback/view.php', array('id' => $this->other['cmid']));
 
72
    }
 
73
 
 
74
    /**
 
75
     * Define whether a user can view the event or not. Make sure no one except admin can see details of an anonymous response.
 
76
     *
 
77
     * @param int|\stdClass $userorid ID of the user.
 
78
     * @return bool True if the user can view the event, false otherwise.
 
79
     */
 
80
    public function can_view($userorid = null) {
 
81
        global $USER;
 
82
 
 
83
        if (empty($userorid)) {
 
84
            $userorid = $USER;
 
85
        }
 
86
        if ($this->other['anonymous'] == FEEDBACK_ANONYMOUS_YES) {
 
87
            return is_siteadmin($userorid);
 
88
        } else {
 
89
            return has_capability('mod/feedback:viewreports', $this->context, $userorid);
 
90
        }
 
91
    }
 
92
 
 
93
    /**
 
94
     * Replace add_to_log() statement.Do this only for the case when anonymous mode is off,
 
95
     * since this is what was happening before.
 
96
     *
 
97
     * @return array of parameters to be passed to legacy add_to_log() function.
 
98
     */
 
99
    protected function get_legacy_logdata() {
 
100
        if ($this->other['anonymous'] == FEEDBACK_ANONYMOUS_YES) {
 
101
            return null;
 
102
        } else {
 
103
            return array($this->courseid, 'feedback', 'view', 'view.php?id=' . $this->other['cmid'], $this->objectid,
 
104
                    $this->other['cmid']);
 
105
        }
 
106
    }
 
107
 
 
108
    /**
 
109
     * Custom validations.
 
110
     *
 
111
     * @throws \coding_exception in case of any problems.
 
112
     */
 
113
    protected function validate_data() {
 
114
        if (!isset($this->other['anonymous'])) {
 
115
            throw new \coding_exception("Field other['anonymous'] cannot be empty");
 
116
        }
 
117
        if (!isset($this->other['cmid'])) {
 
118
            throw new \coding_exception("Field other['cmid'] cannot be empty");
 
119
        }
 
120
 
 
121
        // Call parent validations.
 
122
        parent::validate_data();
 
123
    }
 
124
}
 
125