Class DatePickerField

Form field to display an editable date string, either in a single <input type="text"> field, or in three separate fields for day, month and year.

# Configuration

'showcalendar' (boolean): Determines if a calendar picker is shown. By default, "DHTML Calendar" is used,see http://www.dynarch.com/projects/calendar. CAUTION: Only works in NZ date format, see calendar-setup.js
CAUTION: Might not be useable in combination with 'showcalendar', depending on the used javascript library
'dateformat' (string): Date format compatible with Zend_Date. Usually set to default format for DateField::$locale through Zend_Locale_Format::getDateFormat().
'datavalueformat' (string): Internal ISO format string used by DatePickerField::dataValue() to save the date to a database.
'min' (string): Minimum allowed date value (in ISO format, or strtotime() compatible). Example: '2010-03-31', or '-7 days'
'max' (string): Maximum allowed date value (in ISO format, or strtotime() compatible). Example: '2010-03-31', or '1 year'

# Localization

The field will get its default locale from i18n::get_locale(), and set the dateformat configuration accordingly. Changing the locale through DateField::setLocale() will not update the dateformat configuration automatically.

# Usage

Example: German dates with separate fields for day, month, year

$f = new DateField('MyDate'); $f->setLocale('de_DE');

# Validation

Caution: JavaScript validation is only supported for the 'en_NZ' locale at the moment, it will be disabled automatically for all other locales.

Object

ViewableData implements IteratorAggregate

RequestHandler

FormField

TextField

DateField

DatePickerField

Package: forms\fields-datetime
Located at dataobject_manager/code/date_picker_field/DatePickerField.php

Methods summary

`public static`	# `HTMLField( mixed $id, mixed $name, mixed $val )`
`public static`	# `set_date_format( mixed $format )`
`public static`	# `dmy( )`
`public static`	# `mdy( )`
`public`	# `setValue( String\|Array $val )` Sets the internal value to ISO date format. Sets the internal value to ISO date format. Parameters `$val` String\|Array $val Overrides `DateField::setValue`
`public String`	# `dataValue( )` Returns `String` ISO 8601 date, suitable for insertion into database Overrides `DateField::dataValue`
`public`	# `Field( )` Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag. Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag. Our base FormField class just returns a span containing the value. This should be overridden! Overrides `DateField::Field`