This transfers state between the login and account creation flows. More...
Public Member Functions | |
| __construct (AuthenticationRequest $createRequest=null, array $maybeLink=[]) | |
| getFieldInfo () | |
| hasPrimaryStateForAction ($action) | |
| Indicate whether this request contains state for the specified action sufficient to replace other primary-required requests. More... | |
| hasStateForAction ($action) | |
| Indicate whether this request contains any state for the specified action. More... | |
| loadFromSubmission (array $data) | |
 Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | |
| 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... | |
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. 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 provider. More... | |
| const | REQUIRED = 1 |
| Indicates that the request is required for authentication to proceed. More... | |
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. 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... | |
Detailed Description
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.
- Since
- 1.27
Definition at line 34 of file CreateFromLoginAuthenticationRequest.php.
Constructor & Destructor Documentation
| MediaWiki\Auth\CreateFromLoginAuthenticationRequest::__construct | ( | AuthenticationRequest | $createRequest = null, |
| array | $maybeLink = [] |
||
| ) |
- Parameters
-
AuthenticationRequest | null $createRequest A request to use to begin creating the account AuthenticationRequest[] $maybeLink Additional accounts to link after creation.
Definition at line 49 of file CreateFromLoginAuthenticationRequest.php.
References MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$createRequest, and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\$maybeLink.
Member Function Documentation
| MediaWiki\Auth\CreateFromLoginAuthenticationRequest::getFieldInfo | ( | ) |
Definition at line 57 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.
- Parameters
-
string $action One of the AuthManager::ACTION_* constants
- Returns
- boolean
Definition at line 88 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.
- Parameters
-
string $action One of the AuthManager::ACTION_* constants
- Returns
- boolean
Definition at line 71 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 | ) |
Definition at line 61 of file CreateFromLoginAuthenticationRequest.php.
Member Data Documentation
| AuthenticationRequest null MediaWiki\Auth\CreateFromLoginAuthenticationRequest::$createRequest |
Definition at line 38 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 41 of file CreateFromLoginAuthenticationRequest.php.
Referenced by MediaWiki\Auth\CreateFromLoginAuthenticationRequest\__construct(), and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasStateForAction().
| MediaWiki\Auth\CreateFromLoginAuthenticationRequest::$required = self::OPTIONAL |
Definition at line 35 of file CreateFromLoginAuthenticationRequest.php.
The documentation for this class was generated from the following file:
- includes/auth/CreateFromLoginAuthenticationRequest.php
