Spec-Zone.ru › CakePHP 3.3

Класс Event

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

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

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

  • $_name protected
    string
    Имя события
  • $_stopped protected
    boolean
    Флаг, указывающий, остановлено событие или нет, по умолчанию — false
  • $_subject protected
    object
    Объект, к которому относится это событие (обычно тот же объект, который генерирует событие)
  • $data public
    mixed
    Пользовательские данные для метода, который получает событие
  • $result public
    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
Имя атрибута.

Возвращает

mixed

data()source public

data( )

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

Возвращает

массив

isStopped()source public

isStopped( )

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

Возвращает

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

name()source public

name( )

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

Возвращает

строка

stopPropagation()source public

stopPropagation( )

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

subject()source public

subject( )

Возвращает субъект этого события

Возвращает

объект

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

$_namesource

protected строка

Имя события

null

$_stoppedsource

protected булево

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

false

$_subjectsource

protected объект

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

$datasource

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

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

null

$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

Spec-Zone.ru

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