4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\EventDispatcher;
15 * Event is the base class for classes containing event data.
17 * This class contains no event data. It is used by events that do not pass
18 * state information to an event handler when an event is raised.
20 * You can call the method stopPropagation() to abort the execution of
21 * further listeners in your event listener.
23 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
24 * @author Jonathan Wage <jonwage@gmail.com>
25 * @author Roman Borschel <roman@code-factory.org>
26 * @author Bernhard Schussek <bschussek@gmail.com>
31 * @var bool Whether no further event listeners should be triggered
33 private $propagationStopped = false;
36 * Returns whether further event listeners should be triggered.
38 * @see Event::stopPropagation()
40 * @return bool Whether propagation was already stopped for this event
42 public function isPropagationStopped()
44 return $this->propagationStopped;
48 * Stops the propagation of the event to further event listeners.
50 * If multiple event listeners are connected to the same event, no
51 * further event listener will be triggered once any trigger calls
54 public function stopPropagation()
56 $this->propagationStopped = true;