Класс CakeEvent

Представляет класс транспорта событий по всей системе. Он получает имя, предмет и необязательную полезную нагрузку. Имя может быть любой строкой, которая уникально идентифицирует событие во всём приложении, в то время как предмет представляет объект, к которому относится событие.

Пакет: Cake\Event
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Event/CakeEvent.php

Краткое описание свойств

$_name protected

string
Имя события
$_stopped protected

boolean
Флаг события как остановленного или нет, по умолчанию false
$_subject protected

object
Объект, к которому относится событие (обычно тот же объект, который генерирует событие)
$data public

mixed
Пользовательские данные для метода, который получает событие
$result public

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

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

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

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

name()source public

name( )

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

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

строка

stopPropagation()source public

stopPropagation( )

Останавливает дальнейшее использование события

subject()source public

subject( )

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

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

объект

Подробное описание свойств

$_namesource

protected строка

Имя события

null

$_stoppedsource

protected boolean

Флаг события как остановленного или нет, по умолчанию false

false

$_subjectsource

protected объект

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

$datasource

public смешанный

Пользовательские данные для метода, который получает событие

null

$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.
https://api.cakephp.org/2.9/class-CakeEvent.html