Класс Event
Представляет класс транспорта событий по всей системе. Получает имя, субъект и необязательную полезную нагрузку. Имя может быть любой строкой, которая уникально идентифицирует событие во всём приложении, в то время как субъект представляет объект, к которому относится событие.
Краткое описание свойств
-
$_nameprotectedИмя событияstring -
$_stoppedprotectedФлаг, указывающий, остановлено событие или нет, по умолчанию — falseboolean -
$_subjectprotectedОбъект, к которому относится это событие (обычно тот же объект, который генерирует событие)object -
$datapublicПользовательские данные для метода, который получает событиеmixed -
$resultpublicСвойство, используемое для сохранения значения результата обработчиков событийmixed
Краткое описание методов
- __construct() publicКонструктор
- __get() publicДинамически возвращает имя и субъект, если к ним обращаются напрямую
- data() publicДоступ к данным/полезной нагрузке события.
- isStopped() publicПроверка, остановлено ли событие
- name() publicВозвращает имя этого события. Обычно используется в качестве идентификатора события
- stopPropagation() publicОстанавливает дальнейшее использование события
- subject() publicВозвращает субъект этого события
Подробное описание методов
__construct()source public
__construct( string $name , object|null $subject null , array|null $data null )
Конструктор
Примеры использования:
$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
$event = new Event('User.afterRegister', $UserModel); Параметры
- строка
$name - Имя события
- объект|null
$subjectнеобязательно null - объект, к которому относится это событие (обычно объект, генерирующий событие)
- массив|null
$dataнеобязательно null - любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели
__get()source public
__get( string $attribute )
Динамически возвращает имя и субъект, если к ним обращаются напрямую
Параметры
- строка
$attribute - Имя атрибута.
Возвращает
mixedisStopped()source public
isStopped( )
Проверка, остановлено ли событие
Возвращает
булевоTrue, если событие остановлено
name()source public
name( )
Возвращает имя этого события. Обычно используется в качестве идентификатора события
Возвращает
строкаПодробное описание свойств
$_stoppedsource
protected булево
Флаг, указывающий, остановлено событие или нет, по умолчанию — false
false
$_subjectsource
protected объект
Объект, к которому относится это событие (обычно тот же объект, который генерирует событие)
$resultsource
public смешанный тип
Свойство, используемое для сохранения значения результата обработчиков событий
null
© 2005–2017 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.3/class-Cake.Event.Event.html