This is an authentication request that just implements a simple button. More...
Public Member Functions | |
| __construct ($name, Message $label, Message $help, $required=false) | |
| getFieldInfo () | |
| getUniqueId () | |
 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... | |
Static Public Member Functions | |
| static | __set_state ($data) |
| static | getRequestByName (array $reqs, $name) |
| Fetch a ButtonAuthenticationRequest or subclass by name. More... | |
| 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... | |
Protected Attributes | |
| Message | $help |
| Message | $label |
| string | $name |
Additional Inherited Members | |
| 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 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 an authentication request that just implements a simple button.
- Since
- 1.27
Definition at line 31 of file ButtonAuthenticationRequest.php.
Constructor & Destructor Documentation
| MediaWiki\Auth\ButtonAuthenticationRequest::__construct | ( | $name, | |
| Message | $label, | ||
| Message | $help, | ||
$required = false |
|||
| ) |
- Parameters
-
string $name Button name Message $label Button label Message $help Button help bool $required The button is required for authentication to proceed.
Definition at line 47 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$help, MediaWiki\Auth\ButtonAuthenticationRequest\$label, MediaWiki\Auth\ButtonAuthenticationRequest\$name, MediaWiki\Auth\AuthenticationRequest\$required, and name.
Member Function Documentation
|
static |
Definition at line 85 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequestTest\getInstance().
| MediaWiki\Auth\ButtonAuthenticationRequest::getFieldInfo | ( | ) |
Definition at line 58 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$help, MediaWiki\Auth\ButtonAuthenticationRequest\$label, and name.
|
static |
Fetch a ButtonAuthenticationRequest or subclass by name.
- Parameters
-
AuthenticationRequest[] $reqs Requests to search string $name Name to look for
- Returns
- ButtonAuthenticationRequest|null Returns null if there is not exactly one matching request.
Definition at line 75 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name, $req, $requests, and use.
Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt(), MediaWiki\Auth\ButtonAuthenticationRequestTest\testGetRequestByName(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().
| MediaWiki\Auth\ButtonAuthenticationRequest::getUniqueId | ( | ) |
Definition at line 54 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name.
Member Data Documentation
|
protected |
Definition at line 39 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), and MediaWiki\Auth\ButtonAuthenticationRequest\getFieldInfo().
|
protected |
Definition at line 36 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), and MediaWiki\Auth\ButtonAuthenticationRequest\getFieldInfo().
|
protected |
Definition at line 33 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), MediaWiki\Auth\ButtonAuthenticationRequest\getRequestByName(), and MediaWiki\Auth\ButtonAuthenticationRequest\getUniqueId().
The documentation for this class was generated from the following file:
- includes/auth/ButtonAuthenticationRequest.php
