GenericEvent
class GenericEvent extends Event implements ArrayAccess, IteratorAggregate
Класс для инкапсуляции событий.
Инкапсулирует события, тем самым отвязывая наблюдателя от объекта, который они инкапсулируют.
Свойства
| protected | $subject | ||
| protected | $arguments |
Методы
| bool | isPropagationStopped() Возвращает, должны ли быть запущены дополнительные обработчики событий. | from Event |
| stopPropagation() Останавливает распространение события к дополнительным обработчикам событий. | from 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.
https://api.symfony.com/4.1/Symfony/Component/EventDispatcher/GenericEvent.html
