Adds a generic button inline to the form. More...

Inherits MediaWiki\HTMLForm\HTMLFormField.

Inherited by MediaWiki\HTMLForm\Field\HTMLSubmitField.

Collaboration diagram for MediaWiki\HTMLForm\Field\HTMLButtonField:

[legend]

Public Member Functions

__construct ( $info)

getInputCodex ( $value, $hasErrors)

Same as getInputHTML, but for Codex.This is called by CodexHTMLForm.If not overridden, falls back to getInputHTML.

Parameters

string	$value	The value to set the input to
bool	$hasErrors	Whether there are validation errors. If set to true, this method should apply a CSS class for the error status (e.g. cdx-text-input–status-error) if the component used supports that.

Returns: string HTML

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.

getInputOOUI ( $value)

Get the OOUI widget for this field.

validate ( $value, $alldata)

Button cannot be invalid.

Public Member Functions inherited from MediaWiki\HTMLForm\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.

getCodex ( $value)

Get the Codex version of the div.

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, $cssClasses=[])

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.

Static Public Member Functions
static	buildCodexComponent ( $flags, $buttonLabel, $attribs)
	Build the markup of the Codex component.

Static Public Member Functions inherited from MediaWiki\HTMLForm\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.

Protected Member Functions
	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to? Stability: stable to override Returns bool True to output a label, false to suppress

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

	escapeLabel ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	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.

	makeLabelSnippet ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	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.

Protected Attributes
string null	$buttonLabel = null

string	$buttonType = 'button'

array	$mFlags = []
	Flags to add to OOUI Button widget.

bool	$mFormnovalidate = false

Protected Attributes inherited from MediaWiki\HTMLForm\HTMLFormField
string	$mClass = ''

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

array	$mCondStateClass = []

mixed	$mDefault

string	$mDir

string false	$mHelpClass = false

string	$mID

string	$mLabel
	String label, as HTML.

string	$mName

array null false	$mOptions = false

bool	$mOptionsLabelsNotFromMessage = false

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

string	$mVFormClass = ''

Additional Inherited Members
Public Attributes inherited from MediaWiki\HTMLForm\HTMLFormField
array array[]	$mParams

HTMLForm null	$mParent

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

Detailed Description

Adds a generic button inline to the form.

Does not do anything, you must add click handling code in JavaScript. Use a HTMLSubmitField if you merely wish to add a submit button to a form.

Additional recognized configuration parameters include:

flags: OOUI flags for the button, see OOUI\FlaggedElement
buttonlabel-message: Message to use for the button display text, instead of the value from 'default'. Overrides 'buttonlabel' and 'buttonlabel-raw'.
buttonlabel: Text to display for the button display text, instead of the value from 'default'. Overrides 'buttonlabel-raw'.
buttonlabel-raw: HTMLto display for the button display text, instead of the value from 'default'.
formnovalidate: Set to true if clicking this button should suppress client-side form validation. Used in HTMLFormFieldCloner for add/remove buttons.

Stability: stable: to extend

Since: 1.22

Definition at line 30 of file HTMLButtonField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\Field\HTMLButtonField::__construct ( $info )

Stability: stable: to call Initialise the object.

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 46 of file HTMLButtonField.php.

References MediaWiki\HTMLForm\HTMLFormField\getMessage(), and MediaWiki\HTMLForm\HTMLFormField\setShowEmptyLabel().

Member Function Documentation

◆ buildCodexComponent()

static MediaWiki\HTMLForm\Field\HTMLButtonField::buildCodexComponent	(	$flags,
		$buttonLabel,
		$attribs )

static

Build the markup of the Codex component.

Parameters

array	$flags	The button's flag classes.
string	$buttonLabel	The button's label (raw HTML)
array	$attribs	The button's list of attributes.

Returns: string Raw HTML.

Definition at line 154 of file HTMLButtonField.php.

References MediaWiki\HTMLForm\Field\HTMLButtonField\$buttonLabel.

Referenced by MediaWiki\HTMLForm\CodexHTMLForm\getButtons().

◆ getInputCodex()

MediaWiki\HTMLForm\Field\HTMLButtonField::getInputCodex	(		$value,
			$hasErrors )

Same as getInputHTML, but for Codex.This is called by CodexHTMLForm.If not overridden, falls back to getInputHTML.

