MediaWiki  master
MediaWiki\Auth\PasswordDomainAuthenticationRequest Class Reference

This is a value object for authentication requests with a username, password, and domain. More...

Inheritance diagram for MediaWiki\Auth\PasswordDomainAuthenticationRequest:
Collaboration diagram for MediaWiki\Auth\PasswordDomainAuthenticationRequest:

Public Member Functions

 __construct (array $domainList)
 
 describeCredentials ()
 
 getFieldInfo ()
 
- Public Member Functions inherited from MediaWiki\Auth\PasswordAuthenticationRequest
 describeCredentials ()
 
 getFieldInfo ()
 
- 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 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...
 

Public Attributes

string $domain = null
 Domain. More...
 
- Public Attributes inherited from MediaWiki\Auth\PasswordAuthenticationRequest
string $password = null
 Password. More...
 
string $retype = null
 Password, again. 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...
 

Private Attributes

string [] $domainList
 Domains available. More...
 

Detailed Description

This is a value object for authentication requests with a username, password, and domain.

Since
1.27

Definition at line 29 of file PasswordDomainAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::__construct ( array  $domainList)
Parameters
string[]$domainList List of available domains

Definition at line 39 of file PasswordDomainAuthenticationRequest.php.

References MediaWiki\Auth\PasswordDomainAuthenticationRequest\$domainList.

Member Function Documentation

◆ __set_state()

static MediaWiki\Auth\PasswordDomainAuthenticationRequest::__set_state (   $data)
static
Parameters
array$data
Returns
AuthenticationRequest|static

Definition at line 76 of file PasswordDomainAuthenticationRequest.php.

References $ret, and as.

◆ describeCredentials()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::describeCredentials ( )

Definition at line 62 of file PasswordDomainAuthenticationRequest.php.

References wfMessage().

◆ getFieldInfo()

MediaWiki\Auth\PasswordDomainAuthenticationRequest::getFieldInfo ( )

Member Data Documentation

◆ $domain

string MediaWiki\Auth\PasswordDomainAuthenticationRequest::$domain = null

◆ $domainList

string [] MediaWiki\Auth\PasswordDomainAuthenticationRequest::$domainList
private

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