mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-01 15:28:02 +02:00
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.4@107810 467b73ca-7a2a-4603-9d3b-597d59a354a9
229 lines
5.6 KiB
PHP
Executable File
229 lines
5.6 KiB
PHP
Executable File
<?php
|
|
require_once 'Zend/Date.php';
|
|
|
|
/**
|
|
* Form field to display editable time values in an <input type="text">
|
|
* field. Can optionally display a dropdown with predefined time ranges
|
|
* through `setConfig('showdropdown', true)`.
|
|
*
|
|
* # Configuration
|
|
*
|
|
* - 'timeformat' (string): Time format compatible with Zend_Date.
|
|
* Usually set to default format for {@link locale}
|
|
* through {@link Zend_Locale_Format::getTimeFormat()}.
|
|
* - 'use_strtotime' (boolean): Accept values in PHP's built-in strtotime() notation, in addition
|
|
* to the format specified in `timeformat`. Example inputs: 'now', '11pm', '23:59:59'.
|
|
* - 'showdropdown': Show a dropdown with suggested date values.
|
|
* CAUTION: The dropdown does not support localization.
|
|
*
|
|
* # Localization
|
|
*
|
|
* See {@link DateField}
|
|
*
|
|
* @todo Timezone support
|
|
* @todo 'showdropdown' localization
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-datetime
|
|
*/
|
|
class TimeField extends TextField {
|
|
|
|
protected $config = array(
|
|
'showdropdown' => false,
|
|
'timeformat' => 'HH:mm:ss',
|
|
'use_strtotime' => true,
|
|
'datavalueformat' => 'HH:mm:ss'
|
|
);
|
|
|
|
/**
|
|
* @var String
|
|
*/
|
|
protected $locale = null;
|
|
|
|
/**
|
|
* @var Zend_Date Just set if the date is valid.
|
|
* {@link $value} will always be set to aid validation,
|
|
* and might contain invalid values.
|
|
*/
|
|
protected $valueObj = null;
|
|
|
|
function __construct($name, $title = null, $value = ""){
|
|
if(!$this->locale) {
|
|
$this->locale = i18n::get_locale();
|
|
}
|
|
|
|
if(!$this->getConfig('timeformat')) {
|
|
$this->setConfig('timeformat', i18n::get_time_format());
|
|
}
|
|
|
|
parent::__construct($name,$title,$value);
|
|
}
|
|
|
|
function Field() {
|
|
$html = parent::Field();
|
|
|
|
$html = $this->FieldDriver($html);
|
|
|
|
return $html;
|
|
}
|
|
|
|
/**
|
|
* Internal volatile API.
|
|
*
|
|
* @see DateField->FieldDriver()
|
|
*/
|
|
protected function FieldDriver($html) {
|
|
if($this->getConfig('showdropdown')) {
|
|
Requirements::javascript(SAPPHIRE_DIR . '/javascript/TimeField_dropdown.js');
|
|
Requirements::css(SAPPHIRE_DIR . '/css/TimeField_dropdown.css');
|
|
|
|
$html .= sprintf('<img class="timeIcon" src="sapphire/images/clock-icon.gif" id="%s-icon"/>', $this->id());
|
|
$html .= sprintf('<div class="dropdownpopup" id="%s-dropdowntime"></div>', $this->id());
|
|
$html = '<div class="dropdowntime">' . $html . '</div>';
|
|
}
|
|
|
|
return $html;
|
|
}
|
|
|
|
/**
|
|
* Sets the internal value to ISO date format.
|
|
*
|
|
* @param String|Array $val
|
|
*/
|
|
function setValue($val) {
|
|
// Fuzzy matching through strtotime() to support a wider range of times,
|
|
// e.g. 11am. This means that validate() might not fire.
|
|
// Note: Time formats are assumed to be less ambiguous than dates across locales.
|
|
if($this->getConfig('use_strtotime') && !empty($val)) {
|
|
if($parsedTimestamp = strtotime($val)) {
|
|
$parsedObj = new Zend_Date($parsedTimestamp, Zend_Date::TIMESTAMP);
|
|
$val = $parsedObj->get($this->getConfig('timeformat'));
|
|
unset($parsedObj);
|
|
}
|
|
}
|
|
|
|
if(empty($val)) {
|
|
$this->value = null;
|
|
$this->valueObj = null;
|
|
}
|
|
// load ISO time from database (usually through Form->loadDataForm())
|
|
else if(Zend_Date::isDate($val, $this->getConfig('datavalueformat'))) {
|
|
$this->valueObj = new Zend_Date($val, $this->getConfig('datavalueformat'));
|
|
$this->value = $this->valueObj->get($this->getConfig('timeformat'));
|
|
}
|
|
// Set in current locale (as string)
|
|
else if(Zend_Date::isDate($val, $this->getConfig('timeformat'), $this->locale)) {
|
|
$this->valueObj = new Zend_Date($val, $this->getConfig('timeformat'), $this->locale);
|
|
$this->value = $this->valueObj->get($this->getConfig('timeformat'));
|
|
}
|
|
// Fallback: Set incorrect value so validate() can pick it up
|
|
else {
|
|
$this->value = $val;
|
|
$this->valueObj = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return String ISO 8601 date, suitable for insertion into database
|
|
*/
|
|
function dataValue() {
|
|
if($this->valueObj) {
|
|
return $this->valueObj->toString($this->getConfig('datavalueformat'));
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return Boolean
|
|
*/
|
|
function validate($validator) {
|
|
$valid = true;
|
|
|
|
// Don't validate empty fields
|
|
if(empty($this->value)) return true;
|
|
|
|
if(!Zend_Date::isDate($this->value, $this->getConfig('timeformat'), $this->locale)) {
|
|
$validator->validationError(
|
|
$this->name,
|
|
sprintf(
|
|
_t('TimeField.VALIDATEFORMAT', "Please enter a valid time format (%s)"),
|
|
$this->getConfig('timeformat')
|
|
),
|
|
"validation",
|
|
false
|
|
);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
function getLocale() {
|
|
return $this->locale;
|
|
}
|
|
|
|
/**
|
|
* @param String $locale
|
|
*/
|
|
function setLocale($locale) {
|
|
$this->locale = $locale;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $val
|
|
*/
|
|
function setConfig($name, $val) {
|
|
$this->config[$name] = $val;
|
|
}
|
|
|
|
/**
|
|
* @param String $name
|
|
* @return mixed
|
|
*/
|
|
function getConfig($name) {
|
|
return $this->config[$name];
|
|
}
|
|
|
|
/**
|
|
* Creates a new readonly field specified below
|
|
*/
|
|
function performReadonlyTransformation() {
|
|
return new TimeField_Readonly($this->name, $this->title, $this->dataValue(), $this->getConfig('timeformat'));
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* The readonly class for our {@link TimeField}.
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-datetime
|
|
*/
|
|
class TimeField_Readonly extends TimeField {
|
|
|
|
protected $readonly = true;
|
|
|
|
function Field() {
|
|
if($this->valueObj) {
|
|
$val = Convert::raw2xml($this->valueObj->toString($this->getConfig('timeformat')));
|
|
} else {
|
|
// TODO Localization
|
|
$val = '<i>(not set)</i>';
|
|
}
|
|
|
|
return "<span class=\"readonly\" id=\"" . $this->id() . "\">$val</span>";
|
|
}
|
|
|
|
function jsValidation() {
|
|
return null;
|
|
}
|
|
|
|
function validate($validator) {
|
|
return true;
|
|
}
|
|
}
|
|
?>
|