Класс TimeHelper

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

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

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

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

$_View protected

Cake\View\View

Экземпляр представления, к которому прикреплён данный помощник.
$_config protected

array

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

bool

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

array

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

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

Возвращает красиво отформатированную строку даты для заданной строки даты Datetime.
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 $config = [])

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

Параметры

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

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__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(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge необязательно: Истина для рекурсивного слияния, «поверхностное» для простого слияния, ложь для перезаписи, по умолчанию ложь.

Возвращает

void

Выбрасывает

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

_confirm() protected

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

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

Параметры

string $okCode: Код, который будет выполнен после выбора пользователем «ОК»
string $cancelCode: Код, который будет выполнен после выбора пользователем «Отмена»

Возвращает

string

_getTimezone() protected

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

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

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

Параметры

DateTimeZone|string|null $timezone: Часовой пояс для переопределения, если применимо.

Возвращает

DateTimeZone|string|null

addClass() public

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

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

Параметры

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

Возвращает

array

configShallow() public

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

$this

format() public

format(int|stringDateTimeInterface|null $date, int|string|null $format = null, string|false $invalid = false, stringDateTimeZone|null $timezone = null): string|int|false

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

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

Параметры

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

Возвращает

string|int|false

См. также

\Cake\I18n\Time::i18nFormat()

formatTemplate() public

formatTemplate(string $name, array $data): string

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

Параметры

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

Возвращает

string

fromString() public

fromString(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): Cake\I18n\Time

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

Параметры

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

Возвращает

Cake\I18n\Time

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 необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getTemplates() public

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

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

Параметры

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

Возвращает

string|array

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

gmt() public

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

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

Параметры

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

Возвращает

string

См. также

\Cake\I18n\Time::gmt()

i18nFormat() public

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

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

Параметры

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

Возвращает

string|int|false

Выбрасывает

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

См. также

\Cake\I18n\Time::i18nFormat()

implementedEvents() public

implementedEvents(): array

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

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

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

Возвращает

array

initialize() public

initialize(array $config): void

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

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

Параметры

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

Возвращает

void

isFuture() public

isFuture(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isPast() public

isPast(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isThisMonth() public

isThisMonth(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isThisWeek() public

isThisWeek(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isThisYear() public

isThisYear(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isToday() public

isToday(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isTomorrow() public

isTomorrow(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

isWithinNext() public

isWithinNext(string $timeInterval, int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

См. также

\Cake\I18n\Time::wasWithinLast()

nice() public

nice(int|stringDateTimeInterface|null $dateString = null, stringDateTimeZone|null $timezone = null, string|null $locale = null): string

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

Параметры

int|stringDateTimeInterface|null $dateString необязательно: Отметка Unix, строка, распознаваемая функцией strtotime(), или объект DateTime
stringDateTimeZone|null $timezone необязательно: Строка часового пояса пользователя или объект DateTimeZone
string|null $locale необязательно: Строка языка.

Возвращает

string

setConfig() public

setConfig(string|array $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']);

Параметры

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

Возвращает

$this

Выбрасывает

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

setTemplates() public

setTemplates(string[] $templates): $this

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

Параметры

string[] $templates: Добавляемые шаблоны.

Возвращает

$this

templater() public

templater(): Cake\View\StringTemplate

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

Возвращает

Cake\View\StringTemplate

timeAgoInWords() public

timeAgoInWords(int|stringDateTimeInterface $dateTime, array $options = []): string

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

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

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

Параметры

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

Возвращает

string

См. также

\Cake\I18n\Time::timeAgoInWords()

toAtom() public

toAtom(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): string

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

Параметры

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

Возвращает

string

См. также

\Cake\I18n\Time::toAtom()

toQuarter() public

toQuarter(int|stringDateTimeInterface $dateString, bool $range = false): string[]|int

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

Параметры

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

Возвращает

string[]|int

См. также

\Cake\I18n\Time::toQuarter()

toRss() public

toRss(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): string

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

Параметры

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

Возвращает

string

toUnix() public

toUnix(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): string

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

Параметры

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

Возвращает

string

См. также

\Cake\I18n\Time::toUnix()

wasWithinLast() public

wasWithinLast(string $timeInterval, int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

См. также

\Cake\I18n\Time::wasWithinLast()

wasYesterday() public

wasYesterday(int|stringDateTimeInterface $dateString, stringDateTimeZone|null $timezone = null): bool

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

Параметры

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

Возвращает

bool

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

`$_View` protected

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

Тип

Cake\View\View

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Тип

array

`$_helperMap` protected

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

Тип

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.2/class-Cake.View.Helper.TimeHelper.html