MediaWiki\User\PasswordReset Class Reference

Password reset helper for functionality shared by the web UI and the API. More...

Inherits LoggerAwareInterface.

Collaboration diagram for MediaWiki\User\PasswordReset:

Public Member Functions
	__construct (private readonly ServiceOptions $config, LoggerInterface $logger, private readonly AuthManager $authManager, HookContainer $hookContainer, private readonly UserIdentityLookup $userIdentityLookup, private readonly UserFactory $userFactory, private readonly UserNameUtils $userNameUtils, private readonly UserOptionsLookup $userOptionsLookup,)
	This class is managed by MediaWikiServices, don't instantiate directly.
	execute (User $performingUser, $username=null, $email=null)
	Do a password reset.
	isAllowed (User $user)
	Check if a given user has permission to use this functionality.
	isEnabled ()

Public Attributes
const	CONSTRUCTOR_OPTIONS

Protected Member Functions
	getUsersByEmail ( $email)

Detailed Description

Password reset helper for 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 35 of file PasswordReset.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\User\PasswordReset::__construct	(	private readonly ServiceOptions	$config,
		LoggerInterface	$logger,
		private readonly AuthManager	$authManager,
		HookContainer	$hookContainer,
		private readonly UserIdentityLookup	$userIdentityLookup,
		private readonly UserFactory	$userFactory,
		private readonly UserNameUtils	$userNameUtils,
		private readonly UserOptionsLookup	$userOptionsLookup )

This class is managed by MediaWikiServices, don't instantiate directly.

Definition at line 57 of file PasswordReset.php.

Member Function Documentation

execute()

MediaWiki\User\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

Definition at line 147 of file PasswordReset.php.

References MediaWiki\User\User\getName(), MediaWiki\User\User\getRequest(), and MediaWiki\User\User\pingLimiter().

getUsersByEmail()

MediaWiki\User\PasswordReset::getUsersByEmail ( $email )

protected

Note

This is protected to allow configuring in tests. This class is not stable to extend.

Parameters

string

$email

Returns

Iterator<UserIdentity>

Definition at line 307 of file PasswordReset.php.

isAllowed()

MediaWiki\User\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 81 of file PasswordReset.php.

References MediaWiki\User\User\getName().

isEnabled()

MediaWiki\User\PasswordReset::isEnabled

(

)

Since

1.42

Definition at line 93 of file PasswordReset.php.

Member Data Documentation

CONSTRUCTOR_OPTIONS

const MediaWiki\User\PasswordReset::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::EnableEmail,
        MainConfigNames::PasswordResetRoutes,
    ]

Access: internal

For use by ServiceWiring

Definition at line 49 of file PasswordReset.php.

---

The documentation for this class was generated from the following file:

• includes/User/PasswordReset.php