MediaWiki master
|
This represents additional user data requested on the account creation form. More...
Inherits MediaWiki\Auth\AuthenticationRequest.
Public Member Functions | |
getFieldInfo () | |
Fetch input field info.This will be used in the AuthManager APIs and web UIs to define API input parameters / form fields and to process the submitted data.The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:
| |
populateUser ( $user) | |
Add data to the User object. | |
Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest | |
describeCredentials () | |
Describe the credentials represented by this request. | |
getMetadata () | |
Returns metadata about this request. | |
getUniqueId () | |
Supply a unique key for deduplication. | |
loadFromSubmission (array $data) | |
Initialize form submitted form data. | |
Public Attributes | |
string null | |
Email address. | |
string null | $realname |
Real name. | |
Public Attributes inherited from MediaWiki\Auth\AuthenticationRequest | |
string null | $action = null |
The AuthManager::ACTION_* constant this request was created to be used for. | |
int | $required = self::REQUIRED |
For login, continue, and link actions, one of self::OPTIONAL, self::REQUIRED, or self::PRIMARY_REQUIRED. | |
string null | $returnToUrl = null |
Return-to URL, in case of redirect. | |
string null | $username = null |
Username. | |
const | OPTIONAL = 0 |
Indicates that the request is not required for authentication to proceed. | |
const | PRIMARY_REQUIRED = 2 |
Indicates that the request is required by a primary authentication provider. | |
const | REQUIRED = 1 |
Indicates that the request is required for authentication to proceed. | |
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. | |
static | getRequestByClass (array $reqs, $class, $allowSubclasses=false) |
Select a request by class name. | |
static | getUsernameFromRequests (array $reqs) |
Get the username from the set of requests. | |
static | loadRequestsFromSubmission (array $reqs, array $data) |
Update a set of requests with form submit data, discarding ones that fail. | |
static | mergeFieldInfo (array $reqs) |
Merge the output of multiple AuthenticationRequest::getFieldInfo() calls. | |
This represents additional user data requested on the account creation form.
Definition at line 37 of file UserDataAuthenticationRequest.php.
MediaWiki\Auth\UserDataAuthenticationRequest::getFieldInfo | ( | ) |
Fetch input field info.This will be used in the AuthManager APIs and web UIs to define API input parameters / form fields and to process the submitted data.The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:
Reimplemented from MediaWiki\Auth\AuthenticationRequest.
Definition at line 48 of file UserDataAuthenticationRequest.php.
References MediaWiki\MainConfigNames\EnableEmail, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\HiddenPrefs, and wfMessage().
MediaWiki\Auth\UserDataAuthenticationRequest::populateUser | ( | $user | ) |
Add data to the User object.
User | $user | User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such. |
Definition at line 84 of file UserDataAuthenticationRequest.php.
string null MediaWiki\Auth\UserDataAuthenticationRequest::$email |
Email address.
Definition at line 39 of file UserDataAuthenticationRequest.php.
string null MediaWiki\Auth\UserDataAuthenticationRequest::$realname |
Real name.
Definition at line 42 of file UserDataAuthenticationRequest.php.