[Summary view]

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

   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 the legacy event log data.
  55       *
  56       * @return array|null
  57       */
  58      protected function get_legacy_logdata() {
  59          if (!empty($this->other['auto'])) {
  60              // The token has been automatically created.
  61              return array(SITEID, 'webservice', 'automatically create user token', '' , 'User ID: ' . $this->relateduserid);
  62          }
  63      }
  64  
  65      /**
  66       * Return localised event name.
  67       *
  68       * @return string
  69       */
  70      public static function get_name() {
  71          return get_string('eventwebservicetokencreated', 'webservice');
  72      }
  73  
  74      /**
  75       * Get URL related to the action.
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/admin/settings.php', array('section' => 'webservicetokens'));
  81      }
  82  
  83      /**
  84       * Init method.
  85       *
  86       * @return void
  87       */
  88      protected function init() {
  89          $this->context = \context_system::instance();
  90          $this->data['crud'] = 'c';
  91          $this->data['edulevel'] = self::LEVEL_OTHER;
  92          $this->data['objecttable'] = 'external_tokens';
  93      }
  94  
  95      /**
  96       * Custom validation.
  97       *
  98       * @throws \coding_exception
  99       * @return void
 100       */
 101      protected function validate_data() {
 102          parent::validate_data();
 103          if (!isset($this->relateduserid)) {
 104             throw new \coding_exception('The \'relateduserid\' must be set.');
 105          }
 106  
 107          if (!isset($this->other['auto'])) {
 108              throw new \coding_exception('The \'auto\' value must be set in other.');
 109          }
 110      }
 111  
 112      public static function get_objectid_mapping() {
 113          // Webservices are not included in backups.
 114          return array('db' => 'external_tokens', 'restore' => base::NOT_MAPPED);
 115      }
 116  
 117      public static function get_other_mapping() {
 118          return false;
 119      }
 120  }