Documentation

Horde_Date

Horde Date wrapper/logic class, including some calculation functions.

Tags

author

Chuck Hagenbuch chuck@horde.org

author

Jan Schneider jan@horde.org

author

Michael J Rubinsky mrubinsk@horde.org

category

Horde

copyright

2004-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL

Table of Contents

DATE_DEFAULT  = 'Y-m-d H:i:s'

DATE_FRIDAY  = 5

DATE_JSON  = 'Y-m-d\TH:i:s'

DATE_MONDAY  = 1

DATE_SATURDAY  = 6

DATE_SUNDAY  = 0

DATE_THURSDAY  = 4

DATE_TUESDAY  = 2

DATE_WEDNESDAY  = 3

MASK_ALLDAYS  = 127

MASK_ALLPARTS  = 63

MASK_DAY  = 8

MASK_FRIDAY  = 32

MASK_HOUR  = 4

MASK_MINUTE  = 2

MASK_MONDAY  = 2

MASK_MONTH  = 16

MASK_SATURDAY  = 64

MASK_SECOND  = 1

MASK_SUNDAY  = 1

MASK_THURSDAY  = 16

MASK_TUESDAY  = 4

MASK_WEDNESDAY  = 8

MASK_WEEKDAYS  = 62

MASK_WEEKEND  = 65

MASK_YEAR  = 32

$_corrections  : array<string|int, mixed>

Map of required correction masks.

$_defaultFormat  : string

Default format for __toString()

$_defaultSpecs  : string

Default specs that are always supported.

$_formatCache  : mixed

$_hour  : int

Hour

$_mday  : int

Day

$_min  : int

Minute

$_month  : int

Month

$_sec  : int

Second

$_supportedSpecs  : string

Internally supported strftime() specifiers.

$_timezone  : string

String representation of the date's timezone.

$_timezoneAbbreviations  : array<string|int, mixed>

These aliases map timezone abbreviations to those understood by PHP.

$_timezoneAliases  : array<string|int, mixed>

These aliases map Windows, Lotus, and other Timezone IDs to those understood by PHP.

$_timezoneIdentifiers  : array<string|int, mixed>

A list of (Olson) timezone identifiers understood by PHP.

$_year  : int

Year

__construct()  : mixed

Builds a new date object. If $date contains date parts, use them to initialize the object.

__get()  : int|string

Getter for the date and time properties.

__isset()  : boolen

Returns whether a date or time property exists.

__set()  : mixed

Setter for the date and time properties.

__toString()  : string

Returns a simple string representation of the date object

add()  : mixed

Adds a number of seconds or units to this date, returning a new Date object.

after()  : bool

Returns whether this date is after the other.

before()  : bool

Returns whether this date is before the other.

compareDate()  : int

Compares this date to another date object to see which one is greater (later). Assumes that the dates are in the same timezone.

compareDateTime()  : int

Compares this to another date object, including times, to see which one is greater (later). Assumes that the dates are in the same timezone.

compareTime()  : int

Compares this to another date object by time, to see which one is greater (later). Assumes that the dates are in the same timezone.

datestamp()  : int

Returns the unix timestamp representation of this date, 12:00am.

dateString()  : string

Formats date and time to be passed around as a short url parameter.

dayOfWeek()  : int

Returns the day of the week (0 = Sunday, 6 = Saturday) of this date.

dayOfYear()  : int

Returns the day number of the year (1 to 365/366).

diff()  : int

Returns number of days between this date and another.

equals()  : bool

Returns whether this date is the same like the other.

format()  : string

Formats time using the specifiers available in date() or in the DateTime class' format() method.

fromDays()  : Horde_Date

Converts number of days since 24th November, 4714 B.C. (in the proleptic Gregorian calendar, which is year -4713 using 'Astronomical' year numbering) to Gregorian calendar date.

getTimezoneAlias()  : string

Returns the normalized (Olson) timezone name of a timezone alias.

isValid()  : bool

Is the date currently represented by this object a valid date?

setDefaultFormat()  : mixed

Sets the default date format used in __toString()

setNthWeekday()  : mixed

Sets the date of this object to the $nth weekday of $weekday.

setTimezone()  : Horde_Date

Converts this object to a different timezone.

strftime()  : string

Formats date and time using strftime() format.

sub()  : mixed

Subtracts a number of seconds or units from this date, returning a new Horde_Date object.

timestamp()  : int

Returns the unix timestamp representation of this date.

toDateTime()  : DateTime

Returns a DateTime object representing this object.

toDays()  : int

Converts a date in the proleptic Gregorian calendar to the no of days since 24th November, 4714 B.C.

toiCalendar()  : string

Formats date and time to the RFC 2445 iCalendar DATE-TIME format.

toJson()  : string

Formats date and time to the ISO format used by JSON.

tzOffset()  : string

Returns the time offset for local time zone.

weekOfMonth()  : int

Returns the week of the month.

weekOfYear()  : int

Returns the week of the year, first Monday is first day of first week.

weeksInYear()  : int

Returns the number of weeks in the given year (52 or 53).

_correct()  : mixed

Corrects any over- or underflows in any of the date's members.

_correctMonth()  : mixed

Corrects the current month.

_initializeFromArgs()  : mixed

Handles args in order: year month day hour min sec tz

_initializeFromArray()  : mixed

_initializeFromObject()  : mixed

_initializeTimezone()  : mixed

_regexCallback()  : string

Callback used to replace a strtime pattern

_strftime()  : string

Formats date and time using a limited set of the strftime() format.