This is a value object for authentication requests. More...

Inheritance diagram for MediaWiki\Auth\AuthenticationRequest:

Collaboration diagram for MediaWiki\Auth\AuthenticationRequest:

Public Member Functions
	describeCredentials ()
	Describe the credentials represented by this request. More...

	getFieldInfo ()
	Fetch input field info. More...

	getMetadata ()
	Returns metadata about this request. More...

	getUniqueId ()
	Supply a unique key for deduplication. More...

	loadFromSubmission (array $data)
	Initialize form submitted form data. More...

Static Public Member Functions
static	__set_state ($data)
	Implementing this mainly for use from the unit tests. More...

static	getRequestByClass (array $reqs, $class, $allowSubclasses=false)
	Select a request by class name. More...

static	getUsernameFromRequests (array $reqs)
	Get the username from the set of requests. More...

static	loadRequestsFromSubmission (array $reqs, array $data)
	Update a set of requests with form submit data, discarding ones that fail. More...

static	mergeFieldInfo (array $reqs)
	Merge the output of multiple AuthenticationRequest::getFieldInfo() calls. More...

Public Attributes
string null	$action = null
	The AuthManager::ACTION_* constant this request was created to be used for. More...

int	$required = self::REQUIRED
	For login, continue, and link actions, one of self::OPTIONAL, self::REQUIRED, or self::PRIMARY_REQUIRED. More...

string null	$returnToUrl = null
	Return-to URL, in case of redirect. More...

string null	$username = null
	Username. More...

const	OPTIONAL = 0
	Indicates that the request is not required for authentication to proceed. More...

const	PRIMARY_REQUIRED = 2
	Indicates that the request is required by a primary authentication provdier, but other primary authentication providers do not require it. More...

const	REQUIRED = 1
	Indicates that the request is required for authentication to proceed. More...

Detailed Description

This is a value object for authentication requests.

An AuthenticationRequest represents a set of form fields that are needed on and provided from the login, account creation, or password change forms.

Since: 1.27

Definition at line 37 of file AuthenticationRequest.php.

Member Function Documentation

static MediaWiki\Auth\AuthenticationRequest::__set_state ( $data )

static

Implementing this mainly for use from the unit tests.

Parameters

array $data

Returns: AuthenticationRequest

Definition at line 350 of file AuthenticationRequest.php.

References $ret, and as.

MediaWiki\Auth\AuthenticationRequest::describeCredentials ( )

Describe the credentials represented by this request.

This is used on requests returned by AuthenticationProvider::getAuthenticationRequests() for ACTION_LINK and ACTION_REMOVE and for requests returned in AuthenticationResponse::$linkRequest to create useful user interfaces.

Returns

Message[] with the following keys:

provider: A Message identifying the service that provides the credentials, e.g. the name of the third party authentication service.
account: A Message identifying the credentials themselves, e.g. the email address used with the third party authentication service.

Definition at line 206 of file AuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\getUniqueId().

MediaWiki\Auth\AuthenticationRequest::getFieldInfo ( )

abstract

Fetch input field info.

The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:

type: (string) Type of input. Types and equivalent HTML widgets are:
- string: <input type="text">
- password: <input type="password">
- select: <select>
- checkbox: <input type="checkbox">
- multiselect: More a grid of checkboxes than <select multi>="">
- button: <input type="submit"> (uses 'label' as button text)
- hidden: Not visible to the user, but needs to be preserved for the next request
- null: No widget, just display the 'label' message.
options: (array) Maps option values to Messages for the 'select' and 'multiselect' types.
value: (string) Value (for 'null' and 'hidden') or default value (for other types).
label: (Message) Text suitable for a label in an HTML form
help: (Message) Text suitable as a description of what the field is
optional: (bool) If set and truthy, the field may be left empty

Returns: array As above

Referenced by MediaWiki\Auth\AuthenticationRequest\loadFromSubmission().

MediaWiki\Auth\AuthenticationRequest::getMetadata ( )

Returns metadata about this request.

This is mainly for the benefit of API clients which need more detailed render hints than what's available through getFieldInfo(). Semantics are unspecified and left to the individual subclasses, but the contents of the array should be primitive types so that they can be transformed into JSON or similar formats.

Returns: array A (possibly nested) array with primitive types

Definition at line 119 of file AuthenticationRequest.php.

static MediaWiki\Auth\AuthenticationRequest::getRequestByClass	(	array	$reqs,
			$class,
			$allowSubclasses = `false`
	)

static

Select a request by class name.

Parameters

	AuthenticationRequest[]	$reqs
string	$class	Class name
bool	$allowSubclasses	If true, also returns any request that's a subclass of the given class.

Returns: AuthenticationRequest|null Returns null if there is not exactly one matching request.

Definition at line 234 of file AuthenticationRequest.php.

References $req, $requests, and use.

MediaWiki\Auth\AuthenticationRequest::getUniqueId ( )

Supply a unique key for deduplication.

When the AuthenticationRequests instances returned by the providers are merged, the value returned here is used for keeping only one copy of duplicate requests.

Subclasses should override this if multiple distinct instances would make sense, i.e. the request class has internal state of some sort.

This value might be exposed to the user in web forms so it should not contain private information.