Класс FrozenTime
Расширяет встроенный класс DateTime, предоставляя удобные методы и помощники для форматирования с учетом локали
Этот объект предоставляет неизменяемый вариант Cake\I18n\Time
- Cake\Chronos\Chronos
-
Cake\I18n\FrozenTime реализует JsonSerializable использует Cake\I18n\DateFormatTrait
Краткое описание свойств
-
string|array|integerФормат, используемый при форматировании времени с использованием
Cake\I18n\FrozenTime::i18nFormat()и__toString - Формат, используемый при форматировании времени с использованием
string|array|integerCake\I18n\FrozenTime::nice() -
arrayФормат, используемый при форматировании времени с использованием
Time::timeAgoInWords()и разница меньше чемTime::$wordEnd - Конец относительного временного отсчёта
string -
stringФормат, используемый при форматировании времени с использованием
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 статическое
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=> Указывает, насколько точно должна быть описана дата (массив)- year => Формат, если годы > 0 (по умолчанию "день")
- month => Формат, если месяцы > 0 (по умолчанию "день")
- week => Формат, если недели > 0 (по умолчанию "день")
- day => Формат, если недели > 0 (по умолчанию "час")
- hour => Формат, если часы > 0 (по умолчанию "минута")
- minute => Формат, если минуты > 0 (по умолчанию "минута")
- second => Формат, если секунды > 0 (по умолчанию "секунда")
-
end=> Конец относительного временного отсчёта -
relativeString=> Строка, совместимая с printf, при выводе относительного времени -
absoluteString=> Строка, совместимая с printf, при выводе абсолютного времени -
timezone=> Часовой пояс пользователя, в котором должна быть отформатирована метка времени.
Относительные даты выглядят примерно так:
- 3 недели, 4 дня назад
- 15 секунд назад
Форматирование даты по умолчанию: дд/мм/гггг, например: 18/02/2009. Форматирование выполняется внутри с помощью 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 $locale )
Возвращает переведённую и локализованную строку даты. Реализует функциональность IntlDateFormatter::formatObject() в PHP 5.5+
Параметры
- DateTime
$date - Дата.
- строка|целое число|массив
$format - Формат.
- строка
$locale - Имя локали, в которой должна быть отображена дата.
Возвращает
строкаdiffFormatter()source public статическое
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.
Примеры
$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::$defaultLocale и установить его на один из возможных форматов, поддерживаемых этой функцией.
Вы можете узнать о доступных константах IntlDateFormatter по адресу http://www.php.net/manual/en/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.
Параметры
- string|integer|null
$formatнеобязательно null - Строка формата.
- string|DateTimeZone|null
$timezoneнеобязательно null Строка часового пояса или объект DateTimeZone, в котором будет отображаться дата. Часовой пояс, сохранённый для этого объекта, не будет изменён.
- string|null
$localeнеобязательно null - Имя региона, в котором должна отображаться дата (например, pt-BR)
Возвращает
stringОтформатированная и переведённая строка даты
jsonSerialize()source public
jsonSerialize( )
Возвращает строку, которая должна быть сериализована при преобразовании этого объекта в json
Возвращает
stringnice()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|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
$formatнеобязательно 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
$formatнеобязательно null - Любой формат, поддерживаемый IntlDateFormatter.
Возвращает
Cake\I18n\DateFormatTrait|nullresetToStringFormat()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 string|array|integer
Формат, используемый при форматировании времени с помощью Cake\I18n\FrozenTime::i18nFormat() и __toString
Формат должен быть либо константами форматирования из IntlDateFormatter, как описано в (http://www.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, как описано в (http://www.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–2016 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.
http://api.cakephp.org/3.2/class-Cake.I18n.FrozenTime.html