A field that will contain a date and/or time. More...

Inheritance diagram for HTMLDateTimeField:

Collaboration diagram for HTMLDateTimeField:

Public Member Functions
	__construct ($params)

	getAttributes (array $list)

	getInputOOUI ($value)

	loadDataFromRequest ($request)

	validate ($value, $alldata)

Public Member Functions inherited from HTMLTextField
	__construct ($params)

	getInputHTML ($value)

	getInputOOUI ($value)

	getSize ()

	getSpellCheck ()

	isPersistent ()

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

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

	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. More...

	filter ($value, $alldata)

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

	getDefault ()

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

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

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

	getHelpText ()
	Determine the help text to display. More...

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

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

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

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

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

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

	getLabel ()

	getLabelHtml ($cellAttributes=[])

	getNotices ()
	Determine notices to display for the field. More...

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

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

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

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

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

	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey. More...

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

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

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

	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. More...

	msg ()
	Get a translated interface message. More...

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

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

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

Protected Member Functions
	formatDate ($value)

	getOOUIModules ()

	parseDate ($value)

	shouldInfuseOOUI ()

Protected Member Functions inherited from HTMLTextField
	getDataAttribs ()
	Returns an array of data-* attributes to add to the field. More...

	getInputWidget ($params)

	getType (&$attribs)

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

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

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

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

	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. More...

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

	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. More...

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

	shouldInfuseOOUI ()
	Whether the field should be automatically infused. More...

Protected Attributes
static	$mType = 'datetime'

Protected Attributes inherited from HTMLTextField
	$mPlaceholder = ''

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. More...

	$mValidationCallback

	$mVFormClass = ''

Static Protected Attributes
static	$patterns

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>". More...

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

Public Attributes inherited from HTMLFormField
	$mParams

HTMLForm null	$mParent

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

Detailed Description

A field that will contain a date and/or time.

Currently recognizes only {YYYY}-{MM}-{DD}T{HH}:{MM}:{SS.S*}Z formatted dates.

Besides the parameters recognized by HTMLTextField, additional recognized parameters in the field descriptor array include: type - 'date', 'time', or 'datetime' min - The minimum date to allow, in any recognized format. max - The maximum date to allow, in any recognized format. placeholder - The default comes from the htmlform-(date|time|datetime)-placeholder message.

The result is a formatted date.

Note: This widget is not likely to work well in non-OOUI forms.

Definition at line 19 of file HTMLDateTimeField.php.

Constructor & Destructor Documentation

HTMLDateTimeField::__construct ( $params )

Definition at line 28 of file HTMLDateTimeField.php.

References $params.

Member Function Documentation

HTMLDateTimeField::formatDate ( $value )

protected

Definition at line 148 of file HTMLDateTimeField.php.

References $value.

Referenced by getAttributes(), getInputOOUI(), loadDataFromRequest(), and validate().

HTMLDateTimeField::getAttributes ( array $list )

Definition at line 42 of file HTMLDateTimeField.php.

References $mType, $ret, formatDate(), HTMLFormField\msg(), and parseDate().

HTMLDateTimeField::getInputOOUI ( $value )

Definition at line 161 of file HTMLDateTimeField.php.

References HTMLFormField\$mID, HTMLFormField\$mName, $mType, $params, $value, formatDate(), and parseDate().

HTMLDateTimeField::getOOUIModules ( )

protected

Definition at line 185 of file HTMLDateTimeField.php.

HTMLDateTimeField::loadDataFromRequest ( $request )

Definition at line 78 of file HTMLDateTimeField.php.

References $request, $value, formatDate(), HTMLFormField\getDefault(), and parseDate().

HTMLDateTimeField::parseDate ( $value )

protected

Definition at line 127 of file HTMLDateTimeField.php.

References $value.

Referenced by getAttributes(), getInputOOUI(), loadDataFromRequest(), and validate().

HTMLDateTimeField::shouldInfuseOOUI ( )

protected

Definition at line 189 of file HTMLDateTimeField.php.

HTMLDateTimeField::validate	(	$value,
		$alldata
	)

Definition at line 88 of file HTMLDateTimeField.php.

References $value, formatDate(), HTMLFormField\msg(), and parseDate().

Member Data Documentation

HTMLDateTimeField::$mType = 'datetime'

protected

Definition at line 26 of file HTMLDateTimeField.php.

Referenced by getAttributes(), and getInputOOUI().

HTMLDateTimeField::$patterns

staticprotected

Initial value:

= [

'date' => '[0-9]{4}-[01][0-9]-[0-3][0-9]'

Definition at line 20 of file HTMLDateTimeField.php.

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

includes/htmlform/fields/HTMLDateTimeField.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation