Class JDate

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

DateTime implements DateTimeInterface

JDate

Package: Joomla\Platform\Date
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/date/date.php

Methods summary

`public`	# `__construct( string $date = 'now', mixed $tz = null )` Constructor. Constructor. Parameters `$date` `string` - $date String in a format accepted by strtotime(), defaults to "now". `$tz` `mixed` - $tz Time zone to be used for the date. Might be a string or a DateTimeZone object. Since 11.1 Overrides `DateTime::__construct`
`public mixed`	# `__get( string $name )` Magic method to access properties of the date given by class to the format method. Magic method to access properties of the date given by class to the format method. Parameters `$name` `string` - $name The name of the property. Returns `mixed` - A value if the property name is valid, null otherwise. Since 11.1
`public string`	# `__toString( )` Magic method to render the date object in the format specified in the public static member JDate::$format. Magic method to render the date object in the format specified in the public static member JDate::$format. Returns `string` - The date as a formatted string. Since 11.1
`public static JDate`	# `getInstance( string $date = 'now', mixed $tz = null )` Proxy for new JDate(). Proxy for new JDate(). Parameters `$date` `string` - $date String in a format accepted by strtotime(), defaults to "now". `$tz` `mixed` - $tz Time zone to be used for the date. Returns `JDate` Since 11.3
`public string`	# `dayToString( integer $day, boolean $abbr = false )` Translates day of week number to a string. Translates day of week number to a string. Parameters `$day` `integer` - $day The numeric day of the week. `$abbr` `boolean` - $abbr Return the abbreviated day string? Returns `string` - The day of the week. Since 11.1
`public string`	# `calendar( string $format, boolean $local = false, boolean $translate = true )` Gets the date as a formatted string in a local calendar. Gets the date as a formatted string in a local calendar. Parameters `$format` `string` - $format The date format specification string (see PHP_MANUAL#date) `$local` `boolean` - $local True to return the date string in the local time zone, false to return it in GMT. `$translate` `boolean` - $translate True to translate localised strings Returns `string` - The date string in the specified format format. Since 11.1
`public string`	# `format( string $format, boolean $local = false, boolean $translate = true )` Gets the date as a formatted string. Gets the date as a formatted string. Parameters `$format` `string` - $format The date format specification string (see PHP_MANUAL#date) `$local` `boolean` - $local True to return the date string in the local time zone, false to return it in GMT. `$translate` `boolean` - $translate True to translate localised strings Returns `string` - The date string in the specified format format. Since 11.1 Overrides `DateTime::format`
`public float`	# `getOffsetFromGmt( boolean $hours = false )` Get the time offset from GMT in hours or seconds. Get the time offset from GMT in hours or seconds. Parameters `$hours` `boolean` - $hours True to return the value in hours. Returns `float` - The time offset from GMT either in hours or in seconds. Since 11.1
`public string`	# `monthToString( integer $month, boolean $abbr = false )` Translates month number to a string. Translates month number to a string. Parameters `$month` `integer` - $month The numeric month of the year. `$abbr` `boolean` - $abbr If true, return the abbreviated month string Returns `string` - The month of the year. Since 11.1
`public JDate`	# `setTimezone( DateTimeZone $tz )` Method to wrap the setTimezone() function and set the internal time zone object. Method to wrap the setTimezone() function and set the internal time zone object. Parameters `$tz` `DateTimeZone` - $tz The new DateTimeZone object. Returns `JDate` Since 11.1 Note This method can't be type hinted due to a PHP bug: https://bugs.php.net/bug.php?id=61483 Overrides `DateTime::setTimezone`
`public string`	# `toISO8601( boolean $local = false )` 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. 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. Parameters `$local` `boolean` - $local True to return the date string in the local time zone, false to return it in GMT. Returns `string` - The date string in ISO 8601 format. Since 11.1 Link http://www.ietf.org/rfc/rfc3339.txt
`public string`	# `toSql( boolean $local = false, JDatabaseDriver $db = null )` Gets the date as an SQL datetime string. Gets the date as an SQL datetime string. Parameters `$local` `boolean` - $local True to return the date string in the local time zone, false to return it in GMT. `$db` `JDatabaseDriver` - $db The database driver or null to use JFactory::getDbo() Returns `string` - The date string in SQL datetime format. Since 11.4 Link http://dev.mysql.com/doc/refman/5.0/en/datetime.html
`public string`	# `toRFC822( boolean $local = false )` 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. 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. Parameters `$local` `boolean` - $local True to return the date string in the local time zone, false to return it in GMT. Returns `string` - The date string in RFC 822 format. Since 11.1 Link http://www.ietf.org/rfc/rfc2822.txt
`public integer`	# `toUnix( )` Gets the date as UNIX time stamp. Gets the date as UNIX time stamp. Returns `integer` - The date as a UNIX timestamp. Since 11.1

Methods inherited from DateTime

__set_state(), __wakeup(), add(), createFromFormat(), diff(), getLastErrors(), getOffset(), getTimestamp(), getTimezone(), modify(), setDate(), setISODate(), setTime(), setTimestamp(), sub()

Magic methods summary

`public JDate\|boolean`	# `add( DateInterval $interval = )` Adds an amount of days, months, years, hours, minutes and seconds to a JDate object. Adds an amount of days, months, years, hours, minutes and seconds to a JDate object. Parameters `$interval` `DateInterval` - $interval Returns `JDate\|boolean`
`public JDate\|boolean`	# `sub( DateInterval $interval = )` Subtracts an amount of days, months, years, hours, minutes and seconds from a JDate object. Subtracts an amount of days, months, years, hours, minutes and seconds from a JDate object. Parameters `$interval` `DateInterval` - $interval Returns `JDate\|boolean`
`public JDate\|boolean`	# `modify( )` . . Returns `JDate\|boolean`

Constants summary

`string`	`DAY_ABBR`	`"\x021\x03"`	#
`string`	`DAY_NAME`	`"\x022\x03"`	#
`string`	`MONTH_ABBR`	`"\x023\x03"`	#
`string`	`MONTH_NAME`	`"\x024\x03"`	#

Constants inherited from DateTime

ATOM, COOKIE, ISO8601, RFC1036, RFC1123, RFC2822, RFC3339, RFC3339_EXTENDED, RFC822, RFC850, RSS, W3C

Properties summary

`public static string`	`$format`	# The format string to be applied when using the __toString() magic method. The format string to be applied when using the __toString() magic method. Since 11.1
`protected static object`	`$gmt`	# Placeholder for a DateTimeZone object with GMT as the time zone. Placeholder for a DateTimeZone object with GMT as the time zone. Since 11.1
`protected static object`	`$stz`	# Placeholder for a DateTimeZone object with the default server time zone as the time zone. Placeholder for a DateTimeZone object with the default server time zone as the time zone. Since 11.1
`protected DateTimeZone`	`$tz`	# The DateTimeZone object for usage in rending dates as strings. The DateTimeZone object for usage in rending dates as strings. Since 12.1

Magic properties

`public read-only string`	`$daysinmonth`	# t - Number of days in the given month. t - Number of days in the given month.
`public read-only string`	`$dayofweek`	# N - ISO-8601 numeric representation of the day of the week. N - ISO-8601 numeric representation of the day of the week.
`public read-only string`	`$dayofyear`	# z - The day of the year (starting from 0). z - The day of the year (starting from 0).
`public read-only boolean`	`$isleapyear`	# L - Whether it's a leap year. L - Whether it's a leap year.
`public read-only string`	`$day`	# d - Day of the month, 2 digits with leading zeros. d - Day of the month, 2 digits with leading zeros.
`public read-only string`	`$hour`	# H - 24-hour format of an hour with leading zeros. H - 24-hour format of an hour with leading zeros.
`public read-only string`	`$minute`	# i - Minutes with leading zeros. i - Minutes with leading zeros.
`public read-only string`	`$second`	# s - Seconds with leading zeros. s - Seconds with leading zeros.
`public read-only string`	`$microsecond`	# u - Microseconds with leading zeros. u - Microseconds with leading zeros.
`public read-only string`	`$month`	# m - Numeric representation of a month, with leading zeros. m - Numeric representation of a month, with leading zeros.
`public read-only string`	`$ordinal`	# S - English ordinal suffix for the day of the month, 2 characters. S - English ordinal suffix for the day of the month, 2 characters.
`public read-only string`	`$week`	# W - ISO-8601 week number of year, weeks starting on Monday. W - ISO-8601 week number of year, weeks starting on Monday.
`public read-only string`	`$year`	# Y - A full numeric representation of a year, 4 digits. Y - A full numeric representation of a year, 4 digits.

`public JDate\|boolean`	# `add( DateInterval $interval = )` Adds an amount of days, months, years, hours, minutes and seconds to a JDate object. Adds an amount of days, months, years, hours, minutes and seconds to a JDate object. Parameters `$interval` `DateInterval` - $interval Returns `JDate\|boolean`
`public JDate\|boolean`	# `sub( DateInterval $interval = )` Subtracts an amount of days, months, years, hours, minutes and seconds from a JDate object. Subtracts an amount of days, months, years, hours, minutes and seconds from a JDate object. Parameters `$interval` `DateInterval` - $interval Returns `JDate\|boolean`
`public JDate\|boolean`	# `modify( )` . . Returns `JDate\|boolean`

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JDate

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Note

Overrides

Parameters

Returns

Since

Link

Parameters

Returns

Since

Link

Parameters

Returns

Since

Link

Returns

Since

Methods inherited from DateTime

Magic methods summary

Parameters

Returns

Parameters

Returns

Returns

Constants summary

Constants inherited from DateTime

Properties summary

Since

Since

Since

Since

Magic properties