[Summary view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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   * Web service 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   * Web service token created event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - bool auto: true if it was automatically created.
  35   * }
  36   *
  37   * @package    core
  38   * @since      Moodle 2.6
  39   * @copyright  2013 Frédéric Massart
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class webservice_token_created extends base {
  43  
  44      /**
  45       * Returns description of what happened.
  46       *
  47       * @return string
  48       */
  49      public function get_description() {
  50          return "The user with id '$this->userid' created a web service token for the user with id '$this->relateduserid'.";
  51      }
  52  
  53      /**
  54       * Return localised event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventwebservicetokencreated', 'webservice');
  60      }
  61  
  62      /**
  63       * Get URL related to the action.
  64       *
  65       * @return \moodle_url
  66       */
  67      public function get_url() {
  68          return new \moodle_url('/admin/settings.php', array('section' => 'webservicetokens'));
  69      }
  70  
  71      /**
  72       * Init method.
  73       *
  74       * @return void
  75       */
  76      protected function init() {
  77          $this->context = \context_system::instance();
  78          $this->data['crud'] = 'c';
  79          $this->data['edulevel'] = self::LEVEL_OTHER;
  80          $this->data['objecttable'] = 'external_tokens';
  81      }
  82  
  83      /**
  84       * Custom validation.
  85       *
  86       * @throws \coding_exception
  87       * @return void
  88       */
  89      protected function validate_data() {
  90          parent::validate_data();
  91          if (!isset($this->relateduserid)) {
  92             throw new \coding_exception('The \'relateduserid\' must be set.');
  93          }
  94  
  95          if (!isset($this->other['auto'])) {
  96              throw new \coding_exception('The \'auto\' value must be set in other.');
  97          }
  98      }
  99  
 100      public static function get_objectid_mapping() {
 101          // Webservices are not included in backups.
 102          return array('db' => 'external_tokens', 'restore' => base::NOT_MAPPED);
 103      }
 104  
 105      public static function get_other_mapping() {
 106          return false;
 107      }
 108  }