Helper class for the password reset functionality shared by the web UI and the API. More...
Public Member Functions | |
| __construct ( $config, AuthManager $authManager, PermissionManager $permissionManager, ILoadBalancer $loadBalancer=null, LoggerInterface $logger=null, HookContainer $hookContainer=null) | |
| This class is managed by MediaWikiServices, don't instantiate directly. More... | |
| execute (User $performingUser, $username=null, $email=null) | |
| Do a password reset. More... | |
| isAllowed (User $user) | |
| Check if a given user has permission to use this functionality. More... | |
Public Attributes | |
| const | CONSTRUCTOR_OPTIONS |
Protected Member Functions | |
| getUsersByEmail ( $email) | |
| isBlocked (User $user) | |
| Check whether the user is blocked. More... | |
| lookupUser ( $username) | |
| User object creation helper for testability. More... | |
Protected Attributes | |
| AuthManager | $authManager |
| ServiceOptions Config | $config |
| ILoadBalancer | $loadBalancer |
| PermissionManager | $permissionManager |
Private Attributes | |
| HookContainer | $hookContainer |
| HookRunner | $hookRunner |
| MapCacheLRU | $permissionCache |
| In-process cache for isAllowed lookups, by username. More... | |
Detailed Description
Helper class for the password reset functionality shared by the web UI and the API.
Requires the TemporaryPasswordPrimaryAuthenticationProvider and the EmailNotificationSecondaryAuthenticationProvider (or something providing equivalent functionality) to be enabled.
Definition at line 43 of file PasswordReset.php.
Constructor & Destructor Documentation
◆ __construct()
| PasswordReset::__construct | ( | $config, | |
| AuthManager | $authManager, | ||
| PermissionManager | $permissionManager, | ||
| ILoadBalancer | $loadBalancer = null, |
||
| LoggerInterface | $logger = null, |
||
| HookContainer | $hookContainer = null |
||
| ) |
This class is managed by MediaWikiServices, don't instantiate directly.
- Parameters
-
ServiceOptions | Config $config AuthManager $authManager PermissionManager $permissionManager ILoadBalancer | null $loadBalancer LoggerInterface | null $logger HookContainer | null $hookContainer
Definition at line 87 of file PasswordReset.php.
References $authManager, $config, $hookContainer, $loadBalancer, $permissionManager, and wfDeprecated().
Member Function Documentation
◆ execute()
| PasswordReset::execute | ( | User | $performingUser, |
$username = null, |
|||
$email = null |
|||
| ) |
Do a password reset.
Authorization is the caller's responsibility.
Process the form. At this point we know that the user passes all the criteria in userCanExecute(), and if the data array contains 'Username', etc, then Username resets are allowed.
- Since
- 1.29 Fourth argument for displayPassword removed.
- Parameters
-
User $performingUser The user that does the password reset string | null $username The user whose password is reset string | null $email Alternative way to specify the user
- Returns
- StatusValue
- Exceptions
-
LogicException When the user is not allowed to perform the action MWException On unexpected DB errors
Definition at line 177 of file PasswordReset.php.
References DeferredUpdates\addUpdate(), User\getCanonicalName(), User\getId(), User\getName(), User\getRequest(), getUsersByEmail(), isAllowed(), lookupUser(), StatusValue\newFatal(), Message\newFromSpecifier(), StatusValue\newGood(), User\pingLimiter(), DeferredUpdates\POSTSEND, and Sanitizer\validateEmail().
◆ getUsersByEmail()
|
protected |
- Parameters
-
string $email
- Returns
- User[]
- Exceptions
-
MWException On unexpected database errors
Definition at line 358 of file PasswordReset.php.
References $res, DB_REPLICA, User\getQueryInfo(), and User\newFromRow().
Referenced by execute().
◆ isAllowed()
| PasswordReset::isAllowed | ( | User | $user | ) |
Check if a given user has permission to use this functionality.
- Parameters
-
User $user
- Since
- 1.29 Second argument for displayPassword removed.
- Returns
- StatusValue
Definition at line 126 of file PasswordReset.php.
References User\getName(), isBlocked(), StatusValue\newFatal(), and StatusValue\newGood().
Referenced by execute().
◆ isBlocked()
|
protected |
Check whether the user is blocked.
Ignores certain types of system blocks that are only meant to force users to log in.
- Parameters
-
User $user
- Returns
- bool
- Since
- 1.30
Definition at line 345 of file PasswordReset.php.
References User\getBlock(), and User\getGlobalBlock().
Referenced by isAllowed().
◆ lookupUser()
|
protected |
User object creation helper for testability.
- Parameters
-
string $username
- Returns
- User|false
Definition at line 388 of file PasswordReset.php.
References User\newFromName().
Referenced by execute().
Member Data Documentation
◆ $authManager
|
protected |
Definition at line 50 of file PasswordReset.php.
Referenced by __construct().
◆ $config
|
protected |
Definition at line 47 of file PasswordReset.php.
Referenced by __construct().
◆ $hookContainer
|
private |
Definition at line 59 of file PasswordReset.php.
Referenced by __construct().
◆ $hookRunner
|
private |
Definition at line 62 of file PasswordReset.php.
◆ $loadBalancer
|
protected |
Definition at line 56 of file PasswordReset.php.
Referenced by __construct().
◆ $permissionCache
|
private |
In-process cache for isAllowed lookups, by username.
Contains a StatusValue object
Definition at line 69 of file PasswordReset.php.
◆ $permissionManager
|
protected |
Definition at line 53 of file PasswordReset.php.
Referenced by __construct().
◆ CONSTRUCTOR_OPTIONS
| const PasswordReset::CONSTRUCTOR_OPTIONS |
Definition at line 71 of file PasswordReset.php.
The documentation for this class was generated from the following file:
- includes/user/PasswordReset.php
