Public Member Functions
	__construct ($date=null, $part=null, $locale=null)
	Generates the standard date object, could be a unix timestamp, localized date, string, integer, array and so on.

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

	setTimestamp ($timestamp)
	Sets a new timestamp.

	addTimestamp ($timestamp)
	Adds a timestamp.

	subTimestamp ($timestamp)
	Subtracts a timestamp.

	compareTimestamp ($timestamp)
	Compares two timestamps, returning the difference as integer.

	toString ($format=null, $type=null, $locale=null)
	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.

	__toString ()
	Returns a string representation of the date which is equal with the timestamp.

	toValue ($part=null)
	Returns a integer representation of the object But returns false when the given part is no value f.e.

	toArray ()
	Returns an array representation of the object.

	get ($part=null, $locale=null)
	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.

	set ($date, $part=null, $locale=null)
	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.

	add ($date, $part=self::TIMESTAMP, $locale=null)
	Adds a date or datepart to the existing date, by extracting $part from $date, and modifying this object by adding that part.

	sub ($date, $part=self::TIMESTAMP, $locale=null)
	Subtracts a date from another date.

	compare ($date, $part=self::TIMESTAMP, $locale=null)
	Compares a date or datepart with the existing one.

	copyPart ($part, $locale=null)
	Returns a new instance of Zend_Date with the selected part copied.

	getTimezoneFromString ($zone)
	Internal function, returns the offset of a given timezone.

	equals ($date, $part=self::TIMESTAMP, $locale=null)
	Returns true when both date objects or date parts are equal.

	isEarlier ($date, $part=null, $locale=null)
	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.

	isLater ($date, $part=null, $locale=null)
	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.

	getTime ($locale=null)
	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.

	setTime ($time, $format=null, $locale=null)
	Sets a new time for the date object.

	addTime ($time, $format=null, $locale=null)
	Adds a time to the existing date.

	subTime ($time, $format=null, $locale=null)
	Subtracts a time from the existing date.

	compareTime ($time, $format=null, $locale=null)
	Compares the time from the existing date.

	getDate ($locale=null)
	Returns a clone of $this, with the time part set to 00:00:00.

	setDate ($date, $format=null, $locale=null)
	Sets a new date for the date object.

	addDate ($date, $format=null, $locale=null)
	Adds a date to the existing date object.

	subDate ($date, $format=null, $locale=null)
	Subtracts a date from the existing date object.

	compareDate ($date, $format=null, $locale=null)
	Compares the date from the existing date object, ignoring the time.

	getIso ($locale=null)
	Returns the full ISO 8601 date from the date object.

	setIso ($date, $locale=null)
	Sets a new date for the date object.

	addIso ($date, $locale=null)
	Adds a ISO date to the date object.

	subIso ($date, $locale=null)
	Subtracts a ISO date from the date object.

	compareIso ($date, $locale=null)
	Compares a ISO date with the date object.

	getArpa ($locale=null)
	Returns a RFC 822 compilant datestring from the date object.

	setArpa ($date, $locale=null)
	Sets a RFC 822 date as new date for the date object.

	addArpa ($date, $locale=null)
	Adds a RFC 822 date to the date object.

	subArpa ($date, $locale=null)
	Subtracts a RFC 822 date from the date object.

	compareArpa ($date, $locale=null)
	Compares a RFC 822 compilant date with the date object.

	getSunrise ($location)
	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.

	getSunset ($location)
	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.

	getSunInfo ($location)
	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.

	isLeapYear ()
	Returns true, if the year is a leap year.

	isToday ()
	Returns if the set date is todays date.

	isYesterday ()
	Returns if the set date is yesterdays date.

	isTomorrow ()
	Returns if the set date is tomorrows date.

	getYear ($locale=null)
	Returns only the year from the date object as new object.

	setYear ($year, $locale=null)
	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.

	addYear ($year, $locale=null)
	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.

	subYear ($year, $locale=null)
	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.

	compareYear ($year, $locale=null)
	Compares the year with the existing date object, ignoring other date parts.

	getMonth ($locale=null)
	Returns only the month from the date object as new object.

	setMonth ($month, $locale=null)
	Sets a new month The month can be a number or a string.

	addMonth ($month, $locale=null)
	Adds months to the existing date object.

	subMonth ($month, $locale=null)
	Subtracts months from the existing date object.

	compareMonth ($month, $locale=null)
	Compares the month with the existing date object, ignoring other date parts.

	getDay ($locale=null)
	Returns the day as new date object Example: 20.May.1986 -> 20.Jan.1970 00:00:00.

	setDay ($day, $locale=null)
	Sets a new day The day can be a number or a string.

	addDay ($day, $locale=null)
	Adds days to the existing date object.

	subDay ($day, $locale=null)
	Subtracts days from the existing date object.

	compareDay ($day, $locale=null)
	Compares the day with the existing date object, ignoring other date parts.

	getWeekday ($locale=null)
	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)

	setWeekday ($weekday, $locale=null)
	Sets a new weekday The weekday can be a number or a string.

	addWeekday ($weekday, $locale=null)
	Adds weekdays to the existing date object.

	subWeekday ($weekday, $locale=null)
	Subtracts weekdays from the existing date object.

	compareWeekday ($weekday, $locale=null)
	Compares the weekday with the existing date object, ignoring other date parts.

	getDayOfYear ($locale=null)
	Returns the day of year as new date object Example: 02.Feb.1986 10:00:00 -> 02.Feb.1970 00:00:00.

	setDayOfYear ($day, $locale=null)
	Sets a new day of year The day of year is always a number.

	addDayOfYear ($day, $locale=null)
	Adds a day of year to the existing date object.

	subDayOfYear ($day, $locale=null)
	Subtracts a day of year from the existing date object.

	compareDayOfYear ($day, $locale=null)
	Compares the day of year with the existing date object.

	getHour ($locale=null)
	Returns the hour as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 10:00:00.

	setHour ($hour, $locale=null)
	Sets a new hour The hour is always a number.

	addHour ($hour, $locale=null)
	Adds hours to the existing date object.

	subHour ($hour, $locale=null)
	Subtracts hours from the existing date object.

	compareHour ($hour, $locale=null)
	Compares the hour with the existing date object.

	getMinute ($locale=null)
	Returns the minute as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:30:00.

	setMinute ($minute, $locale=null)
	Sets a new minute The minute is always a number.

	addMinute ($minute, $locale=null)
	Adds minutes to the existing date object.

	subMinute ($minute, $locale=null)
	Subtracts minutes from the existing date object.

	compareMinute ($minute, $locale=null)
	Compares the minute with the existing date object.

	getSecond ($locale=null)
	Returns the second as new date object Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:00:25.

	setSecond ($second, $locale=null)
	Sets new seconds to the existing date object.

	addSecond ($second, $locale=null)
	Adds seconds to the existing date object.

	subSecond ($second, $locale=null)
	Subtracts seconds from the existing date object.

	compareSecond ($second, $locale=null)
	Compares the second with the existing date object.

	getFractionalPrecision ()
	Returns the precision for fractional seconds.

	setFractionalPrecision ($precision)
	Sets a new precision for fractional seconds.

	getMilliSecond ()
	Returns the milliseconds of the date object.

	setMilliSecond ($milli=null, $precision=null)
	Sets new milliseconds for the date object Example: setMilliSecond(550, 2) -> equals +5 Sec +50 MilliSec.

	addMilliSecond ($milli=null, $precision=null)
	Adds milliseconds to the date object.

	subMilliSecond ($milli=null, $precision=null)
	Subtracts a millisecond.

	compareMilliSecond ($milli=null, $precision=null)
	Compares only the millisecond part, returning the difference.

	getWeek ($locale=null)
	Returns the week as new date object using monday as begining of the week Example: 12.Jan.2007 -> 08.Jan.1970 00:00:00.

	setWeek ($week, $locale=null)
	Sets a new week.

	addWeek ($week, $locale=null)
	Adds a week.

	subWeek ($week, $locale=null)
	Subtracts a week.

	compareWeek ($week, $locale=null)
	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.

	setLocale ($locale=null)
	Sets a new standard locale for the date object.

	getLocale ()
	Returns the actual set locale.

