Spec-Zone.ru › CakePHP 3.1

Класс Event

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

Пространство имен: Cake\Event
Расположение Event/Event.php

Подробности метода

__constructsource 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
любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели

__getsource public

__get( string $attribute )

Динамически возвращает имя и предмет при прямом обращении

Параметры

строка $attribute
Имя атрибута.

Возвращает

mixed
смешанный тип

datasource public

data( )

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

Возвращает

array
массив

isStoppedsource public

isStopped( )

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

Возвращает

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

namesource public

name( )

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

Возвращает

string
строка

stopPropagationsource public

stopPropagation( )

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

subjectsource public

subject( )

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

Возвращает

object
объект

Резюме свойств

$_namesource

protected строка

Имя события

null

$_stoppedsource

protected булево

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

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.
http://api.cakephp.org/3.1/class-Cake.Event.Event.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API