$defaultLocale
$defaultLocale : string
The default locale to be used for displaying formatted date strings.
Trait for date formatting methods shared by both Time & Date.
This trait expects that the implementing class define static::$_toStringFormat.
$_jsonEncodeFormat : string|array|integer
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.
nice(string|\DateTimeZone|null $timezone = null, string|null $locale = null) : string
Returns a nicely formatted date string for this object.
The format to be used is stored in the static property Time::niceFormat.
| string|\DateTimeZone|null | $timezone | 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 | The locale name in which the date should be displayed (e.g. pt-BR) |
Formatted date string
i18nFormat(string|integer|null $format = null, string|\DateTimeZone|null $timezone = null, string|null $locale = null) : string|integer
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
$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'If you wish to control the default format to be used for this method, you can alter
the value of the static Time::$defaultLocale variable and set it to one of the
possible formats accepted by this function.
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.
$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 to be used by setting the static variable
Time::$defaultLocale to a valid locale string. If empty, the default will be
taken from the intl.default_locale ini config.
| string|integer|null | $format | Format string. |
| string|\DateTimeZone|null | $timezone | 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 | The locale name in which the date should be displayed (e.g. pt-BR) |
Formatted and translated date string
parseDateTime(string $time, string|array|null $format = null) : 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.
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]);| string | $time | The time string to parse. |
| string|array|null | $format | Any format accepted by IntlDateFormatter. |
parseDate(string $date, string|integer|null $format = null) : 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.
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);| string | $date | The date string to parse. |
| string|integer|null | $format | Any format accepted by IntlDateFormatter. |
parseTime(string $time, string|integer|null $format = null) : 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.
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');| string | $time | The time string to parse. |
| string|integer|null | $format | Any format accepted by IntlDateFormatter. |
diffFormatter(\Cake\I18n\RelativeTimeFormatter|null $formatter = null) : \Cake\I18n\RelativeTimeFormatter
Get the difference formatter instance or overwrite the current one.
| \Cake\I18n\RelativeTimeFormatter|null | $formatter | The formatter instance when setting. |
The formatter instance.
_formatObject(\DateTime $date, string|integer|array $format, string $locale) : string
Returns a translated and localized date string.
Implements what IntlDateFormatter::formatObject() is in PHP 5.5+
| \DateTime | $date | Date. |
| string|integer|array | $format | Format. |
| string | $locale | The locale name in which the date should be displayed. |
Loading…