Spec-Zone.ru › CakePHP 3.3

Класс FrozenDate

Расширяет класс Date, предоставленный Chronos.

Добавляет удобные методы и помощники форматирования с учётом локализации

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

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

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

  • $_toStringFormat protected static
    string|array|integer

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

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

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

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

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

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

  • _formatters, _isDateInstance, _jsonEncodeFormat, defaultLocale

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

  • timeAgoInWords() public

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

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

timeAgoInWords()source public

timeAgoInWords( array $options [] )

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

Параметры:

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

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

  • 3 недели, 4 дня назад
  • 1 день назад

Формат даты по умолчанию - дд/мм/гггг (напр., 18/02/2009). Форматирование выполняется внутри с помощью i18nFormat, см. метод для допустимых строк форматирования.

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

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

Параметры

массив $options необязательно []
Массив параметров.

Возвращаемое значение

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращаемое значение

массив

__toString()source public

__toString( )

_formatObject()source protected

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

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

Параметры

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

Возвращаемое значение

строка

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

Получить локаль по умолчанию.

Возвращаемое значение

строка|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 по адресу http://www.php.net/manual/ru/class.intldateformatter.php

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

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

Примеры

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

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

Параметры

строка|целое|null $format необязательно null
Строка формата.
строка|DateTimeZone|null $timezone необязательно null

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

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

Возвращаемое значение

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

jsonSerialize()source public

jsonSerialize( )

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

Возвращаемое значение

строка

nice()source public

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

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

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

Параметры

строка|DateTimeZone|null $timezone необязательно null

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

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

Возвращаемое значение

строка
Отформатированная строка даты
END_OF_DOCUMENT_MARKER

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);

Параметры

строка $date
Строка даты для парсинга.
строка|целое число|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]);

Параметры

строка $time
Строка времени для парсинга.
строка|массив|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');

Параметры

строка $time
Строка времени для парсинга.
строка|целое число|null $format необязательно null
Любой формат, принятый IntlDateFormatter.

Возвращаемое значение

Cake\I18n\DateFormatTrait|null

resetToStringFormat()source public static

resetToStringFormat( )

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

setDefaultLocale()source public static

setDefaultLocale( string|null $locale null )

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

Параметры

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

setJsonEncodeFormat()source public static

setJsonEncodeFormat( string|array|integer $format )

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

Параметры

строка|массив|целое число $format
Формат.

setToStringFormat()source public static

setToStringFormat( string|array|integer $format )

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

Параметры

строка|массив|целое число $format
Формат.

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

$_toStringFormatsource

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

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

Формат должен быть либо константами форматирования из IntlDateFormatter (см. http://www.php.net/manual/ru/class.intldateformatter.php), либо шаблоном, указанным в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details).

Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования части даты объекта, а вторая — для форматирования части времени.

См. также

\Cake\I18n\DateFormatTrait::i18nFormat()
[IntlDateFormatter::SHORT, -1]

$niceFormatsource

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

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

Формат должен быть либо константами форматирования из IntlDateFormatter (см. http://www.php.net/manual/ru/class.intldateformatter.php), либо шаблоном, указанным в (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details).

Можно указать массив из 2 констант. В этом случае первая позиция будет использоваться для форматирования части даты объекта, а вторая — для форматирования части времени.

См. также

\Cake\I18n\DateFormatTrait::nice()
[IntlDateFormatter::MEDIUM, -1]

$wordAccuracysource

public static массив

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

См. также

\Cake\I18n\Date::timeAgoInWords()
[
    'year' => "day",
    'month' => "day",
    'week' => "day",
    'day' => "day",
    'hour' => "day",
    'minute' => "day",
    'second' => "day",
]

$wordEndsource

public static строка

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

См. также

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

$wordFormatsource

public static строка

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

См. также

\Cake\I18n\DateFormatTrait::parseDate()
[IntlDateFormatter::SHORT, -1]

© 2005–2017 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.3/class-Cake.I18n.FrozenDate.html

Spec-Zone.ru

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