Public Member Functions | |
| getDispatcher () | |
| getDispatcher () | |
| getName () | |
| getName () | |
| isPropagationStopped () | |
| isPropagationStopped () | |
| setDispatcher (EventDispatcherInterface $dispatcher) | |
| setDispatcher (EventDispatcherInterface $dispatcher) | |
| setName ($name) | |
| setName ($name) | |
| stopPropagation () | |
| stopPropagation () | |
Detailed Description
Event is the base class for classes containing event data.
This class contains no event data. It is used by events that do not pass state information to an event handler when an event is raised.
You can call the method stopPropagation() to abort the execution of further listeners in your event listener.
Definition at line 28 of file lib/vendor/symfony/event-dispatcher/Event.php.
Member Function Documentation
◆ getDispatcher() [1/2]
| Symfony\Component\EventDispatcher\Event::getDispatcher | ( | ) |
Returns the EventDispatcher that dispatches this Event.
- Returns
- EventDispatcherInterface
- Deprecated:
- since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.
Definition at line 97 of file lib/vendor/symfony/event-dispatcher/Event.php.
◆ getDispatcher() [2/2]
| Symfony\Component\EventDispatcher\Event::getDispatcher | ( | ) |
Returns the EventDispatcher that dispatches this Event.
- Returns
- EventDispatcherInterface
- Deprecated:
- since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.
Definition at line 97 of file vendor/symfony/event-dispatcher/Event.php.
◆ getName() [1/2]
| Symfony\Component\EventDispatcher\Event::getName | ( | ) |
Gets the event's name.
- Returns
- string
- Deprecated:
- since version 2.4, to be removed in 3.0. The event name is passed to the listener call.
Definition at line 111 of file lib/vendor/symfony/event-dispatcher/Event.php.
◆ getName() [2/2]
| Symfony\Component\EventDispatcher\Event::getName | ( | ) |
Gets the event's name.
- Returns
- string
- Deprecated:
- since version 2.4, to be removed in 3.0. The event name is passed to the listener call.
Definition at line 111 of file vendor/symfony/event-dispatcher/Event.php.
◆ isPropagationStopped() [1/2]
| Symfony\Component\EventDispatcher\Event::isPropagationStopped | ( | ) |
Returns whether further event listeners should be triggered.
- See also
- Event::stopPropagation()
- Returns
- bool Whether propagation was already stopped for this event
Definition at line 61 of file lib/vendor/symfony/event-dispatcher/Event.php.
Referenced by Symfony\Component\EventDispatcher\Debug\WrappedListener\__invoke(), and Symfony\Component\EventDispatcher\EventDispatcher\doDispatch().
◆ isPropagationStopped() [2/2]
| Symfony\Component\EventDispatcher\Event::isPropagationStopped | ( | ) |
Returns whether further event listeners should be triggered.
- See also
- Event::stopPropagation()
- Returns
- bool Whether propagation was already stopped for this event
Definition at line 61 of file vendor/symfony/event-dispatcher/Event.php.
◆ setDispatcher() [1/2]
| Symfony\Component\EventDispatcher\Event::setDispatcher | ( | EventDispatcherInterface | $dispatcher | ) |
Stores the EventDispatcher that dispatches this Event.
- Parameters
-
EventDispatcherInterface $dispatcher
- Deprecated:
- since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.
Definition at line 85 of file vendor/symfony/event-dispatcher/Event.php.
◆ setDispatcher() [2/2]
| Symfony\Component\EventDispatcher\Event::setDispatcher | ( | EventDispatcherInterface | $dispatcher | ) |
Stores the EventDispatcher that dispatches this Event.
- Parameters
-
EventDispatcherInterface $dispatcher
- Deprecated:
- since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.
Definition at line 85 of file lib/vendor/symfony/event-dispatcher/Event.php.
◆ setName() [1/2]
| Symfony\Component\EventDispatcher\Event::setName | ( | $name | ) |
Sets the event's name property.
- Parameters
-
string $name The event name
- Deprecated:
- since version 2.4, to be removed in 3.0. The event name is passed to the listener call.
Definition at line 125 of file vendor/symfony/event-dispatcher/Event.php.
◆ setName() [2/2]
| Symfony\Component\EventDispatcher\Event::setName | ( | $name | ) |
Sets the event's name property.
- Parameters
-
string $name The event name
- Deprecated:
- since version 2.4, to be removed in 3.0. The event name is passed to the listener call.
Definition at line 125 of file lib/vendor/symfony/event-dispatcher/Event.php.
◆ stopPropagation() [1/2]
| Symfony\Component\EventDispatcher\Event::stopPropagation | ( | ) |
Stops the propagation of the event to further event listeners.
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().
Definition at line 73 of file lib/vendor/symfony/event-dispatcher/Event.php.
Referenced by Guzzle\Plugin\Cache\CachePlugin\onRequestError(), Guzzle\Plugin\Cache\CachePlugin\onRequestException(), Symfony\Component\EventDispatcher\Tests\TestEventListener\postFoo(), Guzzle\Service\Command\CreateResponseClassEvent\setResult(), and Symfony\Component\EventDispatcher\Tests\Debug\TraceableEventDispatcherTest\testLoggerWithStoppedEvent().
◆ stopPropagation() [2/2]
| Symfony\Component\EventDispatcher\Event::stopPropagation | ( | ) |
Stops the propagation of the event to further event listeners.
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().
Definition at line 73 of file vendor/symfony/event-dispatcher/Event.php.
The documentation for this class was generated from the following file:
