category Zend
package Zend_Date
subpackage Zend_Date_DateObject
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Return the offset to GMT of $this object's timezone.

getGmtOffset() : integer

The offset to GMT is initially set when the object is instantiated using the currently, in effect, default timezone for PHP functions.

Returns

integerseconds difference between GMT timezone and timezone when object was instantiated

Return the timezone of $this object.

getTimezone() : string

The timezone is initially set when the object is instantiated.

Returns

stringactual set timezone string

Sets a new timezone for calculation of $this object's gmt offset.

setTimezone(string $zone = null) : \Zend_Date_DateObject

For a list of supported timezones look here: http://php.net/timezones If no timezone can be detected or the given timezone is wrong UTC will be set.

Parameters

$zone

string

OPTIONAL timezone for date calculation; defaults to date_default_timezone_get()

Exceptions

\Zend_Date_Exception

Returns

\Zend_Date_DateObjectProvides fluent interface

Internal method to check if the given cache supports tags

_getTagSupportForCache() 
Static

Internal function.

_getTime(integer $sync = null) : integer

Returns time(). This method exists to allow unit tests to work-around methods that might otherwise be hard-coded to use time(). For example, this makes it possible to test isYesterday() in Date.php.

Parameters

$sync

integer

OPTIONAL time syncronisation value

Returns

integertimestamp

Calculates the sunrise or sunset based on a location

calcSun(array $location, boolean $horizon, $rise = false) : mixed

Parameters

$location

array

Location for calculation MUST include 'latitude', 'longitude', 'horizon'

$horizon

boolean

true: sunrise; false: sunset

$rise

Returns

mixed- false: midnight sun, integer:

Internal mktime function used by Zend_Date for handling 64bit timestamps.

date(string $format, mixed $timestamp = null, boolean $gmt = false) : string

Returns a formatted date for a given timestamp.

Parameters

$format

string

format for output

$timestamp

mixed

$gmt

boolean

OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date

Returns

string

Returns the day of week for a Gregorian calendar date.

dayOfWeek(integer $year, integer $month, integer $day) : integer
Static

0 = sunday, 6 = saturday

Parameters

$year

integer

$month

integer

$day

integer

Returns

integerdayOfWeek

Internal getDateParts function for handling 64bit timestamps, similar to: http://www.php.net/getdate

getDateParts(mixed $timestamp = null, boolean $fast = null) : array

Returns an array of date parts for $timestamp, relative to 1970/01/01 00:00:00 GMT/UTC.

$fast specifies ALL date parts should be returned (slower) Default is false, and excludes $dayofweek, weekday, month and timestamp from parts returned.

Parameters

$timestamp

mixed

$fast

boolean

OPTIONAL defaults to fast (false), resulting in fewer date parts

Returns

array

Returns this object's UNIX timestamp A timestamp greater then the integer range will be returned as string This function does not return the timestamp as object. Use copy() instead.

getUnixTimestamp() : integer | string

Returns

integerstringtimestamp

Returns true, if given $year is a leap year.

isYearLeapYear(integer $year) : boolean
Static

Parameters

$year

integer

Returns

booleantrue, if year is leap year

Internal mktime function used by Zend_Date.

mktime(integer $hour, integer $minute, integer $second, integer $month, integer $day, integer $year, boolean $gmt = false) : integer | float

The timestamp returned by mktime() can exceed the precision of traditional UNIX timestamps, by allowing PHP to auto-convert to using a float value.

Returns a timestamp relative to 1970/01/01 00:00:00 GMT/UTC. DST (Summer/Winter) is depriciated since php 5.1.0. Year has to be 4 digits otherwise it would be recognised as year 70 AD instead of 1970 AD as expected !!

Parameters

$hour

integer

$minute

integer

$second

integer

$month

integer

$day

integer

$year

integer

$gmt

boolean

OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date

Returns

integerfloattimestamp (number of seconds elapsed relative to 1970/01/01 00:00:00 GMT/UTC)

Set this object to have a new UNIX timestamp.

setUnixTimestamp(string|integer $timestamp = null) : string | integer

Parameters

$timestamp

stringinteger

OPTIONAL timestamp; defaults to local time using time()

Exceptions

\Zend_Date_Exception

Returns

stringintegerold timestamp

Internal getWeekNumber function for handling 64bit timestamps

weekNumber(integer $year, integer $month, integer $day) : integer

Returns the ISO 8601 week number of a given date

Parameters

$year

integer

$month

integer

$day

integer

Returns

integer

Internal _range function Sets the value $a to be in the range of [0, $b]

_range(float $a, float $b) 

Parameters

$a

float
  • value to correct

$b

float
  • maximum range to set

 Properties

 

$_cache

$_cache 

Default

null
Static
 

$_cacheTags

$_cacheTags 

Default

false
Static
 

$_defaultOffset

$_defaultOffset 

Default

0
Static
 

$_dst

$_dst 

Default

true
 

Table of Monthdays

$_monthTable 

Default

array(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31)
Static
 

$_offset

$_offset 

Default

0
 

$_syncronised

$_syncronised 

Default

0
 

active timezone

$_timezone 

Default

'UTC'
 

UNIX Timestamp

$_unixTimestamp 

Default

 

Table of Years

$_yearTable 

Default

array(1970 => 0, 1960 => -315619200, 1950 => -631152000, 1940 => -946771200, 1930 => -1262304000, 1920 => -1577923200, 1910 => -1893456000, 1900 => -2208988800, 1890 => -2524521600, 1880 => -2840140800, 1870 => -3155673600, 1860 => -3471292800, 1850 => -3786825600, 1840 => -4102444800, 1830 => -4417977600, 1820 => -4733596800, 1810 => -5049129600, 1800 => -5364662400, 1790 => -5680195200, 1780 => -5995814400, 1770 => -6311347200, 1760 => -6626966400, 1750 => -6942499200, 1740 => -7258118400, 1730 => -7573651200, 1720 => -7889270400, 1710 => -8204803200, 1700 => -8520336000, 1690 => -8835868800, 1680 => -9151488000, 1670 => -9467020800, 1660 => -9782640000, 1650 => -10098172800, 1640 => -10413792000, 1630 => -10729324800, 1620 => -11044944000, 1610 => -11360476800, 1600 => -11676096000)
Static