MediaWiki 1.42.1
ApiAuthManagerHelper Class Reference

Helper class for AuthManager-using API modules. More...

Public Member Functions

 __construct (ApiBase $module, AuthManager $authManager=null)
 
 formatAuthenticationResponse (AuthenticationResponse $res)
 Format an AuthenticationResponse for return.
 
 formatRequests (array $reqs)
 Format an array of AuthenticationRequests for return.
 
 getPreservedRequest ()
 Fetch the preserved CreateFromLoginAuthenticationRequest, if any.
 
 loadAuthenticationRequests ( $action)
 Fetch and load the AuthenticationRequests for an action.
 
 logAuthenticationResult ( $event, AuthenticationResponse $result)
 Logs successful or failed authentication.
 
 securitySensitiveOperation ( $operation)
 Call $manager->securitySensitiveOperationStatus()
 

Static Public Member Functions

static blacklistAuthenticationRequests (array $reqs, array $remove)
 Filter out authentication requests by class name.
 
static getStandardParams ( $action,... $wantedParams)
 Fetch the standard parameters this helper recognizes.
 
static newForModule (ApiBase $module, AuthManager $authManager=null)
 Static version of the constructor, for chaining.
 

Detailed Description

Helper class for AuthManager-using API modules.

Intended for use via composition.

Definition at line 39 of file ApiAuthManagerHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ApiAuthManagerHelper::__construct ( ApiBase $module,
AuthManager $authManager = null )
Parameters
ApiBase$moduleAPI module, for context and parameters
AuthManager | null$authManager

Definition at line 53 of file ApiAuthManagerHelper.php.

References $params, and ApiBase\extractRequestParams().

Member Function Documentation

◆ blacklistAuthenticationRequests()

static ApiAuthManagerHelper::blacklistAuthenticationRequests ( array $reqs,
array $remove )
static

Filter out authentication requests by class name.

Parameters
AuthenticationRequest[]$reqsRequests to filter
string[]$removeClass names to remove
Returns
AuthenticationRequest[]

Definition at line 132 of file ApiAuthManagerHelper.php.

Referenced by ApiChangeAuthenticationData\execute(), ApiClientLogin\execute(), and ApiQueryAuthManagerInfo\execute().

◆ formatAuthenticationResponse()

ApiAuthManagerHelper::formatAuthenticationResponse ( AuthenticationResponse $res)

Format an AuthenticationResponse for return.

Parameters
AuthenticationResponse$res
Returns
array

Definition at line 197 of file ApiAuthManagerHelper.php.

References formatRequests().

◆ formatRequests()

ApiAuthManagerHelper::formatRequests ( array $reqs)

Format an array of AuthenticationRequests for return.

Parameters
AuthenticationRequest[]$reqs
Returns
array Will have a 'requests' key, and also 'fields' if $module's params include 'mergerequestfields'.

Definition at line 277 of file ApiAuthManagerHelper.php.

References $params.

Referenced by formatAuthenticationResponse().

◆ getPreservedRequest()

ApiAuthManagerHelper::getPreservedRequest ( )

Fetch the preserved CreateFromLoginAuthenticationRequest, if any.

Returns
CreateFromLoginAuthenticationRequest|null

Definition at line 266 of file ApiAuthManagerHelper.php.

◆ getStandardParams()

static ApiAuthManagerHelper::getStandardParams ( $action,
$wantedParams )
static

Fetch the standard parameters this helper recognizes.

Parameters
string$actionAuthManager action
string...$wantedParams Parameters to use
Returns
array

Definition at line 359 of file ApiAuthManagerHelper.php.

References $params.

Referenced by ApiAMCreateAccount\getAllowedParams(), ApiChangeAuthenticationData\getAllowedParams(), ApiClientLogin\getAllowedParams(), ApiLinkAccount\getAllowedParams(), ApiQueryAuthManagerInfo\getAllowedParams(), and ApiRemoveAuthenticationData\getAllowedParams().

◆ loadAuthenticationRequests()

ApiAuthManagerHelper::loadAuthenticationRequests ( $action)

Fetch and load the AuthenticationRequests for an action.

Parameters
string$actionOne of the AuthManager::ACTION_* constants
Returns
AuthenticationRequest[]

Definition at line 147 of file ApiAuthManagerHelper.php.

References $params, and MediaWiki\Auth\AuthenticationRequest\getUniqueId().

◆ logAuthenticationResult()

ApiAuthManagerHelper::logAuthenticationResult ( $event,
AuthenticationResponse $result )

Logs successful or failed authentication.

Parameters
string$eventEvent type (e.g. 'accountcreation')
AuthenticationResponse$resultResponse or error message

Definition at line 248 of file ApiAuthManagerHelper.php.

References ApiBase\getModuleName().

◆ newForModule()

static ApiAuthManagerHelper::newForModule ( ApiBase $module,
AuthManager $authManager = null )
static

Static version of the constructor, for chaining.

Parameters
ApiBase$moduleAPI module, for context and parameters
AuthManager | null$authManager
Returns
ApiAuthManagerHelper

Definition at line 67 of file ApiAuthManagerHelper.php.

Referenced by ApiRemoveAuthenticationData\execute().

◆ securitySensitiveOperation()

ApiAuthManagerHelper::securitySensitiveOperation ( $operation)

Call $manager->securitySensitiveOperationStatus()

Parameters
string$operationOperation being checked.
Exceptions
ApiUsageException

Definition at line 107 of file ApiAuthManagerHelper.php.


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