silverstripe-framework/src/Forms/DateField.php

581 lines
16 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\Forms;
use IntlDateFormatter;
use SilverStripe\i18n\i18n;
use InvalidArgumentException;
2017-04-03 02:00:59 +02:00
use SilverStripe\ORM\FieldType\DBDate;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\ValidationResult;
FEATURE New DatetimeField class (form field wrapper composed of DateField andTimeField) FEATURE New DateField and TimeField form classes with more consistent API and easier localization API CHANGE Date/time parsing in DateField, TimeField and DatetimeField defaults to i18n::get_locale() ('en_US') instead of using en_NZ/en_GB specific parsing. Use i18n::set_locale('en_NZ') in mysite/_config.php to revert to old behaviour. API CHANGE constructor parameter in TimeField needs to be in ISO date notation (not PHP's date()) API CHANGE TimeField, DateField and related subclasses use Zend_Date for date parsing, meaning they're stricer than the previously used strtotime() API CHANGE Removed DMYCalendarDateField and CalendarDateField, use DateField with setConfig('showcalendar') API CHANGE Removed CompositeDateField, DMYDateField, use DateField with setConfig('dmyfields') API CHANGE Removed DropdownTimeField, use TimeField with setConfig('showdropdown') API CHANGE Removed PopupDateTimeField, use DatetimeField API CHANGE Changed 'date', 'month' and 'year' HTML field names to lowercase in DMYDateField API CHANGE Removed support for ambiguous date formats in DateField, e.g. '06/03/03'. Use DateField->setConfig('dateformat', '<format>') to revert to this behaviour. API CHANGE Removed flag from DateField, CalendarDateField etc., use DateField->setConfig('min') and DateField->setConfig('max') ENHANCEMENT Using Zend_Date for DateField and TimeField, with more robust date handling, starting localization support. Set globally via i18n::set_locale(), or for a field instance through setLocale(). Note: Javascript validation is not localized yet. (from r99360) git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@102859 467b73ca-7a2a-4603-9d3b-597d59a354a9
2010-04-14 06:38:40 +02:00
/**
2018-10-20 18:15:42 +02:00
* Form used for editing a date string
2014-08-15 08:53:05 +02:00
*
* Caution: The form field does not include any JavaScript or CSS when used outside of the CMS context,
* since the required frontend dependencies are included through CMS bundling.
*
FEATURE New DatetimeField class (form field wrapper composed of DateField andTimeField) FEATURE New DateField and TimeField form classes with more consistent API and easier localization API CHANGE Date/time parsing in DateField, TimeField and DatetimeField defaults to i18n::get_locale() ('en_US') instead of using en_NZ/en_GB specific parsing. Use i18n::set_locale('en_NZ') in mysite/_config.php to revert to old behaviour. API CHANGE constructor parameter in TimeField needs to be in ISO date notation (not PHP's date()) API CHANGE TimeField, DateField and related subclasses use Zend_Date for date parsing, meaning they're stricer than the previously used strtotime() API CHANGE Removed DMYCalendarDateField and CalendarDateField, use DateField with setConfig('showcalendar') API CHANGE Removed CompositeDateField, DMYDateField, use DateField with setConfig('dmyfields') API CHANGE Removed DropdownTimeField, use TimeField with setConfig('showdropdown') API CHANGE Removed PopupDateTimeField, use DatetimeField API CHANGE Changed 'date', 'month' and 'year' HTML field names to lowercase in DMYDateField API CHANGE Removed support for ambiguous date formats in DateField, e.g. '06/03/03'. Use DateField->setConfig('dateformat', '<format>') to revert to this behaviour. API CHANGE Removed flag from DateField, CalendarDateField etc., use DateField->setConfig('min') and DateField->setConfig('max') ENHANCEMENT Using Zend_Date for DateField and TimeField, with more robust date handling, starting localization support. Set globally via i18n::set_locale(), or for a field instance through setLocale(). Note: Javascript validation is not localized yet. (from r99360) git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@102859 467b73ca-7a2a-4603-9d3b-597d59a354a9
2010-04-14 06:38:40 +02:00
* # Localization
2014-08-15 08:53:05 +02:00
*
* Date formatting can be controlled in the below order of priority:
* - Format set via setDateFormat()
* - Format generated from current locale set by setLocale() and setDateLength()
* - Format generated from current locale in i18n
*
* You can also specify a setClientLocale() to set the javascript to a specific locale
* on the frontend. However, this will not override the date format string.
2014-08-15 08:53:05 +02:00
*
* See http://doc.silverstripe.org/framework/en/topics/i18n for more information about localizing form fields.
2014-08-15 08:53:05 +02:00
*
FEATURE New DatetimeField class (form field wrapper composed of DateField andTimeField) FEATURE New DateField and TimeField form classes with more consistent API and easier localization API CHANGE Date/time parsing in DateField, TimeField and DatetimeField defaults to i18n::get_locale() ('en_US') instead of using en_NZ/en_GB specific parsing. Use i18n::set_locale('en_NZ') in mysite/_config.php to revert to old behaviour. API CHANGE constructor parameter in TimeField needs to be in ISO date notation (not PHP's date()) API CHANGE TimeField, DateField and related subclasses use Zend_Date for date parsing, meaning they're stricer than the previously used strtotime() API CHANGE Removed DMYCalendarDateField and CalendarDateField, use DateField with setConfig('showcalendar') API CHANGE Removed CompositeDateField, DMYDateField, use DateField with setConfig('dmyfields') API CHANGE Removed DropdownTimeField, use TimeField with setConfig('showdropdown') API CHANGE Removed PopupDateTimeField, use DatetimeField API CHANGE Changed 'date', 'month' and 'year' HTML field names to lowercase in DMYDateField API CHANGE Removed support for ambiguous date formats in DateField, e.g. '06/03/03'. Use DateField->setConfig('dateformat', '<format>') to revert to this behaviour. API CHANGE Removed flag from DateField, CalendarDateField etc., use DateField->setConfig('min') and DateField->setConfig('max') ENHANCEMENT Using Zend_Date for DateField and TimeField, with more robust date handling, starting localization support. Set globally via i18n::set_locale(), or for a field instance through setLocale(). Note: Javascript validation is not localized yet. (from r99360) git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@102859 467b73ca-7a2a-4603-9d3b-597d59a354a9
2010-04-14 06:38:40 +02:00
* # Usage
2014-08-15 08:53:05 +02:00
*
* ## Example: Field localised with german date format
2014-08-15 08:53:05 +02:00
*
* $f = new DateField('MyDate');
* $f->setLocale('de_DE');
2014-08-15 08:53:05 +02:00
*
* # Validation
2014-08-15 08:53:05 +02:00
*
* Caution: JavaScript validation is only supported for the 'en_NZ' locale at the moment,
* it will be disabled automatically for all other locales.
*
* # Formats
*
* All format strings should follow the CLDR standard as per
* https://unicode-org.github.io/icu/userguide/format_parse/datetime These will be converted
* automatically to jquery UI format.
*
* The value of this field in PHP will be ISO 8601 standard (e.g. 2004-02-12), and
* stores this as a timestamp internally.
*
* Note: Do NOT use php date format strings. Date format strings follow the date
* field symbol table as below.
*
* @see https://unicode-org.github.io/icu/userguide/format_parse/datetime
* @see http://api.jqueryui.com/datepicker/#utility-formatDate
*/
2016-11-29 00:31:16 +01:00
class DateField extends TextField
{
protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_DATE;
/**
* Override locale. If empty will default to current locale
*
* @var string
*/
protected $locale = null;
/**
* Override date format. If empty will default to that used by the current locale.
*
* @var null
2016-11-29 00:31:16 +01:00
*/
protected $dateFormat = null;
2016-11-29 00:31:16 +01:00
/**
* Length of this date (full, short, etc).
*
* @see http://php.net/manual/en/class.intldateformatter.php#intl.intldateformatter-constants
* @var int
2016-11-29 00:31:16 +01:00
*/
protected $dateLength = null;
protected $inputType = 'date';
/**
* Min date
*
* @var string ISO 8601 date for min date
*/
protected $minDate = null;
/**
* Max date
*
* @var string ISO 860 date for max date
*/
protected $maxDate = null;
2016-11-29 00:31:16 +01:00
/**
* Unparsed value, used exclusively for comparing with internal value
* to detect invalid values.
*
* @var mixed
2016-11-29 00:31:16 +01:00
*/
protected $rawValue = null;
2016-11-29 00:31:16 +01:00
/**
* Use HTML5-based input fields (and force ISO 8601 date formats).
*
* @var bool
*/
2017-04-03 02:00:59 +02:00
protected $html5 = true;
/**
* @return bool
*/
public function getHTML5()
2016-11-29 00:31:16 +01:00
{
return $this->html5;
}
2016-11-29 00:31:16 +01:00
/**
* @param boolean $bool
* @return $this
*/
public function setHTML5($bool)
{
$this->html5 = $bool;
return $this;
}
2016-11-29 00:31:16 +01:00
/**
* Get length of the date format to use. One of:
*
* - IntlDateFormatter::SHORT
* - IntlDateFormatter::MEDIUM
* - IntlDateFormatter::LONG
* - IntlDateFormatter::FULL
*
* @see http://php.net/manual/en/class.intldateformatter.php#intl.intldateformatter-constants
* @return int
*/
public function getDateLength()
{
if ($this->dateLength) {
return $this->dateLength;
2016-11-29 00:31:16 +01:00
}
return IntlDateFormatter::MEDIUM;
}
2016-11-29 00:31:16 +01:00
/**
2017-04-03 02:00:59 +02:00
* Get length of the date format to use.
* Only applicable with {@link setHTML5(false)}.
*
* @see http://php.net/manual/en/class.intldateformatter.php#intl.intldateformatter-constants
*
* @param int $length
* @return $this
*/
public function setDateLength($length)
{
$this->dateLength = $length;
return $this;
2016-11-29 00:31:16 +01:00
}
/**
* Get date format in CLDR standard format
*
* This can be set explicitly. If not, this will be generated from the current locale
* with the current date length.
*
* @see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#date-field-symbol-table
*/
public function getDateFormat()
2016-11-29 00:31:16 +01:00
{
// Browsers expect ISO 8601 dates, localisation is handled on the client
2017-04-03 02:00:59 +02:00
if ($this->getHTML5()) {
return DBDate::ISO_DATE;
2017-04-03 02:00:59 +02:00
}
if ($this->dateFormat) {
return $this->dateFormat;
2016-11-29 00:31:16 +01:00
}
// Get from locale
2017-04-27 01:53:43 +02:00
return $this->getFrontendFormatter()->getPattern();
2016-11-29 00:31:16 +01:00
}
/**
* Set date format in CLDR standard format.
2017-04-03 02:00:59 +02:00
* Only applicable with {@link setHTML5(false)}.
*
* @see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#date-field-symbol-table
* @param string $format
* @return $this
*/
public function setDateFormat($format)
2016-11-29 00:31:16 +01:00
{
$this->dateFormat = $format;
return $this;
2016-11-29 00:31:16 +01:00
}
/**
* Get date formatter with the standard locale / date format
*
* @throws \LogicException
* @return IntlDateFormatter
*/
2017-04-27 01:53:43 +02:00
protected function getFrontendFormatter()
2016-11-29 00:31:16 +01:00
{
2017-04-03 02:00:59 +02:00
if ($this->getHTML5() && $this->dateFormat && $this->dateFormat !== DBDate::ISO_DATE) {
throw new \LogicException(
'Please opt-out of HTML5 processing of ISO 8601 dates via setHTML5(false) if using setDateFormat()'
);
}
if ($this->getHTML5() && $this->dateLength) {
throw new \LogicException(
'Please opt-out of HTML5 processing of ISO 8601 dates via setHTML5(false) if using setDateLength()'
);
}
if ($this->getHTML5() && $this->locale && $this->locale !== DBDate::ISO_LOCALE) {
2017-04-03 02:00:59 +02:00
throw new \LogicException(
'Please opt-out of HTML5 processing of ISO 8601 dates via setHTML5(false) if using setLocale()'
);
}
$formatter = IntlDateFormatter::create(
$this->getLocale(),
$this->getDateLength(),
IntlDateFormatter::NONE
2016-11-29 00:31:16 +01:00
);
if ($this->getHTML5()) {
// Browsers expect ISO 8601 dates, localisation is handled on the client
2017-04-03 02:00:59 +02:00
$formatter->setPattern(DBDate::ISO_DATE);
} elseif ($this->dateFormat) {
// Don't invoke getDateFormat() directly to avoid infinite loop
$ok = $formatter->setPattern($this->dateFormat);
if (!$ok) {
throw new InvalidArgumentException("Invalid date format {$this->dateFormat}");
2016-11-29 00:31:16 +01:00
}
}
return $formatter;
}
/**
* Get a date formatter for the ISO 8601 format
*
* @return IntlDateFormatter
*/
2017-04-27 01:53:43 +02:00
protected function getInternalFormatter()
{
$formatter = IntlDateFormatter::create(
DBDate::ISO_LOCALE,
IntlDateFormatter::MEDIUM,
IntlDateFormatter::NONE
);
$formatter->setLenient(false);
// CLDR ISO 8601 date.
2017-04-03 02:00:59 +02:00
$formatter->setPattern(DBDate::ISO_DATE);
return $formatter;
}
public function getAttributes()
{
$attributes = parent::getAttributes();
$attributes['lang'] = i18n::convert_rfc1766($this->getLocale());
if ($this->getHTML5()) {
$attributes['min'] = $this->getMinDate();
$attributes['max'] = $this->getMaxDate();
} else {
$attributes['type'] = 'text';
}
return $attributes;
}
public function getSchemaDataDefaults()
{
$defaults = parent::getSchemaDataDefaults();
2017-04-12 12:39:23 +02:00
return array_merge($defaults, [
'lang' => i18n::convert_rfc1766($this->getLocale()),
2017-04-27 01:47:04 +02:00
'data' => array_merge($defaults['data'], [
'html5' => $this->getHTML5(),
'min' => $this->getMinDate(),
'max' => $this->getMaxDate()
])
2017-04-12 12:39:23 +02:00
]);
}
2016-11-29 00:31:16 +01:00
public function Type()
{
return 'date text';
}
/**
* Assign value posted from form submission
2016-11-29 00:31:16 +01:00
*
* @param mixed $value
* @param mixed $data
2016-11-29 00:31:16 +01:00
* @return $this
*/
public function setSubmittedValue($value, $data = null)
2016-11-29 00:31:16 +01:00
{
// Save raw value for later validation
$this->rawValue = $value;
2016-11-29 00:31:16 +01:00
// Null case
if (!$value) {
2016-11-29 00:31:16 +01:00
$this->value = null;
return $this;
}
// Parse from submitted value
2017-04-27 01:53:43 +02:00
$this->value = $this->frontendToInternal($value);
2016-11-29 00:31:16 +01:00
return $this;
}
2017-04-27 01:53:43 +02:00
/**
* Assign value based on {@link $datetimeFormat}, which might be localised.
*
* When $html5=true, assign value from ISO 8601 string.
*
* @param mixed $value
* @param mixed $data
* @return $this
*/
public function setValue($value, $data = null)
2016-11-29 00:31:16 +01:00
{
// Save raw value for later validation
$this->rawValue = $value;
// Null case
if (!$value) {
$this->value = null;
return $this;
2016-11-29 00:31:16 +01:00
}
// Re-run through formatter to tidy up (e.g. remove time component)
2017-04-27 01:53:43 +02:00
$this->value = $this->tidyInternal($value);
return $this;
2016-11-29 00:31:16 +01:00
}
public function Value()
2016-11-29 00:31:16 +01:00
{
2017-04-27 01:53:43 +02:00
return $this->internalToFrontend($this->value);
2016-11-29 00:31:16 +01:00
}
public function performReadonlyTransformation()
2016-11-29 00:31:16 +01:00
{
$field = $this
->castedCopy(DateField_Disabled::class)
->setValue($this->dataValue())
->setLocale($this->getLocale())
->setReadonly(true);
return $field;
2016-11-29 00:31:16 +01:00
}
/**
* @param Validator $validator
* @return bool
*/
public function validate($validator)
{
// Don't validate empty fields
if (empty($this->rawValue)) {
2016-11-29 00:31:16 +01:00
return true;
}
// We submitted a value, but it couldn't be parsed
if (empty($this->value)) {
2016-11-29 00:31:16 +01:00
$validator->validationError(
$this->name,
_t(
2017-04-20 03:15:24 +02:00
'SilverStripe\\Forms\\DateField.VALIDDATEFORMAT2',
2016-11-29 00:31:16 +01:00
"Please enter a valid date format ({format})",
['format' => $this->getDateFormat()]
)
2016-11-29 00:31:16 +01:00
);
return false;
}
// Check min date
$min = $this->getMinDate();
if ($min) {
2022-04-14 03:12:59 +02:00
$oops = strtotime($this->value ?? '') < strtotime($min ?? '');
if ($oops) {
2016-11-29 00:31:16 +01:00
$validator->validationError(
$this->name,
_t(
2017-04-20 03:15:24 +02:00
'SilverStripe\\Forms\\DateField.VALIDDATEMINDATE',
2016-11-29 00:31:16 +01:00
"Your date has to be newer or matching the minimum allowed date ({date})",
[
'date' => sprintf(
'<time datetime="%s">%s</time>',
$min,
$this->internalToFrontend($min)
)
]
),
ValidationResult::TYPE_ERROR,
ValidationResult::CAST_HTML
2016-11-29 00:31:16 +01:00
);
return false;
}
}
// Check max date
$max = $this->getMaxDate();
if ($max) {
2022-04-14 03:12:59 +02:00
$oops = strtotime($this->value ?? '') > strtotime($max ?? '');
if ($oops) {
2016-11-29 00:31:16 +01:00
$validator->validationError(
$this->name,
_t(
2017-04-20 03:15:24 +02:00
'SilverStripe\\Forms\\DateField.VALIDDATEMAXDATE',
2016-11-29 00:31:16 +01:00
"Your date has to be older or matching the maximum allowed date ({date})",
[
'date' => sprintf(
'<time datetime="%s">%s</time>',
$max,
$this->internalToFrontend($max)
)
]
),
ValidationResult::TYPE_ERROR,
ValidationResult::CAST_HTML
2016-11-29 00:31:16 +01:00
);
return false;
}
}
return true;
}
/**
* Get locale to use for this field
*
2016-11-29 00:31:16 +01:00
* @return string
*/
public function getLocale()
{
// Use iso locale for html5
if ($this->getHTML5()) {
return DBDate::ISO_LOCALE;
}
return $this->locale ?: i18n::get_locale();
2016-11-29 00:31:16 +01:00
}
/**
2017-04-03 02:00:59 +02:00
* Determines the presented/processed format based on locale defaults,
* instead of explicitly setting {@link setDateFormat()}.
* Only applicable with {@link setHTML5(false)}.
2016-11-29 00:31:16 +01:00
*
* @param string $locale
* @return $this
*/
public function setLocale($locale)
{
$this->locale = $locale;
return $this;
}
public function getSchemaValidation()
{
$rules = parent::getSchemaValidation();
$rules['date'] = true;
return $rules;
}
/**
* @return string
*/
public function getMinDate()
{
return $this->minDate;
}
/**
* @param string $minDate
* @return $this
*/
public function setMinDate($minDate)
{
2017-04-27 01:53:43 +02:00
$this->minDate = $this->tidyInternal($minDate);
return $this;
}
/**
* @return string
*/
public function getMaxDate()
{
return $this->maxDate;
}
/**
* @param string $maxDate
* @return $this
*/
public function setMaxDate($maxDate)
{
2017-04-27 01:53:43 +02:00
$this->maxDate = $this->tidyInternal($maxDate);
return $this;
}
/**
2017-04-27 01:53:43 +02:00
* Convert frontend date to the internal representation (ISO 8601).
* The frontend date is also in ISO 8601 when $html5=true.
*
* @param string $date
* @return string The formatted date, or null if not a valid date
*/
2017-04-27 01:53:43 +02:00
protected function frontendToInternal($date)
{
if (!$date) {
return null;
}
2017-04-27 01:53:43 +02:00
$fromFormatter = $this->getFrontendFormatter();
$toFormatter = $this->getInternalFormatter();
$timestamp = $fromFormatter->parse($date);
if ($timestamp === false) {
return null;
}
return $toFormatter->format($timestamp) ?: null;
}
/**
2017-04-27 01:53:43 +02:00
* Convert the internal date representation (ISO 8601) to a format used by the frontend,
* as defined by {@link $dateFormat}. With $html5=true, the frontend date will also be
* in ISO 8601.
*
* @param string $date
* @return string The formatted date, or null if not a valid date
*/
2017-04-27 01:53:43 +02:00
protected function internalToFrontend($date)
{
2017-04-27 01:53:43 +02:00
$date = $this->tidyInternal($date);
if (!$date) {
return null;
}
2017-04-27 01:53:43 +02:00
$fromFormatter = $this->getInternalFormatter();
$toFormatter = $this->getFrontendFormatter();
$timestamp = $fromFormatter->parse($date);
if ($timestamp === false) {
return null;
}
return $toFormatter->format($timestamp) ?: null;
}
/**
2017-04-27 01:53:43 +02:00
* Tidy up the internal date representation (ISO 8601),
* and fall back to strtotime() if there's parsing errors.
*
2017-04-27 01:53:43 +02:00
* @param string $date Date in ISO 8601 or approximate form
* @return string ISO 8601 date, or null if not valid
*/
2017-04-27 01:53:43 +02:00
protected function tidyInternal($date)
{
if (!$date) {
return null;
}
// Re-run through formatter to tidy up (e.g. remove time component)
2017-04-27 01:53:43 +02:00
$formatter = $this->getInternalFormatter();
$timestamp = $formatter->parse($date);
if ($timestamp === false) {
// Fallback to strtotime
2022-04-14 03:12:59 +02:00
$timestamp = strtotime($date ?? '', DBDatetime::now()->getTimestamp());
if ($timestamp === false) {
return null;
}
}
return $formatter->format($timestamp);
}
}