Fr3nch13/CakePHP Utilities

FrozenDate extends Date

in package

• Application

implements I18nDateTimeInterface uses DateFormatTrait

Extends the Date class provided by Chronos.

Table of Contents

Interfaces

I18nDateTimeInterface

Interface for date formatting methods shared by both Time & Date.

Properties

$niceFormat  : array<string|int, int>|string|int

The format to use when formatting a time using `Cake\I18n\Date::nice()`

$wordAccuracy  : array<string|int, string>

The format to use when formatting a time using `Date::timeAgoInWords()` and the difference is less than `Date::$wordEnd`

$wordEnd  : string

The end of relative time telling

$wordFormat  : array<string|int, int>|string|int

The format to use when formatting a time using `Cake\I18n\Date::timeAgoInWords()` and the difference is more than `Cake\I18n\Date::$wordEnd`

$_formatters  : array<string|int, IntlDateFormatter>

In-memory cache of date formatters

$_jsonEncodeFormat  : Closure|array<string|int, int>|string|int

The format to use when converting this object to JSON.

$_toStringFormat  : array<string|int, int>|string|int

The format to use when formatting a time using `Cake\I18n\Date::i18nFormat()` and `__toString`. This format is also used by `parseDateTime()`.

$defaultLocale  : string|null

The default locale to be used for displaying formatted date strings.

$lenientParsing  : bool

Whether lenient parsing is enabled for IntlDateFormatter.

Methods

__construct()  : mixed

Create a new Date instance.

__debugInfo()  : array<string, mixed>

Returns the data that should be displayed when debugging this object

__toString()  : string

diffForHumans()  : string

Get the difference in a human readable format.

disableLenientParsing()  : void

Enables lenient parsing for locale formats.

enableLenientParsing()  : void

Enables lenient parsing for locale formats.

getDefaultLocale()  : string|null

Gets the default locale.

getDiffFormatter()  : DifferenceFormatterInterface

Get the difference formatter instance.

i18nFormat()  : string|int

Returns a formatted string for this time object using the preferred format and language for the specified locale.

jsonSerialize()  : string|int

Returns a string that should be serialized when converting this object to JSON

lenientParsingEnabled()  : bool

Gets whether locale format parsing is set to lenient.

nice()  : string

Returns a nicely formatted date string for this object.

parseDate()  : static|null

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()  : static|null

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()  : static|null

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()  : void

Resets the format used to the default when converting an instance of this type to a string

setDefaultLocale()  : void

Sets the default locale.

setDiffFormatter()  : void

Set the difference formatter instance.

setJsonEncodeFormat()  : void

setToStringFormat()  : void

Sets the default format used when type converting instances of this type to string

timeAgoInWords()  : string

Returns either a relative or a formatted absolute date depending on the difference between the current date and this object.

_formatObject()  : string

Returns a translated and localized date string.

$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'

$time = new Time('2014-04-20 22:10');
$time->i18nFormat(null, null, 'de-DE');
$time->i18nFormat(\IntlDateFormatter::FULL, 'Europe/Berlin', 'de-DE');

 $time = Time::parseDate('10/13/2013');
 $time = Time::parseDate('13 Oct, 2013', 'dd MMM, y');
 $time = Time::parseDate('13 Oct, 2013', IntlDateFormatter::SHORT);

 $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, IntlDateFormatter::NONE]);

 $time = Time::parseTime('11:23pm');