Interface ControllerInterface

This interface describes a controller.

Direct known implementers

DcGeneral\Controller\DefaultController

Namespace: DcGeneral\Controller
Package: DcGeneral\Controller
Located at Controller/ControllerInterface.php

Methods summary
`public DcGeneral\Controller\ControllerInterface`	# `setEnvironment( DcGeneral\EnvironmentInterface $environment )` Set the environment. Set the environment. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment. Returns `DcGeneral\Controller\ControllerInterface`
`public DcGeneral\EnvironmentInterface`	# `getEnvironment( )` Retrieve the attached environment. Retrieve the attached environment. Returns `DcGeneral\EnvironmentInterface`
`public DcGeneral\Data\ConfigInterface`	# `getBaseConfig( )` Retrieve the base config for retrieving data. Retrieve the base config for retrieving data. This includes all auxiliary filters from DCA etc. but excludes the filters from panels. Returns `DcGeneral\Data\ConfigInterface`
`public array`	# `assembleAllChildrenFrom( DcGeneral\Data\ModelInterface $objModel, string $strDataProvider = '' )` Scan for children of a given model. Scan for children of a given model. This method is ready for mixed hierarchy and will return all children and grandchildren for the given table (or originating table of the model, if no provider name has been given) for all levels and parent child conditions. Parameters `$objModel` `DcGeneral\Data\ModelInterface` $objModel The model to assemble children from. `$strDataProvider` `string` $strDataProvider The name of the data provider to fetch children from. Returns `array`
`public DcGeneral\Controller\ControllerInterface`	# `updateModelFromPropertyBag( DcGeneral\Data\ModelInterface $model, DcGeneral\Data\PropertyValueBagInterface $propertyValues )` Update the current model from a post request. Additionally, trigger meta palettes, if installed. Update the current model from a post request. Additionally, trigger meta palettes, if installed. Parameters `$model` `DcGeneral\Data\ModelInterface` $model The model to update. `$propertyValues` `DcGeneral\Data\PropertyValueBagInterface` $propertyValues The value bag to retrieve the values from. Returns `DcGeneral\Controller\ControllerInterface`
`public array`	# `getSupportedLanguages( mixed $mixID )` Return all supported languages from the default data data provider. Return all supported languages from the default data data provider. Parameters `$mixID` `mixed` $mixID The id of a model for which the languages shall be retrieved. Returns `array`
`public boolean`	# `isRootModel( DcGeneral\Data\ModelInterface $model )` Check if the given model is a root model for the current data definition. Check if the given model is a root model for the current data definition. Parameters `$model` `DcGeneral\Data\ModelInterface` $model The model to check. Returns `boolean`
`public DcGeneral\Controller\ControllerInterface`	# `setRootModel( DcGeneral\Data\ModelInterface $model )` Apply the root condition of the current data definition to the given model. Apply the root condition of the current data definition to the given model. Parameters `$model` `DcGeneral\Data\ModelInterface` $model The model to be used as root. Returns `DcGeneral\Controller\ControllerInterface`
`public DcGeneral\Controller\ControllerInterface`	# `setParent( DcGeneral\Data\ModelInterface $childModel, DcGeneral\Data\ModelInterface $parentModel )` Set a model as the parent of another model. Set a model as the parent of another model. Parameters `$childModel` `DcGeneral\Data\ModelInterface` $childModel The model to become the child. `$parentModel` `DcGeneral\Data\ModelInterface` $parentModel The model to use as parent. Returns `DcGeneral\Controller\ControllerInterface`
`public DcGeneral\Controller\ControllerInterface`	# `setSameParent( DcGeneral\Data\ModelInterface $receivingModel, DcGeneral\Data\ModelInterface $sourceModel, string $parentTable )` Sets all parent condition fields in the destination to the values from the source model. Sets all parent condition fields in the destination to the values from the source model. Useful when moving an element after another in a different parent. Parameters `$receivingModel` `DcGeneral\Data\ModelInterface` $receivingModel The model that shall get updated. `$sourceModel` `DcGeneral\Data\ModelInterface` $sourceModel The model that the values shall get retrieved from. `$parentTable` `string` $parentTable The name of the parent table for the models. Returns `DcGeneral\Controller\ControllerInterface`