Date.php

Show:

inherited

Classes
- \Zend_Date

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Date
Version: $Id: Date.php 24880 2012-06-12 20:35:18Z matthew $

\Zend_Date
jump to top

Package: Zend\Date

Parent(s): \Zend_Date_DateObject
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                DAY
                = 'dd'

 
                DAY_SHORT
                = 'd'

 
                DAY_SUFFIX
                = 'SS'

 
                DAY_OF_YEAR
                = 'D'

 
                WEEKDAY
                = 'EEEE'

 
                WEEKDAY_SHORT
                = 'EEE'

 
                WEEKDAY_NARROW
                = 'E'

 
                WEEKDAY_NAME
                = 'EE'

 
                WEEKDAY_8601
                = 'eee'

 
                WEEKDAY_DIGIT
                = 'e'

 
                WEEK
                = 'ww'

 
                MONTH
                = 'MM'

 
                MONTH_SHORT
                = 'M'

 
                MONTH_DAYS
                = 'ddd'

 
                MONTH_NAME
                = 'MMMM'

 
                MONTH_NAME_SHORT
                = 'MMM'

 
                MONTH_NAME_NARROW
                = 'MMMMM'

 
                YEAR
                = 'y'

 
                YEAR_SHORT
                = 'yy'

 
                YEAR_8601
                = 'Y'

 
                YEAR_SHORT_8601
                = 'YY'

 
                LEAPYEAR
                = 'l'

 
                MERIDIEM
                = 'a'

 
                SWATCH
                = 'B'

 
                HOUR
                = 'HH'

 
                HOUR_SHORT
                = 'H'

 
                HOUR_AM
                = 'hh'

 
                HOUR_SHORT_AM
                = 'h'

 
                MINUTE
                = 'mm'

 
                MINUTE_SHORT
                = 'm'

 
                SECOND
                = 'ss'

 
                SECOND_SHORT
                = 's'

 
                MILLISECOND
                = 'S'

 
                TIMEZONE_NAME
                = 'zzzz'

 
                DAYLIGHT
                = 'I'

 
                GMT_DIFF
                = 'Z'

 
                GMT_DIFF_SEP
                = 'ZZZZ'

 
                TIMEZONE
                = 'z'

 
                TIMEZONE_SECS
                = 'X'

 
                ISO_8601
                = 'c'

 
                RFC_2822
                = 'r'

 
                TIMESTAMP
                = 'U'

 
                ERA
                = 'G'

 
                ERA_NAME
                = 'GGGG'

 
                ERA_NARROW
                = 'GGGGG'

 
                DATES
                = 'F'

 
                DATE_FULL
                = 'FFFFF'

 
                DATE_LONG
                = 'FFFF'

 
                DATE_MEDIUM
                = 'FFF'

 
                DATE_SHORT
                = 'FF'

 
                TIMES
                = 'WW'

 
                TIME_FULL
                = 'TTTTT'

 
                TIME_LONG
                = 'TTTT'

 
                TIME_MEDIUM
                = 'TTT'

 
                TIME_SHORT
                = 'TT'

 
                DATETIME
                = 'K'

 
                DATETIME_FULL
                = 'KKKKK'

 
                DATETIME_LONG
                = 'KKKK'

 
                DATETIME_MEDIUM
                = 'KKK'

 
                DATETIME_SHORT
                = 'KK'

 
                ATOM
                = 'OOO'

 
                COOKIE
                = 'CCC'

 
                RFC_822
                = 'R'

 
                RFC_850
                = 'RR'

 
                RFC_1036
                = 'RRR'

 
                RFC_1123
                = 'RRRR'

 
                RFC_3339
                = 'RRRRR'

 
                RSS
                = 'SSS'

 
                W3C
                = 'WWW'

Properties

$_cache = null

staticinheritedInherited from: \Zend_Date_DateObject::$$_cache

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_cache

$_cacheTags = false

staticinheritedInherited from: \Zend_Date_DateObject::$$_cacheTags