Public Member Functions inherited from Zend_Date_DateObject
	setTimezone ($zone=null)
	Sets a new timezone for calculation of $this object's gmt offset.

	getTimezone ()
	Return the timezone of $this object.

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

Static Public Member Functions
static	setOptions (array $options=array())
	Sets class wide options, if no option was given, the actual set options will be returned.

static	getFullYear ($value)
	Counts the exact year number < 70 - 2000 added, >70 < 100 - 1900, others just returned.

static	checkLeapYear ($year)
	Check a given year for leap year.

static	now ($locale=null)
	Returns the actual date as new date object.

static	isDate ($date, $format=null, $locale=null)
	Checks if the given date is a real date or datepart.

Public Attributes
const	DAY = 'dd'

const	DAY_SHORT = 'd'

const	DAY_SUFFIX = 'SS'

const	DAY_OF_YEAR = 'D'

const	WEEKDAY = 'EEEE'

const	WEEKDAY_SHORT = 'EEE'

const	WEEKDAY_NARROW = 'E'

const	WEEKDAY_NAME = 'EE'

const	WEEKDAY_8601 = 'eee'

const	WEEKDAY_DIGIT = 'e'

const	WEEK = 'ww'

const	MONTH = 'MM'

const	MONTH_SHORT = 'M'

