Spec-Zone.ru › CakePHP 2.7

Класс CakeEvent

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

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

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

__constructисходный код public

__construct( string $name , object $subject null , mixed $data null )

Конструктор

Параметры

строка $name
Имя события
объект $subject необязательно null
объект, к которому относится это событие (обычно объект, который генерирует событие)
смешанное $data необязательно null
любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели ## Примеры использования: <code> $event = new CakeEvent('Order.afterBuy', $this, array('buyer' => $userData)); $event = new CakeEvent('User.afterRegister', $UserModel); </code>

__getисходный код public

__get( string $attribute )

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

Параметры

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

Возвращает

mixed
смешанный

isStoppedисходный код public

isStopped( )

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

Возвращает

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

nameисходный код public

name( )

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

Возвращает

string
строка

stopPropagationисходный код public

stopPropagation( )

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

subjectисходный код public

subject( )

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

Возвращает

object
объект

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

$_nameисходный код

защищено строка

Имя события

null

$_stoppedисходный код

защищено логическое

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

false

$_subjectисходный код

защищено объект

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

$dataисходный код

публично смешанное

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

null

$resultисходный код

публично смешанное

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

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.7/class-CakeEvent.html

Spec-Zone.ru

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