Класс TimeHelper

formatsource 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()

fromStringsource 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
\Cake\I18n\Time

gmtsource public

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

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

Параметры

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

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

Возвращает

integer
Временная метка Unix

См.

\Cake\I18n\Time::gmt()

i18nFormatsource 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()

implementedEventssource public

implementedEvents( )

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

Возвращает

array
массив

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

Cake\View\Helper::implementedEvents()

isFuturesource 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, если строка даты находится сегодня

isPastsource 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, если строка даты находится сегодня

isThisMonthsource 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, если строка даты находится в текущем месяце

isThisWeeksource 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, если строка даты находится в текущей неделе

isThisYearsource 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, если строка даты находится в текущем году

isTodaysource 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, если строка даты сегодня

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

isWithinNextsource 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
bool

См. также

Cake\I18n\Time::wasWithinLast()

nicesource public

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

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

Параметры

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

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

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

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

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

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

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

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

timeAgoInWordssource 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()

toAtomsource 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()

toQuartersource 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()

toRsssource 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
Отформатированная строка даты

toUnixsource 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()

wasWithinLastsource 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
bool

См. также

Cake\I18n\Time::wasWithinLast()

wasYesterdaysource 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, если дата и время были вчера

__callsource public

__call( string $method , array $params )

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

Параметры

string $method

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

array $params

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

__constructsource public

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

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

Параметры

Cake\View\View $View

Просмотр, к которому прикреплен помощник.

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

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

__debugInfosource public

__debugInfo( )

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

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

array
array

__getsource public

__get( string $name )

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

Параметры

string $name

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

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

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

_confirmsource protected

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

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

Параметры

string $message

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

string $okCode

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

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

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

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

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

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

string
JS код onclick

addClasssource public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

formatTemplatesource public

formatTemplate( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

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

Возвращает

string
строка

templatersource public

templater( )

templater

Возвращает

Cake\View\StringTemplate
\Cake\View\StringTemplate

templatessource public

templates( string|null|array $templates null )

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

Параметры

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

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

строка|null $key

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

Возвращает

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

_configWritesource protected

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

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

Параметры

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

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

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

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

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

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

Исключения

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Исключения

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

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

Параметры

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

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

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

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

Возвращает

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

[]

[]

[]

[]

null

null

[]

null

[]

false