This is a value object for authentication requests with a username, password, and domain Stable to extend. More...

Inheritance diagram for MediaWiki\Auth\PasswordDomainAuthenticationRequest:

[legend]

Collaboration diagram for MediaWiki\Auth\PasswordDomainAuthenticationRequest:

[legend]

Public Member Functions
	__construct (array $domainList)
	Stable to call.

	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.Stable to override 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. Stable to override Stable to override

	getFieldInfo ()
	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 sensitive: (bool) If set and truthy, the field is considered sensitive. Code using the request should avoid exposing the value of the field. skippable: (bool) If set and truthy, the client is free to hide this field from the user to streamline the workflow. If all fields are skippable (except possibly a single button), no user interaction is required at all. All AuthenticationRequests are populated from the same data, so most of the time you'll want to prefix fields names with something unique to the extension/provider (although in some cases sharing the field with other requests is the right thing to do, e.g. for a 'password' field). Returns array As above -return array<string,array{type:string,options?:array,value?:string,label:Message,help:Message,optional?:bool,sensitive?:bool,skippable?:bool}> Stable to override Stable to override

Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest
	getMetadata ()
	Returns metadata about this request.

	getUniqueId ()
	Supply a unique key for deduplication.

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

Static Public Member Functions
static	__set_state ( $data)

Static Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest
static	getRequestByClass (array $reqs, $class, $allowSubclasses=false)
	Select a request by class name.

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

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

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

Public Attributes
string	$domain = null
	Domain.

Public Attributes inherited from MediaWiki\Auth\PasswordAuthenticationRequest
string	$password = null
	Password.

string	$retype = null
	Password, again.

Public Attributes inherited from MediaWiki\Auth\AuthenticationRequest
string null	$action = null
	The AuthManager::ACTION_* constant this request was created to be used for.

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

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

string null	$username = null
	Username.

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

const	PRIMARY_REQUIRED = 2
	Indicates that the request is required by a primary authentication provider.

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

Private Attributes
string[]	$domainList
	Domains available.

Detailed Description

This is a value object for authentication requests with a username, password, and domain Stable to extend.

Since: 1.27

Definition at line 30 of file PasswordDomainAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::__construct ( array $domainList )

Stable to call.

Parameters

string[] $domainList List of available domains

Definition at line 41 of file PasswordDomainAuthenticationRequest.php.

References MediaWiki\Auth\PasswordDomainAuthenticationRequest\$domainList.

Member Function Documentation

◆ __set_state()

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

static

Parameters

array $data

Returns: AuthenticationRequest|static

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 86 of file PasswordDomainAuthenticationRequest.php.

◆ describeCredentials()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::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.Stable to override

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.

Stable to override Stable to override

Reimplemented from MediaWiki\Auth\PasswordAuthenticationRequest.

Definition at line 72 of file PasswordDomainAuthenticationRequest.php.

References wfMessage().

◆ getFieldInfo()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::getFieldInfo ( )

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
sensitive: (bool) If set and truthy, the field is considered sensitive. Code using the request should avoid exposing the value of the field.
skippable: (bool) If set and truthy, the client is free to hide this field from the user to streamline the workflow. If all fields are skippable (except possibly a single button), no user interaction is required at all.

All AuthenticationRequests are populated from the same data, so most of the time you'll want to prefix fields names with something unique to the extension/provider (although in some cases sharing the field with other requests is the right thing to do, e.g. for a 'password' field).

Returns: array As above -return array<string,array{type:string,options?:array,value?:string,label:Message,help:Message,optional?:bool,sensitive?:bool,skippable?:bool}>

Stable to override Stable to override

Reimplemented from MediaWiki\Auth\PasswordAuthenticationRequest.

Definition at line 49 of file PasswordDomainAuthenticationRequest.php.

References MediaWiki\Auth\PasswordDomainAuthenticationRequest\$domain, and wfMessage().