Class Time

Extends the built-in DateTime class to provide handy methods and locale-aware formatting helpers

Cake\Chronos\MutableDateTime

Cake\I18n\Time implements JsonSerializable uses Cake\I18n\DateFormatTrait

Namespace: Cake\I18n
Location: I18n/Time.php

Constants summary

string

UNIX_TIMESTAMP_FORMAT ¶

'unixTimestampFormat'

Properties summary

$_toStringFormat protected static

string|array|integer

The format to use when formatting a time using Cake\I18n\Time::i18nFormat() and __toString
$niceFormat public static

string|array|integer

The format to use when formatting a time using Cake\I18n\Time::nice()
$wordAccuracy public static

array

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

string

The end of relative time telling
$wordFormat public static

string|array|integer

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

Inherited Properties

_formatters, _isDateInstance, _jsonEncodeFormat, defaultLocale

Method Summary

__construct() public
isThisMonth() public

Returns true if this object represents a date within the current month
isThisWeek() public

Returns true if this object represents a date within the current week
isThisYear() public

Returns true if this object represents a date within the current year
isWithinNext() public

Returns true this instance happened within the specified interval
listTimezones() public static

Get list of timezone identifiers
nice() public

Returns a nicely formatted date string for this object.
timeAgoInWords() public

Returns either a relative or a formatted absolute date depending on the difference between the current time and this object.
toQuarter() public

Returns the quarter
toUnixString() public

Returns a UNIX timestamp.
wasWithinLast() public

Returns true this instance will happen within the specified interval

Method Detail

__construct() public ¶

__construct( $time null , $tz null )

isThisMonth() public ¶

isThisMonth( )

Returns true if this object represents a date within the current month

Returns

boolean

isThisWeek() public ¶

isThisWeek( )

Returns true if this object represents a date within the current week

Returns

boolean

isThisYear() public ¶

isThisYear( )

Returns true if this object represents a date within the current year

Returns

boolean

isWithinNext() public ¶

isWithinNext( string|integer $timeInterval )

Returns true this instance happened within the specified interval

This overridden method provides backwards compatible behavior for integers, or strings with trailing spaces. This behavior is deprecated and will be removed in future versions of CakePHP.

Parameters

string|integer $timeInterval: the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

Returns

boolean

listTimezones() public static ¶

listTimezones( integer|string|null $filter null , string|null $country null , boolean|array $options [] )

Get list of timezone identifiers

Parameters

integer|string|null $filter optional null: A regex to filter identifier Or one of DateTimeZone class constants
string|null $country optional null: A two-letter ISO 3166-1 compatible country code. This option is only used when $filter is set to DateTimeZone::PER_COUNTRY
boolean|array $options optional []: If true (default value) groups the identifiers list by primary region. Otherwise, an array containing group, abbr, before, and after keys. Setting group and abbr to true will group results and append timezone abbreviation in the display value. Set before and after to customize the abbreviation wrapper.

Returns

array
List of timezone identifiers

Since

2.2

nice() public ¶

nice( string|DateTimeZone|null $timezone null , string|null $locale null )

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 null: 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 null: The locale name in which the date should be displayed (e.g. pt-BR)

Returns

string
Formatted date string

timeAgoInWords() public ¶

timeAgoInWords( array $options [] )

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

Options:

from => another Time object representing the "now" time
format => a fall back format if the relative time is longer than the duration specified by end
accuracy => Specifies how accurate the date should be described (array)
- year => The format if years > 0 (default "day")
- month => The format if months > 0 (default "day")
- week => The format if weeks > 0 (default "day")
- day => The format if weeks > 0 (default "hour")
- hour => The format if hours > 0 (default "minute")
- minute => The format if minutes > 0 (default "minute")
- second => The format if seconds > 0 (default "second")
end => The end of relative time telling
relativeString => The printf compatible string when outputting relative time
absoluteString => The printf compatible string when outputting absolute time
timezone => The user timezone the timestamp should be formatted in.

Relative dates look something like this:

3 weeks, 4 days ago
15 seconds ago

Default date formatting is d/M/YY e.g: on 18/2/09. Formatting is done internally using i18nFormat, see the method for the valid formatting strings

The returned string includes 'ago' or 'on' and assumes you'll properly add a word like 'Posted ' before the function output.

NOTE: If the difference is one week or more, the lowest level of accuracy is day

Parameters

array $options optional []: Array of options.

Returns

string
Relative time string.

toQuarter() public ¶

toQuarter( boolean $range false )

Returns the quarter

Parameters

boolean $range optional false: Range.

Returns

integer|array
1, 2, 3, or 4 quarter of year, or array if $range true

toUnixString() public ¶

toUnixString( )

Returns a UNIX timestamp.

Returns

string
UNIX timestamp

wasWithinLast() public ¶

wasWithinLast( string|integer $timeInterval )

Returns true this instance will happen within the specified interval

This overridden method provides backwards compatible behavior for integers, or strings with trailing spaces. This behavior is deprecated and will be removed in future versions of CakePHP.

Parameters

string|integer $timeInterval: the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

Returns

boolean

Methods used from Cake\I18n\DateFormatTrait

__debugInfo() public ¶

__debugInfo( )

