PHP Interface Swiftriver\Core\EventDistribution\IEventHandler

Author: mg[at]swiftly[dot]org
显示文件 Open project: ushahidi/Swiftriver-2011

Public Methods

Method Description
Description ( ) : string This method should return a description describing what exactly it is that your Event Handler does
HandleEvent ( GenericEvent $event, CoreConfigurationHandler $configuration, Log $logger ) : GenericEvent Given a GenericEvent object, this method should do something amazing with the data contained in the event arguments.
Name ( ) : string This method should return the name of the event handler that you implement. This name should be unique across all event handlers and should be no more that 50 chars long
ReturnEventNamesToHandle ( ) : string[] This method should return the names of the events that your EventHandler wishes to subscribe to. All the strings returned should be accessed throught the \Swiftriver\Core\EventDistribution\EventEnumeration static enumerator by calling EventEnumeration::[event]
ReturnRequiredParameters ( ) : ConfigurationElement[] This method returns an array of the required paramters that are nessesary to configure this event handler.

Method Details

Description() public method

This method should return a description describing what exactly it is that your Event Handler does
public Description ( ) : string
return string

HandleEvent() public method

Given a GenericEvent object, this method should do something amazing with the data contained in the event arguments.
public HandleEvent ( GenericEvent $event, CoreConfigurationHandler $configuration, Log $logger ) : GenericEvent
$event GenericEvent
$configuration Swiftriver\Core\Configuration\ConfigurationHandlers\CoreConfigurationHandler
$logger Log
return GenericEvent $event

Name() public method

This method should return the name of the event handler that you implement. This name should be unique across all event handlers and should be no more that 50 chars long
public Name ( ) : string
return string

ReturnEventNamesToHandle() public method

This method should return the names of the events that your EventHandler wishes to subscribe to. All the strings returned should be accessed throught the \Swiftriver\Core\EventDistribution\EventEnumeration static enumerator by calling EventEnumeration::[event]
public ReturnEventNamesToHandle ( ) : string[]
return string[]

ReturnRequiredParameters() public method

This method returns an array of the required paramters that are nessesary to configure this event handler.
public ReturnRequiredParameters ( ) : ConfigurationElement[]
return Swiftriver\Core\ObjectModel\ConfigurationElement[]