MediaWiki master
|
This is an authentication request that just implements a simple button. More...
Inherits MediaWiki\Auth\AuthenticationRequest.
Public Member Functions | |
__construct ( $name, Message $label, Message $help, $required=false) | |
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:
| |
getUniqueId () | |
Supply a unique key for deduplication.When the AuthenticationRequests instances returned by the providers are merged, the value returned here is used for keeping only one copy of duplicate requests.Subclasses should override this if multiple distinct instances would make sense, i.e. the request class has internal state of some sort.This value might be exposed to the user in web forms so it should not contain private information.
| |
Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | |
describeCredentials () | |
Describe the credentials represented by this request. | |
getMetadata () | |
Returns metadata about this request. | |
loadFromSubmission (array $data) | |
Initialize form submitted form data. | |
Static Public Member Functions | |
static | __set_state ( $data) |
static | getRequestByName (array $reqs, $name) |
Fetch a ButtonAuthenticationRequest or subclass by name. | |
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. | |
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. | |
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. | |
This is an authentication request that just implements a simple button.
Definition at line 33 of file ButtonAuthenticationRequest.php.
MediaWiki\Auth\ButtonAuthenticationRequest::__construct | ( | $name, | |
Message | $label, | ||
Message | $help, | ||
$required = false ) |
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 50 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$help, MediaWiki\Auth\ButtonAuthenticationRequest\$label, MediaWiki\Auth\ButtonAuthenticationRequest\$name, MediaWiki\Auth\AuthenticationRequest\$required, MediaWiki\Auth\AuthenticationRequest\OPTIONAL, and MediaWiki\Auth\AuthenticationRequest\REQUIRED.
|
static |
array | $data |
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Definition at line 100 of file ButtonAuthenticationRequest.php.
References MediaWiki\Message\Message\newFromKey().
MediaWiki\Auth\ButtonAuthenticationRequest::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 69 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$help, and MediaWiki\Auth\ButtonAuthenticationRequest\$label.
|
static |
Fetch a ButtonAuthenticationRequest or subclass by name.
AuthenticationRequest[] | $reqs | Requests to search |
string | $name | Name to look for |
Definition at line 86 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name.
Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().
MediaWiki\Auth\ButtonAuthenticationRequest::getUniqueId | ( | ) |
Supply a unique key for deduplication.When the AuthenticationRequests instances returned by the providers are merged, the value returned here is used for keeping only one copy of duplicate requests.Subclasses should override this if multiple distinct instances would make sense, i.e. the request class has internal state of some sort.This value might be exposed to the user in web forms so it should not contain private information.
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Definition at line 61 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name.
|
protected |
Definition at line 41 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), and MediaWiki\Auth\ButtonAuthenticationRequest\getFieldInfo().
|
protected |
Definition at line 38 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), and MediaWiki\Auth\ButtonAuthenticationRequest\getFieldInfo().
|
protected |
Definition at line 35 of file ButtonAuthenticationRequest.php.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), MediaWiki\Auth\ButtonAuthenticationRequest\getRequestByName(), and MediaWiki\Auth\ButtonAuthenticationRequest\getUniqueId().