Класс 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().

Параметры

integer|string|DateTime $date

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

integer|string|null $format optional null

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

boolean|string $invalid optional false

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

string|DateTimeZone|null $timezone optional null

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

Возвращает

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

См.

\Cake\I18n\Time::i18nFormat()

fromString()source public

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

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

Параметры

integer|string|DateTime $dateString

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

string|DateTimeZone|null $timezone optional null

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

Возвращает

Cake\I18n\Time

gmt()source public

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

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

Параметры

integer|string|DateTime|null $string optional null

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

Возвращает

string
Временная метка 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().

Параметры

integer|string|DateTime $date

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

string|null $format optional null

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

boolean|string $invalid optional false

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

string|DateTimeZone|null $timezone optional null

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

Возвращает

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

Вызывает

Exception
Когда дата не может быть обработана

См.

\Cake\I18n\Time::i18nFormat()

implementedEvents()source public

implementedEvents( )

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

Возвращает

array

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

Cake\View\Helper::implementedEvents()

isFuture()source public

isFuture( 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, если заданная строка даты и времени находится в будущем.

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 )

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

Параметры

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

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

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

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

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

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

Возвращает

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

timeAgoInWords()source public

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

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

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

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

Параметры

integer|string|DateTime|Cake\Chronos\ChronosInterface $dateTime

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

array $options необязательный []

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

Возвращает

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

См. также

\Cake\I18n\Time::timeAgoInWords()

toAtom()source public

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

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

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

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

См. также

\Cake\I18n\Time::toAtom()

toQuarter()source public

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

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

Параметры

integer|string|DateTime $dateString

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

boolean $range необязательный false

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

Возвращает

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

См. также

\Cake\I18n\Time::toQuarter()

toRss()source public

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

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

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

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

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 )

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

Параметры

строка $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'

Ключ, используемый для класса.

Возвращает

массив
Массив параметров со значением $key.

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 )

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

Параметры

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

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

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

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

boolean|строка $merge необязательно false

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

Исключения

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

config()source public устарело

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() вместо этого.

Параметры

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

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

смешанный тип|null $value необязательно null

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

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

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

Возвращает

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

Исключения

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

Параметры

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

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

смешанный тип|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');

Параметры

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

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

смешанный тип $default необязательно 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']);

Параметры

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

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

смешанный тип|null $value необязательно null

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

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

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

Возвращает

$this

Исключения

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

[
    'outputTimezone' => null
]