[Summary view]

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