MDL-45890 Blog: add additional events
[moodle.git] / lib / classes / event / blog_external_viewed.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/>.
16 /**
17  * Event for when a new blog entry is associated with a context.
18  *
19  * @package    core
20  * @copyright  2016 Stephen Bourget
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
23 namespace core\event;
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Class for event to be triggered when an external blog is viewed to moodle.
29  *
30  * @property-read array $other {
31  *      Extra information about event.
32  *
33  * @package    core
34  * @since      Moodle 3.2
35  * @copyright  2016 Stephen Bourget
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class blog_external_viewed extends base {
40     /**
41      * Set basic properties for the event.
42      */
43     protected function init() {
44         $this->data['crud'] = 'r';
45         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
46     }
48     /**
49      * Returns localised general event name.
50      *
51      * @return string
52      */
53     public static function get_name() {
54         return get_string('eventexternalblogsviewed', 'core_blog');
55     }
57     /**
58      * Returns non-localised event description with id's for admin use only.
59      *
60      * @return string
61      */
62     public function get_description() {
63         return "The user with id '$this->userid' viewed their registered external blogs";
64     }
66     /**
67      * Used for backup / restore of events.
68      * @return array
69      */
70     public static function get_objectid_mapping() {
71         // Blogs are not backed up, so no mapping required for restore.
72         return array('db' => 'blog_external', 'restore' => base::NOT_MAPPED);
73     }
74 }