const	MONTH_DAYS = 'ddd'

const	MONTH_NAME = 'MMMM'

const	MONTH_NAME_SHORT = 'MMM'

const	MONTH_NAME_NARROW = 'MMMMM'

const	YEAR = 'y'

const	YEAR_SHORT = 'yy'

const	YEAR_8601 = 'Y'

const	YEAR_SHORT_8601 = 'YY'

const	LEAPYEAR = 'l'

const	MERIDIEM = 'a'

const	SWATCH = 'B'

const	HOUR = 'HH'

const	HOUR_SHORT = 'H'

const	HOUR_AM = 'hh'

const	HOUR_SHORT_AM = 'h'

const	MINUTE = 'mm'

const	MINUTE_SHORT = 'm'

const	SECOND = 'ss'

const	SECOND_SHORT = 's'

const	MILLISECOND = 'S'

const	TIMEZONE_NAME = 'zzzz'

const	DAYLIGHT = 'I'

const	GMT_DIFF = 'Z'

const	GMT_DIFF_SEP = 'ZZZZ'

const	TIMEZONE = 'z'

const	TIMEZONE_SECS = 'X'

const	ISO_8601 = 'c'

const	RFC_2822 = 'r'

const	TIMESTAMP = 'U'

const	ERA = 'G'

const	ERA_NAME = 'GGGG'

const	ERA_NARROW = 'GGGGG'

const	DATES = 'F'

const	DATE_FULL = 'FFFFF'

const	DATE_LONG = 'FFFF'

const	DATE_MEDIUM = 'FFF'

const	DATE_SHORT = 'FF'

const	TIMES = 'WW'

const	TIME_FULL = 'TTTTT'

const	TIME_LONG = 'TTTT'

const	TIME_MEDIUM = 'TTT'

const	TIME_SHORT = 'TT'

const	DATETIME = 'K'

const	DATETIME_FULL = 'KKKKK'

const	DATETIME_LONG = 'KKKK'

const	DATETIME_MEDIUM = 'KKK'

const	DATETIME_SHORT = 'KK'

const	ATOM = 'OOO'

const	COOKIE = 'CCC'

const	RFC_822 = 'R'

const	RFC_850 = 'RR'

const	RFC_1036 = 'RRR'

const	RFC_1123 = 'RRRR'

const	RFC_3339 = 'RRRRR'

const	RSS = 'SSS'

const	W3C = 'WWW'

Static Protected Member Functions
static	_getLocalizedToken ($token, $locale)
	Returns the ISO Token for all localized constants.

Static Protected Member Functions inherited from Zend_Date_DateObject
static	isYearLeapYear ($year)
	Returns true, if given $year is a leap year.

static	dayOfWeek ($year, $month, $day)
	Returns the day of week for a Gregorian calendar date.

static	_getTagSupportForCache ()
	Internal method to check if the given cache supports tags.

