Class TimeHelper

Класс Time Helper для удобного использования данных времени.

Обработка данных времени.

Пространство имён: Cake\View\Helper
См.: \Cake\I18n\Time
Ссылка: https://book.cakephp.org/4/ru/views/helpers/time.html

Краткое описание свойств

$_View protected

Cake\View\View

Экземпляр View, к которому прикреплён этот помощник
$_config protected

array<string, mixed>

Конфигурация выполнения
$_configInitialized protected

bool

Была ли конфигурация свойств уже настроена по умолчанию
$_defaultConfig protected

array<string, mixed>

Параметры конфигурации
$_helperMap protected

array<string, array>

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
$_templater protected

Cake\View\StringTemplate|null

Экземпляр StringTemplate.
$helpers protected

array

Список помощников, используемых этим помощником

Краткое описание методов

__call() public

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

Конструктор по умолчанию
__debugInfo() public

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

Лениво загружает помощники.
_configDelete() protected

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

Считывает ключ конфигурации.
_configWrite() protected

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

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

Получить часовой пояс.
addClass() public

Добавляет заданный класс к опциям элемента.
configShallow() public

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

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

Форматирует шаблонную строку с $data
fromString() public

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

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

Возвращает конфигурацию для этого конкретного ключа.
getTemplates() public

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

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

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

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

Обработчики событий.
initialize() public

Метод-обработчик события конструктора.
isFuture() public

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

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

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

isThisWeek() public

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

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

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

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

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

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

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

Устанавливает используемые шаблоны.
templater() public

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

Форматирует дату в выражение, описывающее относительное время.
toAtom() public

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

Возвращает квартал.
toRss() public

Форматирует дату для RSS лент.
toUnix() public

Возвращает метку времени UNIX из текстового описания даты и времени.
wasWithinLast() public

Возвращает true, если указанное время было в указанном интервале, иначе false.
wasYesterday() public

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

Подробное описание методов

__call() public

__call(string $method, array $params): mixed|void

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

Параметры

string $method: Метод для вызова
array $params: Массив параметров для метода.

Возвращает

mixed|void

__construct() public

__construct(Cake\View\View $view, array<string, mixed> $config = [])

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

Параметры

Cake\View\View $view: Представление, к которому прикреплен этот помощник.
array<string, mixed> $config необязательный: Настройки конфигурации для помощника.

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public

__get(string $name): Cake\View\Helper|null|void

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

Параметры

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

Возвращает

Cake\View\Helper|null|void

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key: Ключ для удаления.

Возвращает

void

Вызывает исключение

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

_configRead() protected

_configRead(string|null $key): mixed

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

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge необязательный: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Вызывает исключение

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

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode: Код, выполняемый после выбора 'OK'
string $cancelCode: Код, выполняемый после выбора 'Отмена'

Возвращает

string

_getTimezone() protected

_getTimezone(DateTimeZone|string|null $timezone): DateTimeZone|string|null

Получение часового пояса.

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

Параметры

DateTimeZone|string|null $timezone: Замена часового пояса, если применимо.

Возвращает

DateTimeZone|string|null

addClass() public

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

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

Параметры

array<string, mixed> $options: Массив опций/атрибутов для добавления класса.
string $class: Имя добавляемого класса.
string $key необязательный: Ключ для использования для класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигов.
mixed|null $value optional: Значение для установки.

Возвращает

$this

format() public

format(DateTimeInterface|string|int|null $date, string|int|null $format = null, string|false $invalid = false, DateTimeZone|string|null $timezone = null): string|int|false

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

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

Параметры

DateTimeInterface|string|int|null $date: Временная метка UNIX, допустимая строка strtotime() или объект DateTime (или строка формата даты).
string|int|null $format optional: Строка формата даты (или временная метка UNIX, strtotime() допустимая строка или объект DateTime).
string|false $invalid optional: Значение по умолчанию для отображения при недействительных датах
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string|int|false

См. также

\Cake\I18n\Time::i18nFormat()

formatTemplate() public

formatTemplate(string $name, array<string, mixed> $data): string

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

Параметры

string $name: Имя шаблона.
array<string, mixed> $data: Данные для вставки.

Возвращает

string

fromString() public

fromString(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): Cake\I18n\FrozenTime

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

Параметры

DateTimeInterface|string|int $dateString: Временная метка UNIX, допустимая строка strtotime() или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

Cake\I18n\FrozenTime

getConfig() public

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

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

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

Чтение всего конфига:

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

string|null $key optional: Ключ для получения или null для всего конфига.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфиг для указанного ключа.

Значение конфига для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getTemplates() public

getTemplates(string|null $template = null): array|string

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

