MediaWiki master
|
This transfers state between the login and account creation flows. More...
Inherits MediaWiki\Auth\AuthenticationRequest.
Public Member Functions | ||||
__construct (AuthenticationRequest $createRequest=null, array $maybeLink=[]) | ||||
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:
| ||||
hasPrimaryStateForAction ( $action) | ||||
Indicate whether this request contains state for the specified action sufficient to replace other primary-required requests. | ||||
hasStateForAction ( $action) | ||||
Indicate whether this request contains any state for the specified action. | ||||
loadFromSubmission (array $data) | ||||
Initialize form submitted form data.The default behavior is to check for each key of self::getFieldInfo() in the submitted data, and copy the value - after type-appropriate transformations - to $this->$key. Most subclasses won't need to override this; if you do override it, make sure to always return false if self::getFieldInfo() returns an empty array.
| ||||
Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | ||||
describeCredentials () | ||||
Describe the credentials represented by this request. | ||||
getMetadata () | ||||
Returns metadata about this request. | ||||
getUniqueId () | ||||
Supply a unique key for deduplication. | ||||
Public Attributes | |
AuthenticationRequest null | $createRequest |
AuthenticationRequest[] | $maybeLink = [] |
$required = self::OPTIONAL | |
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 transfers state between the login and account creation flows.
AuthManager::getAuthenticationRequests() won't return this type, but it may be passed to AuthManager::beginAuthentication() or AuthManager::beginAccountCreation() anyway.
Definition at line 35 of file CreateFromLoginAuthenticationRequest.php.
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::__construct | ( | AuthenticationRequest | $createRequest = null, |
array | $maybeLink = [] ) |
AuthenticationRequest | null | $createRequest | A request to use to begin creating the account |
AuthenticationRequest[] | $maybeLink | Additional accounts to link after creation. |
Definition at line 52 of file CreateFromLoginAuthenticationRequest.php.
References MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$createRequest, and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$maybeLink.
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::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.
Definition at line 64 of file CreateFromLoginAuthenticationRequest.php.
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::hasPrimaryStateForAction | ( | $action | ) |
Indicate whether this request contains state for the specified action sufficient to replace other primary-required requests.
string | $action | One of the AuthManager::ACTION_* constants |
Definition at line 101 of file CreateFromLoginAuthenticationRequest.php.
References MediaWiki\Auth\AuthenticationRequest\$action, MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$createRequest, and MediaWiki\Auth\AuthManager\ACTION_CREATE.
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::hasStateForAction | ( | $action | ) |
Indicate whether this request contains any state for the specified action.
string | $action | One of the AuthManager::ACTION_* constants |
Definition at line 83 of file CreateFromLoginAuthenticationRequest.php.
References MediaWiki\Auth\AuthenticationRequest\$action, MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$createRequest, MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$maybeLink, MediaWiki\Auth\AuthManager\ACTION_CREATE, and MediaWiki\Auth\AuthManager\ACTION_LOGIN.
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::loadFromSubmission | ( | array | $data | ) |
Initialize form submitted form data.The default behavior is to check for each key of self::getFieldInfo() in the submitted data, and copy the value - after type-appropriate transformations - to $this->$key. Most subclasses won't need to override this; if you do override it, make sure to always return false if self::getFieldInfo() returns an empty array.
array | $data | Submitted data as an associative array (keys will correspond to getFieldInfo()) |
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Definition at line 72 of file CreateFromLoginAuthenticationRequest.php.
AuthenticationRequest null MediaWiki\Auth\CreateFromLoginAuthenticationRequest::$createRequest |
Definition at line 40 of file CreateFromLoginAuthenticationRequest.php.
Referenced by MediaWiki\Auth\CreateFromLoginAuthenticationRequest\__construct(), MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasPrimaryStateForAction(), and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasStateForAction().
AuthenticationRequest [] MediaWiki\Auth\CreateFromLoginAuthenticationRequest::$maybeLink = [] |
Definition at line 43 of file CreateFromLoginAuthenticationRequest.php.
Referenced by MediaWiki\Auth\CreateFromLoginAuthenticationRequest\__construct(), and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasStateForAction().
MediaWiki\Auth\CreateFromLoginAuthenticationRequest::$required = self::OPTIONAL |
Definition at line 37 of file CreateFromLoginAuthenticationRequest.php.