Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

372 lines (327 sloc) 10.455 kB
<?php
/**
* Represents a date field.
* The field currently supports New Zealand date format (DD/MM/YYYY),
* or an ISO 8601 formatted date (YYYY-MM-DD).
* Alternatively you can set a timestamp that is evaluated through
* PHP's built-in date() function according to your system locale.
*
* Example definition via {@link DataObject::$db}:
* <code>
* static $db = array(
* "Expires" => "Date",
* );
* </code>
*
* @todo Add localization support, see http://open.silverstripe.com/ticket/2931
*
* @package framework
* @subpackage model
*/
class Date extends DBField {
function setValue($value, $record = null) {
if($value === false || $value === null || (is_string($value) && !strlen($value))) {
// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be saved as NULL in database
$this->value = null;
return;
}
// @todo This needs tidy up (what if you only specify a month and a year, for example?)
if(is_array($value)) {
if(!empty($value['Day']) && !empty($value['Month']) && !empty($value['Year'])) {
$this->value = $value['Year'] . '-' . $value['Month'] . '-' . $value['Day'];
return;
} else {
// return nothing (so checks below don't fail on an empty array)
return null;
}
}
// Default to NZ date format - strtotime expects a US date
if(preg_match('#^([0-9]+)/([0-9]+)/([0-9]+)$#', $value, $parts)) {
$value = "$parts[2]/$parts[1]/$parts[3]";
}
if(is_numeric($value)) {
$this->value = date('Y-m-d', $value);
} elseif(is_string($value)) {
$this->value = date('Y-m-d', strtotime($value));
}
}
/**
* Returns the date in the format dd/mm/yy
*/
function Nice() {
if($this->value) return date('d/m/Y', strtotime($this->value));
}
/**
* Returns the date in US format: “01/18/2006”
*/
function NiceUS() {
if($this->value) return date('m/d/Y', strtotime($this->value));
}
/**
* Returns the year from the given date
*/
function Year() {
if($this->value) return date('Y', strtotime($this->value));
}
/**
* Returns the Full day, of the given date.
*/
function Day(){
if($this->value) return date('l', strtotime($this->value));
}
/**
* Returns a full textual representation of a month, such as January.
*/
function Month() {
if($this->value) return date('F', strtotime($this->value));
}
/**
* Returns the short version of the month such as Jan
*/
function ShortMonth() {
if($this->value) return date('M', strtotime($this->value));
}
/**
* Returns the day of the month.
* @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd"
* @return string
*/
function DayOfMonth($includeOrdinal = false) {
if($this->value) {
$format = 'j';
if ($includeOrdinal) $format .= 'S';
return date($format, strtotime($this->value));
}
}
/**
* Returns the date in the format 24 December 2006
*/
function Long() {
if($this->value) return date('j F Y', strtotime($this->value));
}
/**
* Returns the date in the format 24 Dec 2006
*/
function Full() {
if($this->value) return date('j M Y', strtotime($this->value));
}
/**
* Return the date using a particular formatting string.
*
* @param string $format Format code string. e.g. "d M Y" (see http://php.net/date)
* @return string The date in the requested format
*/
function Format($format) {
if($this->value) return date($format, strtotime($this->value));
}
/**
* Return the date formatted using the given strftime formatting string.
*
* strftime obeys the current LC_TIME/LC_ALL when printing lexical values
* like day- and month-names
*/
function FormatI18N($formattingString) {
if($this->value) {
$fecfrm = strftime($formattingString, strtotime($this->value));
return utf8_encode($fecfrm);
}
}
/*
* Return a string in the form "12 - 16 Sept" or "12 Aug - 16 Sept"
* @param Date $otherDateObj Another date object specifying the end of the range
* @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd"
* @return string
*/
function RangeString($otherDateObj, $includeOrdinals = false) {
$d1 = $this->DayOfMonth($includeOrdinals);
$d2 = $otherDateObj->DayOfMonth($includeOrdinals);
$m1 = $this->ShortMonth();
$m2 = $otherDateObj->ShortMonth();
$y1 = $this->Year();
$y2 = $otherDateObj->Year();
if($y1 != $y2) return "$d1 $m1 $y1 - $d2 $m2 $y2";
else if($m1 != $m2) return "$d1 $m1 - $d2 $m2 $y1";
else return "$d1 - $d2 $m1 $y1";
}
function Rfc822() {
if($this->value) return date('r', strtotime($this->value));
}
function Rfc2822() {
if($this->value) return date('Y-m-d H:i:s', strtotime($this->value));
}
function Rfc3339() {
$timestamp = ($this->value) ? strtotime($this->value) : false;
if(!$timestamp) return false;
$date = date('Y-m-d\TH:i:s', $timestamp);
$matches = array();
if(preg_match('/^([\-+])(\d{2})(\d{2})$/', date('O', $timestamp), $matches)) {
$date .= $matches[1].$matches[2].':'.$matches[3];
} else {
$date .= 'Z';
}
return $date;
}
/**
* Returns the number of seconds/minutes/hours/days or months since the timestamp
*/
function Ago() {
if($this->value) {
if(strtotime($this->value) == time() || time() > strtotime($this->value)) {
return _t(
'Date.TIMEDIFFAGO',
"{difference} ago",
'Natural language time difference, e.g. 2 hours ago',
array('difference' => $this->TimeDiff())
);
} else {
return _t(
'Date.TIMEDIFFIN',
"in {difference}",
'Natural language time difference, e.g. in 2 hours',
array('difference' => $this->TimeDiff())
);
}
}
}
function TimeDiff() {
if($this->value) {
$ago = abs(time() - strtotime($this->value));
if($ago < 60) {
$span = $ago;
return ($span != 1) ? "{$span} "._t("Date.SECS", " secs") : "{$span} "._t("Date.SEC", " sec");
}
if($ago < 3600) {
$span = round($ago/60);
return ($span != 1) ? "{$span} "._t("Date.MINS", " mins") : "{$span} "._t("Date.MIN", " min");
}
if($ago < 86400) {
$span = round($ago/3600);
return ($span != 1) ? "{$span} "._t("Date.HOURS", " hours") : "{$span} "._t("Date.HOUR", " hour");
}
if($ago < 86400*30) {
$span = round($ago/86400);
return ($span != 1) ? "{$span} "._t("Date.DAYS", " days") : "{$span} "._t("Date.DAY", " day");
}
if($ago < 86400*365) {
$span = round($ago/86400/30);
return ($span != 1) ? "{$span} "._t("Date.MONTHS", " months") : "{$span} "._t("Date.MONTH", " month");
}
if($ago > 86400*365) {
$span = round($ago/86400/365);
return ($span != 1) ? "{$span} "._t("Date.YEARS", " years") : "{$span} "._t("Date.YEAR", " year");
}
}
}
/**
* Gets the time difference, but always returns it in a certain format
* @param string $format The format, could be one of these:
* 'seconds', 'minutes', 'hours', 'days', 'months', 'years'.
*
* @return string
*/
function TimeDiffIn($format) {
if($this->value) {
$ago = abs(time() - strtotime($this->value));
switch($format) {
case "seconds":
$span = $ago;
return ($span != 1) ? "{$span} seconds" : "{$span} second";
break;
case "minutes":
$span = round($ago/60);
return ($span != 1) ? "{$span} minutes" : "{$span} minute";
break;
case "hours":
$span = round($ago/3600);
return ($span != 1) ? "{$span} hours" : "{$span} hour";
break;
case "days":
$span = round($ago/86400);
return ($span != 1) ? "{$span} days" : "{$span} day";
break;
case "months":
$span = round($ago/86400/30);
return ($span != 1) ? "{$span} months" : "{$span} month";
break;
case "years":
$span = round($ago/86400/365);
return ($span != 1) ? "{$span} years" : "{$span} year";
break;
}
}
}
function requireField() {
$parts=Array('datatype'=>'date', 'arrayValue'=>$this->arrayValue);
$values=Array('type'=>'date', 'parts'=>$parts);
DB::requireField($this->tableName, $this->name, $values);
}
/**
* Returns true if date is in the past.
* @return boolean
*/
function InPast() {
return strtotime($this->value) < time();
}
/**
* Returns true if date is in the future.
* @return boolean
*/
function InFuture() {
return strtotime($this->value) > time();
}
/**
* Returns true if date is today.
* @return boolean
*/
function IsToday() {
return (date('Y-m-d', strtotime($this->value)) == date('Y-m-d', time()));
}
/**
* Returns a date suitable for insertion into a URL and use by the system.
*/
function URLDate() {
return date('Y-m-d', strtotime($this->value));
}
function days_between($fyear, $fmonth, $fday, $tyear, $tmonth, $tday){
return abs((mktime ( 0, 0, 0, $fmonth, $fday, $fyear) - mktime ( 0, 0, 0, $tmonth, $tday, $tyear))/(60*60*24));
}
function day_before($fyear, $fmonth, $fday){
return date ("Y-m-d", mktime (0,0,0,$fmonth,$fday-1,$fyear));
}
function next_day($fyear, $fmonth, $fday){
return date ("Y-m-d", mktime (0,0,0,$fmonth,$fday+1,$fyear));
}
function weekday($fyear, $fmonth, $fday){ // 0 is a Monday
return (((mktime ( 0, 0, 0, $fmonth, $fday, $fyear) - mktime ( 0, 0, 0, 7, 17, 2006))/(60*60*24))+700000) % 7;
}
function prior_monday($fyear, $fmonth, $fday){
return date ("Y-m-d", mktime (0,0,0,$fmonth,$fday-$this->weekday($fyear, $fmonth, $fday),$fyear));
}
/**
* Return the nearest date in the past, based on day and month.
* Automatically attaches the correct year.
*
* This is useful for determining a financial year start or end date.
*
* @param $fmonth int The number of the month (e.g. 3 is March, 4 is April)
* @param $fday int The day of the month
* @param $fyear int Determine historical value
* @return string Date in YYYY-MM-DD format
*/
static function past_date($fmonth, $fday = 1, $fyear = null) {
if(!$fyear) $fyear = date('Y');
$fday = (int) $fday;
$fmonth = (int) $fmonth;
$fyear = (int) $fyear;
$pastDate = mktime(0, 0, 0, $fmonth, $fday, $fyear);
$curDate = mktime(0, 0, 0, date('m'), date('d'), $fyear);
if($pastDate < $curDate) {
return date('Y-m-d', mktime(0, 0, 0, $fmonth, $fday, $fyear));
} else {
return date('Y-m-d', mktime(0, 0, 0, $fmonth, $fday, $fyear - 1));
}
}
public function scaffoldFormField($title = null, $params = null) {
return new DateField($this->name, $title);
}
}
Jump to Line
Something went wrong with that request. Please try again.