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 deleted.
18
 *
19
 * @package    core
20
 * @copyright  2013 Ankit Agarwal
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 blog_entry_deleted
29
 *
30
 * Event for when a new blog entry is deleted.
31
 *
32
 * @package    core
33
 * @since      Moodle 2.6
34
 * @copyright  2013 Ankit Agarwal
35
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36
 */
37
 
38
class blog_entry_deleted extends base {
39
 
40
    /** @var \blog_entry A reference to the active blog_entry object. */
41
    protected $blogentry;
42
 
43
    /**
44
     * Set basic event properties.
45
     */
46
    protected function init() {
47
        $this->context = \context_system::instance();
48
        $this->data['objecttable'] = 'post';
49
        $this->data['crud'] = 'd';
50
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
51
    }
52
 
53
    /**
54
     * Returns localised general event name.
55
     *
56
     * @return string
57
     */
58
    public static function get_name() {
59
        return get_string("evententrydeleted", "core_blog");
60
    }
61
 
62
    /**
63
     * Sets blog_entry object to be used by observers.
64
     *
65
     * @param \blog_entry $blogentry A reference to the active blog_entry object.
66
     */
67
    public function set_blog_entry(\blog_entry $blogentry) {
68
        $this->blogentry = $blogentry;
69
    }
70
 
71
    /**
72
     * Returns deleted blog entry for event observers.
73
     *
74
     * @throws \coding_exception
75
     * @return \blog_entry
76
     */
77
    public function get_blog_entry() {
78
        if ($this->is_restored()) {
79
            throw new \coding_exception('Function get_blog_entry() can not be used on restored events.');
80
        }
81
        return $this->blogentry;
82
    }
83
 
84
    /**
85
     * Returns non-localised description of what happened.
86
     *
87
     * @return string
88
     */
89
    public function get_description() {
90
        return "The user with id '$this->userid' deleted the blog entry with id '$this->objectid'.";
91
    }
92
 
93
    /**
94
     * Custom validations.
95
     *
96
     * @throws \coding_exception
97
     * @return void
98
     */
99
    protected function validate_data() {
100
        parent::validate_data();
101
 
102
        if (!isset($this->relateduserid)) {
103
            throw new \coding_exception('The \'relateduserid\' must be set.');
104
        }
105
    }
106
 
107
    public static function get_objectid_mapping() {
108
        // Blogs are not backed up, so no need for mapping for restore.
109
        return array('db' => 'post', 'restore' => base::NOT_MAPPED);
110
    }
111
}