Класс Event
Класс Event
Краткое описание свойств
- $_data protected
arrayДополнительные данные для метода, который получает событие
- $_name protected
stringИмя события
- $_stopped protected
boolФлаг, указывающий на остановку события, по умолчанию false
- $_subject protected
object|nullОбъект, к которому относится это событие (обычно тот же объект, который генерирует событие)
- $result protected
mixedСвойство, используемое для сохранения значения результата обработчиков событий
Краткое описание методов
-
__construct() public
Конструктор
-
getData() public
Доступ к данным события/загрузке.
-
getName() public
Возвращает имя этого события. Обычно используется в качестве идентификатора события.
-
getResult() public
Значение результата обработчиков события.
-
getSubject() public
Возвращает объект-субъект этого события.
-
isStopped() public
Проверка остановки события.
-
setData() public
Присваивает значение данным/загрузке этого события.
-
setResult() public
Обработчики могут прикрепить значение результата к событию.
-
stopPropagation() public
Останавливает дальнейшее использование события.
Подробное описание методов
__construct() public
__construct(string $name, object|null $subject = null, ArrayAccess|array|null $data = null)
Конструктор
Примеры использования:
$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
$event = new Event('User.afterRegister', $userModel); Параметры
-
string$name Имя события
-
object|null$subject необязательно объект, к которому относится это событие (обычно объект, генерирующий событие).
-
ArrayAccess|array|null$data необязательно любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать обработчики.
getData() public
getData(string|null $key = null): mixed|array|null
Доступ к данным события/загрузке.
Параметры
-
string|null$key необязательно Элемент данных загрузки для возврата или null для возврата всех данных.
Возвращаемое значение
mixed|array|nullgetName() public
getName(): string
Возвращает имя этого события. Обычно используется в качестве идентификатора события
Возвращаемое значение
stringgetResult() public
getResult(): mixed
Значение результата обработчиков события
Возвращаемое значение
mixedgetSubject() public
getSubject(): object
Возвращает объект-субъект этого события
Если событие не имеет объекта-субъекта, будет возбуждено исключение.
Возвращаемое значение
objectИсключения
Cake\Core\Exception\CakeExceptionisStopped() public
isStopped(): bool
Проверка остановки события
Возвращаемое значение
boolsetData() public
setData(array|string $key, mixed $value = null): $this
Присваивает значение данным/загрузке этого события.
Параметры
-
array|string$key Массив заменит все данные загрузки, а ключ установит только этот элемент массива.
-
mixed$value необязательно Устанавливаемое значение.
Возвращаемое значение
$thissetResult() public
setResult(mixed $value = null): $this
Обработчики могут прикрепить значение результата к событию.
Параметры
-
mixed$value необязательно Устанавливаемое значение.
Возвращаемое значение
$thisstopPropagation() public
stopPropagation(): void
Останавливает дальнейшее использование события
Возвращаемое значение
voidПодробное описание свойств
$_data protected
Дополнительные данные для метода, принимающего событие
Тип
array$_name protected
Имя события
Тип
string$_stopped protected
Флаг остановки события, по умолчанию false
Тип
bool$_subject protected
Объект, к которому относится это событие (обычно тот же объект, который генерирует событие)
Тип
object|null$result protected
Свойство для сохранения значения результата обработчиков события
Используйте setResult() и getResult() для установки и получения результата.
Тип
mixed
© 2005–present 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/4.3/class-Cake.Event.Event.html
