Класс FrozenTime
Расширяет встроенный класс DateTime, предоставляя удобные методы и помощники по форматированию с учётом региональных настроек.
Этот объект предоставляет неизменяемый вариант Cake\I18n\Time
- Cake\Chronos\Chronos
-
Cake\I18n\FrozenTime реализует JsonSerializable использует Cake\I18n\DateFormatTrait
Краткое описание констант
-
stringUNIX_TIMESTAMP_FORMAT'unixTimestampFormat'
Краткое описание свойств
-
string|array|integerФормат, используемый при форматировании времени с помощью
Cake\I18n\FrozenTime::i18nFormat()и__toString. Этот формат также используетсяparseDateTime(). - Формат, используемый при форматировании времени с помощью
string|array|integerCake\I18n\FrozenTime::nice() -
arrayФормат, используемый при форматировании времени с помощью
Time::timeAgoInWords()и разница меньшеTime::$wordEnd - Конец относительного времени
string -
string|array|integerФормат, используемый при форматировании времени с помощью
Cake\I18n\FrozenTime::timeAgoInWords()и разница большеCake\I18n\FrozenTime::$wordEnd
Унаследованные свойства
Краткое описание методов
- __construct() public
- isWithinNext() publicВозвращает true, если этот экземпляр произойдёт в течение указанного интервала
- Получить список идентификаторов часовых поясов
- timeAgoInWords() public
Возвращает относительную или отформатированную абсолютную дату в зависимости от разницы между текущим временем и этим объектом.
- wasWithinLast() publicВозвращает true, если этот экземпляр произошёл в течение указанного интервала
Подробное описание методов
__construct()source public
__construct( $time = null , $tz = null )
isWithinNext()source public
isWithinNext( string|integer $timeInterval )
Возвращает true, если этот экземпляр произойдёт в течение указанного интервала
Этот переопределённый метод обеспечивает обратную совместимость для целых чисел или строк с завершающими пробелами. Это поведение является устаревшим и будет удалено в будущих версиях CakePHP.
Параметры
- строка|целое число
$timeInterval Числовое значение со временем. Например, допустимые типы: 6 часов, 2 дня, 1 минута.
Возвращает
booleanlistTimezones()source public static
listTimezones( integer|string|null $filter = null , string|null $country = null , boolean|array $options = [] )
Получить список идентификаторов часовых поясов
Параметры
- целое число|строка|null
$filterнеобязательно null Регулярное выражение для фильтрации идентификатора или одно из констант класса DateTimeZone
- строка|null
$countryнеобязательно null Двухбуквенный ISO 3166-1 совместимый код страны. Этот параметр используется только при установке $filter в DateTimeZone::PER_COUNTRY
- boolean|массив
$optionsнеобязательно [] Если true (значение по умолчанию), группирует список идентификаторов по основному региону. В противном случае, массив, содержащий ключи
group,abbr,before, иafter. Установкаgroupиabbrк true сгруппирует результаты и добавит сокращение часового пояса в значение отображения. Установитеbeforeиafterдля настройки обертки сокращения.
Возвращает
массивСписок идентификаторов часовых поясов
С
2.2timeAgoInWords()source public
timeAgoInWords( array $options = [] )
Возвращает относительную или отформатированную абсолютную дату в зависимости от разницы между текущим временем и этим объектом.
Параметры:
-
from=> другой объект Time, представляющий время "текущее" -
format=> резервный формат, если относительное время больше, чем указано параметром end -
accuracy=> Указывает, насколько точно должна быть описана дата (массив)- год => Формат, если годы > 0 (по умолчанию "день")
- месяц => Формат, если месяцы > 0 (по умолчанию "день")
- неделя => Формат, если недели > 0 (по умолчанию "день")
- день => Формат, если недели > 0 (по умолчанию "час")
- час => Формат, если часы > 0 (по умолчанию "минута")
- минута => Формат, если минуты > 0 (по умолчанию "минута")
- секунда => Формат, если секунды > 0 (по умолчанию "секунда")
-
end=> Конец относительного времени -
relativeString=> Строка, совместимая с printf, при выводе относительного времени -
absoluteString=> Строка, совместимая с printf, при выводе абсолютного времени -
timezone=> Часовой пояс пользователя, в котором должна быть отформатирована метка времени.
Относительные даты выглядят примерно так:
- 3 недели, 4 дня назад
- 15 секунд назад
Формат даты по умолчанию - d/М/ГГГГ, например: 18/02/09. Форматирование выполняется внутри с помощью i18nFormat, см. метод для допустимых форматов.
Возвращаемая строка включает 'назад' или 'в' и предполагает, что вы правильно добавите слово вроде 'Опубликовано ' перед результатом функции.
ПРИМЕЧАНИЕ: Если разница составляет одну неделю или больше, наименьшая точность - день
Параметры
- массив
$optionsнеобязательно [] - Массив параметров.
Возвращает
строкаСтрока относительного времени.
wasWithinLast()source public
wasWithinLast( string|integer $timeInterval )
Возвращает true, если этот экземпляр произошёл в течение указанного интервала
Этот переопределённый метод обеспечивает обратную совместимость для целых чисел или строк с завершающими пробелами. Это поведение является устаревшим и будет удалено в будущих версиях CakePHP.
Параметры
- строка|целое число
$timeInterval Числовое значение со временем. Например, допустимые типы: 6 часов, 2 дня, 1 минута.
Возвращает
booleanИспользуемые методы из Cake\I18n\DateFormatTrait
__debugInfo()source public
__debugInfo( )
Возвращает данные, которые должны быть отображены при отладке этого объекта
Возвращает
массив__toString()source public
__toString( )
_formatObject()source protected
_formatObject( DateTime $date , string|integer|array $format , string|null $locale )
Возвращает переведённую и локализованную строку даты. Реализует то, что IntlDateFormatter::formatObject() делает в PHP 5.5+
Параметры
- DateTime
$date - Дата.
- строка|целое число|массив
$format - Формат.
- строка|null
$locale - Имя локали, в которой должна отображаться дата.
Возвращает
строкаdiffFormatter()source public static
diffFormatter( Cake\I18n\RelativeTimeFormatter|null $formatter = null )
Получить экземпляр форматировщика разницы или перезаписать текущий.
Параметры
- Cake\I18n\RelativeTimeFormatter|null
$formatteroptional null - Экземпляр форматировщика при установке.
Возвращает
Cake\I18n\RelativeTimeFormatterЭкземпляр форматировщика.
getDefaultLocale()source public static
getDefaultLocale( )
Получить значение по умолчанию для региона.
Возвращает
string|nullСтрока региона по умолчанию для использования или null.
i18nFormat()source public
i18nFormat( string|integer|null $format = null , string|DateTimeZone|null $timezone = null , string|null $locale = null )
Возвращает отформатированную строку для этого объекта времени, используя предпочитаемый формат и язык для указанного региона.
Можно указать желаемый формат отображаемой строки. Вы можете передать IntlDateFormatter константы в качестве первого аргумента этой функции или передать полную строку форматирования даты ICU, как указано в следующих ресурсах: http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details.
В дополнение к IntlDateFormatter константам и строке форматирования даты можно использовать Time::UNIX_TIMESTAMP_FORMAT для получения метки времени Unix.
Примеры
$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::setToStringFormat().
Вы можете прочитать о доступных константах IntlDateFormatter по адресу https://secure.php.net/manual/en/class.intldateformatter.php
Если вам нужно отобразить дату в другом часовом поясе, отличном от используемого для этого объекта Time, без изменения его внутреннего состояния, вы можете передать строку часового пояса или объект DateTimeZone в качестве второго параметра.
Наконец, если вам нужно использовать другой регион для отображения объекта времени, передайте строку региона в качестве третьего параметра этой функции.
Примеры
$time = new Time('2014-04-20 22:10');
$time->i18nFormat(null, null, 'de-DE');
$time->i18nFormat(\IntlDateFormatter::FULL, 'Europe/Berlin', 'de-DE'); Вы можете управлять регионом по умолчанию с помощью Time::setDefaultLocale(). Если он пустой, значение по умолчанию будет взято из intl.default_locale ini конфигурации.
Параметры
- string|integer|null
$formatoptional null - Строка формата.
- string|DateTimeZone|null
$timezoneoptional null Строка часового пояса или объект DateTimeZone, в котором будет отображаться дата. Часовой пояс, сохраненный для этого объекта, не будет изменен.
- string|null
$localeoptional null - Имя региона, в котором должна отображаться дата (например, pt-BR).
Возвращает
string|integerОтформатированная и переведенная строка даты
jsonSerialize()source public
jsonSerialize( )
Возвращает строку, которая должна быть сериализована при преобразовании этого объекта в json
Возвращает
stringnice()source public
nice( string|DateTimeZone|null $timezone = null , string|null $locale = null )
Возвращает красиво отформатированную строку даты для этого объекта.
Используемый формат хранится в статическом свойстве Time::niceFormat.
Параметры
- string|DateTimeZone|null
$timezoneoptional null Строка часового пояса или объект DateTimeZone, в котором будет отображаться дата. Часовой пояс, сохраненный для этого объекта, не будет изменен.
- string|null
$localeoptional null - Имя региона, в котором должна отображаться дата (например, pt-BR).
Возвращает
stringОтформатированная строка даты
parseDate()source public static
parseDate( string $date , string|integer|null $format = null )
Возвращает новый объект Time после разбора предоставленной строки $date, основываясь на переданном или настроенном формате даты и времени. Этот метод зависит от региона, любая строка, переданная в эту функцию, будет интерпретироваться как строка, зависящая от региона.
Если $format не указан, будет использован формат wordFormat.
Если невозможно разобрать переданное время, возвращается null.
Пример:
$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 - Строка даты для разбора.
- string|integer|null
$formatoptional null - Любой формат, принятый IntlDateFormatter.
Возвращает
Cake\I18n\DateFormatTrait|nullparseDateTime()source public static
parseDateTime( string $time , string|array|null $format = null )
Возвращает новый объект Time после разбора предоставленной строки времени, основываясь на переданном или настроенном формате даты и времени. Этот метод зависит от региона, любая строка, переданная в эту функцию, будет интерпретироваться как строка, зависящая от региона.
Если $format не указан, будет использован формат toString.
Если невозможно разобрать переданное время, возвращается null.
Пример:
$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 - Строка времени для разбора.
- string|array|null
$formatoptional null - Любой формат, принятый IntlDateFormatter.
Возвращает
Cake\I18n\DateFormatTrait|nullparseTime()source public static
parseTime( string $time , string|integer|null $format = null )
Возвращает новый объект Time после разбора предоставленной строки $time, основываясь на переданном или настроенном формате даты и времени. Этот метод зависит от региона, любая строка, переданная в эту функцию, будет интерпретироваться как строка, зависящая от региона.
Если $format не указан, будет использован формат IntlDateFormatter::SHORT.
Если невозможно разобрать переданное время, возвращается null.
Пример:
$time = Time::parseTime('11:23pm'); Параметры
- string
$time - Строка времени для разбора.
- string|integer|null
$formatoptional null - Любой формат, принятый IntlDateFormatter.
Возвращает
Cake\I18n\DateFormatTrait|nullresetToStringFormat()source public static
resetToStringFormat( )
Сбрасывает формат до значения по умолчанию при преобразовании экземпляра этого типа в строку.
setDefaultLocale()source public static
setDefaultLocale( string|null $locale = null )
Устанавливает регион по умолчанию.
Параметры
- string|null
$localeoptional null - Строка региона по умолчанию для использования или null.
setJsonEncodeFormat()source public static
setJsonEncodeFormat( string|array|integer $format )
Устанавливает формат по умолчанию, используемый при преобразовании этого объекта в json
Формат должен быть либо константами форматирования из IntlDateFormatter, как описано в (https://secure.php.net/manual/en/class.intldateformatter.php), либо шаблоном, как указано в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования части даты объекта, а вторая позиция — для форматирования части времени.
Параметры
- string|array|integer
$format - Формат.
См.
\Cake\I18n\Time::i18nFormat()setToStringFormat()source public static
setToStringFormat( string|array|integer $format )
Устанавливает формат по умолчанию, используемый при преобразовании экземпляров этого типа в строку.
Формат должен быть либо константами форматирования из IntlDateFormatter, как описано в (https://secure.php.net/manual/en/class.intldateformatter.php), либо шаблоном, как указано в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования части даты объекта, а вторая позиция — для форматирования части времени.
Параметры
- string|array|integer
$format - Формат.
Подробное описание свойств
$_toStringFormatsource
protected static string|array|integer
Формат, используемый при форматировании времени с помощью Cake\I18n\FrozenTime::i18nFormat() и __toString. Этот формат также используется parseDateTime().
Формат должен быть либо константами форматирования из IntlDateFormatter, как описано в (https://secure.php.net/manual/en/class.intldateformatter.php), либо шаблоном, как указано в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования даты объекта, а вторая — для форматирования времени.
См. также
\Cake\I18n\FrozenTime::i18nFormat()[IntlDateFormatter::SHORT, IntlDateFormatter::SHORT]
$niceFormatsource
public static string|array|integer
Формат, используемый при форматировании времени с помощью Cake\I18n\FrozenTime::nice()
Формат должен быть либо константами форматирования из IntlDateFormatter, как описано в (https://secure.php.net/manual/en/class.intldateformatter.php), либо шаблоном, как указано в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования даты объекта, а вторая — для форматирования времени.
См. также
\Cake\I18n\FrozenTime::nice()[IntlDateFormatter::MEDIUM, IntlDateFormatter::SHORT]
$wordAccuracysource
public static array
Формат, используемый при форматировании времени с помощью Time::timeAgoInWords() и разность меньше, чем Time::$wordEnd
См. также
\Cake\I18n\FrozenTime::timeAgoInWords()[
'year' => 'day',
'month' => 'day',
'week' => 'day',
'day' => 'hour',
'hour' => 'minute',
'minute' => 'minute',
'second' => 'second',
] $wordEndsource
public static string
Конец описания относительного времени
См. также
\Cake\I18n\FrozenTime::timeAgoInWords()'+1 month'
$wordFormatsource
public static string|array|integer
Формат, используемый при форматировании времени с помощью Cake\I18n\FrozenTime::timeAgoInWords() и разность больше, чем Cake\I18n\FrozenTime::$wordEnd
См. также
\Cake\I18n\FrozenTime::timeAgoInWords()[IntlDateFormatter::SHORT, -1]
© 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.8/class-Cake.I18n.FrozenTime.html