[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 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   * Defines the user list viewed event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Defines the user list viewed event.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string courseshortname: (optional) the short name of course.
  36   *      - string coursefullname: (optional) the full name of course.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.6
  41   * @copyright  2013 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  
  45  class user_list_viewed extends base {
  46  
  47      /**
  48       * Initialise required event data properties.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'course';
  52          $this->data['crud'] = 'r';
  53          $this->data['edulevel'] = self::LEVEL_OTHER;
  54      }
  55  
  56      /**
  57       * Returns localised event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventuserlistviewed');
  63      }
  64  
  65      /**
  66       * Returns non-localised event description with id's for admin use only.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' viewed the list of users in the course with id '$this->courseid'.";
  72      }
  73  
  74      /**
  75       * Returns relevant URL.
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/user/index.php', array('id' => $this->courseid));
  81      }
  82  
  83      /**
  84       * Returns array of parameters to be passed to legacy add_to_log() function.
  85       *
  86       * @return array
  87       */
  88      protected function get_legacy_logdata() {
  89          return array($this->courseid, 'user', 'view all', 'index.php?id=' . $this->courseid, '');
  90      }
  91  
  92      public static function get_objectid_mapping() {
  93          return array('db' => 'course', 'restore' => 'course');
  94      }
  95  
  96      public static function get_other_mapping() {
  97          return false;
  98      }
  99  }