Класс Event

__construct()source public

__construct( string $name , object|null $subject = null , array|ArrayAccess|null $data = null )

Конструктор

Примеры использования:

$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
 $event = new Event('User.afterRegister', $UserModel);

Параметры

string $name

Имя события

object|null $subject optional null

объект, к которому относится это событие (обычно объект, который генерирует событие)

array|ArrayAccess|null $data optional null

любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать обработчики

__get()source public deprecated

__get( string $attribute )

Предоставляет доступ для чтения только для свойств name и subject.

Устаревшее

3.4.0 Публичные свойства будут удалены.

Параметры

string $attribute

Имя атрибута.

Возвращает

mixed

__set()source public deprecated

__set( string $attribute , mixed $value )

Обеспечивает обратную совместимость для записи данных и свойств result.

Устаревшее

3.4.0 Публичные свойства будут удалены.

Параметры

string $attribute

Имя атрибута.

mixed $value

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

data()source public deprecated

data( string|null $key = null )

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

Устаревшее

3.4.0 используйте getData() вместо этого.

Параметры

string|null $key optional null

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

Возвращает

array|mixed|null

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

getData()source public

getData( string|null $key = null )

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

Параметры

string|null $key optional null

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

Возвращает

array|mixed|null

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

Реализация

Cake\Event\EventInterface::getData()

getName()source public

getName( )

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

Возвращает

string

Реализация

Cake\Event\EventInterface::getName()

getResult()source public

getResult( )

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

Возвращает

mixed

Реализация

Cake\Event\EventInterface::getResult()

getSubject()source public

getSubject( )

Возвращает объект-субъект этого события

Возвращает

object

Реализация

Cake\Event\EventInterface::getSubject()

isStopped()source public

isStopped( )

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

Возвращает

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

Реализация

Cake\Event\EventInterface::isStopped()

name()source public deprecated

name( )

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

Устаревшее

3.4.0 используйте getName() вместо этого.

Возвращает

string

result()source public deprecated

result( )

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

Устаревшее

3.4.0 используйте getResult() вместо этого.

Возвращает

mixed

setData()source public

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

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

Параметры

array|string $key

Массив заменит все данные загрузки, а ключ установит только этот элемент массива.

mixed $value optional null

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

Возвращает

$this

Реализация

Cake\Event\EventInterface::setData()

setResult()source public

setResult( mixed $value = null )

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

Параметры

mixed $value необязательный null

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

Возвращает

$this

Реализация

Cake\Event\EventInterface::setResult()

stopPropagation()source public

stopPropagation( )

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

Реализация

Cake\Event\EventInterface::stopPropagation()

subject()source public deprecated

subject( )

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

Устарело

3.4.0 используйте getSubject() вместо этого.

Возвращает

объект

false