Returns the data that should be displayed when debugging this object

Returns

array

_formatObject() protected ¶

_formatObject( DateTime $date , string|integer|array $format , string $locale )

Returns a translated and localized date string. Implements what IntlDateFormatter::formatObject() is in PHP 5.5+

Parameters

DateTime $date: Date.
string|integer|array $format: Format.
string $locale: The locale name in which the date should be displayed.

Returns

string

diffFormatter() public static ¶

diffFormatter( Cake\I18n\RelativeTimeFormatter|null $formatter null )

Get the difference formatter instance or overwrite the current one.

Parameters

Cake\I18n\RelativeTimeFormatter|null $formatter optional null: The formatter instance when setting.

Returns

Cake\I18n\RelativeTimeFormatter
The formatter instance.

getDefaultLocale() public static ¶

getDefaultLocale( )

Gets the default locale.

Returns

string|null
The default locale string to be used or null.

i18nFormat() public ¶

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'

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.

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 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.

Parameters

string|integer|null $format optional null: Format string.
string|DateTimeZone|null $timezone optional null: 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 null: The locale name in which the date should be displayed (e.g. pt-BR)

Returns

string|integer
Formatted and translated date string

jsonSerialize() public ¶

jsonSerialize( )

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

Returns

string

parseDate() public static ¶

parseDate( string $date , string|integer|null $format 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);

Parameters

string $date: The date string to parse.
string|integer|null $format optional null: Any format accepted by IntlDateFormatter.

Returns

Cake\I18n\DateFormatTrait|null

parseDateTime() public static ¶

parseDateTime( string $time , string|array|null $format 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]);

Parameters

string $time: The time string to parse.
string|array|null $format optional null: Any format accepted by IntlDateFormatter.

Returns

Cake\I18n\DateFormatTrait|null

parseTime() public static ¶

parseTime( string $time , string|integer|null $format 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');

Parameters

string $time: The time string to parse.
string|integer|null $format optional null: Any format accepted by IntlDateFormatter.

Returns

Cake\I18n\DateFormatTrait|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( string|null $locale null )

Sets the default locale.

Parameters

string|null $locale optional null: The default locale string to be used or null.

setJsonEncodeFormat() public static ¶

setJsonEncodeFormat( string|array|integer $format )

Sets the default format used when converting this object to json

Parameters

string|array|integer $format: Format.

setToStringFormat() public static ¶

setToStringFormat( string|array|integer $format )

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

Parameters

string|array|integer $format: Format.

Properties detail

`$_toStringFormat` ¶

protected static string|array|integer

The format to use when formatting a time using Cake\I18n\Time::i18nFormat() and __toString

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.

See

\Cake\I18n\Time::i18nFormat()

[IntlDateFormatter::SHORT, IntlDateFormatter::SHORT]

`$niceFormat` ¶

public static string|array|integer

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

See

\Cake\I18n\Time::nice()

[IntlDateFormatter::MEDIUM, IntlDateFormatter::SHORT]

`$wordAccuracy` ¶

public static array

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

See

\Cake\I18n\Time::timeAgoInWords()

[
    'year' => 'day',
    'month' => 'day',
    'week' => 'day',
    'day' => 'hour',
    'hour' => 'minute',
    'minute' => 'minute',
    'second' => 'second',
]

`$wordEnd` ¶

public static string

The end of relative time telling

See

\Cake\I18n\Time::timeAgoInWords()

'+1 month'

`$wordFormat` ¶

public static string|array|integer

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

See

\Cake\I18n\Time::timeAgoInWords()

[IntlDateFormatter::SHORT, -1]

Namespaces

Classes

Traits

Class Time

Constants summary

Properties summary

Inherited Properties

Method Summary

__construct() public

isThisMonth() public

isThisWeek() public

isThisYear() public

isWithinNext() public

listTimezones() public static

nice() public

timeAgoInWords() public

toQuarter() public

toUnixString() public

wasWithinLast() public

Method Detail

__construct() public ¶

isThisMonth() public ¶

Returns

isThisWeek() public ¶

Returns

isThisYear() public ¶

Returns

isWithinNext() public ¶

Parameters

Returns

listTimezones() public static ¶

Parameters

Returns

Since

nice() public ¶

Parameters

Returns

timeAgoInWords() public ¶

Options:

Parameters

Returns

toQuarter() public ¶

Parameters

Returns

toUnixString() public ¶

Returns

wasWithinLast() public ¶

Parameters

Returns

Methods used from Cake\I18n\DateFormatTrait

__debugInfo() public ¶

Returns

__toString() public ¶

_formatObject() protected ¶

Parameters

Returns

diffFormatter() public static ¶

Parameters

Returns

getDefaultLocale() public static ¶

Returns

i18nFormat() public ¶

Examples

Examples

Parameters

Returns

jsonSerialize() public ¶

Returns

parseDate() public static ¶

Parameters

Returns

parseDateTime() public static ¶

Parameters

Returns

parseTime() public static ¶

Parameters

Returns

resetToStringFormat() public static ¶

setDefaultLocale() public static ¶

Parameters

`$_toStringFormat` ¶

`$niceFormat` ¶

`$wordAccuracy` ¶

`$wordEnd` ¶

`$wordFormat` ¶