Additional Inherited Members
Protected Member Functions inherited from Zend_Date_DateObject
	setUnixTimestamp ($timestamp=null)
	Set this object to have a new UNIX timestamp.

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

	_getTime ($sync=null)
	Internal function.

	mktime ($hour, $minute, $second, $month, $day, $year, $gmt=false)
	Internal mktime function used by Zend_Date.

	date ($format, $timestamp=null, $gmt=false)
	Internal mktime function used by Zend_Date for handling 64bit timestamps.

	getDateParts ($timestamp=null, $fast=null)
	Internal getDateParts function for handling 64bit timestamps, similar to: http://www.php.net/getdate.

	weekNumber ($year, $month, $day)
	Internal getWeekNumber function for handling 64bit timestamps.

	calcSun ($location, $horizon, $rise=false)
	Calculates the sunrise or sunset based on a location.

Protected Attributes inherited from Zend_Date_DateObject
	$_dst = true

Static Protected Attributes inherited from Zend_Date_DateObject
static	$_cache = null

static	$_cacheTags = false

static	$_defaultOffset = 0

Constructor & Destructor Documentation

__construct	(	$date = `null`,
		$part = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date

Exceptions

Zend_Date_Exception

Member Function Documentation

__toString ( )

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

Returns: string

static _getLocalizedToken	(	$token,
		$locale
	)

staticprotected

Returns the ISO Token for all localized constants.

Parameters

string	$token	Token to normalize
string	$locale	Locale to search

Returns: string

add	(	$date,
		$part = `self::TIMESTAMP`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addArpa	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addDate	(	$date,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addDay	(	$day,
		$locale = `null`
	)

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

string \| integer \| array \| Zend_Date	$month	Day to add
string \| Zend_Locale	$locale	OPTIONAL Locale for parsing input

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addDayOfYear	(	$day,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addHour	(	$hour,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addIso	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addMilliSecond	(	$milli = `null`,
		$precision = `null`
	)

Adds milliseconds to the date object.

Parameters

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

Returns: Zend_Date Provides fluid interface

addMinute	(	$minute,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addMonth	(	$month,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addSecond	(	$second,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addTime	(	$time,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addTimestamp ( $timestamp )

Adds a timestamp.

Parameters

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addWeek	(	$week,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addWeekday	(	$weekday,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

addYear	(	$year,
		$locale = `null`
	)

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

string \| integer \| array \| Zend_Date	$date	Year to add
string \| Zend_Locale	$locale	OPTIONAL Locale for parsing input

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

static checkLeapYear ( $year )

static

Check a given year for leap year.

Parameters

integer | array | Zend_Date $year Year to check

Returns: boolean

compare	(	$date,
		$part = `self::TIMESTAMP`,
		$locale = `null`
	)

Compares a date or datepart with the existing one.

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

Parameters

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareArpa	(	$date,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareDate	(	$date,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareDay	(	$day,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareDayOfYear	(	$day,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareHour	(	$hour,
		$locale = `null`
	)

Compares the hour with the existing date object.

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

Parameters

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareIso	(	$date,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareMilliSecond	(	$milli = `null`,
		$precision = `null`
	)

Compares only the millisecond part, returning the difference.

Parameters

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

Exceptions

Zend_Date_Exception On invalid input

Returns: integer 0 = equal, 1 = later, -1 = earlier

compareMinute	(	$minute,
		$locale = `null`
	)

Compares the minute with the existing date object.

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

Parameters

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareMonth	(	$month,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareSecond	(	$second,
		$locale = `null`
	)

Compares the second with the existing date object.

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

Parameters

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareTime	(	$time,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareTimestamp ( $timestamp )

Compares two timestamps, returning the difference as integer.

Parameters

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareWeek	(	$week,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

compareWeekday	(	$weekday,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

compareYear	(	$year,
		$locale = `null`
	)

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

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

Returns: integer 0 = equal, 1 = later, -1 = earlier

Exceptions

Zend_Date_Exception

copyPart	(	$part,
		$locale = `null`
	)

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

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.

Returns: Zend_Date New clone with requested part

equals	(	$date,
		$part = `self::TIMESTAMP`,
		$locale = `null`
	)

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

string \| integer \| array \| Zend_Date	$date	Date or datepart to equal 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

Returns: boolean

Exceptions

Zend_Date_Exception

get	(	$part = `null`,
		$locale = `null`
	)

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

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

Returns: string date or datepart

getArpa ( $locale = null )

Returns a RFC 822 compilant datestring from the date object.

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

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: string

getDate ( $locale = null )

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

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getDay ( $locale = null )

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

Parameters

Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getDayOfYear ( $locale = null )

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

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getFractionalPrecision ( )

Returns the precision for fractional seconds.

Returns: integer

static getFullYear ( $value )

static

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

Parameters

integer $value year number

Returns: integer Number of year

getHour ( $locale = null )

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

Parameters

Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getIso ( $locale = null )

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

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: string

getLocale ( )

Returns the actual set locale.

Returns: string

getMilliSecond ( )

Returns the milliseconds of the date object.

Returns: string

getMinute ( $locale = null )

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

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getMonth ( $locale = null )

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

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getSecond ( $locale = null )

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

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getSunInfo ( $location )

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

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

Returns: array - [sunset|sunrise][effective|civil|nautic|astronomic]

Exceptions

Zend_Date_Exception

getSunrise ( $location )

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

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

Returns: Zend_Date

Exceptions

Zend_Date_Exception

getSunset ( $location )

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

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

Returns: Zend_Date

Exceptions

Zend_Date_Exception

getTime ( $locale = null )

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

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getTimestamp ( )

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: integer|string UNIX timestamp

getTimezoneFromString ( $zone )

Internal function, returns the offset of a given timezone.

Parameters

string $zone

Returns: integer

getWeek ( $locale = null )

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

Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getWeekday ( $locale = null )

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

Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

getYear ( $locale = null )

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

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

static isDate	(	$date,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: boolean True when all date parts are correct

isEarlier	(	$date,
		$part = `null`,
		$locale = `null`
	)

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

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

Returns: boolean

Exceptions

Zend_Date_Exception

isLater	(	$date,
		$part = `null`,
		$locale = `null`
	)

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

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

Returns: boolean

Exceptions

Zend_Date_Exception

isLeapYear ( )

Returns true, if the year is a leap year.

Returns: boolean

isToday ( )

Returns if the set date is todays date.

Returns: boolean

isTomorrow ( )

Returns if the set date is tomorrows date.

Returns: boolean

isYesterday ( )

Returns if the set date is yesterdays date.

Returns: boolean

static now ( $locale = null )

static

Returns the actual date as new date object.

Parameters

string | Zend_Locale $locale OPTIONAL Locale for parsing input

Returns: Zend_Date

set	(	$date,
		$part = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setArpa	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setDate	(	$date,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setDay	(	$day,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setDayOfYear	(	$day,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setFractionalPrecision ( $precision )

Sets a new precision for fractional seconds.

Parameters

integer $precision Precision for the fractional datepart 3 = milliseconds

Exceptions

Zend_Date_Exception

Returns: Zend_Date Provides fluid interface

setHour	(	$hour,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setIso	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setLocale ( $locale = null )

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

string | Zend_Locale $locale (Optional) Locale for parsing input

Exceptions

Zend_Date_Exception When the given locale does not exist

Returns: Zend_Date Provides fluent interface

setMilliSecond	(	$milli = `null`,
		$precision = `null`
	)

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

Parameters

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

Returns: Zend_Date Provides fluid interface

setMinute	(	$minute,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setMonth	(	$month,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

static setOptions ( array $options = array() )

static

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

Parameters

array $options Options to set

Exceptions

Zend_Date_Exception

Returns: Options array if no option was given

setSecond	(	$second,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setTime	(	$time,
		$format = `null`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setTimestamp ( $timestamp )

Sets a new timestamp.

Parameters

integer | string | array | Zend_Date $timestamp Timestamp to set

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setWeek	(	$week,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setWeekday	(	$weekday,
		$locale = `null`
	)

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

string \| integer \| array \| Zend_Date	$month	Weekday to set
string \| Zend_Locale	$locale	OPTIONAL Locale for parsing input

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

setYear	(	$year,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

sub	(	$date,
		$part = `self::TIMESTAMP`,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subArpa	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subDate	(	$date,
		$format = `null`,
		$locale = `null`
	)

Subtracts a date from the existing date object.

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

Parameters

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subDay	(	$day,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subDayOfYear	(	$day,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subHour	(	$hour,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subIso	(	$date,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subMilliSecond	(	$milli = `null`,
		$precision = `null`
	)

Subtracts a millisecond.

Parameters

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

Returns: Zend_Date Provides fluid interface

subMinute	(	$minute,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subMonth	(	$month,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subSecond	(	$second,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subTime	(	$time,
		$format = `null`,
		$locale = `null`
	)

Subtracts a time from the existing date.

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

Parameters

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

Returns: Zend_Date Provides fluid inteface

Exceptions

Zend_Date_Exception

subTimestamp ( $timestamp )

Subtracts a timestamp.

Parameters

integer | string | array | Zend_Date $timestamp Timestamp to sub

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subWeek	(	$week,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subWeekday	(	$weekday,
		$locale = `null`
	)

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

string \| integer \| array \| Zend_Date	$month	Weekday to sub
string \| Zend_Locale	$locale	OPTIONAL Locale for parsing input

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

subYear	(	$year,
		$locale = `null`
	)

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

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

Returns: Zend_Date Provides fluid interface

Exceptions

Zend_Date_Exception

toArray ( )

Returns an array representation of the object.

Returns: array

toString	(	$format = `null`,
		$type = `null`,
		$locale = `null`
	)

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

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

Returns: string

toValue ( $part = null )

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

Month-Name

Parameters

string | integer | Zend_Date $part OPTIONAL Defines the date or datepart to return as integer

Returns: integer|false

Member Data Documentation

const ATOM = 'OOO'

const COOKIE = 'CCC'

const DATE_FULL = 'FFFFF'

const DATE_LONG = 'FFFF'

const DATE_MEDIUM = 'FFF'

const DATE_SHORT = 'FF'

const DATES = 'F'

const DATETIME = 'K'

const DATETIME_FULL = 'KKKKK'

const DATETIME_LONG = 'KKKK'

const DATETIME_MEDIUM = 'KKK'

const DATETIME_SHORT = 'KK'

const DAY = 'dd'

const DAY_OF_YEAR = 'D'

const DAY_SHORT = 'd'

const DAY_SUFFIX = 'SS'

const DAYLIGHT = 'I'

const ERA = 'G'

const ERA_NAME = 'GGGG'

const ERA_NARROW = 'GGGGG'

const GMT_DIFF = 'Z'

const GMT_DIFF_SEP = 'ZZZZ'

const HOUR = 'HH'

const HOUR_AM = 'hh'

const HOUR_SHORT = 'H'

const HOUR_SHORT_AM = 'h'

const ISO_8601 = 'c'

const LEAPYEAR = 'l'

const MERIDIEM = 'a'

const MILLISECOND = 'S'

const MINUTE = 'mm'

const MINUTE_SHORT = 'm'

const MONTH = 'MM'

const MONTH_DAYS = 'ddd'

const MONTH_NAME = 'MMMM'

const MONTH_NAME_NARROW = 'MMMMM'

const MONTH_NAME_SHORT = 'MMM'

const MONTH_SHORT = 'M'

const RFC_1036 = 'RRR'

const RFC_1123 = 'RRRR'

const RFC_2822 = 'r'

const RFC_3339 = 'RRRRR'

const RFC_822 = 'R'

const RFC_850 = 'RR'

const RSS = 'SSS'

const SECOND = 'ss'

const SECOND_SHORT = 's'

const SWATCH = 'B'

const TIME_FULL = 'TTTTT'

const TIME_LONG = 'TTTT'

const TIME_MEDIUM = 'TTT'

const TIME_SHORT = 'TT'

const TIMES = 'WW'

const TIMESTAMP = 'U'

const TIMEZONE = 'z'

const TIMEZONE_NAME = 'zzzz'

const TIMEZONE_SECS = 'X'

const W3C = 'WWW'

const WEEK = 'ww'

const WEEKDAY = 'EEEE'

const WEEKDAY_8601 = 'eee'

const WEEKDAY_DIGIT = 'e'

const WEEKDAY_NAME = 'EE'

const WEEKDAY_NARROW = 'E'

const WEEKDAY_SHORT = 'EEE'

const YEAR = 'y'

const YEAR_8601 = 'Y'

const YEAR_SHORT = 'yy'

const YEAR_SHORT_8601 = 'YY'

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation