MediaWiki  REL1_31
MediaWiki\Auth\ConfirmLinkAuthenticationRequest Class Reference
Inheritance diagram for MediaWiki\Auth\ConfirmLinkAuthenticationRequest:
Collaboration diagram for MediaWiki\Auth\ConfirmLinkAuthenticationRequest:

Public Member Functions

 __construct (array $linkRequests)
 
 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)
 Implementing this mainly for use from the unit tests. 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...
 

Public Attributes

string[] $confirmedLinkIDs = []
 List of unique IDs of the confirmed accounts. More...
 
- 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...
 

Protected Attributes

AuthenticationRequest[] $linkRequests
 

Detailed Description

Definition at line 24 of file ConfirmLinkAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\ConfirmLinkAuthenticationRequest::__construct ( array  $linkRequests)
Parameters
AuthenticationRequest[]$linkRequestsA list of autolink requests which need to be confirmed.

Definition at line 35 of file ConfirmLinkAuthenticationRequest.php.

References MediaWiki\Auth\ConfirmLinkAuthenticationRequest\$linkRequests.

Member Function Documentation

◆ __set_state()

static MediaWiki\Auth\ConfirmLinkAuthenticationRequest::__set_state (   $data)
static

Implementing this mainly for use from the unit tests.

Parameters
array$data
Returns
AuthenticationRequest

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 73 of file ConfirmLinkAuthenticationRequest.php.

References $ret, and as.

◆ getFieldInfo()

MediaWiki\Auth\ConfirmLinkAuthenticationRequest::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:

  • type: (string) Type of input. Types and equivalent HTML widgets are:
    • string: <input type="text">
    • password: <input type="password">
    • select: <select>
    • checkbox: <input type="checkbox">
    • multiselect: More a grid of checkboxes than <select multi>
    • button: <input type="submit"> (uses 'label' as button text)
    • hidden: Not visible to the user, but needs to be preserved for the next request
    • null: No widget, just display the 'label' message.
  • options: (array) Maps option values to Messages for the 'select' and 'multiselect' types.
  • value: (string) Value (for 'null' and 'hidden') or default value (for other types).
  • label: (Message) Text suitable for a label in an HTML form
  • help: (Message) Text suitable as a description of what the field is
  • optional: (bool) If set and truthy, the field may be left empty
  • sensitive: (bool) If set and truthy, the field is considered sensitive. Code using the request should avoid exposing the value of the field.
  • skippable: (bool) If set and truthy, the client is free to hide this field from the user to streamline the workflow. If all fields are skippable (except possibly a single button), no user interaction is required at all.

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).

Returns
array As above

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 42 of file ConfirmLinkAuthenticationRequest.php.

References $options, $req, as, text, and wfMessage().

◆ getUniqueId()

MediaWiki\Auth\ConfirmLinkAuthenticationRequest::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.

Returns
string

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 62 of file ConfirmLinkAuthenticationRequest.php.

References MediaWiki\Auth\ConfirmLinkAuthenticationRequest\$linkRequests, and $req.

Member Data Documentation

◆ $confirmedLinkIDs

string [] MediaWiki\Auth\ConfirmLinkAuthenticationRequest::$confirmedLinkIDs = []

List of unique IDs of the confirmed accounts.

Definition at line 29 of file ConfirmLinkAuthenticationRequest.php.

◆ $linkRequests

AuthenticationRequest [] MediaWiki\Auth\ConfirmLinkAuthenticationRequest::$linkRequests
protected

The documentation for this class was generated from the following file: