MediaWiki  master
MediaWiki\Auth\TemporaryPasswordAuthenticationRequest Class Reference

This represents the intention to set a temporary password for the user. More...

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

Public Member Functions

 __construct ( $password=null)
 
 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 newInvalid ()
 Return an instance with an invalid password. More...
 
static newRandom ()
 Return an instance with a new, random password. More...
 
- 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 $caller
 Username or IP address of the caller. More...
 
bool $mailpassword = false
 Email password to the user. More...
 
string null $password
 Temporary password. 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...
 

Detailed Description

This represents the intention to set a temporary password for the user.

Since
1.27

Definition at line 31 of file TemporaryPasswordAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::__construct (   $password = null)
Parameters
string | null$password

Definition at line 54 of file TemporaryPasswordAuthenticationRequest.php.

References MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\$password.

Member Function Documentation

◆ describeCredentials()

MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::describeCredentials ( )

Definition at line 94 of file TemporaryPasswordAuthenticationRequest.php.

References wfMessage().

◆ getFieldInfo()

MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::getFieldInfo ( )

Definition at line 41 of file TemporaryPasswordAuthenticationRequest.php.

References wfMessage().

◆ newInvalid()

static MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::newInvalid ( )
static

Return an instance with an invalid password.

Returns
TemporaryPasswordAuthenticationRequest

Definition at line 89 of file TemporaryPasswordAuthenticationRequest.php.

References $request, and null.

Referenced by MediaWiki\Auth\TemporaryPasswordAuthenticationRequestTest\testNewInvalid().

◆ newRandom()

Member Data Documentation

◆ $caller

string MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::$caller

Username or IP address of the caller.

Definition at line 39 of file TemporaryPasswordAuthenticationRequest.php.

◆ $mailpassword

bool MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::$mailpassword = false

Email password to the user.

Definition at line 36 of file TemporaryPasswordAuthenticationRequest.php.

◆ $password

string null MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::$password

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