MediaWiki  1.29.1
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. More...
 
 testForAuthentication (array $reqs)
 Determine whether an authentication may begin. More...
 
 testUserForCreation ( $user, $autocreate, array $options=[])
 Determine whether an account may be created. More...
 
- Public Member Functions inherited from MediaWiki\Auth\AbstractPreAuthenticationProvider
 getAuthenticationRequests ( $action, array $options)
 Return the applicable list of AuthenticationRequests. More...
 
 postAccountCreation ( $user, $creator, AuthenticationResponse $response)
 Post-creation callback. More...
 
 postAccountLink ( $user, AuthenticationResponse $response)
 Post-link callback. More...
 
 postAuthentication ( $user, AuthenticationResponse $response)
 Post-login callback. More...
 
 testForAccountLink ( $user)
 Determine whether an account may linked to another authentication method. More...
 
- Public Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider
 getUniqueId ()
 Return a unique identifier for this instance.This must be the same across requests. If multiple instances return the same ID, exceptions will be thrown from AuthManager.
Returns
string
More...
 
 setConfig (Config $config)
 Set configuration. More...
 
 setLogger (LoggerInterface $logger)
 
 setManager (AuthManager $manager)
 Set AuthManager. More...
 

Protected Member Functions

 makeFailResponse ( $user, $creator, $constant, $msg, $hook)
 Construct an appropriate failure response. More...
 

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,
  $creator,
  $constant,
  $msg,
  $hook 
)
protected

◆ 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$userUser being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
User$creatorUser 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, $user, StatusValue\newFatal(), StatusValue\newGood(), Hooks\run(), and wfMessage().

◆ testForAuthentication()

◆ testUserForCreation()

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

Determine whether an account may be created.

Parameters
User$userUser 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$autocreateFalse 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 $user, LoginForm\ABORTED, MediaWiki\Auth\LegacyHookPreAuthenticationProvider\makeFailResponse(), StatusValue\newGood(), and Hooks\run().


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