Class DcGeneralFactory

Factory to create a DcGeneral instance.

DcGeneral\Factory\DcGeneralFactory implements DcGeneral\Factory\DcGeneralFactoryInterface

Namespace: DcGeneral\Factory
Package: DcGeneral\Factory
Located at Factory/DcGeneralFactory.php

Methods summary
`public static DcGeneral\Factory\DcGeneralFactory`	# `deriveEmptyFromEnvironment( DcGeneral\EnvironmentInterface $environment )` Create a new factory with basic settings from the environment. Create a new factory with basic settings from the environment. This factory can be used to create a new Container, Environment, DcGeneral with the same base settings as the given environment. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment to use as base. Returns `DcGeneral\Factory\DcGeneralFactory`
`public static DcGeneral\Factory\DcGeneralFactory`	# `deriveFromEnvironment( DcGeneral\EnvironmentInterface $environment )` Create a new factory with basic settings and same container name as the given environment is build for. Create a new factory with basic settings and same container name as the given environment is build for. This factory can be used to create a second Container, Environment, DcGeneral for the same container. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment to use as base. Returns `DcGeneral\Factory\DcGeneralFactory`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setEnvironmentClassName( string $environmentClassName )` Set the class name to use as environment. Set the class name to use as environment. Parameters `$environmentClassName` `string` $environmentClassName The class name. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setEnvironmentClassName()`
`public string`	# `getEnvironmentClassName( )` Retrieve the class name to use as environment. Retrieve the class name to use as environment. Returns `string` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getEnvironmentClassName()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setContainerName( string $containerName )` Set the name for the data definition container. Set the name for the data definition container. Parameters `$containerName` `string` $containerName The class name. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setContainerName()`
`public string`	# `getContainerName( )` Retrieve the name for the data definition container. Retrieve the name for the data definition container. Returns `string` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getContainerName()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setContainerClassName( string $containerClassName )` Set the class name to use as data definition container. Set the class name to use as data definition container. Parameters `$containerClassName` `string` $containerClassName The class name. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setContainerClassName()`
`public string`	# `getContainerClassName( )` Retrieve the class name to use as data definition container. Retrieve the class name to use as data definition container. Returns `string` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getContainerClassName()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setDcGeneralClassName( string $dcGeneralClassName )` Set the class name to use as DcGeneral. Set the class name to use as DcGeneral. Parameters `$dcGeneralClassName` `string` $dcGeneralClassName The class name. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setDcGeneralClassName()`
`public string`	# `getDcGeneralClassName( )` Retrieve the class name to use as DcGeneral. Retrieve the class name to use as DcGeneral. Returns `string` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getDcGeneralClassName()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setEventPropagator( DcGeneral\Event\EventPropagatorInterface $eventPropagator )` Set the event propagator to use. Set the event propagator to use. Parameters `$eventPropagator` `DcGeneral\Event\EventPropagatorInterface` $eventPropagator The event propagator. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setEventPropagator()`
`public DcGeneral\Event\EventPropagatorInterface`	# `getEventPropagator( )` Retrieve the event propagator. Retrieve the event propagator. Returns `DcGeneral\Event\EventPropagatorInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getEventPropagator()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setTranslator( ContaoCommunityAlliance\Translator\TranslatorInterface $translator )` Set the translator to use. Set the translator to use. Parameters `$translator` `ContaoCommunityAlliance\Translator\TranslatorInterface` $translator The translator instance. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setTranslator()`
`public ContaoCommunityAlliance\Translator\TranslatorInterface`	# `getTranslator( )` Get the translator to use. Get the translator to use. Returns `ContaoCommunityAlliance\Translator\TranslatorInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getTranslator()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setEnvironment( DcGeneral\EnvironmentInterface $environment = null )` Set the environment to use. Set the environment to use. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment instance. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setEnvironment()`
`public DcGeneral\EnvironmentInterface`	# `getEnvironment( )` Retrieve the environment to use. Retrieve the environment to use. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getEnvironment()`
`public DcGeneral\Factory\DcGeneralFactoryInterface`	# `setDataContainer( DcGeneral\DataDefinition\ContainerInterface $dataContainer = null )` Set the data definition container to use. Set the data definition container to use. Parameters `$dataContainer` `DcGeneral\DataDefinition\ContainerInterface` $dataContainer The data definition container instance. Returns `DcGeneral\Factory\DcGeneralFactoryInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::setDataContainer()`
`public DcGeneral\DataDefinition\ContainerInterface`	# `getDataContainer( )` Retrieve the data definition container. Retrieve the data definition container. Returns `DcGeneral\DataDefinition\ContainerInterface` Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::getDataContainer()`
`public DcGeneral`	# `createDcGeneral( )` Create a new instance of DcGeneral. Create a new instance of DcGeneral. Returns `DcGeneral` Throws `DcGeneral\Exception\DcGeneralRuntimeException` When no container name, no container or no event propagator is given. Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::createDcGeneral()`
`public DcGeneral\EnvironmentInterface`	# `createEnvironment( )` Create a new instance of Environment. Create a new instance of Environment. Returns `DcGeneral\EnvironmentInterface` Throws `DcGeneral\Exception\DcGeneralRuntimeException` When no container name, no container, no event propagator or no translator is given. Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::createEnvironment()`
`public DcGeneral\DataDefinition\ContainerInterface`	# `createContainer( )` Create a new instance of Container. Create a new instance of Container. Returns `DcGeneral\DataDefinition\ContainerInterface` Throws `DcGeneral\Exception\DcGeneralRuntimeException` When no container name or no event propagator is given. Implementation of `DcGeneral\Factory\DcGeneralFactoryInterface::createContainer()`

Properties summary
`protected string`	`$environmentClassName`	`'DcGeneral\DefaultEnvironment'`	# The class name to use for the environment. The class name to use for the environment.
`protected string`	`$containerName`		# The name of the data container. The name of the data container.
`protected string`	`$containerClassName`	`'DcGeneral\DataDefinition\DefaultContainer'`	# The class name of the class to use for the data definition container. The class name of the class to use for the data definition container.
`protected string`	`$dcGeneralClassName`	`'DcGeneral\DcGeneral'`	# The class name of the class to use as DcGeneral. The class name of the class to use as DcGeneral.
`protected DcGeneral\Event\EventPropagatorInterface`	`$eventPropagator`	`null`	# The event propagator to use. The event propagator to use.
`protected ContaoCommunityAlliance\Translator\TranslatorInterface`	`$translator`	`null`	# The translator that shall be used. The translator that shall be used.
`protected DcGeneral\EnvironmentInterface`	`$environment`	`null`	# The environment for the new instance. The environment for the new instance.
`protected DcGeneral\DataDefinition\ContainerInterface`	`$dataContainer`	`null`	# The data definition container instance. The data definition container instance.

Namespaces

Classes

Interfaces

Class DcGeneralFactory

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of