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

Возвращает

integer
Метка времени 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
Отформатированная и переведённая строка даты

Вызывает

Исключение
При невозможности парсинга даты

См.

\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 минута.

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 $dateTime , array $options [] )

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

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

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

Параметры

integer|string|DateTime $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, возвращает диапазон в формате Y-m-d

Возвращает

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 из текстового описания даты и времени.

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

integer
Метка времени Unix

См. также

\Cake\I18n\Time::toUnix()

wasWithinLast()source public

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

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

Параметры

string|integer $timeInterval

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

integer|string|DateTime $dateString

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

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

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

Возвращает

boolean

См. также

\Cake\I18n\Time::wasWithinLast()

wasYesterday()source public

wasYesterday( 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, если строка даты и времени была вчера

__call()source public

__call( string $method , array $params )

Предоставляет ошибки без катастрофических последствий при вызове несуществующих методов.

Параметры

string $method

Вызываемый метод

array $params

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

__construct()source public

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

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

Параметры

Cake\View\View $View

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

array $config необязательно []

Параметры настройки помощника.

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

_confirm()source protected

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

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

Параметры

string $message

Сообщение, которое нужно отобразить

string $okCode

Код, который нужно выполнить после того, как пользователь выбрал «OK»

string $cancelCode необязательно ''

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

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

Массив параметров

Возвращает

string
JS-код onclick

addClass()source public

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

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

Параметры

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

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

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

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

string $key необязательно 'class'

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

Возвращает

array
Массив параметров с установленным $key.

initialize()source public

initialize( array $config )

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

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

Параметры

array $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

Форматирует строку шаблона с помощью $data

Параметры

string $name

Имя шаблона.

array $data

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

Возвращает

string

templater()source public

templater( )

templater

Возвращает

Cake\View\StringTemplate

templates()source public

templates( string|null|array $templates null )

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

Параметры

string|null|array $templates необязательно null

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

Возвращает

$this|string|array

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

string|null $key

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

Возвращает

mixed

_configWrite()source protected

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

Запись переменной конфигурации

Параметры

string|array $key

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

mixed $value

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

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

True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию — false.

Выбрасывает

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

Параметры

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

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

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

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

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

Рекурсивно слить или перезаписать существующие настройки, по умолчанию true.

Возвращает

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

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

string|array $key

Ключ для установки или массив настроек.

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

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

Возвращает

$this Сам объект.

[
    'outputTimezone' => null
]