Docs For Class Date

object Date Date(
[mixed
$date = null])

Constructor

Creates a new Date Object initialized to the current date/time in the system default time zone by default. A date optionally passed in may be in the ISO, TIMESTAMP or UNIXTIME format, or another Date object.

Return: the new Date object
Access: public

Parameters:

mixed $date — optional - date/time to initialize

[ Top ]

void addSeconds(
int
$sec)

Adds a given number of seconds to the date

Access: public

Parameters:

int $sec — the number of seconds to add

[ Top ]

void addSpan(
object Date_Span
$span)

Adds a time span to the date

Access: public

Parameters:

object Date_Span $span — the time span to add

[ Top ]

boolean after(
object Date
$when)

Test if this date/time is after a certian date/time

Return: true if this date is after $when
Access: public

Parameters:

object Date $when — the date to test against

[ Top ]

boolean before(
object Date
$when)

Test if this date/time is before a certian date/time

Return: true if this date is before $when
Access: public

Parameters:

object Date $when — the date to test against

[ Top ]

int compare(
object Date
$d1, object Date
$d2)

Compares two dates

Compares two dates. Suitable for use in sorting functions.

Return: 0 if the dates are equal, -1 if d1 is before d2, 1 if d1 is after d2
Access: public

Parameters:

object Date	`$d1`	—	the first date
object Date	`$d2`	—	the second date

[ Top ]

void convertTZ(
object Date_TimeZone
$tz)

Converts this date to a new time zone

Converts this date to a new time zone. WARNING: This may not work correctly if your system does not allow putenv() or if localtime() does not work in your environment. See Date::TimeZone::inDaylightTime() for more information.

Access: public

Parameters:

object Date_TimeZone $tz — the Date::TimeZone object for the conversion time zone

[ Top ]

void convertTZbyID(
string
$id)

Converts this date to a new time zone, given a valid time zone ID

Converts this date to a new time zone, given a valid time zone ID WARNING: This may not work correctly if your system does not allow putenv() or if localtime() does not work in your environment. See Date::TimeZone::inDaylightTime() for more information.

Access: public

Parameters:

string $id — id a time zone id

[ Top ]

void copy(
object Date
$date)

Copy values from another Date object

Makes this Date a copy of another Date object.

Access: public

Parameters:

object Date $date — Date to copy from

[ Top ]

boolean equals(
object Date
$when)

Test if this date/time is exactly equal to a certian date/time

Return: true if this date is exactly equal to $when
Access: public

Parameters:

object Date $when — the date to test against

[ Top ]

string format(
string
$format)

Date pretty printing, similar to strftime()

Formats the date in the given format, much like strftime(). Most strftime() options are supported.

formatting options:


1     %a

abbreviated weekday name (Sun, Mon, Tue)


1     %A

full weekday name (Sunday, Monday, Tuesday)


1     %b

abbreviated month name (Jan, Feb, Mar)


1     %B

full month name (January, February, March)


1     %C

century number (the year divided by 100 and truncated to an integer, range 00 to 99)


1     %d

day of month (range 00 to 31)


1     %D

same as "%m/%d/%y"


1     %e

day of month, single digit (range 0 to 31)


1     %E

number of days since unspecified epoch (integer, Date_Calc::dateToDays())


1     %H

hour as decimal number (00 to 23)


1     %I

hour as decimal number on 12-hour clock (01 to 12)


1     %j

day of year (range 001 to 366)


1     %m

month as decimal number (range 01 to 12)


1     %M

minute as a decimal number (00 to 59)


1     %n

newline character (\n)


1     %O

dst-corrected timezone offset expressed as "+/-HH:MM"


1     %o

raw timezone offset expressed as "+/-HH:MM"


1     %p

either 'am' or 'pm' depending on the time


1     %P

either 'AM' or 'PM' depending on the time


1     %r

time in am/pm notation, same as "%I:%M:%S %p"


1     %R

time in 24-hour notation, same as "%H:%M"


1     %S

seconds as a decimal number (00 to 59)


1     %t

tab character (\t)


1     %T

current time, same as "%H:%M:%S"


1     %w

weekday as decimal (0 = Sunday)


1     %U

