Open Journal Systems  3.3.0
Symfony\Component\EventDispatcher\ImmutableEventDispatcher Class Reference
Inheritance diagram for Symfony\Component\EventDispatcher\ImmutableEventDispatcher:
Symfony\Component\EventDispatcher\EventDispatcherInterface

Public Member Functions

 __construct (EventDispatcherInterface $dispatcher)
 
 __construct (EventDispatcherInterface $dispatcher)
 
 addListener ($eventName, $listener, $priority=0)
 
 addListener ($eventName, $listener, $priority=0)
 
 addSubscriber (EventSubscriberInterface $subscriber)
 
 addSubscriber (EventSubscriberInterface $subscriber)
 
 dispatch ($eventName, Event $event=null)
 
 dispatch ($eventName, Event $event=null)
 
 getListenerPriority ($eventName, $listener)
 
 getListenerPriority ($eventName, $listener)
 
 getListeners ($eventName=null)
 
 getListeners ($eventName=null)
 
 hasListeners ($eventName=null)
 
 hasListeners ($eventName=null)
 
 removeListener ($eventName, $listener)
 
 removeListener ($eventName, $listener)
 
 removeSubscriber (EventSubscriberInterface $subscriber)
 
 removeSubscriber (EventSubscriberInterface $subscriber)
 

Detailed Description

A read-only proxy for an event dispatcher.

Author
Bernhard Schussek bschu.nosp@m.ssek.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Definition at line 19 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::__construct ( EventDispatcherInterface  $dispatcher)

◆ __construct() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::__construct ( EventDispatcherInterface  $dispatcher)

Member Function Documentation

◆ addListener() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::addListener (   $eventName,
  $listener,
  $priority = 0 
)

{Adds an event listener that listens on the specified events.

Parameters
string$eventNameThe event to listen on
callable$listenerThe listener
int$priorityThe higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 39 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ addListener() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::addListener (   $eventName,
  $listener,
  $priority = 0 
)

{Adds an event listener that listens on the specified events.

Parameters
string$eventNameThe event to listen on
callable$listenerThe listener
int$priorityThe higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 39 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ addSubscriber() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::addSubscriber ( EventSubscriberInterface  $subscriber)

{Adds an event subscriber.The subscriber is asked for all the events he is interested in and added as a listener for these events.}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 47 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ addSubscriber() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::addSubscriber ( EventSubscriberInterface  $subscriber)

{Adds an event subscriber.The subscriber is asked for all the events he is interested in and added as a listener for these events.}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 47 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ dispatch() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::dispatch (   $eventName,
Event  $event = null 
)

{Dispatches an event to all registered listeners.

Parameters
string$eventNameThe name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
Event$eventThe event to pass to the event handlers/listeners If not supplied, an empty Event instance is created
Returns
Event
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 31 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ dispatch() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::dispatch (   $eventName,
Event  $event = null 
)

{Dispatches an event to all registered listeners.

Parameters
string$eventNameThe name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
Event$eventThe event to pass to the event handlers/listeners If not supplied, an empty Event instance is created
Returns
Event
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 31 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ getListenerPriority() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::getListenerPriority (   $eventName,
  $listener 
)

◆ getListenerPriority() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::getListenerPriority (   $eventName,
  $listener 
)

◆ getListeners() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::getListeners (   $eventName = null)

{Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters
string$eventNameThe name of the event
Returns
array The event listeners for the specified event, or all event listeners by event name
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 71 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ getListeners() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::getListeners (   $eventName = null)

{Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters
string$eventNameThe name of the event
Returns
array The event listeners for the specified event, or all event listeners by event name
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 71 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ hasListeners() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::hasListeners (   $eventName = null)

{Checks whether an event has any registered listeners.

Parameters
string$eventNameThe name of the event
Returns
bool true if the specified event has any listeners, false otherwise
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 87 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ hasListeners() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::hasListeners (   $eventName = null)

{Checks whether an event has any registered listeners.

Parameters
string$eventNameThe name of the event
Returns
bool true if the specified event has any listeners, false otherwise
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 87 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ removeListener() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::removeListener (   $eventName,
  $listener 
)

{Removes an event listener from the specified events.

Parameters
string$eventNameThe event to remove a listener from
callable$listenerThe listener to remove
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 55 of file lib/vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ removeListener() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::removeListener (   $eventName,
  $listener 
)

{Removes an event listener from the specified events.

Parameters
string$eventNameThe event to remove a listener from
callable$listenerThe listener to remove
}

Implements Symfony\Component\EventDispatcher\EventDispatcherInterface.

Definition at line 55 of file vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php.

◆ removeSubscriber() [1/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::removeSubscriber ( EventSubscriberInterface  $subscriber)

◆ removeSubscriber() [2/2]

Symfony\Component\EventDispatcher\ImmutableEventDispatcher::removeSubscriber ( EventSubscriberInterface  $subscriber)

The documentation for this class was generated from the following file: