API Documentation

Date.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Date
version
$Id: Date.php 22321 2010-05-30 09:35:10Z thomas $
Classes
Zend_Date

Description

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.

Zend_Date

Extends from
Zend_Date_DateObject
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Date
Constants
DAY
DAY_SHORT
DAY_SUFFIX
DAY_OF_YEAR
WEEKDAY
WEEKDAY_SHORT
WEEKDAY_NARROW
WEEKDAY_NAME
WEEKDAY_8601
WEEKDAY_DIGIT
WEEK
MONTH
MONTH_SHORT
MONTH_DAYS
MONTH_NAME
MONTH_NAME_SHORT
MONTH_NAME_NARROW
YEAR
YEAR_SHORT
YEAR_8601
YEAR_SHORT_8601
LEAPYEAR
MERIDIEM
SWATCH
HOUR
HOUR_SHORT
HOUR_AM
HOUR_SHORT_AM
MINUTE
MINUTE_SHORT
SECOND
SECOND_SHORT
MILLISECOND
TIMEZONE_NAME
DAYLIGHT
GMT_DIFF
GMT_DIFF_SEP
TIMEZONE
TIMEZONE_SECS
ISO_8601
RFC_2822
TIMESTAMP
ERA
ERA_NAME
ERA_NARROW
DATES
DATE_FULL
DATE_LONG
DATE_MEDIUM
DATE_SHORT
TIMES
TIME_FULL
TIME_LONG
TIME_MEDIUM
TIME_SHORT
DATETIME
DATETIME_FULL
DATETIME_LONG
DATETIME_MEDIUM
DATETIME_SHORT
ATOM
COOKIE
RFC_822
RFC_850
RFC_1036
RFC_1123
RFC_3339
RSS
W3C
Properties
$_locale
$_fractional
$_precision
$_options
Methods
__construct
setOptions
getTimestamp
_timestamp
setTimestamp
addTimestamp
subTimestamp
compareTimestamp
toString
__toString
toValue
toArray
get
_toToken
_parseIsoToDate
_toComment
_getDigitFromName
getFullYear
set
add
sub
compare
copyPart
getTimezoneFromString
_assign
_calculate
equals
isEarlier
isLater
getTime
_time
setTime
addTime
subTime
compareTime
getDate
_date
setDate
addDate
subDate
compareDate
getIso
setIso
addIso
subIso
compareIso
getArpa
setArpa
addArpa
subArpa
compareArpa
_checkLocation
getSunrise
getSunset
getSunInfo
checkLeapYear
isLeapYear
isToday
isYesterday
isTomorrow
now
_calcdetail
_calcvalue
getYear
setYear
addYear
subYear
compareYear
getMonth
_month
setMonth
addMonth
subMonth
compareMonth
getDay
_day
setDay
addDay
subDay
compareDay
getWeekday
_weekday
setWeekday
addWeekday
subWeekday
compareWeekday
getDayOfYear
setDayOfYear
addDayOfYear
subDayOfYear
compareDayOfYear
getHour
setHour
addHour
subHour
compareHour
getMinute
setMinute
addMinute
subMinute
compareMinute
getSecond
setSecond
addSecond
subSecond
compareSecond
getFractionalPrecision
setFractionalPrecision
getMilliSecond
setMilliSecond
addMilliSecond
subMilliSecond
compareMilliSecond
getWeek
setWeek
addWeek
subWeek
compareWeek
setLocale
getLocale
isDate
_getLocalizedToken

Description

Constants

DAY

 DAY = 'dd'

Details

value
dd

DAY_SHORT

 DAY_SHORT = 'd'

Details

value
d

DAY_SUFFIX

 DAY_SUFFIX = 'SS'

Details

value
SS

DAY_OF_YEAR

 DAY_OF_YEAR = 'D'

Details

value
D

WEEKDAY

 WEEKDAY = 'EEEE'

Details

value
EEEE

WEEKDAY_SHORT

 WEEKDAY_SHORT = 'EEE'

Details

value
EEE

WEEKDAY_NARROW

 WEEKDAY_NARROW = 'E'

Details

value
E

WEEKDAY_NAME

 WEEKDAY_NAME = 'EE'

Details

value
EE

WEEKDAY_8601

 WEEKDAY_8601 = 'eee'

Details

value
eee

WEEKDAY_DIGIT

 WEEKDAY_DIGIT = 'e'

Details

value
e

WEEK

 WEEK = 'ww'

Details

value
ww

MONTH

 MONTH = 'MM'

Details

value
MM

MONTH_SHORT

 MONTH_SHORT = 'M'

Details

value
M

MONTH_DAYS

 MONTH_DAYS = 'ddd'

Details

value
ddd

MONTH_NAME

 MONTH_NAME = 'MMMM'

Details

value
MMMM

MONTH_NAME_SHORT

 MONTH_NAME_SHORT = 'MMM'

Details

value
MMM

MONTH_NAME_NARROW

 MONTH_NAME_NARROW = 'MMMMM'

Details

value
MMMMM

YEAR

 YEAR = 'y'

Details

value
y

YEAR_SHORT

 YEAR_SHORT = 'yy'

Details

value
yy

YEAR_8601

 YEAR_8601 = 'Y'

Details

value
Y

YEAR_SHORT_8601

 YEAR_SHORT_8601 = 'YY'

Details

value
YY

LEAPYEAR

 LEAPYEAR = 'l'

Details

value
l

MERIDIEM

 MERIDIEM = 'a'

Details

value
a

SWATCH

 SWATCH = 'B'

Details

value
B

HOUR

 HOUR = 'HH'

Details

value
HH

HOUR_SHORT

 HOUR_SHORT = 'H'

Details

value
H

HOUR_AM

 HOUR_AM = 'hh'

Details

value
hh

HOUR_SHORT_AM

 HOUR_SHORT_AM = 'h'

Details

value
h

MINUTE

 MINUTE = 'mm'

Details

value
mm

MINUTE_SHORT

 MINUTE_SHORT = 'm'

Details

value
m

SECOND

 SECOND = 'ss'

Details

value
ss

SECOND_SHORT

 SECOND_SHORT = 's'

Details

value
s

MILLISECOND

 MILLISECOND = 'S'

Details

value
S

TIMEZONE_NAME

 TIMEZONE_NAME = 'zzzz'

Details

value
zzzz

DAYLIGHT

 DAYLIGHT = 'I'

Details

value
I

GMT_DIFF

 GMT_DIFF = 'Z'

Details

value
Z

GMT_DIFF_SEP

 GMT_DIFF_SEP = 'ZZZZ'

Details

value
ZZZZ

TIMEZONE

 TIMEZONE = 'z'

Details

value
z

TIMEZONE_SECS

 TIMEZONE_SECS = 'X'

Details

value
X

ISO_8601

 ISO_8601 = 'c'

Details

value
c

RFC_2822

 RFC_2822 = 'r'

Details

value
r

TIMESTAMP

 TIMESTAMP = 'U'

Details

value
U

ERA

 ERA = 'G'

Details

value
G

ERA_NAME

 ERA_NAME = 'GGGG'

Details

value
GGGG

ERA_NARROW

 ERA_NARROW = 'GGGGG'

Details

value
GGGGG

DATES

 DATES = 'F'

Details

value
F

DATE_FULL

 DATE_FULL = 'FFFFF'

Details

value
FFFFF

DATE_LONG

 DATE_LONG = 'FFFF'

Details

value
FFFF

DATE_MEDIUM

 DATE_MEDIUM = 'FFF'

Details

value
FFF

DATE_SHORT

 DATE_SHORT = 'FF'

Details

value
FF

TIMES

 TIMES = 'WW'

Details

value
WW

TIME_FULL

 TIME_FULL = 'TTTTT'

Details

value
TTTTT

TIME_LONG

 TIME_LONG = 'TTTT'

Details

value
TTTT

TIME_MEDIUM

 TIME_MEDIUM = 'TTT'

Details

value
TTT

TIME_SHORT

 TIME_SHORT = 'TT'

Details

value
TT

DATETIME

 DATETIME = 'K'

Details

value
K

DATETIME_FULL

 DATETIME_FULL = 'KKKKK'

Details

value
KKKKK

DATETIME_LONG

 DATETIME_LONG = 'KKKK'

