lib/classes/event/webservice_token_created.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/>.
  16
  17 /**
  18  * core webservice token_created 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  */
  24
  25 namespace core\event;
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * core webservice token_created 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_token_created extends \core\event\base {
  36
  37     /**
  38      * Returns description of what happened.
  39      *
  40      * @return string
  41      */
  42     public function get_description() {
  43         return "A web service token has been created for the user $this->relateduserid.";
  44     }
  45
  46     /**
  47      * Return the legacy event log data.
  48      *
  49      * @return array|null
  50      */
  51     protected function get_legacy_logdata() {
  52         if (!empty($this->other['auto'])) {
  53             // The token has been automatically created.
  54             return array(SITEID, 'webservice', 'automatically create user token', '' , 'User ID: ' . $this->relateduserid);
  55         }
  56     }
  57
  58     /**
  59      * Return localised event name.
  60      *
  61      * @return string
  62      */
  63     public static function get_name() {
  64         return get_string('event_webservice_token_created', 'webservice');
  65     }
  66
  67     /**
  68      * Get URL related to the action.
  69      *
  70      * @return \moodle_url
  71      */
  72     public function get_url() {
  73         return new \moodle_url('/admin/settings.php', array('section' => 'webservicetokens'));
  74     }
  75
  76     /**
  77      * Init method.
  78      *
  79      * @return void
  80      */
  81     protected function init() {
  82         $this->context = \context_system::instance();
  83         $this->data['crud'] = 'c';
  84         $this->data['level'] = self::LEVEL_OTHER;
  85         $this->data['objecttable'] = 'external_tokens';
  86     }
  87
  88     /**
  89      * Custom validation.
  90      *
  91      * @throws \coding_exception
  92      * @return void
  93      */
  94     protected function validate_data() {
  95         if (!isset($this->relateduserid)) {
  96            throw new \coding_exception('The property \'relateduserid\' must be set.');
  97         }
  98     }
  99
 100 }