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
/**
18
 * The mod_forum subscription created event.
19
 *
20
 * @package    mod_forum
21
 * @copyright  2014 Dan Poltawski <dan@moodle.com>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace mod_forum\event;
26
 
27
defined('MOODLE_INTERNAL') || die();
28
 
29
/**
30
 * The mod_forum subscription created event class.
31
 *
32
 * @property-read array $other {
33
 *      Extra information about the event.
34
 *
35
 *      - int forumid: The id of the forum which has been subscribed to.
36
 * }
37
 *
38
 * @package    mod_forum
39
 * @since      Moodle 2.7
40
 * @copyright  2014 Dan Poltawski <dan@moodle.com>
41
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42
 */
43
class subscription_created extends \core\event\base {
44
    /**
45
     * Init method.
46
     *
47
     * @return void
48
     */
49
    protected function init() {
50
        $this->data['crud'] = 'c';
51
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
52
        $this->data['objecttable'] = 'forum_subscriptions';
53
    }
54
 
55
    /**
56
     * Returns description of what happened.
57
     *
58
     * @return string
59
     */
60
    public function get_description() {
61
        return "The user with id '$this->userid' subscribed the user with id '$this->relateduserid' to the forum with " .
62
            "course module id '$this->contextinstanceid'.";
63
    }
64
 
65
    /**
66
     * Return localised event name.
67
     *
68
     * @return string
69
     */
70
    public static function get_name() {
71
        return get_string('eventsubscriptioncreated', 'mod_forum');
72
    }
73
 
74
    /**
75
     * Get URL related to the action
76
     *
77
     * @return \moodle_url
78
     */
79
    public function get_url() {
80
        return new \moodle_url('/mod/forum/subscribers.php', array('id' => $this->other['forumid']));
81
    }
82
 
83
    /**
84
     * Custom validation.
85
     *
86
     * @throws \coding_exception
87
     * @return void
88
     */
89
    protected function validate_data() {
90
        parent::validate_data();
91
 
92
        if (!isset($this->relateduserid)) {
93
            throw new \coding_exception('The \'relateduserid\' must be set.');
94
        }
95
 
96
        if (!isset($this->other['forumid'])) {
97
            throw new \coding_exception('The \'forumid\' value must be set in other.');
98
        }
99
 
100
        if ($this->contextlevel != CONTEXT_MODULE) {
101
            throw new \coding_exception('Context level must be CONTEXT_MODULE.');
102
        }
103
    }
104
 
105
    public static function get_objectid_mapping() {
106
        return array('db' => 'forum_subscriptions', 'restore' => 'forum_subscription');
107
    }
108
 
109
    public static function get_other_mapping() {
110
        $othermapped = array();
111
        $othermapped['forumid'] = array('db' => 'forum', 'restore' => 'forum');
112
 
113
        return $othermapped;
114
    }
115
}