[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/guzzlehttp/guzzle/src/Event/ -> EmitterInterface.php (summary)

(no description)

File Size: 96 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

EmitterInterface:: (8 methods):
  on()
  once()
  removeListener()
  listeners()
  hasListeners()
  emit()
  attach()
  detach()


Interface: EmitterInterface  - X-Ref

Guzzle event emitter.

on($eventName, callable $listener, $priority = 0)   X-Ref
Binds a listener to a specific event.

param: string     $eventName Name of the event to bind to.
param: callable   $listener  Listener to invoke when triggered.
param: int|string $priority  The higher this value, the earlier an event

once($eventName, callable $listener, $priority = 0)   X-Ref
Binds a listener to a specific event. After the listener is triggered
once, it is removed as a listener.

param: string   $eventName Name of the event to bind to.
param: callable $listener  Listener to invoke when triggered.
param: int      $priority  The higher this value, the earlier an event

removeListener($eventName, callable $listener)   X-Ref
Removes an event listener from the specified event.

param: string   $eventName The event to remove a listener from
param: callable $listener  The listener to remove

listeners($eventName = null)   X-Ref
Gets the listeners of a specific event or all listeners if no event is
specified.

param: string $eventName The name of the event. Pass null (the default)
return: array The event listeners for the specified event, or all event

hasListeners($eventName)   X-Ref
Checks if the emitter has listeners by the given name.

param: string $eventName The name of the event to check.
return: bool

emit($eventName, EventInterface $event)   X-Ref
Emits an event to all registered listeners.

Each event that is bound to the emitted eventName receives a
EventInterface, the name of the event, and the event emitter.

param: string         $eventName The name of the event to dispatch.
param: EventInterface $event     The event to pass to the event handlers/listeners.
return: EventInterface Returns the provided event object

attach(SubscriberInterface $subscriber)   X-Ref
Attaches an event subscriber.

The subscriber is asked for all the events it is interested in and added
as an event listener for each event.

param: SubscriberInterface $subscriber Subscriber to attach.

detach(SubscriberInterface $subscriber)   X-Ref
Detaches an event subscriber.

param: SubscriberInterface $subscriber Subscriber to detach.



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1