week number of current year, first sunday as first week


1     %y

year as decimal (range 00 to 99)


1     %Y

year as decimal including century (range 0000 to 9999)


1     %%

literal '%'

Return: date/time in given format
Access: public

Parameters:

string $format — format the format string for returned date/time

[ Top ]

string getDate(
[int
$format = DATE_FORMAT_ISO])

Get a string (or other) representation of this date

Get a string (or other) representation of this date in the format specified by the DATE_FORMAT_* constants.

Return: the date in the requested format
Access: public

Parameters:

int $format — format constant (DATE_FORMAT_*) of the output date

[ Top ]

int getDay(
)

Returns the day field of the date object

Return: the day
Access: public

[ Top ]

string getDayName(
[boolean
$abbr = false])

Gets the full name or abbriviated name of this weekday

Return: name of this day
Access: public

Parameters:

boolean $abbr — abbrivate the name

[ Top ]

int getDayOfWeek(
)

Gets the day of the week for this date

Gets the day of the week for this date (0=Sunday)

Return: the day of the week (0=Sunday)
Access: public

[ Top ]

int getDaysInMonth(
)

Gets number of days in the month for this date

Return: number of days in this month
Access: public

[ Top ]

int getHour(
)

Returns the hour field of the date object

Return: the hour
Access: public

[ Top ]

int getJulianDate(
)

Get the Julian date for this date

Return: the Julian date
Access: public

[ Top ]

int getMinute(
)

Returns the minute field of the date object

Return: the minute
Access: public

[ Top ]

int getMonth(
)

Returns the month field of the date object

Return: the month
Access: public

[ Top ]

string getMonthName(
[boolean
$abbr = false])

Gets the full name or abbriviated name of this month

Return: name of this month
Access: public

Parameters:

boolean $abbr — abbrivate the name

[ Top ]

object Date getNextDay(
)

Get a Date object for the day after this one

Get a Date object for the day after this one. The time of the returned Date object is the same as this time.

Return: Date representing the next day
Access: public

[ Top ]

object Date getNextWeekday(
)

Get a Date object for the weekday after this one

Get a Date object for the weekday after this one. The time of the returned Date object is the same as this time.

Return: Date representing the next weekday
Access: public

[ Top ]

object Date getPrevDay(
)

Get a Date object for the day before this one

Get a Date object for the day before this one. The time of the returned Date object is the same as this time.

Return: Date representing the previous day
Access: public

[ Top ]

object Date getPrevWeekday(
)

Get a Date object for the weekday before this one

Get a Date object for the weekday before this one. The time of the returned Date object is the same as this time.

Return: Date representing the previous weekday
Access: public

[ Top ]

int getQuarterOfYear(
)

Gets the quarter of the year for this date

Return: the quarter of the year (1-4)
Access: public

[ Top ]

int getSecond(
)

Returns the second field of the date object

Return: the second
Access: public

[ Top ]

int getTime(
)

Get this date/time in Unix time() format

Get a representation of this date in Unix time() format. This may only be valid for dates from 1970 to ~2038.

Return: number of seconds since the unix epoch
Access: public

[ Top ]

int getWeekOfYear(
)

Gets the week of the year for this date

Return: the week of the year
Access: public

[ Top ]

int getWeeksInMonth(
)

Gets the number of weeks in the month for this date

Return: number of weeks in this month
Access: public

[ Top ]

int getYear(
)

Returns the year field of the date object

Return: the year
Access: public

[ Top ]

boolean inDaylightTime(
)

Tests if this date/time is in DST

Returns true if daylight savings time is in effect for this date in this date's time zone. See Date_TimeZone::inDaylightTime() for compatability information.

Return: true if DST is in effect for this date
Access: public

[ Top ]

boolean isFuture(
)

Determine if this date is in the future

Return: true if this date is in the future
Access: public

[ Top ]

boolean isLeapYear(
)

Determine if the year in this date is a leap year

Return: true if this year is a leap year
Access: public

[ Top ]

boolean isPast(
)

Determine if this date is in the past

Return: true if this date is in the past
Access: public

[ Top ]

void setDate(
string
$date, [int
$format = DATE_FORMAT_ISO])

