source: moodle/trunk/fuentes/lib/classes/event/calendar_event_created.php @ 136

Last change on this file since 136 was 136, checked in by mabarracus, 3 years ago

Ported code to xenial

File size: 3.4 KB
Line 
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 * Calendar event created event.
19 *
20 * @package    core
21 * @copyright  2014 onwards Ankit Agarwal <ankit.agrr@gmail.com>
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Calendar event created event.
31 *
32 * @property-read array $other {
33 *      Extra information about the event.
34 *
35 *      - int repeatid: id of the parent event if present, else 0.
36 *      - int timestart: timestamp for event time start.
37 *      - string name: name of the event.
38 * }
39 *
40 * @package    core
41 * @since      Moodle 2.7
42 * @copyright  2014 onwards Ankit Agarwal <ankit.agrr@gmail.com>
43 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44 */
45class calendar_event_created extends base {
46
47    /**
48     * Init method.
49     *
50     * @return void
51     */
52    protected function init() {
53        $this->data['crud'] = 'c';
54        $this->data['edulevel'] = self::LEVEL_OTHER;
55        $this->data['objecttable'] = 'event';
56    }
57
58    /**
59     * Returns localised general event name.
60     *
61     * @return string
62     */
63    public static function get_name() {
64        return get_string('eventcalendareventcreated', 'core_calendar');
65    }
66
67    /**
68     * Returns description of what happened.
69     *
70     * @return string
71     */
72    public function get_description() {
73        $eventname = s($this->other['name']);
74        return "The user with id '$this->userid' created the event '$eventname' with id '$this->objectid'.";
75    }
76
77    /**
78     * Returns relevant URL.
79     *
80     * @return \moodle_url
81     */
82    public function get_url() {
83        return new \moodle_url('/calendar/view.php', array('view' => 'day', 'time' => $this->other['timestart']),
84                'event_' . $this->objectid);
85    }
86
87    /**
88     * Replace legacy add_to_log() statement.
89     *
90     * @return array of parameters to be passed to legacy add_to_log() function.
91     */
92    protected function get_legacy_logdata() {
93        return array($this->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id=' . $this->objectid , $this->other['name']);
94    }
95
96    /**
97     * Custom validation.
98     *
99     * Throw \coding_exception notice in case of any problems.
100     */
101    protected function validate_data() {
102        parent::validate_data();
103
104        if (!isset($this->other['repeatid'])) {
105            throw new \coding_exception('The \'repeatid\' value must be set in other.');
106        }
107        if (empty($this->other['name'])) {
108            throw new \coding_exception('The \'name\' value must be set in other.');
109        }
110        if (!isset($this->other['timestart'])) {
111            throw new \coding_exception('The \'timestart\' value must be set in other.');
112        }
113    }
114}
Note: See TracBrowser for help on using the repository browser.