forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-40050 webservice: Replace add_to_log() with new events
- Loading branch information
Frederic Massart
committed
Sep 24, 2013
1 parent
7f3836d
commit d733a8c
Showing
15 changed files
with
1,398 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| <?php | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * core webservice function_called event. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * core webservice function_called event class. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class webservice_function_called extends \core\event\base { | ||
|
|
||
| /** | ||
| * Legacy log data. | ||
| */ | ||
| protected $legacylogdata; | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "The web service function '{$this->other['function']}' has been called."; | ||
| } | ||
|
|
||
| /** | ||
| * Return the legacy event log data. | ||
| * | ||
| * @return array|null | ||
| */ | ||
| protected function get_legacy_logdata() { | ||
| return $this->legacylogdata; | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('event_webservice_function_called', 'webservice'); | ||
| } | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['level'] = self::LEVEL_OTHER; | ||
| $this->context = \context_system::instance(); | ||
| } | ||
|
|
||
| /** | ||
| * Return the legacy event log data. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function set_legacy_logdata($legacydata) { | ||
| $this->legacylogdata = $legacydata; | ||
| } | ||
|
|
||
| /** | ||
| * Custom validation. | ||
| * | ||
| * @throws \coding_exception | ||
| * @return void | ||
| */ | ||
| protected function validate_data() { | ||
| if (!isset($this->other['function'])) { | ||
| throw new \coding_exception('The key \'function\' needs to be set in $other.'); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <?php | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * core web service login failed event. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * core web service login_failed event class. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class webservice_login_failed extends \core\event\base { | ||
|
|
||
| /** | ||
| * Legacy log data. | ||
| * | ||
| * @var null|array | ||
| */ | ||
| protected $legacylogdata; | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "Web service authentication failed with code: {$this->other['reason']}."; | ||
| } | ||
|
|
||
| /** | ||
| * Return the legacy event log data. | ||
| * | ||
| * @return array|null | ||
| */ | ||
| protected function get_legacy_logdata() { | ||
| return $this->legacylogdata; | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('event_webservice_login_failed', 'webservice'); | ||
| } | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['level'] = self::LEVEL_OTHER; | ||
| $this->context = \context_system::instance(); | ||
| } | ||
|
|
||
| /** | ||
| * Set the legacy event log data. | ||
| * | ||
| * @param array $logdata The log data. | ||
| * @return void | ||
| */ | ||
| public function set_legacy_logdata($logdata) { | ||
| $this->legacylogdata = $logdata; | ||
| } | ||
|
|
||
| /** | ||
| * Custom validation. | ||
| * | ||
| * @throws \coding_exception | ||
| * @return void | ||
| */ | ||
| protected function validate_data() { | ||
| if (!isset($this->other['reason'])) { | ||
| throw new \coding_exception('The key \'reason\' needs to be set in $other.'); | ||
| } else if (!isset($this->other['method'])) { | ||
| throw new \coding_exception('The key \'method\' needs to be set in $other.'); | ||
| } else if (!isset($this->other['token']) && !isset($this->other['tokenid']) && !isset($this->other['username'])) { | ||
| throw new \coding_exception('The keys \'username\', \'token\' or \'tokenid\' need to be set in $other.'); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| <?php | ||
| // This file is part of Moodle - http://moodle.org/ | ||
| // | ||
| // Moodle is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // Moodle is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * core webservice service created event. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * core webservice service created event class. | ||
| * | ||
| * @package core | ||
| * @copyright 2013 Frédéric Massart | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class webservice_service_created extends \core\event\base { | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "The web service service $this->objectid has been created by user $this->userid."; | ||
| } | ||
|
|
||
| /** | ||
| * Return the legacy event log data. | ||
| * | ||
| * @return array|null | ||
| */ | ||
| protected function get_legacy_logdata() { | ||
| global $CFG; | ||
| $service = $this->get_record_snapshot('external_services', $this->objectid); | ||
| return array(SITEID, 'webservice', 'add', $CFG->wwwroot . "/" . $CFG->admin . "/settings.php?section=externalservices", | ||
| get_string('addservice', 'webservice', $service)); | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('event_webservice_service_created', 'webservice'); | ||
| } | ||
|
|
||
| /** | ||
| * Get URL related to the action. | ||
| * | ||
| * @return \moodle_url | ||
| */ | ||
| public function get_url() { | ||
| return new \moodle_url('/admin/settings.php', array('section' => 'externalservices')); | ||
| } | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->context = \context_system::instance(); | ||
| $this->data['crud'] = 'c'; | ||
| $this->data['level'] = self::LEVEL_OTHER; | ||
| $this->data['objecttable'] = 'external_services'; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.