GenericEvent
class GenericEvent extends Event implements ArrayAccess, IteratorAggregate
Класс для инкапсуляции событий.
Инкапсулирует события, тем самым отвязывая наблюдателя от объекта, который они инкапсулируют.
Методы
| bool | isPropagationStopped() Возвращает, следует ли запускать дальнейшие обработчики событий. | из Event |
| stopPropagation() Останавливает распространение события на дальнейшие обработчики событий. | из Event | |
| setDispatcher(EventDispatcherInterface $dispatcher) устаревший Хранит EventDispatcher, который отправляет это событие. | из Event | |
| EventDispatcherInterface | getDispatcher() устаревший Возвращает EventDispatcher, который отправляет это событие. | из Event |
| string | getName() устаревший Получает имя события. | из Event |
| setName(string $name) устаревший Устанавливает свойство имени события. | из Event | |
| __construct(mixed $subject = null, array $arguments = array()) Инкапсулирует событие с $subject и $args. | ||
| mixed | getSubject() Геттер для свойства subject. | |
| mixed | getArgument(string $key) Получить аргумент по ключу. | |
| $this | setArgument(string $key, mixed $value) Добавить аргумент к событию. | |
| array | getArguments() Геттер для всех аргументов. | |
| $this | setArguments(array $args = array()) Установить свойство args. | |
| bool | hasArgument(string $key) Есть ли аргумент. | |
| mixed | offsetGet(string $key) ArrayAccess для получения аргумента. | |
| offsetSet(string $key, mixed $value) ArrayAccess для установки аргумента. | ||
| offsetUnset(string $key) ArrayAccess для удаления аргумента. | ||
| bool | offsetExists(string $key) ArrayAccess содержит аргумент. | |
| ArrayIterator | getIterator() IteratorAggregate для итерации по объекту как по массиву. |
Подробности
bool isPropagationStopped()
Возвращает, будут ли вызываться дополнительные обработчики событий.
Значение возврата
| bool | Было ли событие остановлено для этого события |
См. также
| Event::stopPropagation() |
stopPropagation()
Останавливает распространение события к дополнительным обработчикам событий.
Если к одному и тому же событию подключены несколько обработчиков событий, после того как любой обработчик вызовет stopPropagation(), дальнейшие обработчики событий не будут вызваны.
setDispatcher(EventDispatcherInterface $dispatcher) устаревшее
устаревшее
Хранит EventDispatcher, который обрабатывает это событие.
Параметры
| EventDispatcherInterface | $dispatcher |
EventDispatcherInterface getDispatcher() устаревшее
устаревшее
Возвращает EventDispatcher, который обрабатывает это событие.
Значение возврата
| EventDispatcherInterface |
string getName() устаревшее
устаревшее
Получает имя события.
Значение возврата
| string |
setName(string $name) устаревшее
устаревшее
Устанавливает свойство имени события.
Параметры
| string | $name | Имя события |
__construct(mixed $subject = null, array $arguments = array())
Оборачивает событие с $subject и $args.
Параметры
| mixed | $subject | Предмет события, обычно объект |
| array | $arguments | Аргументы для хранения в событии |
mixed getSubject()
Геттер для свойства subject.
Значение возврата
| mixed | $subject Предмет наблюдателя |
mixed getArgument(string $key)
Получить аргумент по ключу.
Параметры
| string | $key | Ключ |
Значение возврата
| mixed | Содержимое ключа массива |
Исключения
| InvalidArgumentException | если ключ не найден |
$this setArgument(string $key, mixed $value)
Добавить аргумент к событию.
Параметры
| string | $key | Имя аргумента |
| mixed | $value | Значение |
Значение возврата
| $this |
array getArguments()
Геттер для всех аргументов.
Значение возврата
| array |
$this setArguments(array $args = array())
Устанавливает свойство args.
Параметры
| array | $args | Аргументы |
Значение возврата
| $this |
bool hasArgument(string $key)
Есть аргумент.
Параметры
| string | $key | Ключ массива аргументов |
Значение возврата
| bool |
mixed offsetGet(string $key)
ArrayAccess для получения аргумента.
Параметры
| string | $key | Ключ массива |
Значение возврата
| mixed |
Исключения
| InvalidArgumentException | если ключ не существует в $this->args |
offsetSet(string $key, mixed $value)
ArrayAccess для установки аргумента.
Параметры
| string | $key | Ключ массива для установки |
| mixed | $value | Значение |
offsetUnset(string $key)
ArrayAccess для удаления аргумента.
Параметры
| string | $key | Ключ массива |
bool offsetExists(string $key)
ArrayAccess содержит аргумент.
Параметры
| string | $key | Ключ массива |
Значение возврата
| bool |
ArrayIterator getIterator()
IteratorAggregate для итерации по объекту как по массиву.
Значение возврата
| ArrayIterator |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/EventDispatcher/GenericEvent.html
