Trait DateFormatTrait
Trait for date formatting methods shared by both Time & Date.
This trait expects that the implementing class define static::$_toStringFormat.
Properties summary
- $_formatters protected static
\IntlDateFormatter[]
In-memory cache of date formatters
- $_isDateInstance protected static
bool
Caches whether or not this class is a subclass of a Date or MutableDate
- $_jsonEncodeFormat protected static
string|array|int|\Closure
The format to use when when converting this object to json
- $defaultLocale public static
string
The default locale to be used for displaying formatted date strings.
- $lenientParsing protected static
bool
Whether lenient parsing is enabled for IntlDateFormatter.
Method Summary
- i18nFormat() public
Returns a formatted string for this time object using the preferred format and language for the specified locale.
- jsonSerialize() public
Returns a string that should be serialized when converting this object to json
- parseDate() public static
Returns a new Time object after parsing the provided $date string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
- parseDateTime() public static
Returns a new Time object after parsing the provided time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
- parseTime() public static
Returns a new Time object after parsing the provided $time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
- resetToStringFormat() public static
Resets the format used to the default when converting an instance of this type to a string
- setJsonEncodeFormat() public static
Sets the default format used when converting this object to json
- setToStringFormat() public static
Sets the default format used when type converting instances of this type to string
Method Detail
__debugInfo() public
__debugInfo()
Returns the data that should be displayed when debugging this object
Returns
array
__toString() public
__toString()
{@inheritDoc}
_formatObject() protected
_formatObject(mixed $date, mixed $format, mixed $locale)
Returns a translated and localized date string.
Implements what IntlDateFormatter::formatObject() is in PHP 5.5+
Parameters
-
\DateTime|\DateTimeImmutable
$date Date.
-
string|int|array
$format Format.
-
string|null
$locale The locale name in which the date should be displayed.
Returns
string
diffFormatter() public static
diffFormatter(mixed $formatter)
Get the difference formatter instance or overwrite the current one.
Parameters
-
\Cake\I18n\RelativeTimeFormatter|null
$formatter optional The formatter instance when setting.
Returns
\Cake\I18n\RelativeTimeFormatter
The formatter instance.
disableLenientParsing() public static
disableLenientParsing()
Enables lenient parsing for locale formats.
enableLenientParsing() public static
enableLenientParsing()
Enables lenient parsing for locale formats.
getDefaultLocale() public static
getDefaultLocale()
Gets the default locale.
Returns
string|null
The default locale string to be used or null.
i18nFormat() public
i18nFormat(mixed $format, mixed $timezone, mixed $locale)
Returns a formatted string for this time object using the preferred format and language for the specified locale.
It is possible to specify the desired format for the string to be displayed. You can either pass IntlDateFormatter
constants as the first argument of this function, or pass a full ICU date formatting string as specified in the following resource: http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details.
Additional to IntlDateFormatter
constants and date formatting string you can use Time::UNIX_TIMESTAMP_FORMAT to get a unix timestamp
Examples
$time = new Time('2014-04-20 22:10'); $time->i18nFormat(); // outputs '4/20/14, 10:10 PM' for the en-US locale $time->i18nFormat(\IntlDateFormatter::FULL); // Use the full date and time format $time->i18nFormat([\IntlDateFormatter::FULL, \IntlDateFormatter::SHORT]); // Use full date but short time format $time->i18nFormat('yyyy-MM-dd HH:mm:ss'); // outputs '2014-04-20 22:10' $time->i18nFormat(Time::UNIX_TIMESTAMP_FORMAT); // outputs '1398031800'
You can control the default format used through Time::setToStringFormat()
.
You can read about the available IntlDateFormatter constants at https://secure.php.net/manual/en/class.intldateformatter.php
If you need to display the date in a different timezone than the one being used for this Time object without altering its internal state, you can pass a timezone string or object as the second parameter.
Finally, should you need to use a different locale for displaying this time object, pass a locale string as the third parameter to this function.
Examples
$time = new Time('2014-04-20 22:10'); $time->i18nFormat(null, null, 'de-DE'); $time->i18nFormat(\IntlDateFormatter::FULL, 'Europe/Berlin', 'de-DE');
You can control the default locale used through Time::setDefaultLocale()
. If empty, the default will be taken from the intl.default_locale
ini config.
Parameters
-
string|int|array|null
$format optional Format string.
-
string|\DateTimeZone|null
$timezone optional Timezone string or DateTimeZone object in which the date will be displayed. The timezone stored for this object will not be changed.
-
string|null
$locale optional The locale name in which the date should be displayed (e.g. pt-BR)
Returns
string|int
Formatted and translated date string
jsonSerialize() public
jsonSerialize()
Returns a string that should be serialized when converting this object to json
Returns
string
lenientParsingEnabled() public static
lenientParsingEnabled()
Gets whether locale format parsing is set to lenient.
Returns
bool
nice() public
nice(mixed $timezone, mixed $locale)
Returns a nicely formatted date string for this object.
The format to be used is stored in the static property Time::niceFormat
.
Parameters
-
string|\DateTimeZone|null
$timezone optional Timezone string or DateTimeZone object in which the date will be displayed. The timezone stored for this object will not be changed.
-
string|null
$locale optional The locale name in which the date should be displayed (e.g. pt-BR)
Returns
string
Formatted date string
parseDate() public static
parseDate(mixed $date, mixed $format)
Returns a new Time object after parsing the provided $date string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the wordFormat
format will be used.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseDate('10/13/2013'); $time = Time::parseDate('13 Oct, 2013', 'dd MMM, y'); $time = Time::parseDate('13 Oct, 2013', IntlDateFormatter::SHORT);
Parameters
-
string
$date The date string to parse.
-
string|int|null
$format optional Any format accepted by IntlDateFormatter.
Returns
static|null
parseDateTime() public static
parseDateTime(mixed $time, mixed $format)
Returns a new Time object after parsing the provided time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the toString
format will be used.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseDateTime('10/13/2013 12:54am'); $time = Time::parseDateTime('13 Oct, 2013 13:54', 'dd MMM, y H:mm'); $time = Time::parseDateTime('10/10/2015', [IntlDateFormatter::SHORT, -1]);
Parameters
-
string
$time The time string to parse.
-
string|array|null
$format optional Any format accepted by IntlDateFormatter.
Returns
static|null
parseTime() public static
parseTime(mixed $time, mixed $format)
Returns a new Time object after parsing the provided $time string based on the passed or configured date time format. This method is locale dependent, Any string that is passed to this function will be interpreted as a locale dependent string.
When no $format is provided, the IntlDateFormatter::SHORT format will be used.
If it was impossible to parse the provided time, null will be returned.
Example:
$time = Time::parseTime('11:23pm');
Parameters
-
string
$time The time string to parse.
-
string|int|null
$format optional Any format accepted by IntlDateFormatter.
Returns
static|null
resetToStringFormat() public static
resetToStringFormat()
Resets the format used to the default when converting an instance of this type to a string
setDefaultLocale() public static
setDefaultLocale(mixed $locale)
Sets the default locale.
Set to null to use IntlDateFormatter default.
Parameters
-
string|null
$locale optional The default locale string to be used or null.
setJsonEncodeFormat() public static
setJsonEncodeFormat(mixed $format)
Sets the default format used when converting this object to json
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
Alternatively, the format can provide a callback. In this case, the callback can receive this datetime object and return a formatted string.
Parameters
-
string|array|int|\Closure
$format Format.
See Also
setToStringFormat() public static
setToStringFormat(mixed $format)
Sets the default format used when type converting instances of this type to string
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
Parameters
-
string|array|int
$format Format.
Property Detail
$_formatters protected static
In-memory cache of date formatters
Type
\IntlDateFormatter[]
$_isDateInstance protected static
Caches whether or not this class is a subclass of a Date or MutableDate
Type
bool
$_jsonEncodeFormat protected static
The format to use when when converting this object to json
The format should be either the formatting constants from IntlDateFormatter as described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
It is possible to provide an array of 2 constants. In this case, the first position will be used for formatting the date part of the object and the second position will be used to format the time part.
Type
string|array|int|\Closure
$defaultLocale public static
The default locale to be used for displaying formatted date strings.
Type
string
$lenientParsing protected static
Whether lenient parsing is enabled for IntlDateFormatter.
Defaults to true which is the default for IntlDateFormatter.
Type
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/trait-Cake.I18n.DateFormatTrait.html