Documentation

Subscription extends SubscriptionBase
in package

The EventDispatcherInterface is the central point of Symfony's event listener system.

Listeners are registered on the manager and events are dispatched through the manager.

Table of Contents

Constants

EVENT_NOTIFICATION  = 'notification'
EVENT_REMOVE_ERROR  = 'removeError'
EVENT_REMOVE_SUCCESS  = 'removeSuccess'
EVENT_RENEW_ERROR  = 'renewError'
EVENT_RENEW_SUCCESS  = 'renewSuccess'
EVENT_SUBSCRIBE_ERROR  = 'subscribeError'
EVENT_SUBSCRIBE_SUCCESS  = 'subscribeSuccess'
EVENT_TIMEOUT  = 'timeout'

Properties

$_eventFilters  : array<string|int, string>
$_platform  : Platform
$_subscription  : array<string|int, mixed>
$_webSocket  : WebSocket
$listeners  : mixed
$optimized  : mixed
$sorted  : mixed

Methods

__construct()  : mixed
addEvents()  : $this
addListener()  : mixed
Adds an event listener that listens on the specified events.
addSubscriber()  : mixed
Adds an event subscriber.
alive()  : bool
dispatch()  : object
Dispatches an event to all registered listeners.
getListenerPriority()  : int|null
Gets the listener priority for a specific event.
getListeners()  : array<string|int, mixed>
Gets the listeners of a specific event or all listeners sorted by descending priority.
hasListeners()  : bool
Checks whether an event has any registered listeners.
register()  : ApiResponse|$this
removeListener()  : mixed
Removes an event listener from the specified events.
removeSubscriber()  : mixed
renew()  : mixed
reset()  : mixed
setEvents()  : $this
setSubscription()  : $this
subscribe()  : Subscription
subscribed()  : bool
subscription()  : array<string|int, mixed>
callListeners()  : mixed
Triggers the listeners of an event.
doDispatch()  : mixed
getFullEventFilters()  : array<string|int, mixed>
onNotification()  : mixed
optimizeListeners()  : array<string|int, mixed>
Optimizes the internal list of listeners for the given event by priority.
sortListeners()  : mixed
Sorts the internal list of listeners for the given event by priority.

Constants

EVENT_REMOVE_SUCCESS

public mixed EVENT_REMOVE_SUCCESS = 'removeSuccess'

EVENT_SUBSCRIBE_ERROR

public mixed EVENT_SUBSCRIBE_ERROR = 'subscribeError'

EVENT_SUBSCRIBE_SUCCESS

public mixed EVENT_SUBSCRIBE_SUCCESS = 'subscribeSuccess'

Properties

$_subscription

protected array<string|int, mixed> $_subscription = [ 'eventFilters' => [], 'expirationTime' => '', // 2014-03-12T19:54:35.613Z 'expiresIn' => 0, 'deliveryMode' => ['transportType' => 'PubNub', 'encryption' => false, 'address' => '', 'subscriberKey' => '', 'secretKey' => ''], 'id' => '', 'creationTime' => '', // 2014-03-12T19:54:35.613Z 'status' => '', // Active 'uri' => '', ]

Methods

addEvents()

public addEvents(array<string|int, mixed> $events) : $this
Parameters
$events : array<string|int, mixed>
Return values
$this

addListener()

Adds an event listener that listens on the specified events.

public addListener(mixed $eventName, mixed $listener[, mixed $priority = 0 ]) : mixed
Parameters
$eventName : mixed

The event to listen on

$listener : mixed

The listener

$priority : mixed = 0

The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

dispatch()

Dispatches an event to all registered listeners.

public dispatch(mixed $event) : object
Parameters
$event : mixed

The event to pass to the event handlers/listeners

Return values
object —

The passed $event MUST be returned

getListenerPriority()

Gets the listener priority for a specific event.

public getListenerPriority(mixed $eventName, mixed $listener) : int|null
Parameters
$eventName : mixed

The name of the event

$listener : mixed

The listener

Return values
int|null —

The event listener priority

getListeners()

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

public getListeners([mixed $eventName = null ]) : array<string|int, mixed>
Parameters
$eventName : mixed = null

The name of the event

Return values
array<string|int, mixed> —

The event listeners for the specified event, or all event listeners by event name

hasListeners()

Checks whether an event has any registered listeners.

public hasListeners([mixed $eventName = null ]) : bool
Parameters
$eventName : mixed = null

The name of the event

Return values
bool —

true if the specified event has any listeners, false otherwise

register()

public register([array<string|int, mixed> $options = [] ]) : ApiResponse|$this
Parameters
$options : array<string|int, mixed> = []
Tags
throws
Exception
Return values
ApiResponse|$this

removeListener()

Removes an event listener from the specified events.

public removeListener(mixed $eventName, mixed $listener) : mixed
Parameters
$eventName : mixed

The event to remove a listener from

$listener : mixed

The listener to remove

renew()

public renew([array<string|int, mixed> $options = [] ]) : mixed
Parameters
$options : array<string|int, mixed> = []

setEvents()

public setEvents(array<string|int, mixed> $events) : $this
Parameters
$events : array<string|int, mixed>
Return values
$this

setSubscription()

public setSubscription(array<string|int, mixed> $subscription) : $this
Parameters
$subscription : array<string|int, mixed>
Return values
$this

subscribe()

public subscribe([array<string|int, mixed> $options = [] ]) : Subscription
Parameters
$options : array<string|int, mixed> = []
Tags
throws
Exception
Return values
Subscription

subscribed()

public subscribed() : bool
Return values
bool

subscription()

public subscription() : array<string|int, mixed>
Return values
array<string|int, mixed>

callListeners()

Triggers the listeners of an event.

protected callListeners(array<string|int, callable> $listeners, string $eventName, object $event) : mixed

This method can be overridden to add functionality that is executed for each listener.

Parameters
$listeners : array<string|int, callable>

The event listeners

$eventName : string

The name of the event to dispatch

$event : object

The event object to pass to the event handlers/listeners

doDispatch()

protected doDispatch(mixed $listeners, mixed $eventName, Event $event) : mixed

since Symfony 4.3, use callListeners() instead

Parameters
$listeners : mixed
$eventName : mixed
$event : Event

getFullEventFilters()

protected getFullEventFilters() : array<string|int, mixed>
Return values
array<string|int, mixed>

onNotification()

protected onNotification(mixed $event) : mixed
Parameters
$event : mixed

optimizeListeners()

Optimizes the internal list of listeners for the given event by priority.

private optimizeListeners(string $eventName) : array<string|int, mixed>
Parameters
$eventName : string
Return values
array<string|int, mixed>

sortListeners()

Sorts the internal list of listeners for the given event by priority.

private sortListeners(string $eventName) : mixed
Parameters
$eventName : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results