512 lines
14 KiB
PHP
512 lines
14 KiB
PHP
<?php
|
|
|
|
namespace SilverStripe\Forms;
|
|
|
|
use IntlDateFormatter;
|
|
use InvalidArgumentException;
|
|
use SilverStripe\i18n\i18n;
|
|
use SilverStripe\ORM\FieldType\DBDatetime;
|
|
use SilverStripe\ORM\FieldType\DBTime;
|
|
|
|
/**
|
|
* Form field to display editable time values in an <input type="text"> field.
|
|
*
|
|
* # Localization
|
|
*
|
|
* See {@link DateField}
|
|
*
|
|
* @todo Timezone support
|
|
*/
|
|
class TimeField extends TextField
|
|
{
|
|
protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TIME;
|
|
|
|
/**
|
|
* Override locale. If empty will default to current locale
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $locale = null;
|
|
|
|
protected $inputType = 'time';
|
|
|
|
/**
|
|
* Override time format. If empty will default to that used by the current locale.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $timeFormat = null;
|
|
|
|
/**
|
|
* Length of this date (full, short, etc).
|
|
*
|
|
* @see http://php.net/manual/en/class.intldateformatter.php#intl.intldateformatter-constants
|
|
* @var int
|
|
*/
|
|
protected $timeLength = null;
|
|
|
|
/**
|
|
* Unparsed value, used exclusively for comparing with internal value
|
|
* to detect invalid values.
|
|
*
|
|
* @var mixed
|
|
*/
|
|
protected $rawValue = null;
|
|
|
|
/**
|
|
* Set custom timezone
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $timezone = null;
|
|
|
|
/**
|
|
* Use HTML5-based input fields (and force ISO 8601 time formats).
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $html5 = true;
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getHTML5()
|
|
{
|
|
return $this->html5;
|
|
}
|
|
|
|
/**
|
|
* @param boolean $bool
|
|
* @return $this
|
|
*/
|
|
public function setHTML5($bool)
|
|
{
|
|
$this->html5 = $bool;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get time format in CLDR standard format
|
|
*
|
|
* This can be set explicitly. If not, this will be generated from the current locale
|
|
* with the current time length.
|
|
*
|
|
* @see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#date-field-symbol-table
|
|
*/
|
|
public function getTimeFormat()
|
|
{
|
|
if ($this->getHTML5()) {
|
|
// Browsers expect ISO 8601 times, localisation is handled on the client
|
|
$this->setTimeFormat(DBTime::ISO_TIME);
|
|
}
|
|
|
|
if ($this->timeFormat) {
|
|
return $this->timeFormat;
|
|
}
|
|
|
|
// Get from locale
|
|
return $this->getFrontendFormatter()->getPattern();
|
|
}
|
|
|
|
/**
|
|
* Set time format in CLDR standard format.
|
|
* 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 setTimeFormat($format)
|
|
{
|
|
$this->timeFormat = $format;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get length of the time format to use. One of:
|
|
*
|
|
* - IntlDateFormatter::SHORT E.g. '6:31 PM'
|
|
* - IntlDateFormatter::MEDIUM E.g. '6:30:48 PM'
|
|
* - IntlDateFormatter::LONG E.g. '6:32:09 PM NZDT'
|
|
* - IntlDateFormatter::FULL E.g. '6:32:24 PM New Zealand Daylight Time'
|
|
*
|
|
* @see http://php.net/manual/en/class.intldateformatter.php#intl.intldateformatter-constants
|
|
* @return int
|
|
*/
|
|
public function getTimeLength()
|
|
{
|
|
if ($this->timeLength) {
|
|
return $this->timeLength;
|
|
}
|
|
return IntlDateFormatter::MEDIUM;
|
|
}
|
|
|
|
/**
|
|
* Get length of the time 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 setTimeLength($length)
|
|
{
|
|
$this->timeLength = $length;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get time formatter with the standard locale / date format
|
|
*
|
|
* @return IntlDateFormatter
|
|
*/
|
|
protected function getFrontendFormatter()
|
|
{
|
|
if ($this->getHTML5() && $this->timeFormat && $this->timeFormat !== DBTime::ISO_TIME) {
|
|
throw new \LogicException(
|
|
'Please opt-out of HTML5 processing of ISO 8601 times via setHTML5(false) if using setTimeFormat()'
|
|
);
|
|
}
|
|
|
|
if ($this->getHTML5() && $this->timeLength) {
|
|
throw new \LogicException(
|
|
'Please opt-out of HTML5 processing of ISO 8601 times via setHTML5(false) if using setTimeLength()'
|
|
);
|
|
}
|
|
|
|
if ($this->getHTML5() && $this->locale) {
|
|
throw new \LogicException(
|
|
'Please opt-out of HTML5 processing of ISO 8601 times via setHTML5(false) if using setLocale()'
|
|
);
|
|
}
|
|
|
|
$formatter = IntlDateFormatter::create(
|
|
$this->getLocale(),
|
|
IntlDateFormatter::NONE,
|
|
$this->getTimeLength(),
|
|
$this->getTimezone()
|
|
);
|
|
|
|
if ($this->getHTML5()) {
|
|
// Browsers expect ISO 8601 times, localisation is handled on the client
|
|
$formatter->setPattern(DBTime::ISO_TIME);
|
|
// Don't invoke getTimeFormat() directly to avoid infinite loop
|
|
} elseif ($this->timeFormat) {
|
|
$ok = $formatter->setPattern($this->timeFormat);
|
|
if (!$ok) {
|
|
throw new InvalidArgumentException("Invalid time format {$this->timeFormat}");
|
|
}
|
|
}
|
|
return $formatter;
|
|
}
|
|
|
|
/**
|
|
* Get a time formatter for the ISO 8601 format
|
|
*
|
|
* @return IntlDateFormatter
|
|
*/
|
|
protected function getInternalFormatter()
|
|
{
|
|
$formatter = IntlDateFormatter::create(
|
|
i18n::config()->uninherited('default_locale'),
|
|
IntlDateFormatter::NONE,
|
|
IntlDateFormatter::MEDIUM,
|
|
date_default_timezone_get() // Default to server timezone
|
|
);
|
|
$formatter->setLenient(false);
|
|
|
|
// Note we omit timezone from this format, and we assume server TZ always.
|
|
$formatter->setPattern(DBTime::ISO_TIME);
|
|
|
|
return $formatter;
|
|
}
|
|
|
|
public function getAttributes()
|
|
{
|
|
$attributes = parent::getAttributes();
|
|
|
|
if (!$this->getHTML5()) {
|
|
$attributes['type'] = 'text';
|
|
}
|
|
|
|
return $attributes;
|
|
}
|
|
|
|
public function getSchemaDataDefaults()
|
|
{
|
|
$defaults = parent::getSchemaDataDefaults();
|
|
return array_merge($defaults, [
|
|
'lang' => i18n::convert_rfc1766($this->getLocale()),
|
|
'data' => array_merge($defaults['data'], [
|
|
'html5' => $this->getHTML5(),
|
|
])
|
|
]);
|
|
}
|
|
|
|
public function Type()
|
|
{
|
|
return 'time text';
|
|
}
|
|
|
|
/**
|
|
* Assign value posted from form submission
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $data
|
|
* @return $this
|
|
*/
|
|
public function setSubmittedValue($value, $data = null)
|
|
{
|
|
// Save raw value for later validation
|
|
$this->rawValue = $value;
|
|
|
|
// Parse from submitted value
|
|
$this->value = $this->frontendToInternal($value);
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set time assigned from database value
|
|
*
|
|
* @param mixed $value
|
|
* @param mixed $data
|
|
* @return $this
|
|
*/
|
|
public function setValue($value, $data = null)
|
|
{
|
|
// Save raw value for later validation
|
|
$this->rawValue = $value;
|
|
|
|
// Null case
|
|
if (!$value) {
|
|
$this->value = null;
|
|
return $this;
|
|
}
|
|
|
|
// Re-run through formatter to tidy up (e.g. remove date component)
|
|
$this->value = $this->tidyInternal($value);
|
|
return $this;
|
|
}
|
|
|
|
public function Value()
|
|
{
|
|
$localised = $this->internalToFrontend($this->value);
|
|
if ($localised) {
|
|
return $localised;
|
|
}
|
|
|
|
// Show midnight in localised format
|
|
return $this->getMidnight();
|
|
}
|
|
|
|
/**
|
|
* Show midnight in current format (adjusts for timezone)
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMidnight()
|
|
{
|
|
$formatter = $this->getFrontendFormatter();
|
|
$timestamp = $this->withTimezone($this->getTimezone(), function () {
|
|
return strtotime('midnight');
|
|
});
|
|
return $formatter->format($timestamp);
|
|
}
|
|
|
|
/**
|
|
* Validate this field
|
|
*
|
|
* @param Validator $validator
|
|
* @return bool
|
|
*/
|
|
public function validate($validator)
|
|
{
|
|
// Don't validate empty fields
|
|
if (empty($this->rawValue)) {
|
|
return true;
|
|
}
|
|
|
|
// We submitted a value, but it couldn't be parsed
|
|
if (empty($this->value)) {
|
|
$validator->validationError(
|
|
$this->name,
|
|
_t(
|
|
'SilverStripe\\Forms\\TimeField.VALIDATEFORMAT',
|
|
"Please enter a valid time format ({format})",
|
|
['format' => $this->getTimeFormat()]
|
|
)
|
|
);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getLocale()
|
|
{
|
|
return $this->locale ?: i18n::get_locale();
|
|
}
|
|
|
|
/**
|
|
* Determines the presented/processed format based on locale defaults,
|
|
* instead of explicitly setting {@link setTimeFormat()}.
|
|
* Only applicable with {@link setHTML5(false)}.
|
|
*
|
|
* @param string $locale
|
|
* @return $this
|
|
*/
|
|
public function setLocale($locale)
|
|
{
|
|
$this->locale = $locale;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Creates a new readonly field specified below
|
|
*
|
|
* @return TimeField_Readonly
|
|
*/
|
|
public function performReadonlyTransformation()
|
|
{
|
|
/** @var TimeField_Readonly $result */
|
|
$result = $this->castedCopy(TimeField_Readonly::class);
|
|
$result
|
|
->setValue(false)
|
|
->setHTML5($this->html5)
|
|
->setTimeFormat($this->timeFormat)
|
|
->setTimezone($this->getTimezone())
|
|
->setLocale($this->locale)
|
|
->setTimeLength($this->timeLength)
|
|
->setValue($this->value);
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Convert frontend time to the internal representation (ISO 8601).
|
|
* The frontend time is also in ISO 8601 when $html5=true.
|
|
*
|
|
* @param string $time
|
|
* @return string The formatted time, or null if not a valid time
|
|
*/
|
|
protected function frontendToInternal($time)
|
|
{
|
|
if (!$time) {
|
|
return null;
|
|
}
|
|
$fromFormatter = $this->getFrontendFormatter();
|
|
$toFormatter = $this->getInternalFormatter();
|
|
$timestamp = $fromFormatter->parse($time);
|
|
|
|
// Try to parse time without seconds, since that's a valid HTML5 submission format
|
|
// See https://html.spec.whatwg.org/multipage/infrastructure.html#times
|
|
if ($timestamp === false && $this->getHTML5()) {
|
|
$fromFormatter->setPattern(str_replace(':ss', '', DBTime::ISO_TIME ?? ''));
|
|
$timestamp = $fromFormatter->parse($time);
|
|
}
|
|
|
|
// If timestamp still can't be detected, we've got an invalid time
|
|
if ($timestamp === false) {
|
|
return null;
|
|
}
|
|
|
|
return $toFormatter->format($timestamp);
|
|
}
|
|
|
|
/**
|
|
* Convert the internal time representation (ISO 8601) to a format used by the frontend,
|
|
* as defined by {@link $timeFormat}. With $html5=true, the frontend time will also be
|
|
* in ISO 8601.
|
|
*
|
|
* @param string $time
|
|
* @return string
|
|
*/
|
|
protected function internalToFrontend($time)
|
|
{
|
|
$time = $this->tidyInternal($time);
|
|
if (!$time) {
|
|
return null;
|
|
}
|
|
$fromFormatter = $this->getInternalFormatter();
|
|
$toFormatter = $this->getFrontendFormatter();
|
|
$timestamp = $fromFormatter->parse($time);
|
|
if ($timestamp === false) {
|
|
return null;
|
|
}
|
|
return $toFormatter->format($timestamp);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Tidy up the internal time representation (ISO 8601),
|
|
* and fall back to strtotime() if there's parsing errors.
|
|
*
|
|
* @param string $time Time in ISO 8601 or approximate form
|
|
* @return string ISO 8601 time, or null if not valid
|
|
*/
|
|
protected function tidyInternal($time)
|
|
{
|
|
if (!$time) {
|
|
return null;
|
|
}
|
|
// Re-run through formatter to tidy up (e.g. remove date component)
|
|
$formatter = $this->getInternalFormatter();
|
|
$timestamp = $formatter->parse($time);
|
|
if ($timestamp === false) {
|
|
// Fallback to strtotime
|
|
$timestamp = strtotime($time ?? '', DBDatetime::now()->getTimestamp());
|
|
if ($timestamp === false) {
|
|
return null;
|
|
}
|
|
}
|
|
return $formatter->format($timestamp);
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getTimezone()
|
|
{
|
|
return $this->timezone;
|
|
}
|
|
|
|
/**
|
|
* @param string $timezone
|
|
* @return $this
|
|
*/
|
|
public function setTimezone($timezone)
|
|
{
|
|
if ($this->value && $timezone !== $this->timezone) {
|
|
throw new \BadMethodCallException("Can't change timezone after setting a value");
|
|
}
|
|
$this->timezone = $timezone;
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Run a callback within a specific timezone
|
|
*
|
|
* @param string $timezone
|
|
* @param callable $callback
|
|
*/
|
|
protected function withTimezone($timezone, $callback)
|
|
{
|
|
$currentTimezone = date_default_timezone_get();
|
|
try {
|
|
if ($timezone) {
|
|
date_default_timezone_set($timezone ?? '');
|
|
}
|
|
return $callback();
|
|
} finally {
|
|
// Restore timezone
|
|
if ($timezone) {
|
|
date_default_timezone_set($currentTimezone);
|
|
}
|
|
}
|
|
}
|
|
}
|