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) Получить аргумент по ключу. | |
| GenericEvent | setArgument(string $key, mixed $value) Добавить аргумент в событие. | |
| array | getArguments() Получатель для всех аргументов. | |
| GenericEvent | 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 | Если ключ не найден. |
GenericEvent setArgument(string $key, mixed $value)
Добавление аргумента к событию.
Параметры
| string | $key | Имя аргумента. |
| mixed | $value | Значение. |
Значение возврата
| GenericEvent |
array getArguments()
Получатель для всех аргументов.
Значение возврата
| array |
GenericEvent setArguments(array $args = array())
Устанавливает свойство args.
Параметры
| array | $args | Аргументы. |
Значение возврата
| GenericEvent |
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/3.0/Symfony/Component/EventDispatcher/GenericEvent.html