Details

value
KKKK

DATETIME_MEDIUM

 DATETIME_MEDIUM = 'KKK'

Details

value
KKK

DATETIME_SHORT

 DATETIME_SHORT = 'KK'

Details

value
KK

ATOM

 ATOM = 'OOO'

Details

value
OOO

COOKIE

 COOKIE = 'CCC'

Details

value
CCC

RFC_822

 RFC_822 = 'R'

Details

value
R

RFC_850

 RFC_850 = 'RR'

Details

value
RR

RFC_1036

 RFC_1036 = 'RRR'

Details

value
RRR

RFC_1123

 RFC_1123 = 'RRRR'

Details

value
RRRR

RFC_3339

 RFC_3339 = 'RRRRR'

Details

value
RRRRR

RSS

 RSS = 'SSS'

Details

value
SSS

W3C

 W3C = 'WWW'

Details

value
WWW

Properties

$_fractional

 $_fractional = '0'

Details

visibility
private
default
0
final
false
static
false

$_locale

 $_locale = 'null'

Details

visibility
private
default
null
final
false
static
false

$_options

 $_options = 'array'

Details

visibility
private
default
array
final
false
static
true

$_precision

 $_precision = '3'

Details

visibility
private
default
3
final
false
static
false

Methods

__construct

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

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

Arguments
$date
stringintegerZend_Datearray
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
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false
throws

__toString

__toString( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

_assign

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

Calculates the date or object

Arguments
$calc
string
Calculation to make
$date
stringinteger
Date for calculation
$comp
stringinteger
Second date for calculation
$dst
booleaninteger
Use dst correction if option is set
Output
integer|string|Zend_Date
new timestamp or Zend_Date depending on calculation
Details
visibility
private
final
false
static
false

_calcdetail

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

Calculate date details

Arguments
$calc
string
Calculation to make
$date
stringintegerarrayZend_Date
Date or Part to calculate
$type
$locale
stringZend_Locale
Locale for parsing input
Output
integer|string
new date
Details
visibility
private
final
false
static
false
throws

_calculate

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

Calculates the date or object

Arguments
$calc
string
Calculation to make, one of: 'add'|'sub'|'cmp'|'copy'|'set'
$date
stringintegerarrayZend_Date
Date or datepart to calculate with
$part
string
Part of the date to calculate, if null the timestamp is used
$locale
stringZend_Locale
Locale for parsing input
Output
integer|string|Zend_Date
new timestamp
Details
visibility
private
final
false
static
false
throws

_calcvalue

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

Internal calculation, returns the requested date type

Arguments
$calc
string
Calculation to make
$value
stringintegerZend_Date
Datevalue to calculate with, if null the actual value is taken
$type
$parameter
$locale
stringZend_Locale
Locale for parsing input
Output
integer|Zend_Date
new date
Details
visibility
private
final
false
static
false
throws

_checkLocation

_checkLocation( $location $location ) : $horizon

Check if location is supported

Arguments
$location
$location
array - locations array
Output
$horizon
float
Details
visibility
private
final
false
static
false

_date

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

Returns the calculated date

Arguments
$calc
string
Calculation to make
$date
stringintegerarrayZend_Date
Date to calculate with, if null the actual date is taken
$format
string
Date format for parsing
$locale
stringZend_Locale
Locale for parsing input
Output
integer|Zend_Date
new date
Details
visibility
private
final
false
static
false
throws

_day

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

Returns the calculated day

Arguments
$calc
$calc
string Type of calculation to make
$day
$day
string|integer|Zend_Date Day to calculate, when null the actual day is calculated
$locale
$locale
string|Zend_Locale Locale for parsing input
Output
Zend_Date|integer
Details
visibility
private
final
false
static
false

_getDigitFromName

_getDigitFromName( string $name ) : integer

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

Arguments
$name
string
Output
integer
Number of this month
Details
visibility
private
final
false
static
false
throws

_getLocalizedToken

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

Returns the ISO Token for all localized constants

Arguments
$token
string
Token to normalize
$locale
string
Locale to search
Output
string
Details
visibility
protected
final
false
static
true

_month

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

Returns the calculated month

Arguments
$calc
string
Calculation to make
$month
stringintegerarrayZend_Date
Month to calculate with, if null the actual month is taken
$locale
stringZend_Locale
Locale for parsing input
Output
integer|Zend_Date
new time
Details
visibility
private
final
false
static
false
throws

_parseIsoToDate

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

Internal parsing method

Arguments
$token
string
$locale
string
Output
string
Details
visibility
private
final
false
static
false

_time

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

Returns the calculated time

Arguments
$calc
string
Calculation to make
$time
stringintegerarrayZend_Date
Time to calculate with, if null the actual time is taken
$format
string
Timeformat for parsing input
$locale
stringZend_Locale
Locale for parsing input
Output
integer|Zend_Date
new time
Details
visibility
private
final
false
static
false
throws

_timestamp

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

Returns the calculated timestamp HINT: timestamps are always GMT

Arguments
$calc
string
Type of calculation to make
$stamp
stringintegerarrayZend_Date
Timestamp to calculate, when null the actual timestamp is calculated
Output
Zend_Date|integer
Details
visibility
private
final
false
static
false
throws

_toComment

_toComment( string $token ) : string

Private function to make a comment of a token

Arguments
$token
string
Output
string
Details
visibility
private
final
false
static
false

_toToken

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

Internal method to apply tokens

Arguments
$part
string
$locale
string
Output
string
Details
visibility
private
final
false
static
false

_weekday

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

Returns the calculated weekday

Arguments
$calc
$calc
string Type of calculation to make
$weekday
$weekday
string|integer|array|Zend_Date Weekday to calculate, when null the actual weekday is calculated
$locale
$locale
string|Zend_Locale Locale for parsing input
Output
Zend_Date|integer
Details
visibility
private
final
false
static
false
throws

add

add( string|integer|array|Zend_Date $date, string $part = self, 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.

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to add
$part
string
OPTIONAL Part of the date to add, if null the timestamp is added
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addArpa

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

Adds a RFC 822 date to the date object.

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

Arguments
$date
stringintegerZend_Date
RFC 822 Date to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addDate

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

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

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

Arguments
$date
stringintegerarrayZend_Date
Date to add
$format
string
OPTIONAL Date format for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addDay

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

Adds days to the existing date object.

The day can be a number or a string. Adding days lower then 0 or greater than the number of this months days will result in adding or subtracting the relevant month. If a localized dayname is given it will be parsed with the default locale or the optional set locale.

Arguments
$day
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addDayOfYear

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

Adds a day of year to the existing date object.

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

Arguments
$day
stringintegerarrayZend_Date
Day of Year to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addHour

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

Adds hours to the existing date object.

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

Arguments
$hour
stringintegerarrayZend_Date
Hour to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addIso

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

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

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

Arguments
$date
stringintegerZend_Date
ISO Date to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addMilliSecond

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

Adds milliseconds to the date object

Arguments
$milli
integerZend_Date
(Optional) Millisecond to add, when null the actual millisecond is added
$precision
integer
(Optional) Fractional precision for the given milliseconds
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false

addMinute

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

Adds minutes to the existing date object.

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

Arguments
$minute
stringintegerarrayZend_Date
Minute to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addMonth

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

Adds months to the existing date object.

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

Arguments
$month
stringintegerarrayZend_Date
Month to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addSecond

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

Adds seconds to the existing date object.

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

Arguments
$second
stringintegerarrayZend_Date
Second to add
$locale
stringZend_Locale
(Optional) Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addTime

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

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

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

Arguments
$time
stringintegerarrayZend_Date
Time to add
$format
string
OPTIONAL Timeformat for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addTimestamp

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

Adds a timestamp

Arguments
$timestamp
integerstringarrayZend_Date
Timestamp to add
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addWeek

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

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

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

Arguments
$week
stringintegerarrayZend_Date
Week to add
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addWeekday

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

Adds weekdays to the existing date object.

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

Arguments
$weekday
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

addYear

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

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

Returned is the new date object

Arguments
$year
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

checkLeapYear

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

Check a given year for leap year.

Arguments
$year
integerarrayZend_Date
Year to check
Output
boolean
Details
visibility
public
final
false
static
true

compare

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

Arguments
$date
stringintegerarrayZend_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
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareArpa

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

Compares a RFC 822 compilant date with the date object.

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

Arguments
$date
stringintegerZend_Date
RFC 822 Date to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareDate

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

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

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

Arguments
$date
stringintegerarrayZend_Date
Date to compare
$format
string
OPTIONAL Date format for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareDay

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

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

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

Arguments
$day
stringintegerarrayZend_Date
Day to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareDayOfYear

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

Compares the day of year with the existing date object.

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

Arguments
$day
stringintegerarrayZend_Date
Day of Year to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareHour

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

Compares the hour with the existing date object.

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

Arguments
$hour
stringintegerarrayZend_Date
Hour to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareIso

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

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

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

Arguments
$date
stringintegerZend_Date
ISO Date to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareMilliSecond

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

Compares only the millisecond part, returning the difference

Arguments
$milli
integerZend_Date
OPTIONAL Millisecond to compare, when null the actual millisecond is compared
$precision
integer
OPTIONAL Fractional precision for the given milliseconds
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws
On invalid input

compareMinute

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

Compares the minute with the existing date object.

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

Arguments
$minute
stringintegerarrayZend_Date
Hour to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareMonth

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

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

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

Arguments
$month
stringintegerarrayZend_Date
Month to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareSecond

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

Compares the second with the existing date object.

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

Arguments
$second
stringintegerarrayZend_Date
Second to compare
$locale
stringZend_Locale
(Optional) Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareTime

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

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

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

Arguments
$time
stringintegerarrayZend_Date
Time to compare
$format
string
OPTIONAL Timeformat for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareTimestamp

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

Compares two timestamps, returning the difference as integer

Arguments
$timestamp
integerstringarrayZend_Date
Timestamp to compare
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareWeek

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

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

Arguments
$week
stringintegerarrayZend_Date
Week to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false

compareWeekday

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

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

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

Arguments
$weekday
stringintegerarrayZend_Date
Weekday to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

compareYear

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

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

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

Arguments
$year
stringintegerarrayZend_Date
Year to compare
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
integer
0 = equal, 1 = later, -1 = earlier
Details
visibility
public
final
false
static
false
throws

copyPart

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

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

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

Arguments
$part
string
Part of the date to compare, if null the timestamp is subtracted
$locale
stringZend_Locale
OPTIONAL New object's locale. No adjustments to timezone are made.
Output
Zend_Date
New clone with requested part
Details
visibility
public
final
false
static
false

equals

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

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to equal with
$part
string
OPTIONAL Part of the date to compare, if null the timestamp is used
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
boolean
Details
visibility
public
final
false
static
false
throws

get

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

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

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

Arguments
$part
string
OPTIONAL Part of the date to return, if null the timestamp is returned
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
string
date or datepart
Details
visibility
public
final
false
static
false

getArpa

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

Returns a RFC 822 compilant datestring from the date object.

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
string
Details
visibility
public
final
false
static
false

getDate

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getDay

getDay( $locale $locale = null ) : Zend_Date

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

Arguments
$locale
$locale
string|Zend_Locale OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getDayOfYear

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getFractionalPrecision

getFractionalPrecision( ) : integer

Returns the precision for fractional seconds

Output
integer
Details
visibility
public
final
false
static
false

getFullYear

getFullYear( integer $value ) : integer

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

Arguments
$value
integer
year number
Output
integer
Number of year
Details
visibility
public
final
false
static
true

getHour

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

Arguments
$locale
$locale
string|Zend_Locale OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getIso

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

Returns the full ISO 8601 date from the date object.

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
string
Details
visibility
public
final
false
static
false

getLocale

getLocale( ) : string

Returns the actual set locale

Output
string
Details
visibility
public
final
false
static
false

getMilliSecond

getMilliSecond( ) : string

Returns the milliseconds of the date object

Output
string
Details
visibility
public
final
false
static
false

getMinute

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getMonth

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

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getSecond

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getSunInfo

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

Arguments
$location
$location
array - location of suninfo [&#039;horizon&#039;] -&gt; civil, nautic, astronomical, effective (default) [&#039;longitude&#039;] -&gt; longitude of location [&#039;latitude&#039;] -&gt; latitude of location
Output
array
- [sunset|sunrise][effective|civil|nautic|astronomic]
Details
visibility
public
final
false
static
false
throws

getSunrise

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

Arguments
$location
$location
array - location of sunrise [&#039;horizon&#039;] -&gt; civil, nautic, astronomical, effective (default) [&#039;longitude&#039;] -&gt; longitude of location [&#039;latitude&#039;] -&gt; latitude of location
Output
Zend_Date
Details
visibility
public
final
false
static
false
throws

getSunset

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

Arguments
$location
$location
array - location of sunset [&#039;horizon&#039;] -&gt; civil, nautic, astronomical, effective (default) [&#039;longitude&#039;] -&gt; longitude of location [&#039;latitude&#039;] -&gt; latitude of location
Output
Zend_Date
Details
visibility
public
final
false
static
false
throws

getTime

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getTimestamp

getTimestamp( ) : integer|string

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

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

Output
integer|string
UNIX timestamp
Details
visibility
public
final
false
static
false

getTimezoneFromString

getTimezoneFromString( string $zone ) : integer

Internal function, returns the offset of a given timezone

Arguments
$zone
string
Output
integer
Details
visibility
public
final
false
static
false

getWeek

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

Arguments
$locale
$locale
string|Zend_Locale OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getWeekday

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

Arguments
$locale
$locale
string|Zend_Locale OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

getYear

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

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

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

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
false

isDate

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

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

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

Arguments
$date
stringarrayZend_Date
Date to parse for correctness
$format
string
(Optional) Format for parsing the date string
$locale
stringZend_Locale
(Optional) Locale for parsing date parts
Output
boolean
True when all date parts are correct
Details
visibility
public
final
false
static
true

isEarlier

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

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

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to compare with
$part
string
OPTIONAL Part of the date to compare, if null the timestamp is used
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
boolean
Details
visibility
public
final
false
static
false
throws

isLater

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

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

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to compare with
$part
string
OPTIONAL Part of the date to compare, if null the timestamp is used
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
boolean
Details
visibility
public
final
false
static
false
throws

isLeapYear

isLeapYear( ) : boolean

Returns true, if the year is a leap year.

Output
boolean
Details
visibility
public
final
false
static
false

isToday

isToday( ) : boolean

Returns if the set date is todays date

Output
boolean
Details
visibility
public
final
false
static
false

isTomorrow

isTomorrow( ) : boolean

Returns if the set date is tomorrows date

Output
boolean
Details
visibility
public
final
false
static
false

isYesterday

isYesterday( ) : boolean

Returns if the set date is yesterdays date

Output
boolean
Details
visibility
public
final
false
static
false

now

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

Returns the actual date as new date object

Arguments
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Details
visibility
public
final
false
static
true

set

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

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

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

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to set
$part
string
OPTIONAL Part of the date to set, if null the timestamp is set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setArpa

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

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

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

Arguments
$date
stringintegerZend_Date
RFC 822 to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setDate

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

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

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

Arguments
$date
stringintegerarrayZend_Date
Date to set
$format
string
OPTIONAL Date format for parsing
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setDay

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

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

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

Arguments
$day
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setDayOfYear

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

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

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

Arguments
$day
stringintegerarrayZend_Date
Day of Year to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setFractionalPrecision

setFractionalPrecision( integer $precision ) : Zend_Date

Sets a new precision for fractional seconds

Arguments
$precision
integer
Precision for the fractional datepart 3 = milliseconds
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setHour

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

Sets a new hour The hour is always a number.

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

Arguments
$hour
stringintegerarrayZend_Date
Hour to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setIso

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

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

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

Arguments
$date
stringintegerZend_Date
ISO Date to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setLocale

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

Sets a new standard locale for the date object.

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

Arguments
$locale
stringZend_Locale
(Optional) Locale for parsing input
Output
Zend_Date
Provides fluent interface
Details
visibility
public
final
false
static
false
throws
When the given locale does not exist

setMilliSecond

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

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

Arguments
$milli
integerZend_Date
(Optional) Millisecond to set, when null the actual millisecond is set
$precision
integer
(Optional) Fraction precision of the given milliseconds
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false

setMinute

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

Sets a new minute The minute is always a number.

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

Arguments
$minute
stringintegerarrayZend_Date
Minute to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setMonth

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

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

Returned is the new date object

Arguments
$month
stringintegerarrayZend_Date
Month to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setOptions

setOptions( array $options = array ) : Options

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

Arguments
$options
array
Options to set
Output
Options
array if no option was given
Details
visibility
public
final
false
static
true
throws

setSecond

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

Sets new seconds to the existing date object.

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

Arguments
$second
stringintegerarrayZend_Date
Second to set
$locale
stringZend_Locale
(Optional) Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setTime

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

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

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

Arguments
$time
stringintegerarrayZend_Date
Time to set
$format
string
OPTIONAL Timeformat for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setTimestamp

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

Sets a new timestamp

Arguments
$timestamp
integerstringarrayZend_Date
Timestamp to set
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setWeek

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

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

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

Arguments
$week
stringintegerarrayZend_Date
Week to set
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setWeekday

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

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

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

Arguments
$weekday
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

setYear

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

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

Returned is the new date object

Arguments
$year
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

sub

sub( string|integer|array|Zend_Date $date, string $part = self, 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 !!!

Arguments
$date
stringintegerarrayZend_Date
Date or datepart to subtract
$part
string
OPTIONAL Part of the date to sub, if null the timestamp is subtracted
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subArpa

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

Subtracts a RFC 822 date from the date object.

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

Arguments
$date
stringintegerZend_Date
RFC 822 Date to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subDate

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

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

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

Arguments
$date
stringintegerarrayZend_Date
Date to sub
$format
string
OPTIONAL Date format for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subDay

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

Subtracts days from the existing date object.

The day can be a number or a string. Subtracting days lower then 0 or greater than the number of this months days will result in adding or subtracting the relevant month. If a localized dayname is given it will be parsed with the default locale or the optional set locale.

Arguments
$day
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subDayOfYear

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

Subtracts a day of year from the existing date object.

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

Arguments
$day
stringintegerarrayZend_Date
Day of Year to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subHour

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

Subtracts hours from the existing date object.

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

Arguments
$hour
stringintegerarrayZend_Date
Hour to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subIso

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

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

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

Arguments
$date
stringintegerZend_Date
ISO Date to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subMilliSecond

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

Subtracts a millisecond

Arguments
$milli
integerZend_Date
(Optional) Millisecond to sub, when null the actual millisecond is subtracted
$precision
integer
(Optional) Fractional precision for the given milliseconds
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false

subMinute

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

Subtracts minutes from the existing date object.

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

Arguments
$minute
stringintegerarrayZend_Date
Minute to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subMonth

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

Subtracts months from the existing date object.

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

Arguments
$month
stringintegerarrayZend_Date
Month to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subSecond

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

Subtracts seconds from the existing date object.

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

Arguments
$second
stringintegerarrayZend_Date
Second to sub
$locale
stringZend_Locale
(Optional) Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subTime

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

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

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

Arguments
$time
stringintegerarrayZend_Date
Time to sub
$format
string
OPTIONAL Timeformat for parsing input
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid inteface
Details
visibility
public
final
false
static
false
throws

subTimestamp

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

Subtracts a timestamp

Arguments
$timestamp
integerstringarrayZend_Date
Timestamp to sub
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subWeek

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

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

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

Arguments
$week
stringintegerarrayZend_Date
Week to sub
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subWeekday

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

Subtracts weekdays from the existing date object.

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

Arguments
$weekday
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

subYear

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

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

Returned is the new date object

Arguments
$year
$locale
stringZend_Locale
OPTIONAL Locale for parsing input
Output
Zend_Date
Provides fluid interface
Details
visibility
public
final
false
static
false
throws

toArray

toArray( ) : array

Returns an array representation of the object

Output
array
Details
visibility
public
final
false
static
false

toString

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

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

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

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

Arguments
$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
stringZend_Locale
OPTIONAL Locale for parsing input
Output
string
Details
visibility
public
final
false
static
false

toValue

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

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

Arguments
$part
stringintegerZend_Date
OPTIONAL Defines the date or datepart to return as integer
Output
integer|false
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.