Joomla! API

Extends DateTime

Date is a class that stores a date and provides logic to manipulate and render that date in a variety of formats.

property-read string	t - Number of days in the given month. N - ISO-8601 numeric representation of the day of the week. z - The day of the year (starting from 0). L - Whether it's a leap year. d - Day of the month, 2 digits with leading zeros. H - 24-hour format of an hour with leading zeros. i - Minutes with leading zeros. s - Seconds with leading zeros. u - Microseconds with leading zeros. m - Numeric representation of a month, with leading zeros. S - English ordinal suffix for the day of the month, 2 characters. W - ISO-8601 week number of year, weeks starting on Monday. Y - A full numeric representation of a year, 4 digits.
since	1.7.0
package	Joomla CMS

property-read string

t - Number of days in the given month.

N - ISO-8601 numeric representation of the day of the week.

z - The day of the year (starting from 0).

L - Whether it's a leap year.

d - Day of the month, 2 digits with leading zeros.

H - 24-hour format of an hour with leading zeros.

i - Minutes with leading zeros.

s - Seconds with leading zeros.

u - Microseconds with leading zeros.

m - Numeric representation of a month, with leading zeros.

S - English ordinal suffix for the day of the month, 2 characters.

W - ISO-8601 week number of year, weeks starting on Monday.

Y - A full numeric representation of a year, 4 digits.

since

1.7.0

package

Joomla CMS

Methods

Constructor.

__construct( date = 'now',  tz = null) :

since	1.7.0

Arguments

date: stringString in a format accepted by strtotime(), defaults to "now".
tz: mixedTime zone to be used for the date. Might be a string or a DateTimeZone object.

Response

mixed

Magic method to access properties of the date given by class to the format method.

__get( name) :

since	1.7.0

Arguments

name: stringThe name of the property.

Response

mixedA value if the property name is valid, null otherwise.

Magic method to render the date object in the format specified in the public static member Date::$format.

__toString() :

since	1.7.0

Response

stringThe date as a formatted string.

add(\DateInterval interval) : \Joomla\CMS\Date\Date|bool

Adds an amount of days, months, years, hours, minutes and seconds to a Date object.

Arguments

interval: DateInterval

Response

Date|bool

Gets the date as a formatted string in a local calendar.

calendar( format,  local = false,  translate = true) :

since	1.7.0

Arguments

format: stringThe date format specification string (see {@link PHP_MANUAL#date})
local: boolTrue to return the date string in the local time zone, false to return it in GMT.
translate: boolTrue to translate localised strings

Response

stringThe date string in the specified format format.

Translates day of week number to a string.

dayToString( day,  abbr = false) :

since	1.7.0

Arguments

day: intThe numeric day of the week.
abbr: boolReturn the abbreviated day string?

Response

stringThe day of the week.

Gets the date as a formatted string.

format( format,  local = false,  translate = true) :

since	1.7.0

Arguments

format: stringThe date format specification string (see {@link PHP_MANUAL#date})
local: boolTrue to return the date string in the local time zone, false to return it in GMT.
translate: boolTrue to translate localised strings

Response

stringThe date string in the specified format format.

Proxy for new Date().

getInstance( date = 'now',  tz = null) : \Joomla\CMS\Date\Date

static

since	1.7.3

Arguments

date: stringString in a format accepted by strtotime(), defaults to "now".
tz: mixedTime zone to be used for the date.

Response

Date

Get the time offset from GMT in hours or seconds.

getOffsetFromGmt( hours = false) :

since	1.7.0

Arguments

hours: boolTrue to return the value in hours.

Response

floatThe time offset from GMT either in hours or in seconds.

modify( modify) : \Joomla\CMS\Date\Date|bool

Alter the timestamp of this object by incre/decre-menting in a format accepted by strtotime().

Arguments

modify: string

Response

Date|bool

Translates month number to a string.

monthToString( month,  abbr = false) :

since	1.7.0

Arguments

month: intThe numeric month of the year.
abbr: boolIf true, return the abbreviated month string

Response

stringThe month of the year.

Method to wrap the setTimezone() function and set the internal time zone object.

setTimezone(\DateTimeZone tz) : \Joomla\CMS\Date\Date

since	1.7.0
note	This method can't be type hinted due to a PHP bug: https://bugs.php.net/bug.php?id=61483

Arguments

tz: DateTimeZoneThe new \DateTimeZone object.

Response

Date

sub(\DateInterval interval) : \Joomla\CMS\Date\Date|bool

Subtracts an amount of days, months, years, hours, minutes and seconds from a Date object.

Arguments

interval: DateInterval

Response

Date|bool

Gets the date as an ISO 8601 string. IETF RFC 3339 defines the ISO 8601 format and it can be found at the IETF Web site.

toISO8601( local = false) :

link
since	1.7.0

Arguments

local: boolTrue to return the date string in the local time zone, false to return it in GMT.

Response

stringThe date string in ISO 8601 format.

Gets the date as an RFC 822 string. IETF RFC 2822 supercedes RFC 822 and its definition can be found at the IETF Web site.

toRFC822( local = false) :

link
since	1.7.0

Arguments

local: boolTrue to return the date string in the local time zone, false to return it in GMT.

Response

stringThe date string in RFC 822 format.

Gets the date as an SQL datetime string.

toSql( local = false, \Joomla\Database\DatabaseDriver db = null) :

link
since	2.5.0

Arguments

local: boolTrue to return the date string in the local time zone, false to return it in GMT.
db: DatabaseDriverThe database driver or null to use Factory::getDbo()

Response

stringThe date string in SQL datetime format.

Gets the date as UNIX time stamp.

toUnix() :

since	1.7.0

Response

intThe date as a UNIX timestamp.

Constants

Value	"\x021\x03"

Value	"\x022\x03"

Value	"\x023\x03"

Value	"\x024\x03"

string

Y - A full numeric representation of a year, 4 digits.

Type(s)

string

The format string to be applied when using the __toString() magic method.

static

since	1.7.0

Type(s)

string

Placeholder for a \DateTimeZone object with GMT as the time zone.

static deprecated

since	1.7.0
deprecated	4.0 will be removed in 6.0 Will be removed without replacement

Type(s)

object

Placeholder for a \DateTimeZone object with the default server time zone as the time zone.

static deprecated

since	1.7.0
deprecated	4.0 will be removed in 6.0 Will be removed without replacement

Type(s)

object

The \DateTimeZone object for usage in rending dates as strings.

since	3.0.0

Type(s)

DateTimeZone

Date

Methods

__construct

Arguments

Response

__get

Arguments

Response

__toString

Response

add

Arguments

Response

calendar

Arguments

Response

dayToString

Arguments

Response

format

Arguments

Response

getInstance

Arguments

Response

getOffsetFromGmt

Arguments

Response

modify

Arguments

Response

monthToString

Arguments

Response

setTimezone

Arguments

Response

sub

Arguments

Response

toISO8601

Arguments

Response

toRFC822

Arguments

Response

toSql

Arguments

Response

toUnix

Response

Constants

DAY_ABBR

DAY_NAME

MONTH_ABBR

MONTH_NAME

Properties

daysinmonth

Type(s)

dayofweek

Type(s)

dayofyear

Type(s)

isleapyear

Type(s)

day

Type(s)

hour

Type(s)

minute

Type(s)

second

Type(s)

microsecond

Type(s)

month

Type(s)

ordinal

Type(s)

week