source: moodle/trunk/fuentes/lib/classes/event/course_reset_started.php

Last change on this file was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 2.5 KB
RevLine 
[136]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 * core course reset started event.
19 *
20 * @package    core
21 * @copyright  2013 Frédéric Massart
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26defined('MOODLE_INTERNAL') || die();
27
28/**
29 * core course reset started event class.
30 *
31 * @property-read array $other {
32 *      Extra information about event.
33 *
34 *      - array reset_options: all reset options settings including courseid.
35 * }
36 *
37 * @package    core
38 * @since      Moodle 2.6
39 * @copyright  2013 Frédéric Massart
40 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 */
42class course_reset_started extends base {
43
44    /**
45     * Returns description of what happened.
46     *
47     * @return string
48     */
49    public function get_description() {
50        return "The user with id '$this->userid' started the reset of the course with id '$this->courseid'.";
51    }
52
53    /**
54     * Return localised event name.
55     *
56     * @return string
57     */
58    public static function get_name() {
59        return get_string('eventcourseresetstarted', 'core');
60    }
61
62    /**
63     * Get URL related to the action
64     *
65     * @return \moodle_url
66     */
67    public function get_url() {
68        return new \moodle_url('/course/view.php', array('id' => $this->courseid));
69    }
70
71    /**
72     * Init method.
73     *
74     * @return void
75     */
76    protected function init() {
77        $this->data['crud'] = 'd';
78        $this->data['edulevel'] = self::LEVEL_OTHER;
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        if (!isset($this->other['reset_options'])) {
90            throw new \coding_exception('The \'reset_options\' value must be set in other.');
91        }
92    }
[1331]93
94    public static function get_other_mapping() {
95        return false;
96    }
[136]97}
Note: See TracBrowser for help on using the repository browser.