GenericEvent
class GenericEvent extends Event implements ArrayAccess, IteratorAggregate
Класс для инкапсуляции событий.
Инкапсулирует события, тем самым отвязывая наблюдателя от объекта, который они инкапсулируют.
Методы
| bool | isPropagationStopped() Возвращает, следует ли вызывать дальнейшие слушатели событий. | из Event |
| stopPropagation() Останавливает распространение события к дальнейшим слушателям событий. | из 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().
__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/3.1/Symfony/Component/EventDispatcher/GenericEvent.html