Set the fields of a Date object based on the input date and format

Set the fields of a Date object based on the input date and format, which is specified by the DATE_FORMAT_* constants.

Access: public

Parameters:

string	`$date`	—	input date
int	`$format`	—	format constant (DATE_FORMAT_*) of the input date

[ Top ]

void setDay(
int
$d)

Set the day field of the date object

Set the day field of the date object, invalid days (not 1-31) are set to 1.

Access: public

Parameters:

int $d — the day

[ Top ]

void setHour(
int
$h)

Set the hour field of the date object

Set the hour field of the date object in 24-hour format. Invalid hours (not 0-23) are set to 0.

Access: public

Parameters:

int $h — the hour

[ Top ]

void setMinute(
int
$m)

Set the minute field of the date object

Set the minute field of the date object, invalid minutes (not 0-59) are set to 0.

Access: public

Parameters:

int $m — the minute

[ Top ]

void setMonth(
int
$m)

Set the month field of the date object

Set the month field of the date object, invalid months (not 1-12) are set to 1.

Access: public

Parameters:

int $m — the month

[ Top ]

void setSecond(
int
$s)

Set the second field of the date object

Set the second field of the date object, invalid seconds (not 0-59) are set to 0.

Access: public

Parameters:

int $s — the second

[ Top ]

void setTZ(
object Date_TimeZone
$tz)

Sets the time zone of this Date

Sets the time zone of this date with the given Date_TimeZone object. Does not alter the date/time, only assigns a new time zone. For conversion, use convertTZ().

Access: public

Parameters:

object Date_TimeZone $tz — the Date_TimeZone object to use

[ Top ]

void setTZbyID(
string
$id)

Sets the time zone of this date with the given time zone id

Sets the time zone of this date with the given time zone id, or to the system default if the given id is invalid. Does not alter the date/time, only assigns a new time zone. For conversion, use convertTZ().

Access: public

Parameters:

string $id — id a time zone id

[ Top ]

void setYear(
int
$y)

Set the year field of the date object

Set the year field of the date object, invalid years (not 0-9999) are set to 0.

Access: public

Parameters:

int $y — the year

[ Top ]

void subtractSeconds(
int
$sec)

Subtracts a given number of seconds from the date

Access: public

Parameters:

int $sec — the number of seconds to subtract

[ Top ]

void subtractSpan(
object Date_Span
$span)

Subtracts a time span to the date

Access: public

Parameters:

object Date_Span $span — the time span to subtract

[ Top ]

void toUTC(
)

Converts this date to UTC and sets this date's timezone to UTC

Access: public

[ Top ]

Class: Date

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$day =

$hour =

$minute =

$month =

$second =

$tz =

$year =

Method Detail

Date (Constructor) [line 105]

Parameters:

addSeconds [line 528]

Parameters:

addSpan [line 541]

Parameters:

after [line 689]

Parameters:

before [line 671]

Parameters:

compare [line 645]

Parameters:

convertTZ [line 482]

Parameters:

convertTZbyID [line 510]

Parameters:

copy [line 211]

Parameters:

equals [line 707]

Parameters:

format [line 265]

Parameters:

getDate [line 188]

Parameters:

getDay [line 986]

getDayName [line 852]

Parameters:

getDayOfWeek [line 786]

getDaysInMonth [line 825]

getHour [line 999]

getJulianDate [line 773]

getMinute [line 1012]

getMonth [line 973]

getMonthName [line 870]

Parameters:

getNextDay [line 888]

getNextWeekday [line 924]

getPrevDay [line 906]

getPrevWeekday [line 942]

getQuarterOfYear [line 812]

getSecond [line 1025]

getTime [line 397]

getWeekOfYear [line 799]

getWeeksInMonth [line 838]

getYear [line 960]

inDaylightTime [line 449]

isFuture [line 724]

isLeapYear [line 760]

isPast [line 742]

setDate [line 135]

Parameters:

setDay [line 1072]

Parameters:

setHour [line 1090]

Parameters:

setMinute [line 1107]

Parameters:

setMonth [line 1055]

Parameters:

setSecond [line 1124]

Parameters:

setTZ [line 413]