MediaWiki REL1_32
ReCaptchaAuthenticationRequest Class Reference

Authentication request for ReCaptcha v1. More...

Inheritance diagram for ReCaptchaAuthenticationRequest:
Collaboration diagram for ReCaptchaAuthenticationRequest:

Public Member Functions

 __construct ()
 
 getFieldInfo ()
 @inheritDoc @suppress SecurityCheck-DoubleEscaped T202112
 
 loadFromSubmission (array $data)
 Initialize form submitted form data.
 
- Public Member Functions inherited from CaptchaAuthenticationRequest
 __construct ( $id, $data)
 
 getMetadata ()
 Returns metadata about this request.
 
- Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest
 describeCredentials ()
 Describe the credentials represented by this request.
 
 getUniqueId ()
 Supply a unique key for deduplication.
 

Additional Inherited Members

- Static Public Member Functions inherited from CaptchaAuthenticationRequest
static __set_state ( $data)
 Implementing this mainly for use from the unit tests.
 
- Static Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest
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.
 
- Public Attributes inherited from CaptchaAuthenticationRequest
array $captchaData
 Information about the captcha (e.g.
 
string $captchaId
 Identifier of the captcha.
 
string $captchaWord
 Captcha solution submitted by the user.
 
- 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.
 

Detailed Description

Authentication request for ReCaptcha v1.

Unlike the parent class, no session storage is used; that's handled by Google.

Definition at line 9 of file ReCaptchaAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ReCaptchaAuthenticationRequest::__construct ( )

Definition at line 10 of file ReCaptchaAuthenticationRequest.php.

Member Function Documentation

◆ getFieldInfo()

ReCaptchaAuthenticationRequest::getFieldInfo ( )

@inheritDoc @suppress SecurityCheck-DoubleEscaped T202112

Reimplemented from CaptchaAuthenticationRequest.

Definition at line 19 of file ReCaptchaAuthenticationRequest.php.

References wfMessage().

◆ loadFromSubmission()

ReCaptchaAuthenticationRequest::loadFromSubmission ( array $data)

Initialize form submitted form data.

The default behavior is to to check for each key of self::getFieldInfo() in the submitted data, and copy the value - after type-appropriate transformations - to $this->$key. Most subclasses won't need to override this; if you do override it, make sure to always return false if self::getFieldInfo() returns an empty array.

Parameters
array$dataSubmitted data as an associative array (keys will correspond to getFieldInfo())
Returns
bool Whether the request data was successfully loaded

Reimplemented from CaptchaAuthenticationRequest.

Definition at line 14 of file ReCaptchaAuthenticationRequest.php.


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