MediaWiki  1.27.2
MediaWiki\Auth\CreationReasonAuthenticationRequest Class Reference

Authentication request for the reason given for account creation. More...

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

Public Member Functions

 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

string $reason
 Account creation reason (only used when creating for someone else) 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 provdier. 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

Authentication request for the reason given for account creation.

Used in logs and for notification.

Definition at line 9 of file CreationReasonAuthenticationRequest.php.

Member Function Documentation

MediaWiki\Auth\CreationReasonAuthenticationRequest::getFieldInfo ( )

Definition at line 15 of file CreationReasonAuthenticationRequest.php.

References wfMessage().

Member Data Documentation

string MediaWiki\Auth\CreationReasonAuthenticationRequest::$reason

Account creation reason (only used when creating for someone else)

Definition at line 11 of file CreationReasonAuthenticationRequest.php.

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

Definition at line 13 of file CreationReasonAuthenticationRequest.php.


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