Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. StoppableEventInterface.php

interface StoppableEventInterface

An Event whose processing may be interrupted when the event has been handled.

A Dispatcher implementation MUST check to determine if an Event is marked as stopped after each listener is called. If it is then it should return immediately without calling any further Listeners.

Hierarchy

  • interface \Psr\EventDispatcher\StoppableEventInterface

Expanded class hierarchy of StoppableEventInterface

All classes that implement StoppableEventInterface

4 files declare their use of StoppableEventInterface
Event.php in vendor/symfony/event-dispatcher-contracts/Event.php
EventDispatcher.php in vendor/symfony/event-dispatcher/EventDispatcher.php
TraceableEventDispatcher.php in vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php
WrappedListener.php in vendor/symfony/event-dispatcher/Debug/WrappedListener.php

File

vendor/psr/event-dispatcher/src/StoppableEventInterface.php, line 13

Namespace

Psr\EventDispatcher
View source
interface StoppableEventInterface {
    
    /**
     * Is propagation stopped?
     *
     * This will typically only be used by the Dispatcher to determine if the
     * previous listener halted propagation.
     *
     * @return bool
     *   True if the Event is complete and no further listeners should be called.
     *   False to continue calling listeners.
     */
    public function isPropagationStopped() : bool;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
StoppableEventInterface::isPropagationStopped public function Is propagation stopped? 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal