PHP Интерфейс Swiftriver\Core\EventDistribution\IEventHandler

Автор: mg[at]swiftly[dot]org

Открытые методы

Метод	Описание
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.

Описание методов

Description() публичный Метод

This method should return a description describing what exactly it is that your Event Handler does

public Description ( ) : string
Результат	string

HandleEvent() публичный Метод

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
Результат	GenericEvent	$event

Name() публичный Метод

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
Результат	string

ReturnEventNamesToHandle() публичный Метод

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[]
Результат	string[]

ReturnRequiredParameters() публичный Метод

This method returns an array of the required paramters that are nessesary to configure this event handler.

public ReturnRequiredParameters ( ) : ConfigurationElement[]
Результат	Swiftriver\Core\ObjectModel\ConfigurationElement[]