Spec-Zone.ru › CakePHP 3.6

Класс Time

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

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

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

  • string

    UNIX_TIMESTAMP_FORMAT
    'unixTimestampFormat'

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

  • $_toStringFormat protected static
    string|array|integer

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

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

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

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

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

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

  • _formatters, _isDateInstance, _jsonEncodeFormat, defaultLocale

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

  • __construct() public
  • isThisMonth() public
    Возвращает true, если этот объект представляет дату текущего месяца
  • isThisWeek() public
    Возвращает true, если этот объект представляет дату текущей недели
  • isThisYear() public
    Возвращает true, если этот объект представляет дату текущего года
  • isWithinNext() public
    Возвращает true, если данный экземпляр произошёл в указанном интервале
  • listTimezones() public static
    Получить список идентификаторов часовых поясов
  • nice() public
    Возвращает отформатированную строку даты для данного объекта.
  • timeAgoInWords() public

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

  • toQuarter() public
    Возвращает квартал
  • toUnixString() public
    Возвращает отметку времени Unix.
  • wasWithinLast() public
    Возвращает true, если данный экземпляр произойдёт в указанном интервале

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

__construct()source public

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

isThisMonth()source public

isThisMonth( )

Возвращает true, если этот объект представляет дату текущего месяца

Возвращает

boolean

isThisWeek()source public

isThisWeek( )

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

Возвращает

boolean

isThisYear()source public

isThisYear( )

Возвращает true, если этот объект представляет дату текущего года

Возвращает

boolean

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
Список идентификаторов часовых поясов

Since

2.2

nice()source public

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

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

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

Параметры

string|DateTimeZone|null $timezone optional null

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

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

Возвращает

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

timeAgoInWords()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 секунд назад

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

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

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

Параметры

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

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

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

toQuarter()source public

toQuarter( boolean $range = false )

Возвращает квартал

Параметры

логическое значение $range необязательно false
Диапазон.

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

целое число|массив
1, 2, 3 или 4 квартал года или массив, если $range true

toUnixString()source public

toUnixString( )

Возвращает метку времени Unix.

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

строка
Метка времени Unix

wasWithinLast()source public

wasWithinLast( string|integer $timeInterval )

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

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

Параметры

строка|целое число $timeInterval

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

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

логическое значение

Методы, используемые из 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 на https://secure.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.

Параметры

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

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

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

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

строка|целое число
Отформатированная и переведенная строка даты

jsonSerialize()source public

jsonSerialize( )

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

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

строка

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.

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

объект Time|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\Time::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\Time::i18nFormat()
[IntlDateFormatter::SHORT, IntlDateFormatter::SHORT]

$niceFormatsource

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

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

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

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

См. также

\Cake\I18n\Time::nice()
[IntlDateFormatter::MEDIUM, IntlDateFormatter::SHORT]

$wordAccuracysource

public static массив

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

См. также

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

$wordEndsource

public static строка

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

См. также

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

$wordFormatsource

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

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

См. также

\Cake\I18n\Time::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.Time.html

Spec-Zone.ru

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