\Zend_Date

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

Throws

\Zend_Date_Exception

Returns

Provides fluent interface

getTimezone()

getTimezone() : string

Return the timezone of $this object.

The timezone is initially set when the object is instantiated.

Returns

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

seconds difference between GMT timezone and timezone when object was instantiated

__construct()

__construct(string|integer|\Zend_Date|array  $date = null, string  $part = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Generates the standard date object, could be a unix timestamp, localized date, string, integer, array and so on. Also parts of dates or time are supported Always set the default timezone: http://php.net/date_default_timezone_set For example, in your bootstrap: date_default_timezone_set('America/Los_Angeles'); For detailed instructions please look in the docu.

Parameters

Throws

\Zend_Date_Exception

Returns

setOptions()

setOptions(array  $options = array()) : \Options

Sets class wide options, if no option was given, the actual set options will be returned

Parameters

Throws

\Zend_Date_Exception

Returns

array if no option was given

getTimestamp()

getTimestamp() : integer|string

Returns this object's internal UNIX timestamp (equivalent to Zend_Date::TIMESTAMP).

If the timestamp is too large for integers, then the return value will be a string. This function does not return the timestamp as an object. Use clone() or copyPart() instead.

Returns

UNIX timestamp

setTimestamp()

setTimestamp(integer|string|array|\Zend_Date  $timestamp) : \Zend_Date

Sets a new timestamp

Parameters

Throws

\Zend_Date_Exception

Returns

addTimestamp()

addTimestamp(integer|string|array|\Zend_Date  $timestamp) : \Zend_Date

Adds a timestamp

Parameters

Throws

\Zend_Date_Exception

Returns

subTimestamp()

subTimestamp(integer|string|array|\Zend_Date  $timestamp) : \Zend_Date

Subtracts a timestamp

Parameters

Throws

\Zend_Date_Exception

Returns

compareTimestamp()

compareTimestamp(integer|string|array|\Zend_Date  $timestamp) : integer

Compares two timestamps, returning the difference as integer

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

toString()

toString(string  $format = null, string  $type = null, string|\Zend_Locale  $locale = null) : string

Returns a string representation of the object Supported format tokens are: G - era, y - year, Y - ISO year, M - month, w - week of year, D - day of year, d - day of month E - day of week, e - number of weekday (1-7), h - hour 1-12, H - hour 0-23, m - minute, s - second A - milliseconds of day, z - timezone, Z - timezone offset, S - fractional second, a - period of day

Additionally format tokens but non ISO conform are: SS - day suffix, eee - php number of weekday(0-6), ddd - number of days per month l - Leap year, B - swatch internet time, I - daylight saving time, X - timezone offset in seconds r - RFC2822 format, U - unix timestamp

Not supported ISO tokens are u - extended year, Q - quarter, q - quarter, L - stand alone month, W - week of month F - day of week of month, g - modified julian, c - stand alone weekday, k - hour 0-11, K - hour 1-24 v - wall zone

Parameters

Returns

__toString()

__toString() : string

Returns a string representation of the date which is equal with the timestamp

Returns

toValue()

toValue(string|integer|\Zend_Date  $part = null) : integer|false

Returns a integer representation of the object But returns false when the given part is no value f.e. Month-Name

Parameters

Returns

toArray()

toArray() : array

Returns an array representation of the object

Returns

get()

get(string  $part = null, string|\Zend_Locale  $locale = null) : string

Returns a representation of a date or datepart This could be for example a localized monthname, the time without date, the era or only the fractional seconds. There are about 50 different supported date parts.

For a complete list of supported datepart values look into the docu

Parameters

Returns

date or datepart

getFullYear()

getFullYear(integer  $value) : integer

Counts the exact year number < 70 - 2000 added, >70 < 100 - 1900, others just returned

Parameters

Returns

Number of year

set()

set(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : integer|string

Sets the given date as new date or a given datepart as new datepart returning the new datepart This could be for example a localized dayname, the date without time, the month or only the seconds. There are about 50 different supported date parts.

For a complete list of supported datepart values look into the docu

Parameters

Throws

\Zend_Date_Exception

Returns

new datepart

add()

add(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : integer|string

Adds a date or datepart to the existing date, by extracting $part from $date, and modifying this object by adding that part. The $part is then extracted from this object and returned as an integer or numeric string (for large values, or $part's corresponding to pre-defined formatted date strings).

This could be for example a ISO 8601 date, the hour the monthname or only the minute. There are about 50 different supported date parts. For a complete list of supported datepart values look into the docu.

Parameters

Throws

\Zend_Date_Exception

Returns

new datepart

sub()

sub(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : integer|string

Subtracts a date from another date.

This could be for example a RFC2822 date, the time, the year or only the timestamp. There are about 50 different supported date parts. For a complete list of supported datepart values look into the docu Be aware: Adding -2 Months is not equal to Subtracting 2 Months !!!

Parameters

Throws

\Zend_Date_Exception

Returns

new datepart

compare()

compare(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : integer

Compares a date or datepart with the existing one.

Returns -1 if earlier, 0 if equal and 1 if later.

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

copyPart()

copyPart(string  $part, string|\Zend_Locale  $locale = null) : \Zend_Date

Returns a new instance of Zend_Date with the selected part copied.

To make an exact copy, use PHP's clone keyword. For a complete list of supported date part values look into the docu. If a date part is copied, all other date parts are set to standard values. For example: If only YEAR is copied, the returned date object is equal to 01-01-YEAR 00:00:00 (01-01-1970 00:00:00 is equal to timestamp 0) If only HOUR is copied, the returned date object is equal to 01-01-1970 HOUR:00:00 (so $this contains a timestamp equal to a timestamp of 0 plus HOUR).

Parameters

Returns

getTimezoneFromString()

getTimezoneFromString(string  $zone) : integer

Internal function, returns the offset of a given timezone

Parameters

Returns

equals()

equals(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : boolean

Returns true when both date objects or date parts are equal.

For example: 15.May.2000 <-> 15.June.2000 Equals only for Day or Year... all other will return false

Parameters

Throws

\Zend_Date_Exception

Returns

isEarlier()

isEarlier(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : boolean

Returns if the given date or datepart is earlier For example: 15.May.2000 <-> 13.June.1999 will return true for day, year and date, but not for month

Parameters

Throws

\Zend_Date_Exception

Returns

isLater()

isLater(string|integer|array|\Zend_Date  $date, string  $part = null, string|\Zend_Locale  $locale = null) : boolean

Returns if the given date or datepart is later For example: 15.May.2000 <-> 13.June.1999 will return true for month but false for day, year and date Returns if the given date is later

Parameters

Throws

\Zend_Date_Exception

Returns

getTime()

getTime(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns only the time of the date as new Zend_Date object For example: 15.May.2000 10:11:23 will return a dateobject equal to 01.Jan.1970 10:11:23

Parameters

Returns

setTime()

setTime(string|integer|array|\Zend_Date  $time, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new time for the date object. Format defines how to parse the time string.

Also a complete date can be given, but only the time is used for setting. For example: dd.MMMM.yyTHH:mm' and 'ss sec'-> 10.May.07T25:11 and 44 sec => 1h11min44sec + 1 day Returned is the new date object and the existing date is left as it was before

Parameters

Throws

\Zend_Date_Exception

Returns

new time

addTime()

addTime(string|integer|array|\Zend_Date  $time, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds a time to the existing date. Format defines how to parse the time string.

If only parts are given the other parts are set to 0. If no format is given, the standardformat of this locale is used. For example: HH:mm:ss -> 10 -> +10 hours

Parameters

Throws

\Zend_Date_Exception

Returns

new time

subTime()

subTime(string|integer|array|\Zend_Date  $time, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts a time from the existing date. Format defines how to parse the time string.

If only parts are given the other parts are set to 0. If no format is given, the standardformat of this locale is used. For example: HH:mm:ss -> 10 -> -10 hours

Parameters

Throws

\Zend_Date_Exception

Returns

new time

compareTime()

compareTime(string|integer|array|\Zend_Date  $time, string  $format = null, string|\Zend_Locale  $locale = null) : integer

Compares the time from the existing date. Format defines how to parse the time string.

If only parts are given the other parts are set to default. If no format us given, the standardformat of this locale is used. For example: HH:mm:ss -> 10 -> 10 hours

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getDate()

getDate(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns a clone of $this, with the time part set to 00:00:00.

Parameters

Returns

setDate()

setDate(string|integer|array|\Zend_Date  $date, string  $format = null, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Sets a new date for the date object. Format defines how to parse the date string.

Also a complete date with time can be given, but only the date is used for setting. For example: MMMM.yy HH:mm-> May.07 22:11 => 01.May.07 00:00 Returned is the new date object and the existing time is left as it was before

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addDate()

addDate(string|integer|array|\Zend_Date  $date, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds a date to the existing date object. Format defines how to parse the date string.

If only parts are given the other parts are set to 0. If no format is given, the standardformat of this locale is used. For example: MM.dd.YYYY -> 10 -> +10 months

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subDate()

subDate(string|integer|array|\Zend_Date  $date, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts a date from the existing date object. Format defines how to parse the date string.

If only parts are given the other parts are set to 0. If no format is given, the standardformat of this locale is used. For example: MM.dd.YYYY -> 10 -> -10 months Be aware: Subtracting 2 months is not equal to Adding -2 months !!!

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareDate()

compareDate(string|integer|array|\Zend_Date  $date, string  $format = null, string|\Zend_Locale  $locale = null) : \Zend_Date

Compares the date from the existing date object, ignoring the time.

Format defines how to parse the date string. If only parts are given the other parts are set to 0. If no format is given, the standardformat of this locale is used. For example: 10.01.2000 => 10.02.1999 -> false

Parameters

Throws

\Zend_Date_Exception

Returns

new date

getIso()

getIso(string|\Zend_Locale  $locale = null) : string

Returns the full ISO 8601 date from the date object.

Always the complete ISO 8601 specifiction is used. If an other ISO date is needed (ISO 8601 defines several formats) use toString() instead. This function does not return the ISO date as object. Use copy() instead.

Parameters

Returns

setIso()

setIso(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Sets a new date for the date object. Not given parts are set to default.

Only supported ISO 8601 formats are accepted. For example: 050901 -> 01.Sept.2005 00:00:00, 20050201T10:00:30 -> 01.Feb.2005 10h00m30s Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addIso()

addIso(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Adds a ISO date to the date object. Not given parts are set to default.

Only supported ISO 8601 formats are accepted. For example: 050901 -> + 01.Sept.2005 00:00:00, 10:00:00 -> +10h Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subIso()

subIso(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Subtracts a ISO date from the date object. Not given parts are set to default.

Only supported ISO 8601 formats are accepted. For example: 050901 -> - 01.Sept.2005 00:00:00, 10:00:00 -> -10h Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareIso()

compareIso(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer

Compares a ISO date with the date object. Not given parts are set to default.

Only supported ISO 8601 formats are accepted. For example: 050901 -> - 01.Sept.2005 00:00:00, 10:00:00 -> -10h Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getArpa()

getArpa(string|\Zend_Locale  $locale = null) : string

Returns a RFC 822 compilant datestring from the date object.

This function does not return the RFC date as object. Use copy() instead.

Parameters

Returns

setArpa()

setArpa(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Sets a RFC 822 date as new date for the date object.

Only RFC 822 compilant date strings are accepted. For example: Sat, 14 Feb 09 00:31:30 +0100 Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addArpa()

addArpa(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Adds a RFC 822 date to the date object.

ARPA messages are used in emails or HTTP Headers. Only RFC 822 compilant date strings are accepted. For example: Sat, 14 Feb 09 00:31:30 +0100 Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subArpa()

subArpa(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer|\Zend_Date

Subtracts a RFC 822 date from the date object.

ARPA messages are used in emails or HTTP Headers. Only RFC 822 compilant date strings are accepted. For example: Sat, 14 Feb 09 00:31:30 +0100 Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareArpa()

compareArpa(string|integer|\Zend_Date  $date, string|\Zend_Locale  $locale = null) : integer

Compares a RFC 822 compilant date with the date object.

ARPA messages are used in emails or HTTP Headers. Only RFC 822 compilant date strings are accepted. For example: Sat, 14 Feb 09 00:31:30 +0100 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getSunrise()

getSunrise(  $location) : \Zend_Date

Returns the time of sunrise for this date and a given location as new date object For a list of cities and correct locations use the class Zend_Date_Cities

Parameters

Throws

\Zend_Date_Exception

Returns

getSunset()

getSunset(  $location) : \Zend_Date

Returns the time of sunset for this date and a given location as new date object For a list of cities and correct locations use the class Zend_Date_Cities

Parameters

Throws

\Zend_Date_Exception

Returns

getSunInfo()

getSunInfo(  $location) : array

Returns an array with the sunset and sunrise dates for all horizon types For a list of cities and correct locations use the class Zend_Date_Cities

Parameters

Throws

\Zend_Date_Exception

Returns

• [sunset|sunrise][effective|civil|nautic|astronomic]

checkLeapYear()

checkLeapYear(integer|array|\Zend_Date  $year) : boolean

Check a given year for leap year.

Parameters

Returns

isLeapYear()

isLeapYear() : boolean

Returns true, if the year is a leap year.

Returns

isToday()

isToday() : boolean

Returns if the set date is todays date

Returns

isYesterday()

isYesterday() : boolean

Returns if the set date is yesterdays date

Returns

isTomorrow()

isTomorrow() : boolean

Returns if the set date is tomorrows date

Returns

now()

now(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns the actual date as new date object

Parameters

Returns

getYear()

getYear(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns only the year from the date object as new object.

For example: 10.May.2000 10:30:00 -> 01.Jan.2000 00:00:00

Parameters

Returns

setYear()

setYear(  $year, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new year If the year is between 0 and 69, 2000 will be set (2000-2069) If the year if between 70 and 99, 1999 will be set (1970-1999) 3 or 4 digit years are set as expected. If you need to set year 0-99 use set() instead.

Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addYear()

addYear(  $year, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds the year to the existing date object If the year is between 0 and 69, 2000 will be added (2000-2069) If the year if between 70 and 99, 1999 will be added (1970-1999) 3 or 4 digit years are added as expected. If you need to add years from 0-99 use add() instead.

Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subYear()

subYear(  $year, string|\Zend_Locale  $locale = null) : \Zend_Date

Subs the year from the existing date object If the year is between 0 and 69, 2000 will be subtracted (2000-2069) If the year if between 70 and 99, 1999 will be subtracted (1970-1999) 3 or 4 digit years are subtracted as expected. If you need to subtract years from 0-99 use sub() instead.

Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareYear()

compareYear(string|integer|array|\Zend_Date  $year, string|\Zend_Locale  $locale = null) : integer

Compares the year with the existing date object, ignoring other date parts.

For example: 10.03.2000 -> 15.02.2000 -> true Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getMonth()

getMonth(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns only the month from the date object as new object.

For example: 10.May.2000 10:30:00 -> 01.May.1970 00:00:00

Parameters

Returns

setMonth()

setMonth(string|integer|array|\Zend_Date  $month, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new month The month can be a number or a string. Setting months lower then 0 and greater then 12 will result in adding or subtracting the relevant year. (12 months equal one year) If a localized monthname is given it will be parsed with the default locale or the optional set locale.

Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addMonth()

addMonth(string|integer|array|\Zend_Date  $month, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds months to the existing date object.

The month can be a number or a string. Adding months lower then 0 and greater then 12 will result in adding or subtracting the relevant year. (12 months equal one year) If a localized monthname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subMonth()

subMonth(string|integer|array|\Zend_Date  $month, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts months from the existing date object.

The month can be a number or a string. Subtracting months lower then 0 and greater then 12 will result in adding or subtracting the relevant year. (12 months equal one year) If a localized monthname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareMonth()

compareMonth(string|integer|array|\Zend_Date  $month, string|\Zend_Locale  $locale = null) : integer

Compares the month with the existing date object, ignoring other date parts.

For example: 10.03.2000 -> 15.03.1950 -> true Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getDay()

getDay(  $locale = null) : \Zend_Date

Returns the day as new date object Example: 20.May.1986 -> 20.Jan.1970 00:00:00

Parameters

Returns

setDay()

setDay(  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new day The day can be a number or a string. Setting days lower then 0 or greater than the number of this months days will result in adding or subtracting the relevant month.

If a localized dayname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object Example: setDay('Montag', 'de_AT'); will set the monday of this week as day.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addDay()

addDay(  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds days to the existing date object.

The day can be a number or a string. Adding days lower then 0 or greater than the number of this months days will result in adding or subtracting the relevant month. If a localized dayname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object Example: addDay('Montag', 'de_AT'); will add the number of days until the next monday

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subDay()

subDay(  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts days from the existing date object.

The day can be a number or a string. Subtracting days lower then 0 or greater than the number of this months days will result in adding or subtracting the relevant month. If a localized dayname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object Example: subDay('Montag', 'de_AT'); will sub the number of days until the previous monday

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareDay()

compareDay(string|integer|array|\Zend_Date  $day, string|\Zend_Locale  $locale = null) : integer

Compares the day with the existing date object, ignoring other date parts.

For example: 'Monday', 'en' -> 08.Jan.2007 -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getWeekday()

getWeekday(  $locale = null) : \Zend_Date

Returns the weekday as new date object Weekday is always from 1-7 Example: 09-Jan-2007 -> 2 = Tuesday -> 02-Jan-1970 (when 02.01.1970 is also Tuesday)

Parameters

Returns

setWeekday()

setWeekday(  $weekday, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new weekday The weekday can be a number or a string. If a localized weekday name is given, then it will be parsed as a date in $locale (defaults to the same locale as $this).

Returned is the new date object. Example: setWeekday(3); will set the wednesday of this week as day.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addWeekday()

addWeekday(  $weekday, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds weekdays to the existing date object.

The weekday can be a number or a string. If a localized dayname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object Example: addWeekday(3); will add the difference of days from the begining of the month until wednesday.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subWeekday()

subWeekday(  $weekday, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts weekdays from the existing date object.

The weekday can be a number or a string. If a localized dayname is given it will be parsed with the default locale or the optional set locale. Returned is the new date object Example: subWeekday(3); will subtract the difference of days from the begining of the month until wednesday.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareWeekday()

compareWeekday(string|integer|array|\Zend_Date  $weekday, string|\Zend_Locale  $locale = null) : integer

Compares the weekday with the existing date object, ignoring other date parts.

For example: 'Monday', 'en' -> 08.Jan.2007 -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getDayOfYear()

getDayOfYear(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns the day of year as new date object Example: 02.Feb.1986 10:00:00 -> 02.Feb.1970 00:00:00

Parameters

Returns

setDayOfYear()

setDayOfYear(string|integer|array|\Zend_Date  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new day of year The day of year is always a number.

Returned is the new date object Example: 04.May.2004 -> setDayOfYear(10) -> 10.Jan.2004

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addDayOfYear()

addDayOfYear(string|integer|array|\Zend_Date  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds a day of year to the existing date object.

The day of year is always a number. Returned is the new date object Example: addDayOfYear(10); will add 10 days to the existing date object.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subDayOfYear()

subDayOfYear(string|integer|array|\Zend_Date  $day, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts a day of year from the existing date object.

The day of year is always a number. Returned is the new date object Example: subDayOfYear(10); will subtract 10 days from the existing date object.

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareDayOfYear()

compareDayOfYear(string|integer|array|\Zend_Date  $day, string|\Zend_Locale  $locale = null) : integer

Compares the day of year with the existing date object.

For example: compareDayOfYear(33) -> 02.Feb.2007 -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getHour()

getHour(  $locale = null) : \Zend_Date

Returns the hour as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 10:00:00

Parameters

Returns

setHour()

setHour(string|integer|array|\Zend_Date  $hour, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new hour The hour is always a number.

Returned is the new date object Example: 04.May.1993 13:07:25 -> setHour(7); -> 04.May.1993 07:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addHour()

addHour(string|integer|array|\Zend_Date  $hour, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds hours to the existing date object.

The hour is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> addHour(12); -> 05.May.1993 01:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subHour()

subHour(string|integer|array|\Zend_Date  $hour, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts hours from the existing date object.

The hour is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> subHour(6); -> 05.May.1993 07:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareHour()

compareHour(string|integer|array|\Zend_Date  $hour, string|\Zend_Locale  $locale = null) : integer

Compares the hour with the existing date object.

For example: 10:30:25 -> compareHour(10) -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getMinute()

getMinute(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns the minute as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:30:00

Parameters

Returns

setMinute()

setMinute(string|integer|array|\Zend_Date  $minute, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new minute The minute is always a number.

Returned is the new date object Example: 04.May.1993 13:07:25 -> setMinute(29); -> 04.May.1993 13:29:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addMinute()

addMinute(string|integer|array|\Zend_Date  $minute, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds minutes to the existing date object.

The minute is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> addMinute(65); -> 04.May.1993 13:12:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subMinute()

subMinute(string|integer|array|\Zend_Date  $minute, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts minutes from the existing date object.

The minute is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> subMinute(9); -> 04.May.1993 12:58:25

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareMinute()

compareMinute(string|integer|array|\Zend_Date  $minute, string|\Zend_Locale  $locale = null) : integer

Compares the minute with the existing date object.

For example: 10:30:25 -> compareMinute(30) -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getSecond()

getSecond(string|\Zend_Locale  $locale = null) : \Zend_Date

Returns the second as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:00:25

Parameters

Returns

setSecond()

setSecond(string|integer|array|\Zend_Date  $second, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets new seconds to the existing date object.

The second is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> setSecond(100); -> 04.May.1993 13:08:40

Parameters

Throws

\Zend_Date_Exception

Returns

new date

addSecond()

addSecond(string|integer|array|\Zend_Date  $second, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds seconds to the existing date object.

The second is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> addSecond(65); -> 04.May.1993 13:08:30

Parameters

Throws

\Zend_Date_Exception

Returns

new date

subSecond()

subSecond(string|integer|array|\Zend_Date  $second, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts seconds from the existing date object.

The second is always a number. Returned is the new date object Example: 04.May.1993 13:07:25 -> subSecond(10); -> 04.May.1993 13:07:15

Parameters

Throws

\Zend_Date_Exception

Returns

new date

compareSecond()

compareSecond(string|integer|array|\Zend_Date  $second, string|\Zend_Locale  $locale = null) : integer

Compares the second with the existing date object.

For example: 10:30:25 -> compareSecond(25) -> 0 Returns if equal, earlier or later

Parameters

Throws

\Zend_Date_Exception

Returns

0 = equal, 1 = later, -1 = earlier

getFractionalPrecision()

getFractionalPrecision() : integer

Returns the precision for fractional seconds

Returns

setFractionalPrecision()

setFractionalPrecision(integer  $precision) : void

Sets a new precision for fractional seconds

Parameters

Throws

\Zend_Date_Exception

getMilliSecond()

getMilliSecond() : integer

Returns the milliseconds of the date object

Returns

setMilliSecond()

setMilliSecond(integer|\Zend_Date  $milli = null, integer  $precision = null) : integer|string

Sets new milliseconds for the date object Example: setMilliSecond(550, 2) -> equals +5 Sec +50 MilliSec

Parameters

Returns

addMilliSecond()

addMilliSecond(integer|\Zend_Date  $milli = null, integer  $precision = null) : integer|string

Adds milliseconds to the date object

Parameters

Returns

subMilliSecond()

subMilliSecond(integer|\Zend_Date  $milli = null, integer  $precision = null) : integer

Subtracts a millisecond

Parameters

Returns

compareMilliSecond()

compareMilliSecond(integer|\Zend_Date  $milli = null, integer  $precision = null) : integer

Compares only the millisecond part, returning the difference

Parameters

Returns

getWeek()

getWeek(  $locale = null) : \Zend_Date

Returns the week as new date object using monday as begining of the week Example: 12.Jan.2007 -> 08.Jan.1970 00:00:00

Parameters

Returns

setWeek()

setWeek(string|integer|array|\Zend_Date  $week, string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new week. The week is always a number. The day of week is not changed.

Returned is the new date object Example: 09.Jan.2007 13:07:25 -> setWeek(1); -> 02.Jan.2007 13:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

addWeek()

addWeek(string|integer|array|\Zend_Date  $week, string|\Zend_Locale  $locale = null) : \Zend_Date

Adds a week. The week is always a number. The day of week is not changed.

Returned is the new date object Example: 09.Jan.2007 13:07:25 -> addWeek(1); -> 16.Jan.2007 13:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

subWeek()

subWeek(string|integer|array|\Zend_Date  $week, string|\Zend_Locale  $locale = null) : \Zend_Date

Subtracts a week. The week is always a number. The day of week is not changed.

Returned is the new date object Example: 09.Jan.2007 13:07:25 -> subWeek(1); -> 02.Jan.2007 13:07:25

Parameters

Throws

\Zend_Date_Exception

Returns

compareWeek()

compareWeek(string|integer|array|\Zend_Date  $week, string|\Zend_Locale  $locale = null) : integer

Compares only the week part, returning the difference Returned is the new date object Returns if equal, earlier or later Example: 09.Jan.2007 13:07:25 -> compareWeek(2); -> 0

Parameters

Returns

0 = equal, 1 = later, -1 = earlier

setLocale()

setLocale(string|\Zend_Locale  $locale = null) : \Zend_Date

Sets a new standard locale for the date object.

This locale will be used for all functions Returned is the really set locale. Example: 'de_XX' will be set to 'de' because 'de_XX' does not exist 'xx_YY' will be set to 'root' because 'xx' does not exist

Parameters

Throws

\Zend_Date_Exception

When the given locale does not exist

Returns

Provides fluent interface

getLocale()

getLocale() : string

Returns the actual set locale

Returns

isDate()

isDate(string|array|\Zend_Date  $date, string  $format = null, string|\Zend_Locale  $locale = null) : boolean

Checks if the given date is a real date or datepart.

Returns false if a expected datepart is missing or a datepart exceeds its possible border. But the check will only be done for the expected dateparts which are given by format. If no format is given the standard dateformat for the actual locale is used. f.e. 30.February.2007 will return false if format is 'dd.MMMM.YYYY'

Parameters

Returns

True when all date parts are correct

setUnixTimestamp()

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

Set this object to have a new UNIX timestamp.

Parameters

Throws

\Zend_Date_Exception

Returns

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

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

Returns

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

Returns

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

Returns

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

Returns

dayOfWeek()

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

Returns the day of week for a Gregorian calendar date.

0 = sunday, 6 = saturday

Parameters

Returns

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

Returns

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

Returns

calcSun()

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

Calculates the sunrise or sunset based on a location

Parameters

Returns

• false: midnight sun, integer:

_getLocalizedToken()

_getLocalizedToken(string  $token, string  $locale) : string

Returns the ISO Token for all localized constants

Parameters

Returns

_range()

_range(float  $a, float  $b) 

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

Parameters

_timestamp()

_timestamp(string  $calc, string|integer|array|\Zend_Date  $stamp) : \Zend_Date|integer

Returns the calculated timestamp HINT: timestamps are always GMT

Parameters

Throws

\Zend_Date_Exception

Returns

_toToken()

_toToken(string  $part, string  $locale) : string

Internal method to apply tokens

Parameters

Returns

_parseIsoToDate()

_parseIsoToDate(string  $token, string  $locale) : string

Internal parsing method

Parameters

Returns

_toComment()

_toComment(string  $token) : string

Private function to make a comment of a token

Parameters

Returns

_getDigitFromName()

_getDigitFromName(string  $name) : integer

Return digit from standard names (english) Faster implementation than locale aware searching

Parameters

Throws

\Zend_Date_Exception

Returns

Number of this month

_assign()

_assign(string  $calc, string|integer  $date, string|integer  $comp, boolean|integer  $dst = false) : integer|string|\Zend_Date

Calculates the date or object

Parameters

Returns

new timestamp or Zend_Date depending on calculation

_calculate()

_calculate(string  $calc, string|integer|array|\Zend_Date  $date, string  $part, string|\Zend_Locale  $locale) : integer|string|\Zend_Date

Calculates the date or object

Parameters

Throws

\Zend_Date_Exception

Returns

new timestamp

_time()

_time(string  $calc, string|integer|array|\Zend_Date  $time, string  $format, string|\Zend_Locale  $locale) : integer|\Zend_Date

Returns the calculated time

Parameters

Throws

\Zend_Date_Exception

Returns

new time

_date()

_date(string  $calc, string|integer|array|\Zend_Date  $date, string  $format, string|\Zend_Locale  $locale) : integer|\Zend_Date

Returns the calculated date

Parameters

Throws

\Zend_Date_Exception

Returns

new date

_checkLocation()

_checkLocation(  $location) : \$horizon

Check if location is supported

Parameters

Returns

float

_calcdetail()

_calcdetail(string  $calc, string|integer|array|\Zend_Date  $date,   $type, string|\Zend_Locale  $locale) : integer|string

Calculate date details

Parameters

Throws

\Zend_Date_Exception

Returns

new date

_calcvalue()

_calcvalue(string  $calc, string|integer|\Zend_Date  $value,   $type,   $parameter, string|\Zend_Locale  $locale) : integer|\Zend_Date

Internal calculation, returns the requested date type

Parameters

Throws

\Zend_Date_Exception

Returns

new date

_month()

_month(string  $calc, string|integer|array|\Zend_Date  $month, string|\Zend_Locale  $locale) : integer|\Zend_Date

Returns the calculated month

Parameters

Throws

\Zend_Date_Exception

Returns

new time

_day()

_day(  $calc,   $day,   $locale) : \Zend_Date|integer

Returns the calculated day

Parameters

Returns

_weekday()

_weekday(  $calc,   $weekday,   $locale) : \Zend_Date|integer

Returns the calculated weekday

Parameters

Throws

\Zend_Date_Exception

Returns