Класс TimeHelper

_getTimezone()source protected

_getTimezone( null|string|DateTimeZone $timezone )

Получить часовой пояс.

Будет использоваться предоставленный часовой пояс или, по умолчанию, часовой пояс вывода, если он определен.

Параметры

null|string|DateTimeZone $timezone

Переопределенный часовой пояс, если применимо.

Возвращает

null|string|DateTimeZone
Выбранный часовой пояс или null.

format()source public

format( integer|string|DateTime $date , integer|string|null $format = null , boolean|string $invalid = false , string|DateTimeZone|null $timezone = null )

Возвращает отформатированную строку даты, заданную экземпляром Time, временным отметкой Unix или корректной строкой даты для strtotime().

Этот метод является псевдонимом для TimeHelper::i18nFormat().

Параметры

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

Временная отметка Unix, корректная строка для strtotime() или объект DateTime (или строка формата даты)

целое число|строка|null $format необязательный null

строка формата даты (или временная отметка Unix, корректная строка для strtotime() или объект DateTime)

логическое значение|строка $invalid необязательный false

Значение по умолчанию для отображения при некорректной дате

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

\Cake\I18n\Time::i18nFormat()

fromString()source public

fromString( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает временную отметку Unix, заданную временной отметкой Unix или корректной строкой даты для strtotime().

Параметры

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

Временная отметка Unix, корректная строка для strtotime() или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

Cake\I18n\Time

gmt()source public

gmt( integer|string|DateTime|null $string = null )

Возвращает GMT в виде временной отметки Unix.

Параметры

целое число|строка|DateTime|null $string необязательный null

Временная отметка Unix, корректная строка для strtotime() или объект DateTime

Возвращает

строка
Временная отметка Unix

См. также

\Cake\I18n\Time::gmt()

i18nFormat()source public

i18nFormat( integer|string|DateTime $date , string|null $format = null , boolean|string $invalid = false , string|DateTimeZone|null $timezone = null )

Возвращает отформатированную строку даты, заданную экземпляром Datetime, временной отметкой Unix или корректной строкой даты для strtotime().

Параметры

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

Временная отметка Unix, корректная строка для strtotime() или объект DateTime

строка|null $format необязательный null

Строка формата, совместимая с Intl.

логическое значение|строка $invalid необязательный false

Значение по умолчанию для отображения при некорректной дате

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

строка|false
Отформатированная и переведённая строка даты или значение для $invalid при ошибке.

Исключения

Исключение
Когда дата не может быть обработана

См. также

\Cake\I18n\Time::i18nFormat()

implementedEvents()source public

implementedEvents( )

Обработчики событий.

Возвращает

массив

Переопределяет

Cake\View\Helper::implementedEvents()

isFuture()source public

isFuture( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная строка даты находится в будущем.

Параметры

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

Временная отметка Unix, корректная строка для strtotime() или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

логическое значение
True, если заданная строка даты находится в будущем.

isPast()source public

isPast( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная строка даты и времени находится в прошлом.

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если заданная строка даты и времени находится в прошлом.

isThisMonth()source public

isThisMonth( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

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

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени находится в текущем месяце

isThisWeek()source public

isThisWeek( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

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

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени находится в текущей неделе

isThisYear()source public

isThisYear( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная строка даты и времени находится в текущем году.

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени находится в текущем году

isToday()source public

isToday( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная строка даты и времени — это сегодня.

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если заданная строка даты и времени — это сегодня.

isTomorrow()source public

isTomorrow( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

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

Параметры

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени была вчера

isWithinNext()source public

isWithinNext( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная дата и время находится в указанном интервале, иначе false.

Параметры

string|integer $timeInterval

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

integer|string|DateTime $dateString

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

boolean

См. также

\Cake\I18n\Time::wasWithinLast()

nice()source public

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

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

Параметры

целое число|строка|DateTime|null $dateString необязательно null

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

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

Строка локали.

Возвращает

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

timeAgoInWords()source public

timeAgoInWords( integer|string|DateTime|Cake\Chronos\ChronosInterface $dateTime , array $options = [] )

Форматирует дату в фразу, выражающую относительное время.

Дополнительные параметры

• element - Элемент, в который нужно заключить отформатированное время. Имеет несколько дополнительных параметров:
  • tag - Тег, используемый по умолчанию, 'span'.
  • class - Имя класса, используемое по умолчанию, time-ago-in-words.
  • title - По умолчанию, входной параметр $dateTime.

Параметры

целое число|строка|DateTime|Cake\Chronos\ChronosInterface $dateTime

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Формат по умолчанию, если маркер времени используется в $dateString

Возвращает

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

См. также

\Cake\I18n\Time::timeAgoInWords()

toAtom()source public

toAtom( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает дату, отформатированную для Atom RSS лент.

Параметры

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

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

\Cake\I18n\Time::toAtom()

toQuarter()source public

toQuarter( integer|string|DateTime $dateString , boolean $range = false )

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

Параметры

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

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Если true, возвращает диапазон в формате ГГГГ-ММ-ДД

Возвращает

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

См. также

\Cake\I18n\Time::toQuarter()

toRss()source public

toRss( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Форматирует дату для RSS лент.

Параметры

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

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

toUnix()source public

toUnix( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает маркер времени Unix из текстового описания даты и времени.

Параметры

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

Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime

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

Строка часового пояса пользователя или объект DateTimeZone

Возвращает

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

См. также

\Cake\I18n\Time::toUnix()

wasWithinLast()source public

wasWithinLast( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если указанная дата и время находились в заданном интервале, в противном случае false.

Параметры

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

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

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

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

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

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

boolean

См. также

\Cake\I18n\Time::wasWithinLast()

wasYesterday()source public

wasYesterday( integer|string|DateTime $dateString , string|DateTimeZone|null $timezone = null )

Возвращает true, если заданная строка даты и времени была вчера.

Параметры

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

Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime

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

Строковое представление часового пояса пользователя или объект DateTimeZone

Возвращает

boolean
True, если строка даты и времени была вчера

__call()source public

__call( string $method , array $params )

Обеспечивает некритические ошибки при вызовах отсутствующих методов.

Параметры

строка $method

Метод для вызова

массив $params

Массив параметров для метода.

__construct()source public

__construct( Cake\View\View $View , array $config = [] )

Конструктор по умолчанию

Параметры

Cake\View\View $View

Представление, к которому подключается помощник.

массив $config необязательно []

Настройки конфигурации для помощника.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Ленично загружает помощников.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с предоставленным именем существует

__set()source public

__set( string $name , mixed $value )

Магический setter для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

Значение для установки.

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую к использованию в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанное

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

Код, который будет выполнен после выбора пользователем «ОК»

строка $cancelCode необязательно ''

Код, который будет выполнен после выбора пользователем «Отмена»

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

Массив опций

Возвращает

строка
код JS onclick

addClass()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Добавляет заданный класс к параметрам элемента

Параметры

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

Массив параметров/атрибутов для добавления класса

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

Имя добавляемого класса.

строка $key необязательно 'class'

ключ для использования класса.

Возвращает

массив
Массив параметров с заданным ключом.

getView()source public

getView( )

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

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод обработки конструктора.

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

Параметры

массив $config

Настройки конфигурации, предоставленные этому помощнику.

formatTemplate()source public

formatTemplate( string $name , array $data )

Форматирует строку шаблона с данными $data

Параметры

строка $name

Имя шаблона.

массив $data

Данные для вставки.

Возвращает

строка

getTemplates()source public

getTemplates( string|null $template = null )

Получить шаблоны для использования или определённый шаблон.

Параметры

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

Строка для чтения определенного шаблона, null для всех.

Возвращает

строка|массив

setTemplates()source public

setTemplates( array $templates )

Устанавливает шаблоны для использования.

Параметры

массив $templates

Шаблоны для добавления.

Возвращает

$this

templater()source public

templater( )

Возвращает экземпляр templater.

Возвращает

Cake\View\StringTemplate

templates()source public устаревший

templates( string|null|array $templates = null )

Получает/устанавливает шаблоны для использования.

Устаревший

3.4.0 Используйте setTemplates()/getTemplates() вместо этого.

Параметры

строка|null|массив $templates необязательно null

null или строка для чтения шаблонов. Массив позволяет добавлять шаблоны.

Возвращает

$this|строка|массив

_configDelete()source protected

_configDelete( string $key )

Удаляет один ключ конфигурации.

Параметры

строка $key

Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь переопределить существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

строка|null $key

Ключ для чтения.

Возвращает

смешанный тип

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge необязательный false

Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Получает/устанавливает конфигурацию.

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Устаревший

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

Ключ для получения/установки или полный массив конфигураций.

mixed|null $value необязательный null

Значение для установки.

boolean $merge необязательный true

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

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

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value необязательный null

Значение для установки.

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

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

Ключ для получения или null для всей конфигурации.

mixed $default необязательный null

Значение, возвращаемое, когда ключ не существует.

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

mixed
Данные конфигурации по указанному ключу или null, если ключ не существует.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value необязательный null

Значение для установки.

boolean $merge необязательный true

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

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

$this

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

[
    'outputTimezone' => null
]