Класс CakeEvent
Представляет транспортный класс событий в системе. Он получает имя, предмет и необязательную полезную нагрузку. Имя может быть любой строкой, которая однозначно идентифицирует событие в приложении, в то время как предмет представляет собой объект, к которому относится событие.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Event/CakeEvent.php
Краткое описание свойств
-
$_nameprotectedИмя событияstring -
$_stoppedprotectedФлаг, указывающий, остановлено ли событие, по умолчанию falseboolean -
$_subjectprotectedОбъект, к которому относится событие (обычно тот же объект, который генерирует событие)object -
$datapublicПользовательные данные для метода, который получает событиеmixed -
$resultpublicСвойство, используемое для сохранения значения результата слушателей событийmixed
Краткое описание методов
- __construct() publicКонструктор
- __get() publicДинамически возвращает имя и предмет, если обращение происходит напрямую
- isStopped() publicПроверка, остановлено ли событие
- name() publicВозвращает имя события. Обычно используется в качестве идентификатора события
- stopPropagation() publicПрекращает дальнейшее использование события
- subject() publicВозвращает предмет события
Подробное описание методов
__construct()source public
__construct( string $name , object $subject null , mixed $data null )
Конструктор
Параметры
- строка
$name - Имя события
- объект
$subjectнеобязательно null - объект, к которому относится событие (обычно объект, генерирующий событие)
- смешанное
$dataнеобязательно null -
любое значение, которое вы хотите передать с этим событием для его чтения слушателями
Примеры использования:
$event = new CakeEvent('Order.afterBuy', $this, array('buyer' => $userData)); $event = new CakeEvent('User.afterRegister', $UserModel);
__get()source public
__get( string $attribute )
Динамически возвращает имя и предмет, если обращение происходит напрямую
Параметры
- строка
$attribute - Имя атрибута.
Возвращаемое значение
смешанноеisStopped()source public
isStopped( )
Проверка, остановлено ли событие
Возвращаемое значение
booleanTrue, если событие остановлено
name()source public
name( )
Возвращает имя события. Обычно используется в качестве идентификатора события
Возвращаемое значение
строкаПодробное описание свойств
$_stoppedsource
protected boolean
Флаг, указывающий, остановлено ли событие, по умолчанию false
false
$_subjectsource
protected объект
Объект, к которому относится событие (обычно тот же объект, который генерирует событие)
$resultsource
public смешанное
Свойство, используемое для сохранения значения результата слушателей событий
null
© 2005–2016 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.
http://api.cakephp.org/2.8/class-CakeEvent.html