Class DefaultEnvironment

Default implementation of an environment.

DcGeneral\DefaultEnvironment implements DcGeneral\EnvironmentInterface

Namespace: DcGeneral
Package: DcGeneral
Located at DefaultEnvironment.php

Methods summary
`public DcGeneral\EnvironmentInterface`	# `setController( DcGeneral\Controller\ControllerInterface $objController )` Set the Controller for the current setup. Set the Controller for the current setup. Parameters `$objController` `DcGeneral\Controller\ControllerInterface` $objController The controller to use. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setController()`
`public DcGeneral\Controller\ControllerInterface`	# `getController( )` Retrieve the Controller from the current setup. Retrieve the Controller from the current setup. Returns `DcGeneral\Controller\ControllerInterface` Implementation of `DcGeneral\EnvironmentInterface::getController()`
`public DcGeneral\EnvironmentInterface`	# `setView( DcGeneral\View\ViewInterface $objView )` Set the View for the current setup. Set the View for the current setup. Parameters `$objView` `DcGeneral\View\ViewInterface` $objView The view to use. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setView()`
`public DcGeneral\View\ViewInterface`	# `getView( )` Retrieve the View from the current setup. Retrieve the View from the current setup. Returns `DcGeneral\View\ViewInterface` Implementation of `DcGeneral\EnvironmentInterface::getView()`
`public DcGeneral\EnvironmentInterface`	# `setDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objDataDefinition )` Set the data definition for this instance. Set the data definition for this instance. Parameters `$objDataDefinition` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setDataDefinition()`
`public DcGeneral\DataDefinition\ContainerInterface`	# `getDataDefinition( )` Retrieve the data definition for this instance. Retrieve the data definition for this instance. Returns `DcGeneral\DataDefinition\ContainerInterface` Implementation of `DcGeneral\EnvironmentInterface::getDataDefinition()`
`public DcGeneral\EnvironmentInterface`	# `setParentDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objParentDataDefinition )` Set the data definition of the parent container. Set the data definition of the parent container. Parameters `$objParentDataDefinition` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setParentDataDefinition()`
`public DcGeneral\DataDefinition\ContainerInterface`	# `getParentDataDefinition( )` Retrieve the data definition for the parent container. This applies only when in parented mode. Retrieve the data definition for the parent container. This applies only when in parented mode. Returns `DcGeneral\DataDefinition\ContainerInterface` Implementation of `DcGeneral\EnvironmentInterface::getParentDataDefinition()`
`public DcGeneral\EnvironmentInterface`	# `setRootDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objRootDataDefinition )` Set the data definition of the root container. Set the data definition of the root container. Parameters `$objRootDataDefinition` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setRootDataDefinition()`
`public DcGeneral\DataDefinition\ContainerInterface`	# `getRootDataDefinition( )` Retrieve the data definition for the root container. This applies only when in hierarchical mode. Retrieve the data definition for the root container. This applies only when in hierarchical mode. Returns `DcGeneral\DataDefinition\ContainerInterface` Implementation of `DcGeneral\EnvironmentInterface::getRootDataDefinition()`
`public DcGeneral\EnvironmentInterface`	# `setInputProvider( DcGeneral\InputProviderInterface $objInputProvider )` Set the input provider to use. Set the input provider to use. Parameters `$objInputProvider` `DcGeneral\InputProviderInterface` $objInputProvider The input provider to use. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setInputProvider()`
`public DcGeneral\InputProviderInterface`	# `getInputProvider( )` Retrieve the input provider. Retrieve the input provider. Returns `DcGeneral\InputProviderInterface` Implementation of `DcGeneral\EnvironmentInterface::getInputProvider()`
`public mixed`	# `hasDataProvider( string\|null $strSource = null )` Determine if the data provider with the given name exists. Determine if the data provider with the given name exists. Parameters `$strSource` `string\|null` $strSource The source name to check the providers for. Returns `mixed` Implementation of `DcGeneral\EnvironmentInterface::hasDataProvider()`
`public DcGeneral\Data\DataProviderInterface`	# `getDataProvider( string\|null $strSource = null )` Retrieve the data provider for the named source. Retrieve the data provider for the named source. Parameters `$strSource` `string\|null` $strSource The name of the source. Returns `DcGeneral\Data\DataProviderInterface` Throws `DcGeneral\Exception\DcGeneralRuntimeException` when an undefined provider is requested. Implementation of `DcGeneral\EnvironmentInterface::getDataProvider()`
`public DcGeneral\EnvironmentInterface`	# `addDataProvider( string $strSource, DcGeneral\Data\DataProviderInterface $dataProvider )` Register a data provider to the environment. Register a data provider to the environment. Parameters `$strSource` `string` $strSource The name of the source. `$dataProvider` `DcGeneral\Data\DataProviderInterface` $dataProvider The data provider instance to register under the given name. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::addDataProvider()`
`public DcGeneral\EnvironmentInterface`	# `removeDataProvider( string $strSource )` Remove a data provider from the environment. Remove a data provider from the environment. Parameters `$strSource` `string` $strSource The name of the source. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::removeDataProvider()`
`public DcGeneral\Data\DataProviderInterface`	# `getDataDriver( string\|null $strSource = null )` Retrieve the data provider for the named source. Retrieve the data provider for the named source. 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` `string\|null` $strSource The name of the source. Returns `DcGeneral\Data\DataProviderInterface`
`public DcGeneral\EnvironmentInterface`	# `addDataDriver( string $strSource, DcGeneral\Data\DataProviderInterface $dataProvider )` Register a data provider to the environment. Register a data provider to the environment. Deprecated Use addDataProvider() instead! Parameters `$strSource` `string` $strSource The name of the source. `$dataProvider` `DcGeneral\Data\DataProviderInterface` $dataProvider The data provider instance to register under the given name. Returns `DcGeneral\EnvironmentInterface`
`public DcGeneral\EnvironmentInterface`	# `removeDataDriver( string $strSource )` Remove a data provider from the environment. Remove a data provider from the environment. Deprecated use removeDataProvider() instead! Parameters `$strSource` `string` $strSource The name of the source. Returns `DcGeneral\EnvironmentInterface`
`public DcGeneral\EnvironmentInterface`	# `setPanelContainer( DcGeneral\Panel\PanelContainerInterface $objPanelContainer )` Store the panel container in the view. Store the panel container in the view. Deprecated use the proper interface in the view! Parameters `$objPanelContainer` `DcGeneral\Panel\PanelContainerInterface` $objPanelContainer The panel container. Returns `DcGeneral\EnvironmentInterface` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` When an invalid view instance is stored in the environment.
`public DcGeneral\Panel\PanelContainerInterface`	# `getPanelContainer( )` Retrieve the panel container. Retrieve the panel container. Deprecated use the proper interface in the view! Returns `DcGeneral\Panel\PanelContainerInterface` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` When an invalid view instance is stored in the environment.
`public DcGeneral\Clipboard\ClipboardInterface`	# `getClipboard( )` Return the clipboard. Return the clipboard. Returns `DcGeneral\Clipboard\ClipboardInterface` Implementation of `DcGeneral\EnvironmentInterface::getClipboard()`
`public DcGeneral\EnvironmentInterface`	# `setClipboard( DcGeneral\Clipboard\ClipboardInterface $objClipboard )` Set the the clipboard. Set the the clipboard. Parameters `$objClipboard` `DcGeneral\Clipboard\ClipboardInterface` $objClipboard Clipboard instance. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setClipboard()`
`public DcGeneral\EnvironmentInterface`	# `setTranslator( ContaoCommunityAlliance\Translator\TranslatorInterface $translator )` Set the translation manager to use. Set the translation manager to use. Parameters `$translator` `ContaoCommunityAlliance\Translator\TranslatorInterface` $manager The translation manager. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setTranslator()`
`public ContaoCommunityAlliance\Translator\TranslatorInterface`	# `getTranslator( )` Retrieve the translation manager to use. Retrieve the translation manager to use. Returns `ContaoCommunityAlliance\Translator\TranslatorInterface` Implementation of `DcGeneral\EnvironmentInterface::getTranslator()`
`public DcGeneral\EnvironmentInterface`	# `setEventPropagator( DcGeneral\Event\EventPropagatorInterface $propagator )` Set the event propagator to use. Set the event propagator to use. Parameters `$propagator` `DcGeneral\Event\EventPropagatorInterface` $propagator The event propagator to use. Returns `DcGeneral\EnvironmentInterface` Implementation of `DcGeneral\EnvironmentInterface::setEventPropagator()`
`public DcGeneral\Event\EventPropagatorInterface`	# `getEventPropagator( )` Retrieve the event propagator to use. Retrieve the event propagator to use. Returns `DcGeneral\Event\EventPropagatorInterface` Implementation of `DcGeneral\EnvironmentInterface::getEventPropagator()`

