[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 password updated event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Petr Skoda
  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   * Event when user password is changed or reset.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - bool forgottenreset: true means reset via token.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Petr Skoda
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class user_password_updated extends base {
  44      /**
  45       * Create event for user password changing and resetting.
  46       *
  47       * @param \stdClass $user
  48       * @param bool $forgottenreset true if reset via recovery link
  49       * @return user_password_updated
  50       */
  51      public static function create_from_user(\stdClass $user, $forgottenreset = false) {
  52          $data = array(
  53              'context' => \context_user::instance($user->id),
  54              'relateduserid' => $user->id,
  55              'other' => array('forgottenreset' => $forgottenreset),
  56          );
  57          $event = self::create($data);
  58          $event->add_record_snapshot('user', $user);
  59          return $event;
  60      }
  61  
  62      /**
  63       * Initialise required event data properties.
  64       */
  65      protected function init() {
  66          $this->data['crud'] = 'u';
  67          $this->data['edulevel'] = self::LEVEL_OTHER;
  68      }
  69  
  70      /**
  71       * Returns localised event name.
  72       *
  73       * @return string
  74       */
  75      public static function get_name() {
  76          return get_string('eventuserpasswordupdated');
  77      }
  78  
  79      /**
  80       * Returns non-localised event description with id's for admin use only.
  81       *
  82       * @return string
  83       */
  84      public function get_description() {
  85          if ($this->userid == $this->relateduserid) {
  86              if ($this->other['forgottenreset']) {
  87                  return "The user with id '$this->userid' reset their password.";
  88              }
  89              return "The user with id '$this->userid' changed their password.";
  90          } else {
  91              return "The user with id '$this->userid' changed the password of the user with id '$this->relateduserid'.";
  92          }
  93      }
  94  
  95      /**
  96       * Returns relevant URL.
  97       *
  98       * @return \moodle_url
  99       */
 100      public function get_url() {
 101          return new \moodle_url('/user/profile.php', array('id' => $this->relateduserid));
 102      }
 103  
 104      /**
 105       * Returns array of parameters to be passed to legacy logging.
 106       *
 107       * @return array|null
 108       */
 109      protected function get_legacy_logdata() {
 110          if (!$this->other['forgottenreset']) {
 111              // We did not log password changes in earlier versions.
 112              return null;
 113          }
 114          return array(SITEID, 'user', 'set password', 'profile.php?id='.$this->userid, $this->relateduserid);
 115      }
 116  
 117      /**
 118       * Custom validation.
 119       *
 120       * @throws \coding_exception
 121       */
 122      protected function validate_data() {
 123          parent::validate_data();
 124  
 125          if (!$this->relateduserid) {
 126              throw new \coding_exception('The \'relateduserid\' must be set.');
 127          }
 128  
 129          if (!isset($this->other['forgottenreset'])) {
 130              throw new \coding_exception('The \'forgottenreset\' value must be set in other.');
 131          }
 132      }
 133  
 134      public static function get_other_mapping() {
 135          return false;
 136      }
 137  }