MDL-40908 core_tag: created a 'tag_created' event
[moodle.git] / lib / classes / event / tag_created.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/>.
17 /**
18  * Tag created event.
19  *
20  * @property-read array $other {
21  *      Extra information about event.
22  *
23  *      - string name: the name of the tag.
24  *      - string rawname: the raw name of the tag.
25  * }
26  *
27  * @package    core
28  * @copyright  2014 Mark Nelson <markn@moodle.com>
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 namespace core\event;
34 defined('MOODLE_INTERNAL') || die();
36 class tag_created extends base {
38     /**
39      * Initialise the event data.
40      */
41     protected function init() {
42         $this->data['objecttable'] = 'tag';
43         $this->data['crud'] = 'c';
44         $this->data['edulevel'] = self::LEVEL_OTHER;
45     }
47     /**
48      * Returns localised general event name.
49      *
50      * @return string
51      */
52     public static function get_name() {
53         return get_string('eventtagcreated', 'tag');
54     }
56     /**
57      * Returns non-localised description of what happened.
58      *
59      * @return string
60      */
61     public function get_description() {
62         return 'The tag with the id ' . $this->objectid . ' was created by the user with the id ' . $this->userid;
63     }
65     /**
66      * Custom validation.
67      *
68      * @throws \coding_exception
69      * @return void
70      */
71     protected function validate_data() {
72         parent::validate_data();
74         if (!isset($this->other['name'])) {
75             throw new \coding_exception('The name must be set in $other.');
76         }
78         if (!isset($this->other['rawname'])) {
79             throw new \coding_exception('The rawname must be set in $other.');
80         }
81     }
82 }