MediaWiki master
|
This is a value object for authentication requests with a username and password. More...
Inherits MediaWiki\Auth\AuthenticationRequest.
Inherited by MediaWiki\Auth\PasswordDomainAuthenticationRequest.
Public Member Functions | |
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.
| |
getFieldInfo () | |
Fetch input field info.This will be used in the AuthManager APIs and web UIs to define API input parameters / form fields and to process the submitted data.The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:
| |
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. | |
Public Attributes | |
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. | |
Additional Inherited Members | |
Static Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | |
static | __set_state ( $data) |
Implementing this mainly for use from the unit tests. | |
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. | |
This is a value object for authentication requests with a username and password.
Definition at line 32 of file PasswordAuthenticationRequest.php.
MediaWiki\Auth\PasswordAuthenticationRequest::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.
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Reimplemented in MediaWiki\Auth\PasswordDomainAuthenticationRequest.
Definition at line 90 of file PasswordAuthenticationRequest.php.
References wfMessage().
MediaWiki\Auth\PasswordAuthenticationRequest::getFieldInfo | ( | ) |
Fetch input field info.This will be used in the AuthManager APIs and web UIs to define API input parameters / form fields and to process the submitted data.The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Reimplemented in MediaWiki\Auth\PasswordDomainAuthenticationRequest.
Definition at line 43 of file PasswordAuthenticationRequest.php.
References MediaWiki\Auth\AuthManager\ACTION_CHANGE, MediaWiki\Auth\AuthManager\ACTION_LOGIN, MediaWiki\Auth\AuthManager\ACTION_REMOVE, and wfMessage().
string MediaWiki\Auth\PasswordAuthenticationRequest::$password = null |
Password.
Definition at line 34 of file PasswordAuthenticationRequest.php.
string MediaWiki\Auth\PasswordAuthenticationRequest::$retype = null |
Password, again.
Definition at line 37 of file PasswordAuthenticationRequest.php.