MediaWiki
1.33.0
|
This is an authentication request that just implements a simple button. More...
Public Member Functions | |
__construct ( $name, Message $label, Message $help, $required=false) | |
getFieldInfo () | |
Fetch input field info. More... | |
getUniqueId () | |
Supply a unique key for deduplication. More... | |
Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | |
describeCredentials () | |
Describe the credentials represented by this request. More... | |
getMetadata () | |
Returns metadata about this request. 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 | 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 provider. More... | |
const | REQUIRED = 1 |
Indicates that the request is required for authentication to proceed. More... | |
This is an authentication request that just implements a simple button.
Definition at line 31 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 47 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$help, MediaWiki\Auth\ButtonAuthenticationRequest\$label, MediaWiki\Auth\ButtonAuthenticationRequest\$name, MediaWiki\Auth\AuthenticationRequest\$required, captcha-old\help, name, MediaWiki\Auth\AuthenticationRequest\OPTIONAL, and MediaWiki\Auth\AuthenticationRequest\REQUIRED.
|
static |
array | $data |
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Definition at line 87 of file ButtonAuthenticationRequest.php.
References $data, $ret, and as.
Referenced by MediaWiki\Auth\ButtonAuthenticationRequestTest\getInstance().
MediaWiki\Auth\ButtonAuthenticationRequest::getFieldInfo | ( | ) |
Fetch input field info.
The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:
All AuthenticationRequests are populated from the same data, so most of the time you'll want to prefix fields names with something unique to the extension/provider (although in some cases sharing the field with other requests is the right thing to do, e.g. for a 'password' field).
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
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.
AuthenticationRequest[] | $reqs | Requests to search |
string | $name | Name to look for |
Definition at line 75 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name, $req, $requests, captcha-old\count, and use.
Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt(), MediaWiki\Auth\ButtonAuthenticationRequestTest\testGetRequestByName(), 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 54 of file ButtonAuthenticationRequest.php.
References MediaWiki\Auth\ButtonAuthenticationRequest\$name.
|
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().