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

This interface describes a DcGeneral factory.

The factory is responsible for creating a DcGeneral instance including the data definition container and environment.

 Methods

Create a new instance of Container.

createContainer() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Create a new instance of DcGeneral.

createDcGeneral() : \ContaoCommunityAlliance\DcGeneral\DcGeneral
If no environment is given, a new one is created.

Returns

\ContaoCommunityAlliance\DcGeneral\DcGeneral

Create a new instance of Environment.

createEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface
If no container is given, a new one is created.

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Retrieve the class name to use as data definition container.

getContainerClassName() : string

Returns

string

Retrieve the name for the data definition container.

getContainerName() : string

Returns

string

Retrieve the data definition container.

getDataContainer() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Retrieve the class name to use as DcGeneral.

getDcGeneralClassName() : string

Returns

string

Retrieve the environment to use.

getEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Retrieve the class name to use as environment.

getEnvironmentClassName() : string

Returns

string

Get the event dispatcher to use.

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

Returns

\Symfony\Component\EventDispatcher\EventDispatcherInterface

Get the translator to use.

getTranslator() : \ContaoCommunityAlliance\Translator\TranslatorInterface

Returns

\ContaoCommunityAlliance\Translator\TranslatorInterface

Set the class name to use as data definition container.

setContainerClassName(string $containerClassName) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$containerClassName

string

The class name.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the name for the data definition container.

setContainerName(string $containerName) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$containerName

string

The class name.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the data definition container to use.

setDataContainer(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface $dataContainer) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$dataContainer

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

The data definition container instance.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the class name to use as DcGeneral.

setDcGeneralClassName(string $dcGeneralClassName) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$dcGeneralClassName

string

The class name.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the environment to use.

setEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment instance.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the class name to use as environment.

setEnvironmentClassName(string $environmentClassName) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$environmentClassName

string

The class name.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the event dispatcher to use.

setEventDispatcher(\Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$dispatcher

\Symfony\Component\EventDispatcher\EventDispatcherInterface

The event dispatcher.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Set the translator to use.

setTranslator(\ContaoCommunityAlliance\Translator\TranslatorInterface $translator) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface

Parameters

$translator

\ContaoCommunityAlliance\Translator\TranslatorInterface

The translator instance.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactoryInterface