Expiry Field that allows the user to specify a precise date or a relative date string. More...

Inherits MediaWiki\HTMLForm\HTMLFormField.

Collaboration diagram for MediaWiki\HTMLForm\Field\HTMLExpiryField:

[legend]

Public Member Functions

__construct (array $params=[])

Relative Date Time Field.

getInputCodex ( $value, $hasErrors)

Same as getInputHTML, but for Codex.

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)

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

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.

Stability: stable: to override

Parameters

WebRequest $request

Returns: mixed The value

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

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.

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 Member Functions
	getFieldByType ( $type)
	Get the HTMLForm field by the type string.

	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. Stability: stable to override Returns string[]

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

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

	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.

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

Protected Attributes
HTMLFormField	$relativeField

Protected Attributes inherited from MediaWiki\HTMLForm\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 null false	$mOptions = false

	$mOptionsLabelsNotFromMessage = false

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

	$mVFormClass = ''

Additional Inherited Members
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.

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

Expiry Field that allows the user to specify a precise date or a relative date string.

Stability: stable: to extend

Definition at line 15 of file HTMLExpiryField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\Field\HTMLExpiryField::__construct ( array $params = [] )

Relative Date Time Field.

Stability: stable: to call

Parameters

array $params

Definition at line 28 of file HTMLExpiryField.php.

References $params, and MediaWiki\HTMLForm\Field\HTMLExpiryField\getFieldByType().

Member Function Documentation

◆ getFieldByType()

MediaWiki\HTMLForm\Field\HTMLExpiryField::getFieldByType ( $type )

protected

Get the HTMLForm field by the type string.

Parameters

string $type

Returns: \HTMLFormField

Definition at line 90 of file HTMLExpiryField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mParams, $params, and MediaWiki\HTMLForm\HTMLForm\$typeMappings.

Referenced by MediaWiki\HTMLForm\Field\HTMLExpiryField\__construct().

◆ getInputCodex()

MediaWiki\HTMLForm\Field\HTMLExpiryField::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 73 of file HTMLExpiryField.php.

◆ getInputHTML()

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

Use whatever the relative field is as the standard HTML input.

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 40 of file HTMLExpiryField.php.

◆ getInputOOUI()

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

Definition at line 63 of file HTMLExpiryField.php.

◆ getOOUIModules()

MediaWiki\HTMLForm\Field\HTMLExpiryField::getOOUIModules ( )

protected

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

Stability: stable: to override

Returns: string[]

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 51 of file HTMLExpiryField.php.

◆ loadDataFromRequest()

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

Stability: stable: to override

Parameters

WebRequest $request

Returns: mixed The value

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 80 of file HTMLExpiryField.php.

◆ shouldInfuseOOUI()

MediaWiki\HTMLForm\Field\HTMLExpiryField::shouldInfuseOOUI ( )

protected

Whether the field should be automatically infused.

Note that all OOUI HTMLForm fields are infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 44 of file HTMLExpiryField.php.

Member Data Documentation

◆ $relativeField

HTMLFormField MediaWiki\HTMLForm\Field\HTMLExpiryField::$relativeField

protected

Definition at line 20 of file HTMLExpiryField.php.

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

includes/htmlform/fields/HTMLExpiryField.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFieldByType()

◆ getInputCodex()

◆ getInputHTML()

◆ getInputOOUI()

◆ getOOUIModules()

◆ loadDataFromRequest()

◆ shouldInfuseOOUI()

Member Data Documentation

◆ $relativeField