Properties summary
`protected DcGeneral\Controller\ControllerInterface`	`$objController`	# The controller. The controller.
`protected DcGeneral\View\ViewInterface`	`$objView`	# The view in use. The view in use.
`protected DcGeneral\DataDefinition\ContainerInterface`	`$objDataDefinition`	# The data container definition. The data container definition.
`protected DcGeneral\DataDefinition\ContainerInterface`	`$objParentDataDefinition`	# The data container definition of the parent table. The data container definition of the parent table.
`protected DcGeneral\DataDefinition\ContainerInterface`	`$objRootDataDefinition`	# The data container definition of the root table. The data container definition of the root table.
`protected DcGeneral\InputProviderInterface`	`$objInputProvider`	# The attached input provider. The attached input provider.
`protected DcGeneral\Data\DataProviderInterface[]`	`$arrDataProvider`	# The registered data providers. The registered data providers.
`protected DcGeneral\Clipboard\ClipboardInterface`	`$objClipboard`	# The clipboard in use. The clipboard in use.
`protected ContaoCommunityAlliance\Translator\TranslatorInterface`	`$translator`	# The translator in use. The translator in use.
`protected DcGeneral\Event\EventPropagatorInterface`	`$eventPropagator`	# The event propagator in use. The event propagator in use.

Namespaces

Classes

Interfaces

Class DefaultEnvironment

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

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Throws

Deprecated

Returns

Throws

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of