MediaWiki\Auth\LegacyHookPreAuthenticationProvider Class Reference

A pre-authentication provider to call some legacy hooks. More...

Inheritance diagram for MediaWiki\Auth\LegacyHookPreAuthenticationProvider:

Collaboration diagram for MediaWiki\Auth\LegacyHookPreAuthenticationProvider:

Public Member Functions
	testForAccountCreation ( $user, $creator, array $reqs)
	Determine whether an account creation may begin.
	testForAuthentication (array $reqs)
	Determine whether an authentication may begin.
	testUserForCreation ( $user, $autocreate, array $options=[])
	Determine whether an account may be created.
Public Member Functions inherited from MediaWiki\Auth\AbstractPreAuthenticationProvider
	getAuthenticationRequests ( $action, array $options)
	Return the applicable list of AuthenticationRequests.
	postAccountCreation ( $user, $creator, AuthenticationResponse $response)
	Post-creation callback.
	postAccountLink ( $user, AuthenticationResponse $response)
	Post-link callback.
	postAuthentication ( $user, AuthenticationResponse $response)
	Post-login callback.
	testForAccountLink ( $user)
	Determine whether an account may linked to another authentication method.
Public Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider
	getUniqueId ()
	@inheritDoc
	setConfig (Config $config)
	Set configuration.
	setLogger (LoggerInterface $logger)
	setManager (AuthManager $manager)
	Set AuthManager.

Private Member Functions
	makeFailResponse (User $user, $constant, $msg, $hook)
	Construct an appropriate failure response.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider
Config	$config
LoggerInterface	$logger
AuthManager	$manager

Detailed Description

A pre-authentication provider to call some legacy hooks.

Since

1.27

Deprecated

since 1.27

Definition at line 34 of file LegacyHookPreAuthenticationProvider.php.

Member Function Documentation

makeFailResponse()

MediaWiki\Auth\LegacyHookPreAuthenticationProvider::makeFailResponse ( User $user, $constant, $msg, $hook )

private

Construct an appropriate failure response.

Parameters

User	$user
int	$constant	One of the LoginForm::… constants
string | null	$msg	Optional message key, will be derived from $constant otherwise
string	$hook	Name of the hook for error logging and exception messages

Returns

StatusValue

Definition at line 122 of file LegacyHookPreAuthenticationProvider.php.

References LoginForm\ABORTED, LoginForm\CREATE_BLOCKED, LoginForm\EMPTY_PASS, LoginForm\ILLEGAL, LoginForm\NEED_TOKEN, LoginForm\NO_NAME, LoginForm\NOT_EXISTS, LoginForm\RESET_PASS, LoginForm\SUCCESS, LoginForm\THROTTLED, LoginForm\USER_BLOCKED, LoginForm\USER_MIGRATED, wfEscapeWikiText(), LoginForm\WRONG_PASS, LoginForm\WRONG_PLUGIN_PASS, and LoginForm\WRONG_TOKEN.

Referenced by MediaWiki\Auth\LegacyHookPreAuthenticationProvider\testForAuthentication(), and MediaWiki\Auth\LegacyHookPreAuthenticationProvider\testUserForCreation().

testForAccountCreation()

MediaWiki\Auth\LegacyHookPreAuthenticationProvider::testForAccountCreation	(		$user,
			$creator,
		array	$reqs )

Determine whether an account creation may begin.

Called from AuthManager::beginAccountCreation()

Note

No need to test if the account exists, AuthManager checks that

Parameters

User	$user	User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
User	$creator	User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationRequest[]	$reqs

Returns

StatusValue

Reimplemented from MediaWiki\Auth\AbstractPreAuthenticationProvider.

Definition at line 74 of file LegacyHookPreAuthenticationProvider.php.

References $ret, and wfMessage().

testForAuthentication()

MediaWiki\Auth\LegacyHookPreAuthenticationProvider::testForAuthentication

(

array

$reqs

)

Determine whether an authentication may begin.

Called from AuthManager::beginAuthentication()

Parameters

AuthenticationRequest[]

$reqs

Returns

StatusValue

Reimplemented from MediaWiki\Auth\AbstractPreAuthenticationProvider.

Definition at line 36 of file LegacyHookPreAuthenticationProvider.php.

References $req, LoginForm\ABORTED, MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\LegacyHookPreAuthenticationProvider\makeFailResponse(), User\newFromName(), LoginForm\USER_MIGRATED, and wfRandomString().

testUserForCreation()

MediaWiki\Auth\LegacyHookPreAuthenticationProvider::testUserForCreation	(		$user,
			$autocreate,
		array	$options = [] )

Determine whether an account may be created.

Parameters

User	$user	User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
bool | string	$autocreate	False if this is not an auto-creation, or the source of the auto-creation passed to AuthManager::autoCreateUser().
array	$options	flags: (int) Bitfield of User:READ_* constants, default User::READ_NORMAL creating: (bool) If false (or missing), this call is only testing if a user could be created. If set, this (non-autocreation) is for actually creating an account and will be followed by a call to testForAccountCreation(). In this case, the provider might return StatusValue::newGood() here and let the later call to testForAccountCreation() do a more thorough test.

Returns

StatusValue

Reimplemented from MediaWiki\Auth\AbstractPreAuthenticationProvider.

Definition at line 99 of file LegacyHookPreAuthenticationProvider.php.

References LoginForm\ABORTED, and MediaWiki\Auth\LegacyHookPreAuthenticationProvider\makeFailResponse().

---

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

• includes/auth/LegacyHookPreAuthenticationProvider.php