Spec-Zone.ru › CakePHP 3.6

Класс FrozenTime

Расширяет встроенный класс DateTime, предоставляя удобные методы и помощники по форматированию с учетом локали

Этот объект предоставляет неизменяемый вариант Cake\I18n\Time

Cake\Chronos\Chronos
Extended by Cake\I18n\FrozenTime реализует JsonSerializable и использует Cake\I18n\DateFormatTrait
Пространство имён: Cake\I18n
Расположение: I18n/FrozenTime.php

Краткое описание констант

  • string

    UNIX_TIMESTAMP_FORMAT
    'unixTimestampFormat'

Краткое описание свойств

  • $_toStringFormat protected static
    string|array|integer

    Формат, используемый при форматировании времени с использованием Cake\I18n\FrozenTime::i18nFormat() и __toString

  • $niceFormat public static
    string|array|integer
    Формат, используемый при форматировании времени с использованием Cake\I18n\FrozenTime::nice()
  • $wordAccuracy public static
    array

    Формат, используемый при форматировании времени с использованием Time::timeAgoInWords() и разница меньше Time::$wordEnd

  • $wordEnd public static
    string
    Конец относительного времени
  • $wordFormat public static
    string|array|integer

    Формат, используемый при форматировании времени с использованием Cake\I18n\FrozenTime::timeAgoInWords() и разница больше Cake\I18n\FrozenTime::$wordEnd

Унаследованные свойства

  • _formatters, _isDateInstance, _jsonEncodeFormat, defaultLocale

Краткое описание методов

  • __construct() public
  • isWithinNext() public
    Возвращает true, если этот экземпляр произошел в указанном интервале
  • listTimezones() public static
    Получить список идентификаторов часовых поясов
  • timeAgoInWords() public

    Возвращает либо относительную, либо отформатированную абсолютную дату в зависимости от разницы между текущим временем и этим объектом.

  • wasWithinLast() public
    Возвращает true, если этот экземпляр произойдет в течение указанного интервала

Подробное описание методов

__construct()source public

__construct( $time = null , $tz = null )

isWithinNext()source public

isWithinNext( string|integer $timeInterval )

Возвращает true, если этот экземпляр произошел в указанном интервале

Этот переопределённый метод обеспечивает обратную совместимость для целых чисел или строк с заключительными пробелами. Это поведение устарело и будет удалено в будущих версиях CakePHP.

Параметры

string|integer $timeInterval

Числовое значение с типом времени. Примеры допустимых типов: 6 часов, 2 дня, 1 минута.

Возвращает

boolean

listTimezones()source public static

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

Получить список идентификаторов часовых поясов

Параметры

integer|string|null $filter optional null

Регулярное выражение для фильтрации идентификатора или один из констант класса DateTimeZone

string|null $country optional null

Двухбуквенный ISO 3166-1 совместимый код страны. Этот параметр используется только когда $filter установлен на DateTimeZone::PER_COUNTRY

boolean|array $options optional []

Если true (по умолчанию), группирует список идентификаторов по основному региону. В противном случае, массив, содержащий ключи group, abbr, before, и after. Установка group и abbr на true сгруппирует результаты и добавит аббревиатуру часового пояса в значение отображения. Настройте before и after для настройки обертки аббревиатуры.

Возвращает

array
Список идентификаторов часовых поясов

С тех пор

2.2

timeAgoInWords()source public

timeAgoInWords( array $options = [] )

Возвращает либо относительную, либо отформатированную абсолютную дату в зависимости от разницы между текущим временем и этим объектом.

Параметры:

  • from => другой объект Time, представляющий "текущее" время
  • format => резервный формат, если относительное время больше, чем продолжительность, заданная параметром end
  • accuracy => Указывает, насколько точно должна быть описана дата (массив)
    • year => Формат, если years > 0 (по умолчанию "день")
    • month => Формат, если months > 0 (по умолчанию "день")
    • week => Формат, если weeks > 0 (по умолчанию "день")
    • day => Формат, если недели > 0 (по умолчанию "час")
    • hour => Формат, если hours > 0 (по умолчанию "минута")
    • minute => Формат, если minutes > 0 (по умолчанию "минута")
    • second => Формат, если seconds > 0 (по умолчанию "секунда")
  • end => Конец относительного времени
  • relativeString => строка, совместимая с printf, при выводе относительного времени
  • absoluteString => строка, совместимая с printf, при выводе абсолютного времени
  • timezone => часовой пояс пользователя, в котором должна быть отформатирована метка времени.

Относительные даты выглядят примерно так:

  • 3 недели, 4 дня назад
  • 15 секунд назад

По умолчанию форматирование даты - d/M/YY, например: 18/2/09. Форматирование выполняется внутри с использованием i18nFormat, см. метод для допустимых строк форматирования.

Возвращаемая строка включает 'назад' или 'в' и предполагает, что вы правильно добавите слово, например, 'Опубликовано ' перед выводом функции.

ПРИМЕЧАНИЕ: Если разница составляет одну неделю или более, то минимальная точность равна дню

