Класс 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);

Параметры

строка $name

Имя события

объект|null $subject необязательно null

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

массив|ArrayAccess|null $data необязательно null

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

__get()source public deprecated

__get( string $attribute )

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

Устаревшее

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

Параметры

строка $attribute

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

Возвращает

смешанный

__set()source public deprecated

__set( string $attribute , mixed $value )

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

Устаревшее

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

Параметры

строка $attribute

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

смешанный $value

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

data()source public deprecated

data( string|null $key = null )

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

Устаревшее

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

Параметры

строка|null $key необязательно null

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

Возвращает

массив|смешанный|null

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

getData()source public

getData( string|null $key = null )

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

Параметры

строка|null $key необязательно null

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

Возвращает

массив|смешанный|null

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

Реализация

Cake\Event\EventInterface::getData()

getName()source public

getName( )

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

Возвращает

строка

Реализация

Cake\Event\EventInterface::getName()

getResult()source public

getResult( )

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

Возвращает

смешанный

Реализация

Cake\Event\EventInterface::getResult()

getSubject()source public

getSubject( )

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

Возвращает

объект

Реализация

Cake\Event\EventInterface::getSubject()

isStopped()source public

isStopped( )

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

Возвращает

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

Реализация

Cake\Event\EventInterface::isStopped()

name()source public deprecated

name( )

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

Устаревшее

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

Возвращает

строка

result()source public deprecated

result( )

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

Устаревшее

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

Возвращает

смешанный

setData()source public

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

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

Параметры

массив|строка $key

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

смешанный $value необязательно 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 устаревший

subject( )

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

Устаревший

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

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

объект

false