[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   * User logout event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Event when user logout.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string sessionid: (optional) session id.
  35   * }
  36   *
  37   * @package    core
  38   * @since      Moodle 2.6
  39   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class user_loggedout extends base {
  43  
  44      /**
  45       * Initialise required event data properties.
  46       */
  47      protected function init() {
  48          $this->context = \context_system::instance();
  49          $this->data['objecttable'] = 'user';
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52      }
  53  
  54      /**
  55       * Returns localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventuserloggedout');
  61      }
  62  
  63      /**
  64       * Returns non-localised event description with id's for admin use only.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->objectid' has logged out.";
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          return new \moodle_url('/user/view.php', array('id' => $this->objectid));
  79      }
  80  
  81      /**
  82       * Return name of the legacy event, which is replaced by this event.
  83       *
  84       * @return string legacy event name
  85       */
  86      public static function get_legacy_eventname() {
  87          return 'user_logout';
  88      }
  89  
  90      /**
  91       * Return user_logout legacy event data.
  92       *
  93       * @return \stdClass user data.
  94       */
  95      protected function get_legacy_eventdata() {
  96          return $this->get_record_snapshot('user', $this->objectid);
  97      }
  98  
  99      /**
 100       * Returns array of parameters to be passed to legacy add_to_log() function.
 101       *
 102       * @return array
 103       */
 104      protected function get_legacy_logdata() {
 105          return array(SITEID, 'user', 'logout', 'view.php?id='.$this->objectid.'&course='.SITEID, $this->objectid, 0,
 106              $this->objectid);
 107      }
 108  
 109      public static function get_objectid_mapping() {
 110          return array('db' => 'user', 'restore' => 'user');
 111      }
 112  
 113      public static function get_other_mapping() {
 114          return false;
 115      }
 116  }