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

Default implementation of an environment.

SuppressWarnings (PHPMD.LongVariable)

 Methods

Register a data provider to the environment.

addDataDriver(string $strSource, \ContaoCommunityAlliance\DcGeneral\Data\DataProviderInterface $dataProvider) : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface
deprecated Use addDataProvider() instead!

Parameters

$strSource

string

The name of the source.

$dataProvider

\ContaoCommunityAlliance\DcGeneral\Data\DataProviderInterface

The data provider instance to register under the given name.

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

{@inheritdoc}

addDataProvider($strSource, $dataProvider) 

Parameters

$strSource

$dataProvider

{@inheritdoc}

getBaseConfigRegistry() 

{@inheritdoc}

getClipboard() 

{@inheritdoc}

getController() 

{@inheritdoc}

getDataDefinition() 

Retrieve the data provider for the named source.

getDataDriver(string|null $strSource) : \ContaoCommunityAlliance\DcGeneral\Data\DataProviderInterface
If a source name is given, the named data provider will get returned, if not given, the default data provider will get returned, the default is to be determined via: getEnvironment()->getDataDefinition()->getDataProvider()
deprecated Use getDataProvider() instead!

Parameters

$strSource

stringnull

The name of the source.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\DataProviderInterface

{@inheritdoc}

getDataProvider($strSource) 

Parameters

$strSource

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException when an undefined provider is requested.

{@inheritdoc}

getEventDispatcher() 

{@inheritdoc}

getInputProvider() 

Retrieve the panel container.

getPanelContainer() : \ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface
deprecated use the proper interface in the view!

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When an invalid view instance is stored in the environment.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

{@inheritdoc}

getParentDataDefinition() 

{@inheritdoc}

getRootDataDefinition() 

{@inheritdoc}

getSessionStorage() 

{@inheritdoc}

getTranslator() 

{@inheritdoc}

getView() 

{@inheritdoc}

hasDataProvider($strSource) 

Parameters

$strSource

Remove a data provider from the environment.

removeDataDriver(string $strSource) : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface
deprecated use removeDataProvider() instead!

Parameters

$strSource

string

The name of the source.

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

{@inheritdoc}

removeDataProvider($strSource) 

Parameters

$strSource

{@inheritdoc}

setBaseConfigRegistry($baseConfigRegistry) 

Parameters

$baseConfigRegistry

{@inheritdoc}

setClipboard($objClipboard) 

Parameters

$objClipboard

{@inheritdoc}

setController($objController) 

Parameters

$objController

{@inheritdoc}

setDataDefinition($objDataDefinition) 

Parameters

$objDataDefinition

{@inheritdoc}

setEventDispatcher($dispatcher) 

Parameters

$dispatcher

{@inheritdoc}

setInputProvider($objInputProvider) 

Parameters

$objInputProvider

Store the panel container in the view.

setPanelContainer(\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface $objPanelContainer) : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface
deprecated use the proper interface in the view!

Parameters

$objPanelContainer

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

The panel container.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When an invalid view instance is stored in the environment.

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

{@inheritdoc}

setParentDataDefinition($objParentDataDefinition) 

Parameters

$objParentDataDefinition

{@inheritdoc}

setRootDataDefinition($objRootDataDefinition) 

Parameters

$objRootDataDefinition

{@inheritdoc}

setSessionStorage(\ContaoCommunityAlliance\DcGeneral\SessionStorageInterface $sessionStorage) 

Parameters

$sessionStorage

{@inheritdoc}

setTranslator(\ContaoCommunityAlliance\Translator\TranslatorInterface $translator) 

Parameters

$translator

{@inheritdoc}

setView($objView) 

Parameters

$objView

 Properties

 

The registered data providers.

$arrDataProvider : \ContaoCommunityAlliance\DcGeneral\Data\DataProviderInterface[]
 

The attached base config registry.

$baseConfigRegistry : \ContaoCommunityAlliance\DcGeneral\BaseConfigRegistryInterface
 

The event propagator in use.

$eventDispatcher : \Symfony\Component\EventDispatcher\EventDispatcherInterface
 

The clipboard in use.

$objClipboard : \ContaoCommunityAlliance\DcGeneral\Clipboard\ClipboardInterface
 

The controller.

$objController : \ContaoCommunityAlliance\DcGeneral\Controller\ControllerInterface
 

The data container definition.

$objDataDefinition : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface
 

The attached input provider.

$objInputProvider : \ContaoCommunityAlliance\DcGeneral\InputProviderInterface
 

The data container definition of the parent table.

$objParentDataDefinition : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface
 

The data container definition of the root table.

$objRootDataDefinition : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface
 

The view in use.

$objView : \ContaoCommunityAlliance\DcGeneral\View\ViewInterface
 

The session storage.

$sessionStorage : \ContaoCommunityAlliance\DcGeneral\SessionStorageInterface
 

The translator in use.

$translator : \ContaoCommunityAlliance\Translator\TranslatorInterface