Properties

$_cache

$_cache : 

Type

$_defaultOffset

$_defaultOffset : 

Type

$_dst

$_dst : 

Type

$_unixTimestamp

$_unixTimestamp : 

UNIX Timestamp

Type

$_timezone

$_timezone : 

active timezone

Type

$_offset

$_offset : 

Type

$_syncronised

$_syncronised : 

Type

$_monthTable

$_monthTable : 

Table of Monthdays

Type

$_yearTable

$_yearTable : 

Table of Years

Type

Methods

setTimezone()

setTimezone(string  $zone = null) : \Zend_Date_DateObject

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

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

string $zone

OPTIONAL timezone for date calculation; defaults to date_default_timezone_get()

Throws

\Zend_Date_Exception

Returns

\Zend_Date_DateObject

Provides fluent interface

getTimezone()

getTimezone() : string

Return the timezone of $this object.

The timezone is initially set when the object is instantiated.

Returns

string —

actual set timezone string

getGmtOffset()

getGmtOffset() : integer

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

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

Returns

integer —

seconds difference between GMT timezone and timezone when object was instantiated

setUnixTimestamp()

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

Set this object to have a new UNIX timestamp.

Parameters

string|integer $timestamp

OPTIONAL timestamp; defaults to local time using time()

Throws

\Zend_Date_Exception

Returns

string|integer —

old timestamp

getUnixTimestamp()

getUnixTimestamp() : integer|string

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.

Returns

integer|string —

timestamp

_getTime()

_getTime(integer  $sync = null) : integer

Internal function.

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

integer $sync

OPTIONAL time syncronisation value

Returns

integer —

timestamp

mktime()

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

Internal mktime function used by Zend_Date.

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

integer $hour
integer $minute
integer $second
integer $month
integer $day
integer $year
boolean $gmt

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

Returns

integer|float —

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

isYearLeapYear()

isYearLeapYear(integer  $year) : boolean

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

Parameters

integer $year

Returns

boolean —

true, if year is leap year

date()

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

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

Returns a formatted date for a given timestamp.

Parameters

string $format

format for output

mixed $timestamp
boolean $gmt

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

Returns

string

dayOfWeek()

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

Returns the day of week for a Gregorian calendar date.

0 = sunday, 6 = saturday

Parameters

integer $year
integer $month
integer $day

Returns

integer —

dayOfWeek

getDateParts()

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

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

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

mixed $timestamp
boolean $fast

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

Returns

array

weekNumber()

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

Internal getWeekNumber function for handling 64bit timestamps

Returns the ISO 8601 week number of a given date

Parameters

integer $year
integer $month
integer $day

Returns

integer

calcSun()

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

Calculates the sunrise or sunset based on a location

Parameters

array $location

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

boolean $horizon

true: sunrise; false: sunset

$rise

Returns

mixed —
  • false: midnight sun, integer:

_range()

_range(float  $a, float  $b) 

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

Parameters

float $a
  • value to correct
float $b
  • maximum range to set