static checkLeapYear (line 3366)

Check a given year for leap year.

• access: public

• integer|array|Zend_Date $year: Year to check

static isDate (line 4738)

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'

• return: True when all date parts are correct
• access: public

• string|array|Zend_Date $date: Date to parse for correctness
• string $format: (Optional) Format for parsing the date string
• string|Zend_Locale $locale: (Optional) Locale for parsing date parts

static setOptions (line 238)

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

• return: array if no option was given
• throws: Zend_Date_Exception
• access: public

• array $options: Options to set

add (line 1096)

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.

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Date or datepart to add
• string $part: OPTIONAL Part of the date to add, if null the timestamp is added
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

addDate (line 3020)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Date to add
• string $format: OPTIONAL Date format for parsing input
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

addDayOfYear (line 4125)

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.

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $day: Day of Year to add
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

addIso (line 3107)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date $date: ISO Date to add
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

addMinute (line 4291)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $minute: Minute to add
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

addSecond (line 4377)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $second: Second to add
• string|Zend_Locale $locale: (Optional) Locale for parsing input

addTimestamp (line 371)

Adds a timestamp

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• integer|string|array|Zend_Date $timestamp: Timestamp to add

addWeekday (line 4036)

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.

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $month: Weekday to add
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input
• $weekday

compare (line 1139)

Compares a date or datepart with the existing one.

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Date or datepart to compare with the date object
• string $part: OPTIONAL Part of the date to compare, if null the timestamp is subtracted
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

compareDate (line 3058)

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Date to compare
• string $format: OPTIONAL Date format for parsing input
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

compareDayOfYear (line 4158)

Compares the day of year with the existing date object.

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $day: Day of Year to compare
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

compareIso (line 3141)

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date $date: ISO Date to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

compareMinute (line 4324)

Compares the minute with the existing date object.

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $minute: Hour to compare
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

compareSecond (line 4410)

Compares the second with the existing date object.

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $second: Second to compare
• string|Zend_Locale $locale: (Optional) Locale for parsing input

compareTimestamp (line 395)

Compares two timestamps, returning the difference as integer

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• integer|string|array|Zend_Date $timestamp: Timestamp to compare

compareWeekday (line 4072)

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

• return: 0 = equal, 1 = later, -1 = earlier
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $weekday: Weekday to compare
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

copyPart (line 1169)

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).

• return: New clone with requested part
• access: public

• string $part: Part of the date to compare, if null the timestamp is subtracted
• string|Zend_Locale $locale: OPTIONAL New object's locale. No adjustments to timezone are made.

Constructor __construct (line 137)

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.

• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date|array $date: OPTIONAL Date value or value of date part to set ,depending on $part. If null the actual time is set
• string $part: OPTIONAL Defines the input format of $date
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

getArpa (line 3154)

Returns a RFC 822 compilant datestring from the date object.

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

• access: public

• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

getDay (line 3791)

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

• access: public

• $locale $locale: string|Zend_Locale OPTIONAL Locale for parsing input

getFractionalPrecision (line 4421)

Returns the precision for fractional seconds

• access: public

getIso (line 3073)

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.

• access: public

• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

getMilliSecond (line 4457)

Returns the milliseconds of the date object

• access: public

getMonth (line 3629)

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

• access: public

• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

getSunInfo (line 3330)

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

• return: - [sunset|sunrise][effective|civil|nautic|astronomic]
• throws: Zend_Date_Exception
• access: public

• $location $location: array - location of suninfo ['horizon'] -> civil, nautic, astronomical, effective (default) ['longitude'] -> longitude of location ['latitude'] -> latitude of location

getSunset (line 3310)

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

• throws: Zend_Date_Exception
• access: public

• $location $location: array - location of sunset ['horizon'] -> civil, nautic, astronomical, effective (default) ['longitude'] -> longitude of location ['latitude'] -> latitude of location

getTimestamp (line 311)

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.

• return: UNIX timestamp
• access: public

getWeek (line 4622)

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

• access: public

• $locale $locale: string|Zend_Locale OPTIONAL Locale for parsing input

getYear (line 3537)

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

• access: public

• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

isLater (line 2727)

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

• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Date or datepart to compare with
• string $part: OPTIONAL Part of the date to compare, if null the timestamp is used
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

isToday (line 3406)

Returns if the set date is todays date

• access: public

isYesterday (line 3419)

Returns if the set date is yesterdays date

• access: public

setArpa (line 3177)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date $date: RFC 822 to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

setDay (line 3868)

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.

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $month: Day to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input
• $day

setFractionalPrecision (line 4434)

Sets a new precision for fractional seconds

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• integer $precision: Precision for the fractional datepart 3 = milliseconds

setIso (line 3090)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date $date: ISO Date to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

setMilliSecond (line 4471)

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

• return: Provides fluid interface
• access: public

• integer|Zend_Date $milli: (Optional) Millisecond to set, when null the actual millisecond is set
• integer $precision: (Optional) Fraction precision of the given milliseconds

setMonth (line 3724)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $month: Month to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

setTime (line 2840)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $time: Time to set
• string $format: OPTIONAL Timeformat for parsing input
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

setWeek (line 4643)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $week: Week to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

setYear (line 3562)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Year to set
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input
• $year

subArpa (line 3213)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|Zend_Date $date: RFC 822 Date to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

subDay (line 3904)

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.

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $month: Day to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input
• $day

subHour (line 4222)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $hour: Hour to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

subMilliSecond (line 4560)

Subtracts a millisecond

• return: Provides fluid interface
• access: public

• integer|Zend_Date $milli: (Optional) Millisecond to sub, when null the actual millisecond is subtracted
• integer $precision: (Optional) Fractional precision for the given milliseconds

subMonth (line 3762)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $month: Month to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

subTime (line 2876)

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

• return: Provides fluid inteface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $time: Time to sub
• string $format: OPTIONAL Timeformat for parsing input
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

subWeek (line 4673)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $week: Week to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

subYear (line 3600)

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

• return: Provides fluid interface
• throws: Zend_Date_Exception
• access: public

• string|integer|array|Zend_Date $date: Year to sub
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input
• $year

toString (line 422)

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

• access: public

• string $format: OPTIONAL Rule for formatting output. If null the default date format is used
• string $type: OPTIONAL Type for the format string which overrides the standard setting
• string|Zend_Locale $locale: OPTIONAL Locale for parsing input

__toString (line 473)

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

• access: public