Параметры

string|null $template optional: Строка для чтения определенного шаблона, null для всех.

Возвращает

array|string

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

gmt() public

gmt(DateTimeInterface|string|int|null $string = null): string

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

Параметры

DateTimeInterface|string|int|null $string необязательно: Отметка времени Unix, допустимая строка для strtotime() или объект DateTime

Возвращает

string

См. также

\Cake\I18n\Time::gmt()

i18nFormat() public

i18nFormat(DateTimeInterface|string|int|null $date, string|int|null $format = null, string|false $invalid = false, DateTimeZone|string|null $timezone = null): string|int|false

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

Параметры

DateTimeInterface|string|int|null $date: Отметка времени Unix, допустимая строка для strtotime() или объект DateTime
string|int|null $format необязательно: Строка формата, совместимая с Intl.
string|false $invalid необязательно: Значение по умолчанию для отображения при недействительных датах
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string|int|false

Исключения

Exception
При невозможности анализа даты

См. также

\Cake\I18n\Time::i18nFormat()

implementedEvents() public

implementedEvents(): array<string, mixed>

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

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

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

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

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

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

Параметры

array<string, mixed> $config: Настройки конфигурации, предоставленные этому помощнику.

Возвращает

void

isFuture() public

isFuture(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, допустимая строка для strtotime() или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isPast() public

isPast(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, допустимая строка для strtotime() или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isThisMonth() public

isThisMonth(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, допустимая строка для strtotime() или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isThisWeek() public

isThisWeek(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isThisYear() public

isThisYear(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isToday() public

isToday(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isTomorrow() public

isTomorrow(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

isWithinNext() public

isWithinNext(string $timeInterval, DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

string $timeInterval: Числовое значение со временем. Пример допустимых типов: 6 часов, 2 дня, 1 минута.
DateTimeInterface|string|int $dateString: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

См. также

\Cake\I18n\Time::wasWithinLast()

nice() public

nice(DateTimeInterface|string|int|null $dateString = null, DateTimeZone|string|null $timezone = null, string|null $locale = null): string

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

Параметры

DateTimeInterface|string|int|null $dateString необязательно: Отметка времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone
string|null $locale необязательно: Строка локали.

Возвращает

string

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.
bool $merge необязательно: Выполнить рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Выбрасывает

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

setTemplates() public

setTemplates(array<string> $templates): $this

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

Параметры

array<string> $templates: Шаблоны, которые нужно добавить.

Возвращает

$this

templater() public

templater(): Cake\View\StringTemplate

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

Возвращает

Cake\View\StringTemplate

timeAgoInWords() public

timeAgoInWords(DateTimeInterface|string|int $dateTime, array<string, mixed> $options = []): string

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

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

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

Параметры

DateTimeInterface|string|int $dateTime: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime.
array<string, mixed> $options optional: Формат по умолчанию, если timestamp используется в $dateString

Возвращает

string

См. также

\Cake\I18n\Time::timeAgoInWords()

toAtom() public

toAtom(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string

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

Параметры

DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string

См. также

\Cake\I18n\Time::toAtom()

toQuarter() public

toQuarter(DateTimeInterface|string|int $dateString, bool $range = false): array<string>|int

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

Параметры

DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
bool $range optional: если true, возвращает диапазон в формате Y-m-d

Возвращает

array<string>|int

См. также

\Cake\I18n\Time::toQuarter()

toRss() public

toRss(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string

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

Параметры

DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string

toUnix() public

toUnix(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string

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

Параметры

DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

string

См. также

\Cake\I18n\Time::toUnix()

wasWithinLast() public

wasWithinLast(string $timeInterval, DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

string $timeInterval: Числовое значение со временем. Пример допустимых типов: 6 часов, 2 дня, 1 минута.
DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, подходящая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

См. также

\Cake\I18n\Time::wasWithinLast()

wasYesterday() public

wasYesterday(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool

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

Параметры

DateTimeInterface|string|int $dateString: Маркер времени Unix, строка, допустимая для strtotime(), или объект DateTime
DateTimeZone|string|null $timezone optional: Строка часового пояса пользователя или объект DateTimeZone

Возвращает

bool

Подробное описание свойств

`$_View` protected

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

Тип

Cake\View\View

`$_config` protected

Конфигурация выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Указывает, была ли конфигурация свойства уже настроена по умолчанию

Тип

bool

`$_defaultConfig` protected

Параметры конфигурации

Тип

array<string, mixed>

`$_helperMap` protected

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

Тип

array<string, array>

`$_templater` protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate|null

`$helpers` protected

Список помощников, используемых этим помощником

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.View.Helper.TimeHelper.html