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_workshop submission assessments reset event.
19 *
20 * @package    mod_workshop
21 * @copyright  2013 Adrian Greeve
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace mod_workshop\event;
26defined('MOODLE_INTERNAL') || die();
27
28/**
29 * The mod_workshop submission assessments reset event class.
30 *
31 * @property-read array $other {
32 *      Extra information about the event.
33 *
34 *      - int workshopid: the ID of the workshop.
35 * }
36 *
37 * @package    mod_workshop
38 * @since      Moodle 2.7
39 * @copyright  2013 Adrian Greeve
40 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 */
42class assessments_reset extends \core\event\base {
43
44    /**
45     * Init method.
46     *
47     * @return void
48     */
49    protected function init() {
50        $this->data['crud'] = 'u';
51        $this->data['edulevel'] = self::LEVEL_TEACHING;
52    }
53
54    /**
55     * Returns description of what happened.
56     *
57     * @return string
58     */
59    public function get_description() {
60        return "The user with id '$this->userid' has reset the assessments for the workshop with course module id " .
61            "'$this->contextinstanceid'.";
62    }
63
64    /**
65     * Return the legacy event log data.
66     *
67     * @return array|null
68     */
69    protected function get_legacy_logdata() {
70        return array($this->courseid, 'workshop', 'update clear assessments', 'view.php?id=' . $this->contextinstanceid,
71            $this->other['workshopid'], $this->contextinstanceid);
72    }
73
74    /**
75     * Return localised event name.
76     *
77     * @return string
78     */
79    public static function get_name() {
80        return get_string('eventsubmissionassessmentsreset', 'mod_workshop');
81    }
82
83    /**
84     * Get URL related to the action.
85     *
86     * @return \moodle_url
87     */
88    public function get_url() {
89        return new \moodle_url('/mod/workshop/view.php', array('id' => $this->contextinstanceid));
90    }
91
92    /**
93     * Custom validation.
94     *
95     * @throws \coding_exception
96     * @return void
97     */
98    protected function validate_data() {
99        parent::validate_data();
100
101        if (!isset($this->other['workshopid'])) {
102            throw new \coding_exception('The \'workshopid\' value must be set in other.');
103        }
104    }
105
106    public static function get_other_mapping() {
107        $othermapped = array();
108        $othermapped['workshopid'] = array('db' => 'workshop', 'restore' => 'workshop');
109
110        return $othermapped;
111    }
112}
113