API Documentation

Zend/Date.php

Show: inherited
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 license@zend.com 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Date

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

Constant  DAY = 'dd'
Constant  DAY_SHORT = 'd'
Constant  DAY_SUFFIX = 'SS'
Constant  DAY_OF_YEAR = 'D'
Constant  WEEKDAY = 'EEEE'
Constant  WEEKDAY_SHORT = 'EEE'
Constant  WEEKDAY_NARROW = 'E'
Constant  WEEKDAY_NAME = 'EE'
Constant  WEEKDAY_8601 = 'eee'
Constant  WEEKDAY_DIGIT = 'e'
Constant  WEEK = 'ww'
Constant  MONTH = 'MM'
Constant  MONTH_SHORT = 'M'
Constant  MONTH_DAYS = 'ddd'
Constant  MONTH_NAME = 'MMMM'
Constant  MONTH_NAME_SHORT = 'MMM'
Constant  MONTH_NAME_NARROW = 'MMMMM'
Constant  YEAR = 'y'
Constant  YEAR_SHORT = 'yy'
Constant  YEAR_8601 = 'Y'
Constant  YEAR_SHORT_8601 = 'YY'
Constant  LEAPYEAR = 'l'
Constant  MERIDIEM = 'a'
Constant  SWATCH = 'B'
Constant  HOUR = 'HH'
Constant  HOUR_SHORT = 'H'
Constant  HOUR_AM = 'hh'
Constant  HOUR_SHORT_AM = 'h'
Constant  MINUTE = 'mm'
Constant  MINUTE_SHORT = 'm'
Constant  SECOND = 'ss'
Constant  SECOND_SHORT = 's'
Constant  MILLISECOND = 'S'
Constant  TIMEZONE_NAME = 'zzzz'
Constant  DAYLIGHT = 'I'
Constant  GMT_DIFF = 'Z'
Constant  GMT_DIFF_SEP = 'ZZZZ'
Constant  TIMEZONE = 'z'
Constant  TIMEZONE_SECS = 'X'
Constant  ISO_8601 = 'c'
Constant  RFC_2822 = 'r'
Constant  TIMESTAMP = 'U'
Constant  ERA = 'G'
Constant  ERA_NAME = 'GGGG'
Constant  ERA_NARROW = 'GGGGG'
Constant  DATES = 'F'
Constant  DATE_FULL = 'FFFFF'
Constant  DATE_LONG = 'FFFF'
Constant  DATE_MEDIUM = 'FFF'
Constant  DATE_SHORT = 'FF'
Constant  TIMES = 'WW'
Constant  TIME_FULL = 'TTTTT'
Constant  TIME_LONG = 'TTTT'
Constant  TIME_MEDIUM = 'TTT'
Constant  TIME_SHORT = 'TT'
Constant  DATETIME = 'K'
Constant  DATETIME_FULL = 'KKKKK'
Constant  DATETIME_LONG = 'KKKK'
Constant  DATETIME_MEDIUM = 'KKK'
Constant  DATETIME_SHORT = 'KK'
Constant  ATOM = 'OOO'
Constant  COOKIE = 'CCC'
Constant  RFC_822 = 'R'
Constant  RFC_850 = 'RR'
Constant  RFC_1036 = 'RRR'
Constant  RFC_1123 = 'RRRR'
Constant  RFC_3339 = 'RRRRR'
Constant  RSS = 'SSS'
Constant  W3C = 'WWW'

Properties

Propertyprivate  $_fractional= '0'
Default value0Details
Type
Propertyprivate  $_locale= 'null'
Default valuenullDetails
Type
Propertyprivate  $_options= 'array( 'format_type' => 'iso''
static
Default valuearray( 'format_type' => 'iso'Details
Type
Propertyprivate  $_precision= '3'
Default value3Details
Type

Methods

methodpublic__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
methodpublic__toString( ) : string

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

Returns
Type Description
string
methodprivate_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
methodprivate_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
methodprivate_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
methodprivate_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
methodprivate_checkLocation( array $location ) : \$horizon

Check if location is supported

Parameters
Name Type Description
$location array

locations array

Returns
Type Description
\$horizon float
methodprivate_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
methodprivate_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
methodprivate_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
methodprotected_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
methodprivate_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
methodprivate_parseIsoToDate( string $token, string $locale ) : string

Internal parsing method

Parameters
Name Type Description
$token string
$locale string
Returns
Type Description
string
methodprivate_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
methodprivate_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
methodprivate_toComment( string $token ) : string

Private function to make a comment of a token

Parameters
Name Type Description
$token string
Returns
Type Description
string
methodprivate_toToken( string $part, string $locale ) : string

Internal method to apply tokens

Parameters
Name Type Description
$part string
$locale string
Returns
Type Description
string
methodprivate_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
methodpublicadd( 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
methodpublicaddArpa( 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
methodpublicaddDate( 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
methodpublicaddDay(  $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
methodpublicaddDayOfYear( 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
methodpublicaddHour( 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
methodpublicaddIso( 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
methodpublicaddMilliSecond( 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
methodpublicaddMinute( 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
methodpublicaddMonth( 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
methodpublicaddSecond( 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
methodpublicaddTime( 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
methodpublicaddTimestamp( 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
methodpublicaddWeek( 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
methodpublicaddWeekday(  $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
methodpublicaddYear(  $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
methodpubliccheckLeapYear( 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
methodpubliccompare( 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
methodpubliccompareArpa( 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
methodpubliccompareDate( 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
methodpubliccompareDay( 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
methodpubliccompareDayOfYear( 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
methodpubliccompareHour( 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
methodpubliccompareIso( 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
methodpubliccompareMilliSecond( 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
methodpubliccompareMinute( 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
methodpubliccompareMonth( 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
methodpubliccompareSecond( 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
methodpubliccompareTime( 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
methodpubliccompareTimestamp( 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
methodpubliccompareWeek( 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
methodpubliccompareWeekday( 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
methodpubliccompareYear( 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
methodpubliccopyPart( 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
methodpublicequals( 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
methodpublicget( 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
methodpublicgetArpa( 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
methodpublicgetDate( 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
methodpublicgetDay( \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
methodpublicgetDayOfYear( 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
methodpublicgetFractionalPrecision( ) : integer

Returns the precision for fractional seconds

Returns
Type Description
integer
methodpublicgetFullYear( 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
methodpublicgetHour( \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
methodpublicgetIso( 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
methodpublicgetLocale( ) : string

Returns the actual set locale

Returns
Type Description
string
methodpublicgetMilliSecond( ) : string

Returns the milliseconds of the date object

Returns
Type Description
string
methodpublicgetMinute( 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
methodpublicgetMonth( 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
methodpublicgetSecond( 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
methodpublicgetSunInfo( 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
methodpublicgetSunrise( 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
methodpublicgetSunset( 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
methodpublicgetTime( 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
methodpublicgetTimestamp( ) : 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
methodpublicgetTimezoneFromString( string $zone ) : integer

Internal function, returns the offset of a given timezone

Parameters
Name Type Description
$zone string
Returns
Type Description
integer
methodpublicgetWeek( \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
methodpublicgetWeekday( \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
methodpublicgetYear( 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
methodpublicisDate( 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
methodpublicisEarlier( 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
methodpublicisLater( 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
methodpublicisLeapYear( ) : boolean

Returns true, if the year is a leap year.

Returns
Type Description
boolean
methodpublicisToday( ) : boolean

Returns if the set date is todays date

Returns
Type Description
boolean
methodpublicisTomorrow( ) : boolean

Returns if the set date is tomorrows date

Returns
Type Description
boolean
methodpublicisYesterday( ) : boolean

Returns if the set date is yesterdays date

Returns
Type Description
boolean
methodpublicnow( 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
methodpublicset( 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
methodpublicsetArpa( 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
methodpublicsetDate( 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
methodpublicsetDay(  $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
methodpublicsetDayOfYear( 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
methodpublicsetFractionalPrecision( 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
methodpublicsetHour( 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
methodpublicsetIso( 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
methodpublicsetLocale( 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
methodpublicsetMilliSecond( 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
methodpublicsetMinute( 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
methodpublicsetMonth( 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
methodpublicsetOptions( 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
methodpublicsetSecond( 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
methodpublicsetTime( 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
methodpublicsetTimestamp( 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
methodpublicsetWeek( 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
methodpublicsetWeekday(  $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
methodpublicsetYear(  $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
methodpublicsub( 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
methodpublicsubArpa( 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
methodpublicsubDate( string|integer|array|\Zend_Date $date, string $format = null, string|\Zend_Locale $locale = null ) : \Zend_Date

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

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

Parameters
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
methodpublicsubDay(  $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
methodpublicsubDayOfYear( 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
methodpublicsubHour( 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
methodpublicsubIso( 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
methodpublicsubMilliSecond( 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
methodpublicsubMinute( 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
methodpublicsubMonth( 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
methodpublicsubSecond( 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
methodpublicsubTime( string|integer|array|\Zend_Date $time, string $format = null, string|\Zend_Locale $locale = null ) : \Zend_Date

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

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

Parameters
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
methodpublicsubTimestamp( 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
methodpublicsubWeek( 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
methodpublicsubWeekday(  $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
methodpublicsubYear(  $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
methodpublictoArray( ) : array

Returns an array representation of the object

Returns
Type Description
array
methodpublictoString( 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
methodpublictoValue( 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
Documentation was generated by DocBlox 0.15.1.