[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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   * The user profile 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   * The user profile viewed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int courseid: (optional) id of course.
  36   *      - string courseshortname: (optional) shortname of course.
  37   *      - string coursefullname: (optional) fullname of course.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Mark Nelson <markn@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class user_profile_viewed extends base {
  46  
  47      /**
  48       * Initialise required event data properties.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'user';
  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('eventuserprofileviewed');
  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          $desc = "The user with id '$this->userid' viewed the profile for the user with id '$this->relateduserid'";
  72          $desc .= ($this->contextlevel == CONTEXT_COURSE) ? " in the course with id '$this->courseid'." : ".";
  73          return $desc;
  74      }
  75  
  76      /**
  77       * Returns relevant URL.
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          if ($this->contextlevel == CONTEXT_COURSE) {
  83              return new \moodle_url('/user/view.php', array('id' => $this->relateduserid, 'course' => $this->courseid));
  84          }
  85          return new \moodle_url('/user/profile.php', array('id' => $this->relateduserid));
  86      }
  87  
  88      /**
  89       * Returns array of parameters to be passed to legacy add_to_log() function.
  90       *
  91       * @return array
  92       */
  93      protected function get_legacy_logdata() {
  94          if ($this->contextlevel == CONTEXT_COURSE) {
  95              return array($this->courseid, 'user', 'view', 'view.php?id=' . $this->relateduserid . '&course=' .
  96                  $this->courseid, $this->relateduserid);
  97          }
  98          return null;
  99      }
 100  
 101      /**
 102       * Custom validation.
 103       *
 104       * @throws \coding_exception when validation does not pass.
 105       * @return void
 106       */
 107      protected function validate_data() {
 108          parent::validate_data();
 109  
 110          if (!isset($this->relateduserid)) {
 111              throw new \coding_exception('The \'relateduserid\' must be set.');
 112          }
 113      }
 114  
 115      public static function get_objectid_mapping() {
 116          return array('db' => 'user', 'restore' => 'user');
 117      }
 118  
 119      public static function get_other_mapping() {
 120          $othermapped = array();
 121          $othermapped['courseid'] = array('db' => 'course', 'restore' => 'course');
 122  
 123          return $othermapped;
 124      }
 125  }