MediaWiki  master
MediaWiki\Auth\UserDataAuthenticationRequest Class Reference

This represents additional user data requested on the account creation form. More...

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

Public Member Functions

 getFieldInfo ()
 
 populateUser ( $user)
 Add data to the User object. More...
 
- 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 null $email
 Email address. More...
 
string null $realname
 Real name. 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...
 

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

This represents additional user data requested on the account creation form.

Since
1.27

Definition at line 34 of file UserDataAuthenticationRequest.php.

Member Function Documentation

◆ getFieldInfo()

MediaWiki\Auth\UserDataAuthenticationRequest::getFieldInfo ( )

◆ populateUser()

MediaWiki\Auth\UserDataAuthenticationRequest::populateUser (   $user)

Add data to the User object.

Parameters
User$userUser being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
Returns
StatusValue

Definition at line 76 of file UserDataAuthenticationRequest.php.

References $user, StatusValue\newFatal(), StatusValue\newGood(), null, and Sanitizer\validateEmail().

Member Data Documentation

◆ $email

string null MediaWiki\Auth\UserDataAuthenticationRequest::$email

Email address.

Definition at line 36 of file UserDataAuthenticationRequest.php.

◆ $realname

string null MediaWiki\Auth\UserDataAuthenticationRequest::$realname

Real name.

Definition at line 39 of file UserDataAuthenticationRequest.php.


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