PHP Class Swift_Plugins_DecoratorPlugin, Halite

Author: Chris Corbyn

Inheritance: implements Swift_Events_SendListener, implements Swift_Plugins_Decorator_Replacements

Show file Open project: HaliteChallenge/Halite

Public Methods

Method	Description
__construct ( mixed $replacements )	Create a new DecoratorPlugin with $replacements.
beforeSendPerformed ( Swift_Events_SendEvent $evt )	Invoked immediately before the Message is sent.
getReplacementsFor ( string $address ) : array	Find a map of replacements for the address.
sendPerformed ( Swift_Events_SendEvent $evt )	Invoked immediately after the Message is sent.
setReplacements ( mixed $replacements )	Sets replacements.

Private Methods

Method	Description
_restoreMessage ( Swift_Mime_Message $message )	Restore a changed message back to its original state

Method Details

__construct() public method

The $replacements can either be an associative array, or an implementation of {@link Swift_Plugins_Decorator_Replacements}. When using an array, it should be of the form:


$replacements = array(
 "[email protected]" => array("{a}" => "b", "{c}" => "d"),
 "[email protected]" => array("{a}" => "x", "{c}" => "y")
)

When using an instance of {@link Swift_Plugins_Decorator_Replacements}, the object should return just the array of replacements for the address given to {@link Swift_Plugins_Decorator_Replacements::getReplacementsFor()}.

public __construct ( mixed $replacements )
$replacements	mixed	Array or Swift_Plugins_Decorator_Replacements

beforeSendPerformed() public method

Invoked immediately before the Message is sent.

public beforeSendPerformed ( Swift_Events_SendEvent $evt )
$evt	Swift_Events_SendEvent

getReplacementsFor() public method

If this plugin was provided with a delegate instance of {@link Swift_Plugins_Decorator_Replacements} then the call will be delegated to it. Otherwise, it will attempt to find the replacements from the array provided in the constructor. If no replacements can be found, an empty value (NULL) is returned.

public getReplacementsFor ( string $address ) : array
$address	string
return	array

sendPerformed() public method

Invoked immediately after the Message is sent.

public sendPerformed ( Swift_Events_SendEvent $evt )
$evt	Swift_Events_SendEvent

setReplacements() public method

Sets replacements.

public setReplacements ( mixed $replacements )
$replacements	mixed	Array or Swift_Plugins_Decorator_Replacements