source: moodle/trunk/fuentes/admin/tool/langimport/classes/event/langpack_removed.php @ 136

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

Ported code to xenial

File size: 3.1 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 * The langimport langpack removed event.
19 *
20 * @package    tool_langimport
21 * @copyright  2014 Dan Poltawski <dan@moodle.com>
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace tool_langimport\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * The tool_langimport langpack removed event class.
31 *
32 * @property-read array $other {
33 *      Extra information about event.
34 *
35 *      - string langcode: the langpage pack code.
36 * }
37 *
38 * @package    tool_langimport
39 * @since      Moodle 2.8
40 * @copyright  2014 Dan Poltawski <dan@moodle.com>
41 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 */
43class langpack_removed extends \core\event\base {
44    /**
45     * Create instance of event.
46     *
47     * @param string $langcode
48     * @return langpack_updated
49     */
50    public static function event_with_langcode($langcode) {
51        $data = array(
52            'context' => \context_system::instance(),
53            'other' => array(
54                'langcode' => $langcode,
55            )
56        );
57
58        return self::create($data);
59    }
60
61    /**
62     * Init method.
63     *
64     * @return void
65     */
66    protected function init() {
67        $this->data['crud'] = 'd';
68        $this->data['edulevel'] = self::LEVEL_OTHER;
69    }
70
71    /**
72     * Returns description of what happened.
73     *
74     * @return string
75     */
76    public function get_description() {
77        return "The language pack '{$this->other['langcode']}' was removed.";
78    }
79
80    /**
81     * Returns relevant URL.
82     *
83     * @return \moodle_url
84     */
85    public function get_url() {
86        return new \moodle_url('/admin/tool/langimport/');
87    }
88
89    /**
90     * Return localised event name.
91     *
92     * @return string
93     */
94    public static function get_name() {
95        return get_string('langpackremovedevent', 'tool_langimport');
96    }
97
98    /**
99     * Custom validation.
100     *
101     * @throws \coding_exception
102     */
103    protected function validate_data() {
104        parent::validate_data();
105
106        if (!isset($this->other['langcode'])) {
107            throw new \coding_exception('The \'langcode\' value must be set');
108        }
109
110        // We can't use PARAM_LANG here as it queries installed strings.
111        $cleanedlang = clean_param($this->other['langcode'], PARAM_SAFEDIR);
112        if ($cleanedlang !== $this->other['langcode']) {
113            throw new \coding_exception('The \'langcode\' value must be set to a valid language code');
114        }
115    }
116}
Note: See TracBrowser for help on using the repository browser.