silverstripe-framework/model/FieldType/DBTime.php
Sam Minnee aeccb8b8e0 API: Move DBField subclasses into SilverStripe\Model\FieldType namespace
API: Deprecate SS_Datetime.

The DBField subclasses are have all been renamed to start with “DB” and
be in the SilverStripe\Model\FieldType namespace. To keep DataObject
definitions concise, the original short variations of their names are
preserved as service definitions. Most of the field generation code
doesn’t need to change, but where field classes are referenced directly,
changes will be needed.

SS_Datetime, which is commonly referenced outside the model system
itself, has been preserved as a subclass of DBDatetime. This has been
marked as deprecated and can be removed in SilverStripe 5.

A few places that referred to $db and $casting values weren’t using
the Injector to instantiate the relevant classes. This meant that the
remapping we have created as part of moving classes into a namespace
didn’t work.
2016-03-22 18:09:30 +13:00

96 lines
2.3 KiB
PHP

<?php
namespace SilverStripe\Model\FieldType;
use DB;
use Convert;
use Zend_Date;
use TimeField;
/**
* Represents a column in the database with the type 'Time'.
*
* Example definition via {@link DataObject::$db}:
* <code>
* static $db = array(
* "StartTime" => "Time",
* );
* </code>
*
* @todo Add localization support, see http://open.silverstripe.com/ticket/2931
*
* @package framework
* @subpackage model
*/
class DBTime extends DBField {
public function setValue($value, $record = null, $markChanged = true) {
if($value) {
if(preg_match( '/(\d{1,2})[:.](\d{2})([a|A|p|P|][m|M])/', $value, $match )) $this->TwelveHour( $match );
else $this->value = date('H:i:s', strtotime($value));
} else {
$value = null;
}
}
/**
* Return a user friendly format for time
* in a 12 hour format.
*
* @return string Time in 12 hour format
*/
public function Nice() {
if($this->value) return date('g:ia', strtotime($this->value));
}
/**
* Return a user friendly format for time
* in a 24 hour format.
*
* @return string Time in 24 hour format
*/
public function Nice24() {
if($this->value) return date('H:i', strtotime($this->value));
}
/**
* Return the time using a particular formatting string.
*
* @param string $format Format code string. e.g. "g:ia"
* @return string The date in the requested format
*/
public function Format($format) {
if($this->value) return date($format, strtotime($this->value));
}
public function TwelveHour( $parts ) {
$hour = $parts[1];
$min = $parts[2];
$half = $parts[3];
// the transmation should exclude 12:00pm ~ 12:59pm
$this->value = (( (strtolower($half) == 'pm') && $hour != '12') ? $hour + 12 : $hour ) .":$min:00";
}
public function requireField() {
$parts=Array('datatype'=>'time', 'arrayValue'=>$this->arrayValue);
$values=Array('type'=>'time', 'parts'=>$parts);
DB::require_field($this->tableName, $this->name, $values);
}
public function scaffoldFormField($title = null, $params = null) {
$field = TimeField::create($this->name, $title);
// Show formatting hints for better usability
$field->setDescription(sprintf(
_t('FormField.Example', 'e.g. %s', 'Example format'),
Convert::raw2xml(Zend_Date::now()->toString($field->getConfig('timeformat')))
));
$field->setAttribute('placeholder', $field->getConfig('timeformat'));
return $field;
}
}