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
 * Role unassigned event.
19
 *
20
 * @package    core
21
 * @since      Moodle 2.6
22
 * @copyright  2013 Petr Skoda {@link http://skodak.org}
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24
 */
25
 
26
namespace core\event;
27
 
28
defined('MOODLE_INTERNAL') || die();
29
 
30
/**
31
 * Role unassigned event class.
32
 *
33
 * @property-read array $other {
34
 *      Extra information about event.
35
 *
36
 *      - int id: role assigned id.
37
 *      - string component: name of component.
38
 *      - int itemid: (optional) id of item.
39
 * }
40
 *
41
 * @package    core
42
 * @since      Moodle 2.6
43
 * @copyright  2013 Petr Skoda {@link http://skodak.org}
44
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45
 */
46
class role_unassigned extends base {
47
    protected function init() {
48
        $this->data['objecttable'] = 'role';
49
        $this->data['crud'] = 'd';
50
        $this->data['edulevel'] = self::LEVEL_OTHER;
51
    }
52
 
53
    /**
54
     * Returns localised general event name.
55
     *
56
     * @return string
57
     */
58
    public static function get_name() {
59
        return get_string('eventroleunassigned', 'role');
60
    }
61
 
62
    /**
63
     * Returns non-localised event description with id's for admin use only.
64
     *
65
     * @return string
66
     */
67
    public function get_description() {
68
        return "The user with id '$this->userid' unassigned the role with id '$this->objectid' from the user with " .
69
            "id '$this->relateduserid'.";
70
    }
71
 
72
    /**
73
     * Returns relevant URL.
74
     * @return \moodle_url
75
     */
76
    public function get_url() {
77
        return new \moodle_url('/admin/roles/assign.php', array('contextid' => $this->contextid, 'roleid' => $this->objectid));
78
    }
79
 
80
    /**
81
     * Custom validation.
82
     *
83
     * @throws \coding_exception
84
     * @return void
85
     */
86
    protected function validate_data() {
87
        parent::validate_data();
88
 
89
        if (!isset($this->relateduserid)) {
90
            throw new \coding_exception('The \'relateduserid\' must be set.');
91
        }
92
 
93
        if (!isset($this->other['id'])) {
94
            throw new \coding_exception('The \'id\' value must be set in other.');
95
        }
96
 
97
        if (!isset($this->other['component'])) {
98
            throw new \coding_exception('The \'component\' value must be set in other.');
99
        }
100
    }
101
 
102
    public static function get_objectid_mapping() {
103
        return array('db' => 'role', 'restore' => 'role');
104
    }
105
 
106
    public static function get_other_mapping() {
107
        $othermapped = array();
108
        $othermapped['id'] = array('db' => 'role_assignments', 'restore' => base::NOT_MAPPED);
109
        $othermapped['itemid'] = base::NOT_MAPPED;
110
 
111
        return $othermapped;
112
    }
113
}