MediaWiki  master
MediaWiki\Auth\CreatedAccountAuthenticationRequest Class Reference

Returned from account creation to allow for logging into the created account. More...

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

Public Member Functions

 __construct ( $id, $name)
 
 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...
 

Public Attributes

int $id
 User id. More...
 
 $required = self::OPTIONAL
 
- 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...
 

Additional Inherited Members

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

Detailed Description

Returned from account creation to allow for logging into the created account.

Since
1.27

Definition at line 29 of file CreatedAccountAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\CreatedAccountAuthenticationRequest::__construct (   $id,
  $name 
)
Parameters
int$idUser id
string$nameUsername

Definition at line 44 of file CreatedAccountAuthenticationRequest.php.

References $name.

Member Function Documentation

◆ getFieldInfo()

MediaWiki\Auth\CreatedAccountAuthenticationRequest::getFieldInfo ( )

Definition at line 36 of file CreatedAccountAuthenticationRequest.php.

Member Data Documentation

◆ $id

int MediaWiki\Auth\CreatedAccountAuthenticationRequest::$id

User id.

Definition at line 34 of file CreatedAccountAuthenticationRequest.php.

◆ $required

MediaWiki\Auth\CreatedAccountAuthenticationRequest::$required = self::OPTIONAL

Definition at line 31 of file CreatedAccountAuthenticationRequest.php.


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