Default valuefalseDetails

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_cacheTags

$_defaultOffset = 0

staticinheritedInherited from: \Zend_Date_DateObject::$$_defaultOffset

Default value0Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_defaultOffset

$_dst = true

inheritedInherited from: \Zend_Date_DateObject::$$_dst

Default valuetrueDetails

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_dst

$_fractional = 0

Default value0Details

Type: n/a

$_locale = null

Default valuenullDetails

Type: n/a

$_monthTable = array(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31)

staticinherited

Table of Monthdays

Inherited from: \Zend_Date_DateObject::$$_monthTable

Default valuearray(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31)Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_monthTable

$_offset = 0

inheritedInherited from: \Zend_Date_DateObject::$$_offset

Default value0Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_offset

$_options = array('format_type' => 'iso', 'fix_dst' => true, 'extend_month' => false, 'cache' => null, 'timesync' => null)

static

Default valuearray('format_type' => 'iso', 'fix_dst' => true, 'extend_month' => false, 'cache' => null, 'timesync' => null)Details

Type: n/a

$_precision = 3

Default value3Details

Type: n/a

$_syncronised = 0

inheritedInherited from: \Zend_Date_DateObject::$$_syncronised

Default value0Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_syncronised

$_timezone = 'UTC'

inherited

active timezone

Inherited from: \Zend_Date_DateObject::$$_timezone

Default value'UTC'Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_timezone

$_unixTimestamp =

inherited

UNIX Timestamp

Inherited from: \Zend_Date_DateObject::$$_unixTimestamp

Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_unixTimestamp

$_yearTable = 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)

staticinherited

Table of Years

Inherited from: \Zend_Date_DateObject::$$_yearTable

Default value

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)

Details

Type: n/a
Inherited_from: \Zend_Date_DateObject::$$_yearTable

Methods

__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

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

Returns

Type	Description
\Zend_Date

Throws

Exception	Description
\Zend_Date_Exception

__toString() : string

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

Returns

Type	Description
string

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

Calculates the date or object

Parameters

Name	Type	Description
$calc	string	Calculation to make
$date	string \| integer	Date for calculation
$comp	string \| integer	Second date for calculation
$dst	boolean \| integer	Use dst correction if option is set

Returns

Type	Description
integer \| string \| \Zend_Date	new timestamp or Zend_Date depending on calculation

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

Calculate date details

Parameters

Name	Type	Description
$calc	string	Calculation to make
$date	string \| integer \| array \| \Zend_Date	Date or Part to calculate
$type
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| string	new date

Throws

Exception	Description
\Zend_Date_Exception

_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

Name	Type	Description
$calc	string	Calculation to make, one of: 'add'\|'sub'\|'cmp'\|'copy'\|'set'
$date	string \| integer \| array \| \Zend_Date	Date or datepart to calculate with
$part	string	Part of the date to calculate, if null the timestamp is used
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| string \| \Zend_Date	new timestamp

Throws

Exception	Description
\Zend_Date_Exception

_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

Name	Type	Description
$calc	string	Calculation to make
$value	string \| integer \| \Zend_Date	Datevalue to calculate with, if null the actual value is taken
$type
$parameter
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| \Zend_Date	new date

Throws

Exception	Description
\Zend_Date_Exception

_checkLocation(array $location) : \$horizon

Check if location is supported

Parameters

Name	Type	Description
$location	array	locations array

Returns

Type	Description
\$horizon	float

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

Returns the calculated date

Parameters

Name	Type	Description
$calc	string	Calculation to make
$date	string \| integer \| array \| \Zend_Date	Date to calculate with, if null the actual date is taken
$format	string	Date format for parsing
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| \Zend_Date	new date

Throws

Exception	Description
\Zend_Date_Exception

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

Returns the calculated day

Parameters

Name	Type	Description
$calc	string	Type of calculation to make
$day	\Zend_Date	Day to calculate, when null the actual day is calculated
$locale	\Zend_Locale	Locale for parsing input

