Swift_Events_EventDispatcher Interface Reference

Inheritance diagram for Swift_Events_EventDispatcher:

Public Member Functions
	createSendEvent (Swift_Transport $source, Swift_Mime_Message $message)
	createCommandEvent (Swift_Transport $source, $command, $successCodes=array())
	createResponseEvent (Swift_Transport $source, $response, $valid)
	createTransportChangeEvent (Swift_Transport $source)
	createTransportExceptionEvent (Swift_Transport $source, Swift_TransportException $ex)
	bindEventListener (Swift_Events_EventListener $listener)
	dispatchEvent (Swift_Events_EventObject $evt, $target)

Detailed Description

Interface for the EventDispatcher which handles the event dispatching layer.

Author

Chris Corbyn

Definition at line 16 of file EventDispatcher.php.

Member Function Documentation

bindEventListener

(

Swift_Events_EventListener

$listener

)

Bind an event listener to this dispatcher.

Parameters

Swift_Events_EventListener

$listener

Implemented in Swift_Events_SimpleEventDispatcher.

createCommandEvent	(	Swift_Transport	$source,
			$command,
			$successCodes = array()
	)

Create a new CommandEvent for $source and $command.

Parameters

Swift_Transport	$source
string	$command	That will be executed
array	$successCodes	That are needed

Returns

Swift_Events_CommandEvent

Implemented in Swift_Events_SimpleEventDispatcher.

createResponseEvent	(	Swift_Transport	$source,
			$response,
			$valid
	)

Create a new ResponseEvent for $source and $response.

Parameters

Swift_Transport	$source
string	$response
bool	$valid	If the response is valid

Returns

Swift_Events_ResponseEvent

Implemented in Swift_Events_SimpleEventDispatcher.

createSendEvent	(	Swift_Transport	$source,
		Swift_Mime_Message	$message
	)

Create a new SendEvent for $source and $message.

Parameters

Swift_Transport	$source
	Swift_Mime_Message

Returns

Swift_Events_SendEvent

Implemented in Swift_Events_SimpleEventDispatcher.

createTransportChangeEvent

(

Swift_Transport

$source

)

Create a new TransportChangeEvent for $source.

Parameters

Swift_Transport

$source

Returns

Swift_Events_TransportChangeEvent

Implemented in Swift_Events_SimpleEventDispatcher.

createTransportExceptionEvent	(	Swift_Transport	$source,
		Swift_TransportException	$ex
	)

Create a new TransportExceptionEvent for $source.

Parameters

Swift_Transport	$source
Swift_TransportException	$ex

Returns

Swift_Events_TransportExceptionEvent

Implemented in Swift_Events_SimpleEventDispatcher.

dispatchEvent	(	Swift_Events_EventObject	$evt,
			$target
	)

Dispatch the given Event to all suitable listeners.

Parameters

Swift_Events_EventObject	$evt
string	$target	method

Implemented in Swift_Events_SimpleEventDispatcher.