MDL-40050 webservice: Replace add_to_log() with new events
[moodle.git] / lib / classes / event / webservice_service_user_added.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/>.
17 /**
18  * core webservice service user added event.
19  *
20  * @package    core
21  * @copyright  2013 Frédéric Massart
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\event;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * core webservice service user added event class.
30  *
31  * @package    core
32  * @copyright  2013 Frédéric Massart
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class webservice_service_user_added extends \core\event\base {
37     /**
38      * Returns description of what happened.
39      *
40      * @return string
41      */
42     public function get_description() {
43         return "The user $this->relateduserid has been added to the web service service $this->objectid.";
44     }
46     /**
47      * Return the legacy event log data.
48      *
49      * @return array|null
50      */
51     protected function get_legacy_logdata() {
52         global $CFG;
53         return array(SITEID, 'core', 'assign', $CFG->admin . '/webservice/service_users.php?id=' . $this->objectid, 'add', '',
54             $this->relateduserid);
55     }
57     /**
58      * Return localised event name.
59      *
60      * @return string
61      */
62     public static function get_name() {
63         return get_string('event_webservice_service_user_added', 'webservice');
64     }
66     /**
67      * Get URL related to the action.
68      *
69      * @return \moodle_url
70      */
71     public function get_url() {
72         return new \moodle_url('/admin/webservice/service_users.php', array('id' => $this->objectid));
73     }
75     /**
76      * Init method.
77      *
78      * @return void
79      */
80     protected function init() {
81         $this->context = \context_system::instance();
82         $this->data['crud'] = 'c';
83         $this->data['level'] = self::LEVEL_OTHER;
84         $this->data['objecttable'] = 'external_services';
85     }
87     /**
88      * Custom validation.
89      *
90      * @return void
91      */
92     protected function validate_data() {
93         if (!isset($this->relateduserid)) {
94             throw new \coding_exception('The relateduserid must be set.');
95         }
96     }
98 }