Класс 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 необязательно null

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

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

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

string|DateTimeZone|null $timezone необязательно 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 необязательно null

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

Возвращает

Cake\I18n\Time

gmt()source public

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

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

Параметры

integer|string|DateTime|null $string необязательно 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 необязательно null

Формат строки, совместимый с Intl.

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

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

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

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

Возвращает

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

Выбрасывает

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

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

Параметры

integer|string|DateTime $dateString

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

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

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

Возвращает

string
Метка времени 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.

getView()source public

getView( )

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

Возвращает

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

initialize()source public

initialize( array $config )

Метод обратной связи конструктора.

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

Параметры

array $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

string $name

Имя шаблона.

array $data

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

Возвращает

string

getTemplates()source public

getTemplates( string|null $template null )

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

Параметры

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

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

Возвращает

string|array

setTemplates()source public

setTemplates( array $templates )

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

Параметры

array $templates

Добавляемые шаблоны.

Возвращает

$this

templater()source public

templater( )

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

Возвращает

Cake\View\StringTemplate

templates()source public

templates( string|null|array $templates null )

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

Устарело

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

Параметры

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

Параметры

string|array|null $key optional null

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

mixed|null $value optional null

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

boolean $merge optional 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 optional 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 optional null

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

mixed $default optional null

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

Возвращает

mixed
Значение конфигурации, которое читается.

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 optional null

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

boolean $merge optional true

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

Возвращает

$this

Исключения

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

[
    'outputTimezone' => null
]