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

Collaboration diagram for ApiAuthManagerHelper:

[legend]

Public Member Functions
	__construct (ApiBase $module)

	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, $result)
	Logs successful or failed authentication.

	securitySensitiveOperation ( $operation)
	Call $manager->securitySensitiveOperationStatus()

Static Public Member Functions
static	blacklistAuthenticationRequests (array $reqs, array $blacklist)
	Filter out authentication requests by class name.

static	getStandardParams ( $action, $param)
	Fetch the standard parameters this helper recognizes.

static	newForModule (ApiBase $module)
	Static version of the constructor, for chaining.

Private Member Functions
	formatFields (array $fields)
	Clean up a field array for output.

	formatMessage (array &$res, $key, Message $message)
	Format a message for output.

Private Attributes
string	$messageFormat
	Message output format.

ApiBase	$module
	API module, for context and parameters.

Detailed Description

Helper class for AuthManager-using API modules.

Intended for use via composition.

Definition at line 36 of file ApiAuthManagerHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ApiAuthManagerHelper::__construct ( ApiBase $module )

Parameters

ApiBase $module API module, for context and parameters

Definition at line 47 of file ApiAuthManagerHelper.php.

References $module, $params, and ApiBase\extractRequestParams().

Member Function Documentation

◆ blacklistAuthenticationRequests()

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

static

Filter out authentication requests by class name.

Parameters

AuthenticationRequest[]	$reqs	Requests to filter
string[]	$blacklist	Class names to remove

Returns: AuthenticationRequest[]

Definition at line 121 of file ApiAuthManagerHelper.php.

References $req, and use.

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 184 of file ApiAuthManagerHelper.php.

References $res, $ret, ApiMessage\create(), formatMessage(), and formatRequests().

◆ formatFields()

ApiAuthManagerHelper::formatFields ( array $fields )

private

Clean up a field array for output.

Parameters

ApiBase	$module	For context and parameters 'mergerequestfields' and 'messageformat'
array	$fields

Returns: array

Definition at line 314 of file ApiAuthManagerHelper.php.

References $module, $name, $ret, as, formatMessage(), plain, ApiResult\setArrayType(), and use.

Referenced by formatRequests().

◆ formatMessage()

ApiAuthManagerHelper::formatMessage	(	array &	$res,
			$key,
		Message	$message
	)

private

Format a message for output.

Parameters

array	&$res	Result array
string	$key	Result key
Message	$message

Definition at line 69 of file ApiAuthManagerHelper.php.

References $res, Message\getKey(), Message\getParams(), Message\setContext(), and ApiResult\setIndexedTagName().

Referenced by formatAuthenticationResponse(), formatFields(), and 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 269 of file ApiAuthManagerHelper.php.

References $params, $req, $ret, array(), as, formatFields(), formatMessage(), and ApiResult\META_TYPE.

Referenced by formatAuthenticationResponse().

◆ getPreservedRequest()

ApiAuthManagerHelper::getPreservedRequest ( )

Fetch the preserved CreateFromLoginAuthenticationRequest, if any.

Returns: CreateFromLoginAuthenticationRequest|null

Definition at line 258 of file ApiAuthManagerHelper.php.

References $ret.

◆ getStandardParams()

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

static

Fetch the standard parameters this helper recognizes.

Parameters

string	$action	AuthManager action
string	$param,...	Parameters to use

Returns: array

Definition at line 351 of file ApiAuthManagerHelper.php.

References $name, $params, $ret, as, ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

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 $action One of the AuthManager::ACTION_* constants

Returns: AuthenticationRequest[]

Definition at line 136 of file ApiAuthManagerHelper.php.

References $data, $params, $req, array(), as, true, and use.

◆ logAuthenticationResult()

ApiAuthManagerHelper::logAuthenticationResult	(	$event,
		$result
	)

Logs successful or failed authentication.

Parameters

string	$event	Event type (e.g. 'accountcreation')
string \| AuthenticationResponse	$result	Response or error message

Definition at line 235 of file ApiAuthManagerHelper.php.

References $module, and ApiBase\getModuleName().

◆ newForModule()

static ApiAuthManagerHelper::newForModule ( ApiBase $module )

static

Static version of the constructor, for chaining.

Parameters

ApiBase $module API module, for context and parameters

Returns: ApiAuthManagerHelper

Definition at line 59 of file ApiAuthManagerHelper.php.

References $module.

Referenced by ApiRemoveAuthenticationData\execute().

◆ securitySensitiveOperation()

ApiAuthManagerHelper::securitySensitiveOperation ( $operation )

Call $manager->securitySensitiveOperationStatus()

Parameters

string $operation Operation being checked.

Exceptions

ApiUsageException

Definition at line 98 of file ApiAuthManagerHelper.php.

Member Data Documentation

◆ $messageFormat

string ApiAuthManagerHelper::$messageFormat

private

Message output format.

Definition at line 42 of file ApiAuthManagerHelper.php.

◆ $module

ApiBase ApiAuthManagerHelper::$module

private

API module, for context and parameters.

Definition at line 39 of file ApiAuthManagerHelper.php.

Referenced by __construct(), formatFields(), logAuthenticationResult(), and newForModule().

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

includes/api/ApiAuthManagerHelper.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ blacklistAuthenticationRequests()

◆ formatAuthenticationResponse()

◆ formatFields()

◆ formatMessage()

◆ formatRequests()

◆ getPreservedRequest()

◆ getStandardParams()

◆ loadAuthenticationRequests()

◆ logAuthenticationResult()

◆ newForModule()

◆ securitySensitiveOperation()

Member Data Documentation

◆ $messageFormat

◆ $module