Swift_Events_EventDispatcher
in
Interface for the EventDispatcher which handles the event dispatching layer.
Tags
Table of Contents
- bindEventListener() : mixed
- Bind an event listener to this dispatcher.
- createCommandEvent() : Swift_Events_CommandEvent
- Create a new CommandEvent for $source and $command.
- createResponseEvent() : Swift_Events_ResponseEvent
- Create a new ResponseEvent for $source and $response.
- createSendEvent() : Swift_Events_SendEvent
- Create a new SendEvent for $source and $message.
- createTransportChangeEvent() : Swift_Events_TransportChangeEvent
- Create a new TransportChangeEvent for $source.
- createTransportExceptionEvent() : Swift_Events_TransportExceptionEvent
- Create a new TransportExceptionEvent for $source.
- dispatchEvent() : mixed
- Dispatch the given Event to all suitable listeners.
Methods
bindEventListener()
Bind an event listener to this dispatcher.
public
bindEventListener(Swift_Events_EventListener $listener) : mixed
Parameters
- $listener : Swift_Events_EventListener
Return values
mixed —createCommandEvent()
Create a new CommandEvent for $source and $command.
public
createCommandEvent(Swift_Transport $source, string $command[, array<string|int, mixed> $successCodes = [] ]) : Swift_Events_CommandEvent
Parameters
- $source : Swift_Transport
- $command : string
-
That will be executed
- $successCodes : array<string|int, mixed> = []
-
That are needed
Return values
Swift_Events_CommandEvent —createResponseEvent()
Create a new ResponseEvent for $source and $response.
public
createResponseEvent(Swift_Transport $source, string $response, bool $valid) : Swift_Events_ResponseEvent
Parameters
- $source : Swift_Transport
- $response : string
- $valid : bool
-
If the response is valid
Return values
Swift_Events_ResponseEvent —createSendEvent()
Create a new SendEvent for $source and $message.
public
createSendEvent(Swift_Transport $source, Swift_Mime_SimpleMessage $message) : Swift_Events_SendEvent
Parameters
- $source : Swift_Transport
- $message : Swift_Mime_SimpleMessage
Return values
Swift_Events_SendEvent —createTransportChangeEvent()
Create a new TransportChangeEvent for $source.
public
createTransportChangeEvent(Swift_Transport $source) : Swift_Events_TransportChangeEvent
Parameters
- $source : Swift_Transport
Return values
Swift_Events_TransportChangeEvent —createTransportExceptionEvent()
Create a new TransportExceptionEvent for $source.
public
createTransportExceptionEvent(Swift_Transport $source, Swift_TransportException $ex) : Swift_Events_TransportExceptionEvent
Parameters
- $source : Swift_Transport
- $ex : Swift_TransportException
Return values
Swift_Events_TransportExceptionEvent —dispatchEvent()
Dispatch the given Event to all suitable listeners.
public
dispatchEvent(Swift_Events_EventObject $evt, string $target) : mixed
Parameters
- $evt : Swift_Events_EventObject
- $target : string
-
method