[Summary view]

   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   * Password policy failed event.
  19   *
  20   * @package    core
  21   * @copyright  2020 Peter Burnett <peterburnett@catalyst-au.net>
  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's current password fails the password policy
  31   *
  32   * @package    core
  33   * @since      Moodle 3.9
  34   * @copyright  2020 Peter Burnett <peterburnett@catalyst-au.net>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class user_password_policy_failed extends base {
  38      /**
  39       * Create event for user's current password failing password policy.
  40       *
  41       * @param \stdClass $user
  42       * @return user_password_updated
  43       */
  44      public static function create_from_user(\stdClass $user) {
  45          $data = array(
  46              'context' => \context_user::instance($user->id),
  47              'userid' => $user->id,
  48              'relateduserid' => $user->id,
  49          );
  50          $event = self::create($data);
  51          $event->add_record_snapshot('user', $user);
  52          return $event;
  53      }
  54  
  55      /**
  56       * Initialise required event data properties.
  57       */
  58      protected function init() {
  59          $this->data['crud'] = 'r';
  60          $this->data['edulevel'] = self::LEVEL_OTHER;
  61      }
  62  
  63      /**
  64       * Returns localised event name.
  65       *
  66       * @return string
  67       */
  68      public static function get_name() {
  69          return get_string('eventuserpasswordpolicyfailed');
  70      }
  71  
  72      /**
  73       * Returns non-localised event description with id's for admin use only.
  74       *
  75       * @return string
  76       */
  77      public function get_description() {
  78          return "The password for user with id '$this->userid' failed the current password policy.";
  79      }
  80  
  81      /**
  82       * Returns relevant URL.
  83       *
  84       * @return \moodle_url
  85       */
  86      public function get_url() {
  87          return new \moodle_url('/user/profile.php', array('id' => $this->userid));
  88      }
  89  }