Интерфейс EventInterface

Представляет класс транспорта событий по всей системе. Он получает имя, предмет и необязательную полезную нагрузку. Имя может быть любой строкой, которая уникально идентифицирует событие в приложении, а предмет представляет объект, к которому относится событие.

Пространство имен: Cake\Event

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

getData() public

Доступ к данным/полезной нагрузке события.
getName() public

Возвращает имя этого события. Обычно используется в качестве идентификатора события.
getResult() public

Значение результата обработчиков событий.
getSubject() public

Возвращает предмет этого события.
isStopped() public

Проверяет, остановлено ли событие.
setData() public

Присваивает значение данным/полезной нагрузке этого события.
setResult() public

Обработчики могут прикрепить значение результата к событию.
stopPropagation() public

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

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

getData() public

getData(string|null $key = null): mixed|array|null

Доступ к данным/полезной нагрузке события.

Параметры

string|null $key необязательный: Элемент полезной нагрузки данных для возврата или null для возврата всех данных.

Возвращает

mixed|array|null

getName() public

getName(): string

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

Возвращает

string

getResult() public

getResult(): mixed

Значение результата обработчиков событий.

Возвращает

mixed

getSubject() public

getSubject(): object

Возвращает предмет этого события.

Возвращает

object

isStopped() public

isStopped(): bool

Проверяет, остановлено ли событие.

Возвращает

bool

setData() public

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

Присваивает значение данным/полезной нагрузке этого события.

Параметры

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

Возвращает

$this

setResult() public

setResult(mixed $value = null): $this

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

Параметры

mixed $value необязательный: Значение для установки.

Возвращает

$this

stopPropagation() public

stopPropagation(): void

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

Возвращает

void

© 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.4/interface-Cake.Event.EventInterface.html