Enables HTMLFormField elements to be build with a button. More...

Inheritance diagram for HTMLFormFieldWithButton:

Collaboration diagram for HTMLFormFieldWithButton:

[legend]

Public Member Functions
	__construct ( $info)

	getElement ( $element)
	Combines the passed element with a button.

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

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

Public Member Functions inherited from HTMLFormField
	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.

	getLabel ()

	getLabelHtml ( $cellAttributes=[])

	getName ()
	Get the field name that will be used for submission.

	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.

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

	isHelpInline ()
	Determine if the help text should be displayed inline.

	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 ( $key,... $params)
	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.

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

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

Protected Attributes
string	$mButtonClass = ''
	CSS class for the button in this field.

string[]	$mButtonFlags = [ 'progressive' ]
	Value for the button in this field.

string int	$mButtonId = ''
	Element ID for the button in this field.

string	$mButtonName = ''
	Name the button in this field.

string	$mButtonType = 'submit'
	Type of the button in this field (e.g.

string	$mButtonValue
	Value for the button in this field.

Protected Attributes inherited from HTMLFormField
	$mClass = ''

array	$mCondState = []
	Array to hold params for 'hide-if' or 'disable-if' statements.

	$mCondStateClass = []

	$mDefault

	$mDir

	$mFilterCallback

	$mHelpClass = false

	$mID

	$mLabel

	$mName

array bool null	$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
array array[]	$mParams

HTMLForm null	$mParent

Protected Member Functions inherited from HTMLFormField
	checkStateRecurse (array $alldata, array $params)
	Helper function for isHidden and isDisabled to handle recursive data structures.

	getClassName ()
	Gets the non namespaced class name.

	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.

	getNearestField ( $name, $backCompat=false)
	Get the closest field matching a given name.

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

	getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
	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 OOUI widget.

	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?

	parseCondState ( $params)
	Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.

	parseCondStateForClient ()
	Parse the cond-state array for client-side.

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

	validateCondState ( $params)
	Validate the cond-state params, the existence check of fields should be done later.

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

Detailed Description

Enables HTMLFormField elements to be build with a button.

TODO This class should be a trait

Stability: stable: to extend

Definition at line 9 of file HTMLFormFieldWithButton.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLFormFieldWithButton::__construct ( $info )

Stability: stable: to call Initialise the object.

Reimplemented from HTMLFormField.

Definition at line 32 of file HTMLFormFieldWithButton.php.

Member Function Documentation

◆ getElement()

HTMLFormFieldWithButton::getElement ( $element )

Combines the passed element with a button.

Parameters

string $element Element to combine the button with.

Returns: string

Definition at line 81 of file HTMLFormFieldWithButton.php.

References getInputHTML().

◆ getInputHTML()

HTMLFormFieldWithButton::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

mixed $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 54 of file HTMLFormFieldWithButton.php.

References $mButtonClass, $mButtonId, and HTMLFormField\getAttributes().

Referenced by getElement().

◆ getInputOOUI()

HTMLFormFieldWithButton::getInputOOUI ( $value )

Same as getInputHTML, but returns an OOUI object.

Defaults to false, which getOOUI will interpret as "use the HTML version"

Stability: stable: to override

Parameters

string $value

Returns: OOUI\Widget|string|false

Reimplemented from HTMLFormField.

Definition at line 63 of file HTMLFormFieldWithButton.php.

References HTMLFormField\getAttributes().

Member Data Documentation

◆ $mButtonClass

string HTMLFormFieldWithButton::$mButtonClass = ''

protected

CSS class for the button in this field.

Definition at line 11 of file HTMLFormFieldWithButton.php.

Referenced by getInputHTML().

◆ $mButtonFlags

string [] HTMLFormFieldWithButton::$mButtonFlags = [ 'progressive' ]

protected

Value for the button in this field.

Definition at line 26 of file HTMLFormFieldWithButton.php.

◆ $mButtonId

string int HTMLFormFieldWithButton::$mButtonId = ''

protected

Element ID for the button in this field.

Definition at line 14 of file HTMLFormFieldWithButton.php.

Referenced by getInputHTML().

◆ $mButtonName

string HTMLFormFieldWithButton::$mButtonName = ''

protected

Name the button in this field.

Definition at line 17 of file HTMLFormFieldWithButton.php.

◆ $mButtonType

string HTMLFormFieldWithButton::$mButtonType = 'submit'

protected

Type of the button in this field (e.g.

button or submit)

Definition at line 20 of file HTMLFormFieldWithButton.php.

◆ $mButtonValue

string HTMLFormFieldWithButton::$mButtonValue

protected

Value for the button in this field.

Definition at line 23 of file HTMLFormFieldWithButton.php.

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

includes/htmlform/fields/HTMLFormFieldWithButton.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getElement()

◆ getInputHTML()

◆ getInputOOUI()

Member Data Documentation

◆ $mButtonClass

◆ $mButtonFlags

◆ $mButtonId

◆ $mButtonName

◆ $mButtonType

◆ $mButtonValue