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

Factory to create a DcGeneral instance.

 Methods

{@inheritdoc}

createContainer() 
SuppressWarnings (PHPMD.Superglobals)
SuppressWarnings (PHPMD.CamelCaseVariableName)

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When no container name or no event propagator is given.

{@inheritdoc}

createDcGeneral() 

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When no container name, no container or no event propagator is given.

{@inheritdoc}

createEnvironment() 

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When no container name, no container, no event propagator or no translator is given.

Create a new factory with basic settings from the environment.

deriveEmptyFromEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactory
Static
This factory can be used to create a new Container, Environment, DcGeneral with the same base settings as the given environment.

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment to use as base.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactory

Create a new factory with basic settings and same container name as the given environment is build for.

deriveFromEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) : \ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactory
Static
This factory can be used to create a second Container, Environment, DcGeneral for the same container.

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment to use as base.

Returns

\ContaoCommunityAlliance\DcGeneral\Factory\DcGeneralFactory

{@inheritdoc}

getContainerClassName() 

{@inheritdoc}

getContainerName() 

{@inheritdoc}

getDataContainer() 

{@inheritdoc}

getDcGeneralClassName() 

{@inheritdoc}

getEnvironment() 

{@inheritdoc}

getEnvironmentClassName() 

{@inheritdoc}

getEventDispatcher() 

{@inheritdoc}

getTranslator() 

{@inheritdoc}

setContainerClassName($containerClassName) 

Parameters

$containerClassName

{@inheritdoc}

setContainerName($containerName) 

Parameters

$containerName

{@inheritdoc}

setDataContainer(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface $dataContainer) 

Parameters

$dataContainer

{@inheritdoc}

setDcGeneralClassName($dcGeneralClassName) 

Parameters

$dcGeneralClassName

{@inheritdoc}

setEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) 

Parameters

$environment

{@inheritdoc}

setEnvironmentClassName($environmentClassName) 

Parameters

$environmentClassName

{@inheritdoc}

setEventDispatcher($dispatcher) 

Parameters

$dispatcher

{@inheritdoc}

setTranslator(\ContaoCommunityAlliance\Translator\TranslatorInterface $translator) 

Parameters

$translator

 Properties

 

The class name of the class to use for the data definition container.

$containerClassName : string
 

The name of the data container.

$containerName : string
 

The data definition container instance.

$dataContainer : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface
 

The class name of the class to use as DcGeneral.

$dcGeneralClassName : string
 

The environment for the new instance.

$environment : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface
 

The class name to use for the environment.

$environmentClassName : string
 

The event dispatcher to use.

$eventDispatcher : \Symfony\Component\EventDispatcher\EventDispatcherInterface
 

The translator that shall be used.

$translator : \ContaoCommunityAlliance\Translator\TranslatorInterface