Интерфейс EventInterface

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

Прямые реализаторы

Cake\Event\Event

Пространство имен: Cake\Event
Расположение: Event/EventInterface.php

Краткое описание магических свойств

$data public

array
(устаревшее) Дополнительные данные для метода, который получает событие
$name public

string
(устаревшее) Имя события
$result public

mixed
(устаревшее) Свойство для сохранения значения результата обработчиков события
$subject public

object
(устаревшее) Объект, к которому относится это событие

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

getData() public
Доступ к данным/полезной нагрузке события.
getName() public
Возвращает имя этого события. Обычно используется в качестве идентификатора события.
getResult() public
Значение результата обработчиков события.
getSubject() public
Возвращает предмет этого события.
isStopped() public
Проверяет, остановлено ли событие.
setData() public
Присваивает значение данным/полезной нагрузке этого события.
setResult() public
Обработчики могут прикрепить значение результата к событию.
stopPropagation() public
Останавливает дальнейшее использование события.

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

getData()source public

getData( string|null $key = null )

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

Параметры

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

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

array|mixed|null

Полезная нагрузка, если $key равен null, или значение данных для заданного $key. Если $key не существует, возвращается значение null.

getName()source public

getName( )

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

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

string

getResult()source public

getResult( )

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

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

mixed

getSubject()source public

getSubject( )

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

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

object

isStopped()source public

isStopped( )

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

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

boolean
True, если событие остановлено

setData()source public

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

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

Параметры

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

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

$this

setResult()source public

setResult( mixed $value = null )

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

Параметры

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

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

$this

stopPropagation()source public

stopPropagation( )

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

Подробное описание магических свойств

$datasource

public массив

$namesource

public строка

$resultsource

public mixed

$subjectsource

public объект

© 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/3.8/class-Cake.Event.EventInterface.html