Generic captcha authentication request class. More...

Inheritance diagram for CaptchaAuthenticationRequest:

[legend]

Collaboration diagram for CaptchaAuthenticationRequest:

[legend]

Public Member Functions
	__construct ( $id, $data)

	getFieldInfo ()
	@inheritDoc @suppress SecurityCheck-DoubleEscaped T202112

	getMetadata ()
	Returns metadata about this request.

	loadFromSubmission (array $data)
	Initialize form submitted form data.

Public Member Functions inherited from MediaWiki\Auth\AuthenticationRequest
	describeCredentials ()
	Describe the credentials represented by this request.

	getUniqueId ()
	Supply a unique key for deduplication.

Static Public Member Functions
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
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

Generic captcha authentication request class.

A captcha consist some data stored in the session (e.g. a question and its answer), an ID that references the data, and a solution.

Definition at line 10 of file CaptchaAuthenticationRequest.php.

Constructor & Destructor Documentation

◆ __construct()

CaptchaAuthenticationRequest::__construct	(		$id,
			$data )

Definition at line 21 of file CaptchaAuthenticationRequest.php.

References $data.

Member Function Documentation

◆ __set_state()

static CaptchaAuthenticationRequest::__set_state ( $data )

static

Implementing this mainly for use from the unit tests.

Parameters

array $data

Returns: AuthenticationRequest

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 85 of file CaptchaAuthenticationRequest.php.

References $data, $ret, and(), and null.

◆ getFieldInfo()

CaptchaAuthenticationRequest::getFieldInfo ( )

@inheritDoc @suppress SecurityCheck-DoubleEscaped T202112

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Reimplemented in ReCaptchaAuthenticationRequest, and ReCaptchaNoCaptchaAuthenticationRequest.

Definition at line 43 of file CaptchaAuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\$action, $captchaId, ConfirmEditHooks\getInstance(), and wfMessage().

◆ getMetadata()

CaptchaAuthenticationRequest::getMetadata ( )

Returns metadata about this request.

This is mainly for the benefit of API clients which need more detailed render hints than what's available through getFieldInfo(). Semantics are unspecified and left to the individual subclasses, but the contents of the array should be primitive types so that they can be transformed into JSON or similar formats.

Returns: array A (possibly nested) array with primitive types

Reimplemented from MediaWiki\Auth\AuthenticationRequest.

Definition at line 80 of file CaptchaAuthenticationRequest.php.

References ConfirmEditHooks\getInstance().

◆ loadFromSubmission()

CaptchaAuthenticationRequest::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 $data Submitted data as an associative array (keys will correspond to getFieldInfo())