Spec-Zone.ru › CakePHP 2.8

Класс CakeEvent

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

Пакет: Cake\Event
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: 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.
http://api.cakephp.org/2.8/class-CakeEvent.html

Spec-Zone.ru

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