contao-community-alliance/dc-general
Back to top  

Class AbstractEventDrivenDataDefinitionBuilder.

Abstract base class for an data definition builder. To use it, implement the method build() and register the class to the event dispatcher.

 Methods

Creates an instance of itself and processes the event.

process(\ContaoCommunityAlliance\DcGeneral\Factory\Event\BuildDataDefinitionEvent $event, string $eventName, \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher) : void
Static
The attached data definition {@link ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface} will be populated with the information from the builder's data source.

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Factory\Event\BuildDataDefinitionEvent

The event to process.

$eventName

string

The name of the event to process.

$dispatcher

\Symfony\Component\EventDispatcher\EventDispatcherInterface

The event dispatcher calling us.

Retrieve the name of the dispatched event.

getDispatchedEventName() : string

Returns

string

Retrieve the dispatcher.

getDispatcher() : \Symfony\Component\EventDispatcher\EventDispatcherInterface

Returns

\Symfony\Component\EventDispatcher\EventDispatcherInterface

 Properties

 

The event dispatcher currently calling.

$dispatcher : \Symfony\Component\EventDispatcher\EventDispatcherInterface
 

The name of the called event.

$eventName : string

 Constants

 

Priority of the listener.

PRIORITY 
Just here for sanity, must be overwritten by implementation.