Параметры

array $options optional []
Массив параметров.

Возвращает

string
Строка относительного времени.

wasWithinLast()source public

wasWithinLast( string|integer $timeInterval )

Возвращает true, если этот экземпляр произойдет в течение указанного интервала

Этот переопределённый метод обеспечивает обратную совместимость для целых чисел или строк с заключительными пробелами. Это поведение устарело и будет удалено в будущих версиях CakePHP.

Параметры

string|integer $timeInterval

Числовое значение с типом времени. Примеры допустимых типов: 6 часов, 2 дня, 1 минута.

Возвращает

boolean

Используемые методы из Cake\I18n\DateFormatTrait

__debugInfo()source public

__debugInfo( )

Возвращает данные, которые должны отображаться при отладке этого объекта

Возвращает

array

__toString()source public

__toString( )

_formatObject()source protected

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

Возвращает переведённую и локализованную строку даты. Реализует IntlDateFormatter::formatObject() в PHP 5.5+

Параметры

DateTime $date
Дата.
string|integer|array $format
Формат.
string $locale
Имя локали, в которой должна отображаться дата.

Возвращает

string

diffFormatter()source public static

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

Получить экземпляр форматировщика разницы или перезаписать текущий.

Параметры

Cake\I18n\RelativeTimeFormatter|null $formatter необязательный 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::$defaultLocale переменной и установить ее на один из возможных форматов, принимаемых этой функцией.

Вы можете узнать о доступных константах IntlDateFormatter на https://secure.php.net/manual/en/class.intldateformatter.php

Если вам нужно отобразить дату в часовом поясе, отличном от используемого для этого объекта времени, не изменяя его внутреннее состояние, вы можете передать строку часового пояса или объект DateTimeZone в качестве второго параметра.

Наконец, если вам необходимо использовать другой язык для отображения этого объекта времени, передайте строку языка в качестве третьего параметра этой функции.

Примеры

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

Вы можете контролировать язык по умолчанию, установив статическую переменную Time::$defaultLocale на допустимую строку языка. Если она пустая, значение будет взято из конфигурации ini intl.default_locale.

Параметры

string|integer|null $format необязательный null
Строка формата.
string|DateTimeZone|null $timezone необязательный null

Строка часового пояса или объект DateTimeZone, в котором будет отображаться дата. Сохранённый часовой пояс для этого объекта не будет изменён.

string|null $locale необязательный null
Имя языка, на котором должна быть отображена дата (например, pt-BR).

Возвращает

string|integer
Отформатированная и переведённая строка даты.

jsonSerialize()source public

jsonSerialize( )

Возвращает строку, которая должна быть сериализована при преобразовании этого объекта в json.

Возвращает

string

nice()source public

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

Возвращает красиво отформатированную строку даты для этого объекта.

Используемый формат хранится в статическом свойстве Time::niceFormat.

Параметры

string|DateTimeZone|null $timezone необязательный null

Строка часового пояса или объект DateTimeZone, в котором будет отображаться дата. Сохранённый часовой пояс для этого объекта не будет изменён.

string|null $locale необязательный 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 $format необязательный null
Любой формат, поддерживаемый IntlDateFormatter.

Возвращает

Cake\I18n\DateFormatTrait|null

parseDateTime()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 $format необязательный null
Любой формат, поддерживаемый IntlDateFormatter.

Возвращает

Cake\I18n\DateFormatTrait|null

parseTime()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 $format необязательный null
Любой формат, поддерживаемый IntlDateFormatter.

Возвращает

Cake\I18n\DateFormatTrait|null

resetToStringFormat()source public static

resetToStringFormat( )

Сбрасывает формат к значению по умолчанию при преобразовании экземпляра этого типа в строку.

setDefaultLocale()source public static

setDefaultLocale( string|null $locale = null )

Устанавливает язык по умолчанию.

Параметры

string|null $locale необязательный null
Строка языка по умолчанию или null.

setJsonEncodeFormat()source public static

setJsonEncodeFormat( string|array|integer $format )

Устанавливает формат по умолчанию, используемый при преобразовании этого объекта в json.

Параметры

string|array|integer $format
Формат.

setToStringFormat()source public static

setToStringFormat( string|array|integer $format )

Устанавливает формат по умолчанию, используемый при преобразовании экземпляров этого типа в строку.

Параметры

string|array|integer $format
Формат.

Подробное описание свойств

$_toStringFormatsource

protected static строка|массив|целое число

Формат, используемый при форматировании времени с помощью Cake\I18n\FrozenTime::i18nFormat() и __toString

Формат должен быть либо константами форматирования из 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 строка|массив|целое число

Формат, используемый при форматировании времени с помощью 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 массив

Формат, используемый при форматировании времени с помощью 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 строка

Конец описания относительного времени

См. также

\Cake\I18n\FrozenTime::timeAgoInWords()
'+1 month'

$wordFormatsource

public static строка|массив|целое число

Формат, используемый при форматировании времени с помощью 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.6/class-Cake.I18n.FrozenTime.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API