Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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;
24
 
25
defined('MOODLE_INTERNAL') || die();
26
 
27
/**
28
 * Class for event to be triggered when an external blog is updated in moodle.
29
 *
30
 * @property-read array $other {
31
 *      Extra information about event.
32
 *
33
 *      - string url: web address of the external blog.
34
 *
35
 * @package    core
36
 * @since      Moodle 3.2
37
 * @copyright  2016 Stephen Bourget
38
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39
 */
40
class blog_external_updated extends base {
41
 
42
    /**
43
     * Set basic properties for the event.
44
     */
45
    protected function init() {
46
        $this->data['objecttable'] = 'blog_external';
47
        $this->data['crud'] = 'u';
48
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
49
    }
50
 
51
    /**
52
     * Returns localised general event name.
53
     *
54
     * @return string
55
     */
56
    public static function get_name() {
57
        return get_string('eventblogexternalupdated', 'core_blog');
58
    }
59
 
60
    /**
61
     * Returns non-localised event description with id's for admin use only.
62
     *
63
     * @return string
64
     */
65
    public function get_description() {
66
        return "The user with id '$this->userid' added the external blog with the id '{$this->objectid}'" .
67
            " with the web address '{$this->other['url']}'.";
68
    }
69
 
70
    /**
71
     * Custom validations.
72
     *
73
     * @throws \coding_exception when validation fails.
74
     * @return void
75
     */
76
    protected function validate_data() {
77
        parent::validate_data();
78
 
79
        if (!isset($this->other['url'])) {
80
            throw new \coding_exception('The \'url\' value must be set in other.');
81
        }
82
    }
83
 
84
    /**
85
     * Used for maping events on restore
86
     *
87
     * @return bool
88
     */
89
    public static function get_other_mapping() {
90
        // No mapping required.
91
        return false;
92
    }
93
 
94
    /**
95
     * Used for restore of events.
96
     *
97
     * @return array
98
     */
99
    public static function get_objectid_mapping() {
100
        // Blogs are not backed up, so no mapping required for restore.
101
        return array('db' => 'blog_external', 'restore' => base::NOT_MAPPED);
102
    }
103
}
104