Класс 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 необязательно null

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

array|ArrayAccess|null $data необязательно null

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

__get()source public

__get( string $attribute )

Обеспечивает чтение только для свойств name и subject.

Устарело

3.4.0 Свойства public будут удалены.

Параметры

string $attribute

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

Возвращает

mixed

__set()source public

__set( string $attribute , mixed $value )

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

Устарело

3.4.0 Свойства public будут удалены.

Параметры

string $attribute

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

mixed $value

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

data()source public

data( string|null $key null )

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

Устарело

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

Параметры

string|null $key необязательно null

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

Возвращает

array|mixed|null

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

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, если событие остановлено

name()source public

name( )

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

Устарело

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

Возвращает

string

result()source public

result( )

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

Устарело

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

Возвращает

mixed

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( )

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

subject()source public

subject( )

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

Устарело

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

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

объект

false