MDL-40050 webservice: Replace add_to_log() with new events
[moodle.git] / lib / classes / event / webservice_login_failed.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 web service login failed 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 web service login_failed 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_login_failed extends \core\event\base {
37     /**
38      * Legacy log data.
39      *
40      * @var null|array
41      */
42     protected $legacylogdata;
44     /**
45      * Returns description of what happened.
46      *
47      * @return string
48      */
49     public function get_description() {
50         return "Web service authentication failed with code: {$this->other['reason']}.";
51     }
53     /**
54      * Return the legacy event log data.
55      *
56      * @return array|null
57      */
58     protected function get_legacy_logdata() {
59         return $this->legacylogdata;
60     }
62     /**
63      * Return localised event name.
64      *
65      * @return string
66      */
67     public static function get_name() {
68         return get_string('event_webservice_login_failed', 'webservice');
69     }
71     /**
72      * Init method.
73      *
74      * @return void
75      */
76     protected function init() {
77         $this->data['crud'] = 'r';
78         $this->data['level'] = self::LEVEL_OTHER;
79         $this->context = \context_system::instance();
80     }
82     /**
83      * Set the legacy event log data.
84      *
85      * @param array $logdata The log data.
86      * @return void
87      */
88     public function set_legacy_logdata($logdata) {
89         $this->legacylogdata = $logdata;
90     }
92     /**
93      * Custom validation.
94      *
95      * @throws \coding_exception
96      * @return void
97      */
98     protected function validate_data() {
99         if (!isset($this->other['reason'])) {
100            throw new \coding_exception('The key \'reason\' needs to be set in $other.');
101         } else if (!isset($this->other['method'])) {
102            throw new \coding_exception('The key \'method\' needs to be set in $other.');
103         } else if (!isset($this->other['token']) && !isset($this->other['tokenid']) && !isset($this->other['username'])) {
104            throw new \coding_exception('The keys \'username\', \'token\' or \'tokenid\' need to be set in $other.');
105         }
106     }