Parameters

string	$value	The value to set the input to
bool	$hasErrors	Whether there are validation errors. If set to true, this method should apply a CSS class for the error status (e.g. cdx-text-input–status-error) if the component used supports that.

Returns: string HTML

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 125 of file HTMLButtonField.php.

References MediaWiki\HTMLForm\Field\HTMLButtonField\$buttonLabel, MediaWiki\HTMLForm\Field\HTMLButtonField\$buttonType, MediaWiki\HTMLForm\HTMLFormField\$mClass, MediaWiki\HTMLForm\Field\HTMLButtonField\$mFlags, MediaWiki\HTMLForm\Field\HTMLButtonField\$mFormnovalidate, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\$mName, MediaWiki\HTMLForm\HTMLFormField\getAttributes(), and MediaWiki\HTMLForm\HTMLFormField\getDefault().

◆ getInputHTML()

MediaWiki\HTMLForm\Field\HTMLButtonField::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 MediaWiki\HTMLForm\HTMLFormField.

Definition at line 77 of file HTMLButtonField.php.

References MediaWiki\HTMLForm\Field\HTMLButtonField\$buttonType, MediaWiki\HTMLForm\Field\HTMLButtonField\$mFormnovalidate, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\$mName, MediaWiki\HTMLForm\HTMLFormField\getAttributes(), and MediaWiki\HTMLForm\HTMLFormField\getDefault().

◆ getInputOOUI()

MediaWiki\HTMLForm\Field\HTMLButtonField::getInputOOUI ( $value )

Get the OOUI widget for this field.

Stability: stable: to override

Parameters

string $value

Returns: \OOUI\ButtonInputWidget

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 107 of file HTMLButtonField.php.

References MediaWiki\HTMLForm\Field\HTMLButtonField\$buttonType, MediaWiki\HTMLForm\HTMLFormField\$mClass, MediaWiki\HTMLForm\Field\HTMLButtonField\$mFlags, MediaWiki\HTMLForm\Field\HTMLButtonField\$mFormnovalidate, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\getAttributes(), and MediaWiki\HTMLForm\HTMLFormField\getDefault().

◆ needsLabel()

MediaWiki\HTMLForm\Field\HTMLButtonField::needsLabel ( )

protected

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

Stability: stable: to override

Returns: bool True to output a label, false to suppress

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 187 of file HTMLButtonField.php.

◆ validate()

MediaWiki\HTMLForm\Field\HTMLButtonField::validate	(		$value,
			$alldata )

Button cannot be invalid.

Stability: stable: to override

Parameters

string	$value
array	$alldata

Returns: bool|string|Message

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 200 of file HTMLButtonField.php.

Member Data Documentation

◆ $buttonLabel

string null MediaWiki\HTMLForm\Field\HTMLButtonField::$buttonLabel = null

protected

Definition at line 34 of file HTMLButtonField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\buildCodexComponent(), and MediaWiki\HTMLForm\Field\HTMLButtonField\getInputCodex().

◆ $buttonType

string MediaWiki\HTMLForm\Field\HTMLButtonField::$buttonType = 'button'

protected

Definition at line 32 of file HTMLButtonField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLButtonField\getInputHTML(), and MediaWiki\HTMLForm\Field\HTMLButtonField\getInputOOUI().

◆ $mFlags

array MediaWiki\HTMLForm\Field\HTMLButtonField::$mFlags = []

protected

Flags to add to OOUI Button widget.

Definition at line 37 of file HTMLButtonField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\getInputCodex(), and MediaWiki\HTMLForm\Field\HTMLButtonField\getInputOOUI().

◆ $mFormnovalidate

bool MediaWiki\HTMLForm\Field\HTMLButtonField::$mFormnovalidate = false

protected

Definition at line 40 of file HTMLButtonField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLButtonField\getInputHTML(), and MediaWiki\HTMLForm\Field\HTMLButtonField\getInputOOUI().

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

includes/HTMLForm/Field/HTMLButtonField.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildCodexComponent()

◆ getInputCodex()

◆ getInputHTML()

◆ getInputOOUI()

◆ needsLabel()

◆ validate()

Member Data Documentation

◆ $buttonLabel

◆ $buttonType

◆ $mFlags

◆ $mFormnovalidate