class Event

Same name in this branch
  1. 9.x drupal/core/vendor/guzzle/common/Guzzle/Common/Event.php \Guzzle\Common\Event
  2. 9.x drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Event.php \Symfony\Component\EventDispatcher\Event

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.

@author Guilherme Blanco <guilhermeblanco@hotmail.com> @author Jonathan Wage <jonwage@gmail.com> @author Roman Borschel <roman@code-factory.org> @author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

  • class \Symfony\Component\EventDispatcher\Event

Expanded class hierarchy of Event

10 files declare their use of Event
ConfigEvent.php in drupal/core/lib/Drupal/Core/Config/ConfigEvent.php
ContainerAwareEventDispatcherTest.php in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/ContainerAwareEventDispatcherTest.php
ContainerAwareTraceableEventDispatcher.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Debug/ContainerAwareTraceableEventDispatcher.php
Event.php in drupal/core/vendor/guzzle/common/Guzzle/Common/Event.php
EventDispatcherTest.php in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/EventDispatcherTest.php

... See full list

8 string references to 'Event'
GenericEventTest::setUp in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/GenericEventTest.php
Prepares the environment before running a test.
GenericEventTest::testGetArgument in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/GenericEventTest.php
GenericEventTest::testGetArguments in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/GenericEventTest.php
Tests Event->getArgs()
GenericEventTest::testHasIterator in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/GenericEventTest.php
GenericEventTest::testOffsetGet in drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Tests/GenericEventTest.php

... See full list

File

drupal/core/vendor/symfony/event-dispatcher/Symfony/Component/EventDispatcher/Event.php, line 30

Namespace

Symfony\Component\EventDispatcher
View source
class Event {

  /**
   * @var Boolean Whether no further event listeners should be triggered
   */
  private $propagationStopped = false;

  /**
   * @var EventDispatcher Dispatcher that dispatched this event
   */
  private $dispatcher;

  /**
   * @var string This event's name
   */
  private $name;

  /**
   * Returns whether further event listeners should be triggered.
   *
   * @see Event::stopPropagation
   * @return Boolean Whether propagation was already stopped for this event.
   *
   * @api
   */
  public function isPropagationStopped() {
    return $this->propagationStopped;
  }

  /**
   * 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().
   *
   * @api
   */
  public function stopPropagation() {
    $this->propagationStopped = true;
  }

  /**
   * Stores the EventDispatcher that dispatches this Event
   *
   * @param EventDispatcher $dispatcher
   *
   * @api
   */
  public function setDispatcher(EventDispatcher $dispatcher) {
    $this->dispatcher = $dispatcher;
  }

  /**
   * Returns the EventDispatcher that dispatches this Event
   *
   * @return EventDispatcher
   *
   * @api
   */
  public function getDispatcher() {
    return $this->dispatcher;
  }

  /**
   * Gets the event's name.
   *
   * @return string
   *
   * @api
   */
  public function getName() {
    return $this->name;
  }

  /**
   * Sets the event's name property.
   *
   * @param string $name The event name.
   *
   * @api
   */
  public function setName($name) {
    $this->name = $name;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Event::$dispatcher private property
Event::$name private property
Event::$propagationStopped private property
Event::getDispatcher public function Returns the EventDispatcher that dispatches this Event
Event::getName public function Gets the event's name.
Event::isPropagationStopped public function Returns whether further event listeners should be triggered.
Event::setDispatcher public function Stores the EventDispatcher that dispatches this Event
Event::setName public function Sets the event's name property.
Event::stopPropagation public function Stops the propagation of the event to further event listeners.