Returns

Type	Description
\Zend_Date \| integer

_getDigitFromName(string $name) : integer

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
integer	Number of this month

Throws

Exception	Description
\Zend_Date_Exception

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

static

Returns the ISO Token for all localized constants

Parameters

Name	Type	Description
$token	string	Token to normalize
$locale	string	Locale to search

Returns

Type	Description
string

_getTagSupportForCache() : void

staticinherited

Internal method to check if the given cache supports tags

Inherited from: \Zend_Date_DateObject::_getTagSupportForCache()

_getTime(integer $sync = null) : integer

inherited

Internal function.

Inherited from: \Zend_Date_DateObject::_getTime()

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

Name	Type	Description
$sync	integer	OPTIONAL time syncronisation value

Returns

Type	Description
integer	timestamp

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

Returns the calculated month

Parameters

Name	Type	Description
$calc	string	Calculation to make
$month	string \| integer \| array \| \Zend_Date	Month to calculate with, if null the actual month is taken
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| \Zend_Date	new time

Throws

Exception	Description
\Zend_Date_Exception

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

Internal parsing method

Parameters

Name	Type	Description
$token	string
$locale	string

Returns

Type	Description
string

_range(float $a, float $b) : void

inherited

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

Inherited from: \Zend_Date_DateObject::_range()

Parameters

Name	Type	Description
$a	float	value to correct
$b	float	maximum range to set

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

Returns the calculated time

Parameters

Name	Type	Description
$calc	string	Calculation to make
$time	string \| integer \| array \| \Zend_Date	Time to calculate with, if null the actual time is taken
$format	string	Timeformat for parsing input
$locale	string \| \Zend_Locale	Locale for parsing input

Returns

Type	Description
integer \| \Zend_Date	new time

Throws

Exception	Description
\Zend_Date_Exception

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

Returns the calculated timestamp HINT: timestamps are always GMT

Parameters

Name	Type	Description
$calc	string	Type of calculation to make
$stamp	string \| integer \| array \| \Zend_Date	Timestamp to calculate, when null the actual timestamp is calculated

Returns

Type	Description
\Zend_Date \| integer

Throws

Exception	Description
\Zend_Date_Exception

_toComment(string $token) : string

Private function to make a comment of a token

Parameters

Name	Type	Description
$token	string

Returns

Type	Description
string

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

Internal method to apply tokens

Parameters

Name	Type	Description
$part	string
$locale	string

Returns

Type	Description
string

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

Returns the calculated weekday

Parameters

Name	Type	Description
$calc	string	Type of calculation to make
$weekday	\Zend_Date	Weekday to calculate, when null the actual weekday is calculated
$locale	\Zend_Locale	Locale for parsing input

Returns

Type	Description
\Zend_Date \| integer

Throws

Exception	Description
\Zend_Date_Exception

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

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

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

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

addArpa(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	RFC 822 Date to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date to add
$format	string	OPTIONAL Date format for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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.

Parameters

Name	Type	Description
$day
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day	string \| integer \| array \| \Zend_Date	Day of Year to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$hour	string \| integer \| array \| \Zend_Date	Hour to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

addIso(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	ISO Date to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Adds milliseconds to the date object

Parameters

Name	Type	Description
$milli	integer \| \Zend_Date	(Optional) Millisecond to add, when null the actual millisecond is added
$precision	integer	(Optional) Fractional precision for the given milliseconds

Returns

Type	Description
\Zend_Date	Provides fluid interface

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

Name	Type	Description
$minute	string \| integer \| array \| \Zend_Date	Minute to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$month	string \| integer \| array \| \Zend_Date	Month to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$second	string \| integer \| array \| \Zend_Date	Second to add
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$time	string \| integer \| array \| \Zend_Date	Time to add
$format	string	OPTIONAL Timeformat for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Adds a timestamp

Parameters

Name	Type	Description
$timestamp	integer \| string \| array \| \Zend_Date	Timestamp to add

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$week	string \| integer \| array \| \Zend_Date	Week to add
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$weekday
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$year
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

inherited

Calculates the sunrise or sunset based on a location

Inherited from: \Zend_Date_DateObject::calcSun()

Parameters

Name	Type	Description
$location	array	Location for calculation MUST include 'latitude', 'longitude', 'horizon'
$horizon	bool	true: sunrise; false: sunset
$rise

Returns

Type	Description
mixed	- false: midnight sun, integer:

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

static

Check a given year for leap year.

Parameters

Name	Type	Description
$year	integer \| array \| \Zend_Date	Year to check

Returns

Type	Description
boolean

compare(string | integer | array | \Zend_Date $date, string $part = self::TIMESTAMP, 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

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

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$date	string \| integer \| \Zend_Date	RFC 822 Date to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

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

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date to compare
$format	string	OPTIONAL Date format for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day	string \| integer \| array \| \Zend_Date	Day to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day	string \| integer \| array \| \Zend_Date	Day of Year to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$hour	string \| integer \| array \| \Zend_Date	Hour to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$date	string \| integer \| \Zend_Date	ISO Date to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Compares only the millisecond part, returning the difference

Parameters

Name	Type	Description
$milli	integer \| \Zend_Date	OPTIONAL Millisecond to compare, when null the actual millisecond is compared
$precision	integer	OPTIONAL Fractional precision for the given milliseconds

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception	On invalid input

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

Name	Type	Description
$minute	string \| integer \| array \| \Zend_Date	Hour to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$month	string \| integer \| array \| \Zend_Date	Month to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$second	string \| integer \| array \| \Zend_Date	Second to compare
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$time	string \| integer \| array \| \Zend_Date	Time to compare
$format	string	OPTIONAL Timeformat for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Compares two timestamps, returning the difference as integer

Parameters

Name	Type	Description
$timestamp	integer \| string \| array \| \Zend_Date	Timestamp to compare

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$week	string \| integer \| array \| \Zend_Date	Week to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

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

Name	Type	Description
$weekday	string \| integer \| array \| \Zend_Date	Weekday to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$year	string \| integer \| array \| \Zend_Date	Year to compare
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
integer	0 = equal, 1 = later, -1 = earlier

Throws

Exception	Description
\Zend_Date_Exception

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

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

Returns

Type	Description
\Zend_Date	New clone with requested part

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

inherited

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

Inherited from: \Zend_Date_DateObject::date()

Returns a formatted date for a given timestamp.

Parameters

Name	Type	Description
$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

Type	Description
string

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

staticinherited

Returns the day of week for a Gregorian calendar date.

Inherited from: \Zend_Date_DateObject::dayOfWeek()

0 = sunday, 6 = saturday

Parameters

Name	Type	Description
$year	integer
$month	integer
$day	integer

Returns

Type	Description
integer	dayOfWeek

equals(string | integer | array | \Zend_Date $date, string $part = self::TIMESTAMP, 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

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

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$part	string	OPTIONAL Part of the date to return, if null the timestamp is returned
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
string	date or datepart

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
string

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

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

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

inherited

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

Inherited from: \Zend_Date_DateObject::getDateParts()

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

Name	Type	Description
$timestamp	mixed
$fast	boolean	OPTIONAL defaults to fast (false), resulting in fewer date parts

Returns

Type	Description
array

getDay(\Zend_Locale $locale = null) : \Zend_Date

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

Parameters

Name	Type	Description
$locale	\Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

getFractionalPrecision() : integer

Returns the precision for fractional seconds

Returns

Type	Description
integer

getFullYear(integer $value) : integer

static

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

Parameters

Name	Type	Description
$value	integer	year number

Returns

Type	Description
integer	Number of year

getGmtOffset() : integer

inherited

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

Inherited from: \Zend_Date_DateObject::getGmtOffset()

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

Returns

Type	Description
integer	seconds difference between GMT timezone and timezone when object was instantiated

getHour(\Zend_Locale $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

Name	Type	Description
$locale	\Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
string

getLocale() : string

Returns the actual set locale

Returns

Type	Description
string

getMilliSecond() : string

Returns the milliseconds of the date object

Returns

Type	Description
string

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

getSunInfo(array $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

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

Returns

Type	Description
array	- [sunset\|sunrise][effective\|civil\|nautic\|astronomic]

Throws

Exception	Description
\Zend_Date_Exception

getSunrise(array $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

Name	Type	Description
$location	array	location of sunrise ['horizon'] -> civil, nautic, astronomical, effective (default) ['longitude'] -> longitude of location ['latitude'] -> latitude of location

Returns

Type	Description
\Zend_Date

Throws

Exception	Description
\Zend_Date_Exception

getSunset(array $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

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

Returns

Type	Description
\Zend_Date

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Type	Description
integer \| string	UNIX timestamp

getTimezone() : string

inherited

Return the timezone of $this object.

Inherited from: \Zend_Date_DateObject::getTimezone()

The timezone is initially set when the object is instantiated.

Returns

Type	Description
string	actual set timezone string

getTimezoneFromString(string $zone) : integer

Internal function, returns the offset of a given timezone

Parameters

Name	Type	Description
$zone	string

Returns

Type	Description
integer

getUnixTimestamp() : integer | string

inherited

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.

Inherited from: \Zend_Date_DateObject::getUnixTimestamp()

Use copy() instead.

Returns

Type	Description
integer \| string	timestamp

getWeek(\Zend_Locale $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

Name	Type	Description
$locale	\Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

getWeekday(\Zend_Locale $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

Name	Type	Description
$locale	\Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

static

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

Name	Type	Description
$date	string \| array \| \Zend_Date	Date to parse for correctness
$format	string	(Optional) Format for parsing the date string
$locale	string \| \Zend_Locale	(Optional) Locale for parsing date parts

Returns

Type	Description
boolean	True when all date parts are correct

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

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

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Date_Exception

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

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

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Date_Exception

isLeapYear() : boolean

Returns true, if the year is a leap year.

Returns

Type	Description
boolean

isToday() : boolean

Returns if the set date is todays date

Returns

Type	Description
boolean

isTomorrow() : boolean

Returns if the set date is tomorrows date

Returns

Type	Description
boolean

isYearLeapYear(integer $year) : boolean

staticinherited

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

Inherited from: \Zend_Date_DateObject::isYearLeapYear()

Parameters

Name	Type	Description
$year	integer

Returns

Type	Description
boolean	true, if year is leap year

isYesterday() : boolean

Returns if the set date is yesterdays date

Returns

Type	Description
boolean

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

inherited

Internal mktime function used by Zend_Date.

Inherited from: \Zend_Date_DateObject::mktime()

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

Name	Type	Description
$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

Type	Description
integer \| float	timestamp (number of seconds elapsed relative to 1970/01/01 00:00:00 GMT/UTC)

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

static

Returns the actual date as new date object

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date

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

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

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date or datepart to set
$part	string	OPTIONAL Part of the date to set, if null the timestamp is set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

setArpa(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	RFC 822 to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

setDate(string | integer | array | \Zend_Date $date, string $format = null, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date to set
$format	string	OPTIONAL Date format for parsing
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day	string \| integer \| array \| \Zend_Date	Day of Year to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

setFractionalPrecision(integer $precision) : \Zend_Date

Sets a new precision for fractional seconds

Parameters

Name	Type	Description
$precision	integer	Precision for the fractional datepart 3 = milliseconds

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$hour	string \| integer \| array \| \Zend_Date	Hour to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

setIso(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	ISO Date to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluent interface

Throws

Exception	Description
\Zend_Date_Exception	When the given locale does not exist

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

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

Parameters

Name	Type	Description
$milli	integer \| \Zend_Date	(Optional) Millisecond to set, when null the actual millisecond is set
$precision	integer	(Optional) Fraction precision of the given milliseconds

Returns

Type	Description
\Zend_Date	Provides fluid interface

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

Name	Type	Description
$minute	string \| integer \| array \| \Zend_Date	Minute to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$month	string \| integer \| array \| \Zend_Date	Month to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

static

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

Parameters

Name	Type	Description
$options	array	Options to set

Returns

Type	Description
\Options	array if no option was given

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$second	string \| integer \| array \| \Zend_Date	Second to set
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$time	string \| integer \| array \| \Zend_Date	Time to set
$format	string	OPTIONAL Timeformat for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Sets a new timestamp

Parameters

Name	Type	Description
$timestamp	integer \| string \| array \| \Zend_Date	Timestamp to set

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

setTimezone(string $zone = null) : \Zend_Date_DateObject

inherited

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

Inherited from: \Zend_Date_DateObject::setTimezone()

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

Name	Type	Description
$zone	string	OPTIONAL timezone for date calculation; defaults to date_default_timezone_get()

Returns

Type	Description
\Zend_Date_DateObject	Provides fluent interface

Throws

Exception	Description
\Zend_Date_Exception

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

inherited

Set this object to have a new UNIX timestamp.

Inherited from: \Zend_Date_DateObject::setUnixTimestamp()

Parameters

Name	Type	Description
$timestamp	string \| integer	OPTIONAL timestamp; defaults to local time using time()

Returns

Type	Description
string \| integer	old timestamp

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$week	string \| integer \| array \| \Zend_Date	Week to set
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$weekday
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$year
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

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

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date or datepart to subtract
$part	string	OPTIONAL Part of the date to sub, if null the timestamp is subtracted
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

subArpa(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	RFC 822 Date to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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.

Parameters

Name	Type	Description
$date	string \| integer \| array \| \Zend_Date	Date to sub
$format	string	OPTIONAL Date format for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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.

Parameters

Name	Type	Description
$day
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$day	string \| integer \| array \| \Zend_Date	Day of Year to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$hour	string \| integer \| array \| \Zend_Date	Hour to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

subIso(string | integer | \Zend_Date $date, string | \Zend_Locale $locale = null) : \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

Name	Type	Description
$date	string \| integer \| \Zend_Date	ISO Date to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Subtracts a millisecond

Parameters

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

Returns

Type	Description
\Zend_Date	Provides fluid interface

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

Name	Type	Description
$minute	string \| integer \| array \| \Zend_Date	Minute to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$month	string \| integer \| array \| \Zend_Date	Month to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$second	string \| integer \| array \| \Zend_Date	Second to sub
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Subtracts a time from the existing date.

Parameters

Name	Type	Description
$time	string \| integer \| array \| \Zend_Date	Time to sub
$format	string	OPTIONAL Timeformat for parsing input
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid inteface

Throws

Exception	Description
\Zend_Date_Exception

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

Subtracts a timestamp

Parameters

Name	Type	Description
$timestamp	integer \| string \| array \| \Zend_Date	Timestamp to sub

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$week	string \| integer \| array \| \Zend_Date	Week to sub
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$weekday
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

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

Name	Type	Description
$year
$locale	string \| \Zend_Locale	OPTIONAL Locale for parsing input

Returns

Type	Description
\Zend_Date	Provides fluid interface

Throws

Exception	Description
\Zend_Date_Exception

toArray() : array

Returns an array representation of the object

Returns

Type	Description
array

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

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

Returns

Type	Description
string

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

Name	Type	Description
$part	string \| integer \| \Zend_Date	OPTIONAL Defines the date or datepart to return as integer

Returns

Type	Description
integer \| false

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

inherited

Internal getWeekNumber function for handling 64bit timestamps

Inherited from: \Zend_Date_DateObject::weekNumber()

Returns the ISO 8601 week number of a given date

Parameters

Name	Type	Description
$year	integer
$month	integer
$day	integer

Returns

Type	Description
integer

Date.php

\Zend_Datejump to top

Constants

Properties

Methods

\Zend_Date
jump to top