Interface EnvironmentInterface

Interface EnvironmentInterface.

This interface describes the environment of a DcGeneral instance. It holds reference to the data providers, the view, the data definition etc. One could say the Environment is the glue of DcGeneral, holding everything together.

Direct known implementers

DcGeneral\DefaultEnvironment

Namespace: DcGeneral
Package: DcGeneral
Located at EnvironmentInterface.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`
`public DcGeneral\Controller\ControllerInterface`	# `getController( )` Retrieve the Controller from the current setup. Retrieve the Controller from the current setup. Returns `DcGeneral\Controller\ControllerInterface`
`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`
`public DcGeneral\View\ViewInterface`	# `getView( )` Retrieve the View from the current setup. Retrieve the View from the current setup. Returns `DcGeneral\View\ViewInterface`
`public DcGeneral\EnvironmentInterface`	# `setDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objContainer )` Set the data definition for this instance. Set the data definition for this instance. Parameters `$objContainer` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `getDataDefinition( )` Retrieve the data definition for this instance. Retrieve the data definition for this instance. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\EnvironmentInterface`	# `setParentDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objContainer )` Set the data definition of the parent container. Set the data definition of the parent container. Parameters `$objContainer` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface`
`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`
`public DcGeneral\EnvironmentInterface`	# `setRootDataDefinition( DcGeneral\DataDefinition\ContainerInterface $objContainer )` Set the data definition of the root container. Set the data definition of the root container. Parameters `$objContainer` `DcGeneral\DataDefinition\ContainerInterface` $objContainer The data definition container to store. Returns `DcGeneral\EnvironmentInterface`
`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`
`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`
`public DcGeneral\InputProviderInterface`	# `getInputProvider( )` Retrieve the input provider. Retrieve the input provider. Returns `DcGeneral\InputProviderInterface`
`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`
`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. 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() Parameters `$strSource` `string\|null` $strSource The name of the source. Returns `DcGeneral\Data\DataProviderInterface`
`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`
`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`
`public DcGeneral\Clipboard\ClipboardInterface`	# `getClipboard( )` Return the clipboard. Return the clipboard. Returns `DcGeneral\Clipboard\ClipboardInterface`
`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`
`public DcGeneral\EnvironmentInterface`	# `setTranslator( ContaoCommunityAlliance\Translator\TranslatorInterface $manager )` Set the translation manager to use. Set the translation manager to use. Parameters `$manager` `ContaoCommunityAlliance\Translator\TranslatorInterface` $manager The translation manager. Returns `DcGeneral\EnvironmentInterface`
`public ContaoCommunityAlliance\Translator\TranslatorInterface`	# `getTranslator( )` Retrieve the translation manager to use. Retrieve the translation manager to use. Returns `ContaoCommunityAlliance\Translator\TranslatorInterface`
`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`
`public DcGeneral\Event\EventPropagatorInterface`	# `getEventPropagator( )` Retrieve the event propagator to use. Retrieve the event propagator to use. Returns `DcGeneral\Event\EventPropagatorInterface`

Namespaces

Classes

Interfaces

Interface EnvironmentInterface

Direct known implementers

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns