Inheritance diagram for HTMLReCaptchaField:

Collaboration diagram for HTMLReCaptchaField:

[legend]

Public Member Functions
	__construct (array $params)
	Parameters:

	getInputHTML ( $value)
	This function must be implemented to return the HTML to generate the input object itself.

	skipLoadData ( $request)
	Skip this field when collecting data.

Public Member Functions inherited from HTMLFormField
	__construct ( $params)
	Initialise the object.

	cancelSubmit ( $value, $alldata)
	Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

	canDisplayErrors ()
	True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

	filter ( $value, $alldata)

	getAttributes (array $list)
	Returns the given attributes from the parameters.

	getDefault ()

	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever.

	getErrorsAndErrorClass ( $value)
	Determine form errors to display and their classes.

	getErrorsRaw ( $value)
	Determine form errors to display, returning them in an array.

	getHelpText ()
	Determine the help text to display.

	getHelpTextHtmlDiv ( $helptext)
	Generate help text HTML in div format.

	getHelpTextHtmlRaw ( $helptext)
	Generate help text HTML formatted for raw output.

	getHelpTextHtmlTable ( $helptext)
	Generate help text HTML in table format.

	getInline ( $value)
	Get the complete field as an inline element.

	getInputOOUI ( $value)
	Same as getInputHTML, but returns an OOUI object.

	getLabel ()

	getLabelHtml ( $cellAttributes=[])

	getNotices ()
	Determine notices to display for the field.

	getOOUI ( $value)
	Get the OOUI version of the div.

	getOptions ()
	Fetch the array of options from the field's parameters.

	getOptionsOOUI ()
	Get options and make them into arrays suitable for OOUI.

	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever.

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.

	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

	getTooltipAndAccessKeyOOUI ()
	Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

	getVForm ( $value)
	Get the complete field for the input, including help text, labels, and whatever.

	hasVisibleOutput ()
	If this field has a user-visible output or not.

	isHidden ( $alldata)
	Test whether this field is supposed to be hidden, based on the values of the other form fields.

	loadDataFromRequest ( $request)
	Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

	msg ()
	Get a translated interface message.

	needsJSForHtml5FormValidation ()
	Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank.

	validate ( $value, $alldata)
	Override this function to add specific validation checks on the field input.

Protected Attributes
string	$error
	Error returned by ReCaptcha in the previous round.

string	$key
	Public key parameter to be passed to ReCaptcha.

bool	$secure
	Use secure connection to ReCaptcha.

string	$theme
	Theme parameter to be passed to ReCaptcha.

Protected Attributes inherited from HTMLFormField
	$mClass = ''

	$mDefault

	$mDir

	$mFilterCallback

	$mHelpClass = false

	$mHideIf = null

	$mID

	$mLabel

	$mName

	$mOptions = false

	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.

	$mValidationCallback

	$mVFormClass = ''

Additional Inherited Members
Static Public Member Functions inherited from HTMLFormField
static	flattenOptions ( $options)
	flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".

static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Public Attributes inherited from HTMLFormField
	$mParams

HTMLForm null	$mParent

Protected Member Functions inherited from HTMLFormField
	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.

	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.

	getNearestFieldByName ( $alldata, $name)
	Fetch a field value from $alldata for the closest field matching a given name.

	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOjs UI widget.

	isHiddenRecurse (array $alldata, array $params)
	Helper function for isHidden to handle recursive data structures.

	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

Static Protected Member Functions inherited from HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Detailed Description

Creates a ReCaptcha widget.

Does not return any data; handling the data submitted by the widget is callers' responsibility.

Definition at line 7 of file HTMLReCaptchaField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLReCaptchaField::__construct ( array $params )

Parameters:

key: (string, required) ReCaptcha public key
theme: (string, required) ReCaptcha theme
secure: (bool) Use secure connection to ReCaptcha
error: (string) ReCaptcha error from previous round
Parameters

array $params

Definition at line 28 of file HTMLReCaptchaField.php.

References $params, and key.

Member Function Documentation

◆ getInputHTML()

HTMLReCaptchaField::getInputHTML ( $value )

This function must be implemented to return the HTML to generate the input object itself.

It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters

string $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

Reimplemented from HTMLFormField.

Definition at line 41 of file HTMLReCaptchaField.php.

References $attribs, $theme, HTMLFormField\getAttributes(), key, and recaptcha_get_html().

◆ skipLoadData()

HTMLReCaptchaField::skipLoadData ( $request )

Skip this field when collecting data.

Parameters

WebRequest $request

Returns: bool

Since: 1.27

Reimplemented from HTMLFormField.

Definition at line 48 of file HTMLReCaptchaField.php.

Member Data Documentation

◆ $error

string HTMLReCaptchaField::$error

protected

Error returned by ReCaptcha in the previous round.

Definition at line 18 of file HTMLReCaptchaField.php.

◆ $key

string HTMLReCaptchaField::$key

protected

Public key parameter to be passed to ReCaptcha.

Definition at line 9 of file HTMLReCaptchaField.php.

◆ $secure

bool HTMLReCaptchaField::$secure

protected

Use secure connection to ReCaptcha.

Definition at line 15 of file HTMLReCaptchaField.php.

◆ $theme

string HTMLReCaptchaField::$theme

protected

Theme parameter to be passed to ReCaptcha.

Definition at line 12 of file HTMLReCaptchaField.php.

Referenced by getInputHTML().

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

extensions/ConfirmEdit/ReCaptcha/HTMLReCaptchaField.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInputHTML()

◆ skipLoadData()

Member Data Documentation

◆ $error

◆ $key

◆ $secure

◆ $theme