Class DefaultBasicDefinition

Default implementation of the basic information about the data definition.

DcGeneral\DataDefinition\Definition\DefaultBasicDefinition implements DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

Namespace: DcGeneral\DataDefinition\Definition
Package: DcGeneral\DataDefinition\Definition
Located at DataDefinition/Definition/DefaultBasicDefinition.php

Methods summary
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setMode( integer $mode )` Set the mode the data definition is in. Set the mode the data definition is in. Parameters `$mode` `integer` $mode See the constants in this interface. The mode should either be `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::MODE_FLAT` or `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::MODE_HIERARCHICAL`. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setMode()`
`public integer`	# `getMode( )` Get the mode the data definition is in. Get the mode the data definition is in. Returns `integer` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::getMode()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setRootDataProvider( string $providerName )` Set the name of the data provider that holds the models for the root level. Set the name of the data provider that holds the models for the root level. Parameters `$providerName` `string` $providerName The name of the data provider of the root elements. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setRootDataProvider()`
`public string`	# `getRootDataProvider( )` Retrieve the name of data provider that holds the models for the root level. Retrieve the name of data provider that holds the models for the root level. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::getRootDataProvider()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setParentDataProvider( string $providerName )` Set the name of the data provider that holds the parent model. Set the name of the data provider that holds the parent model. Parameters `$providerName` `string` $providerName The name of the data provider of the parent element. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setParentDataProvider()`
`public string`	# `getParentDataProvider( )` Retrieve the name of data provider that holds the parent model. Retrieve the name of data provider that holds the parent model. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::getParentDataProvider()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setDataProvider( string $providerName )` Set the name of the data provider which holds the models that we work on. Set the name of the data provider which holds the models that we work on. Parameters `$providerName` `string` $providerName The name of the data provider of the elements being processed. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setDataProvider()`
`public string`	# `getDataProvider( )` Retrieve the name of data provider which holds the models that we work on. Retrieve the name of data provider which holds the models that we work on. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::getDataProvider()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setAdditionalFilter( string $dataProvider, array $filter )` Set the additional filters to be used for retrieving elements for the view. Set the additional filters to be used for retrieving elements for the view. Parameters `$dataProvider` `string` $dataProvider The name of the data provider for which additional filters shall be passed. `$filter` `array` $filter Array of filter rules. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setAdditionalFilter()`
`public boolean`	# `hasAdditionalFilter( string $dataProvider = null )` Determine if additional filters are set for the given data provider. Determine if additional filters are set for the given data provider. Parameters `$dataProvider` `string` $dataProvider The name of the data provider for which additional filters shall be checked. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::hasAdditionalFilter()`
`public array`	# `getAdditionalFilter( string $dataProvider = null )` Get the additional filters to be used for retrieving elements for the view. Get the additional filters to be used for retrieving elements for the view. Parameters `$dataProvider` `string` $dataProvider The name of the data provider for which additional filters shall be retrieved. Returns `array` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::getAdditionalFilter()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setClosed( boolean $value )` If true, adding of further records is prohibited. If true, adding of further records is prohibited. Parameters `$value` `boolean` $value The flag - true means prohibit element creation, false means allow creation of new elements. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setClosed()`
`public boolean`	# `isClosed( )` Boolean flag determining if this data container is closed. Boolean flag determining if this data container is closed. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::isClosed()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setEditable( boolean $value )` Boolean flag determining if this data container is editable. Boolean flag determining if this data container is editable. Parameters `$value` `boolean` $value True means, the data records may be edited. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setEditable()`
`public boolean`	# `isEditable( )` Boolean flag determining if this data container is editable. Boolean flag determining if this data container is editable. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::isEditable()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setDeletable( boolean $value )` Set boolean flag determining if this data container is deletable. Set boolean flag determining if this data container is deletable. Parameters `$value` `boolean` $value True means, the data records may be deleted. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setDeletable()`
`public boolean`	# `isDeletable( )` Boolean flag determining if this data container is deletable. Boolean flag determining if this data container is deletable. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::isDeletable()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setCreatable( boolean $value )` Determines if new entries may be created within this data container. Determines if new entries may be created within this data container. Parameters `$value` `boolean` $value True means new entries may be created, false prohibits creation of new entries. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setCreatable()`
`public boolean`	# `isCreatable( )` Determines if new entries may be created within this data container. Determines if new entries may be created within this data container. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::isCreatable()`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `setSwitchToEditEnabled( boolean $switchToEditEnabled )` Determines if the view shall switch automatically into edit mode. Determines if the view shall switch automatically into edit mode. Parameters `$switchToEditEnabled` `boolean` $switchToEditEnabled The flag - true means switch automatically to editing mode, false allows listing. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::setSwitchToEditEnabled()`
`public boolean`	# `isSwitchToEditEnabled( )` Determines if the view shall switch automatically into edit mode. Determines if the view shall switch automatically into edit mode. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface::isSwitchToEditEnabled()`

Constants inherited from DcGeneral\DataDefinition\Definition\BasicDefinitionInterface
`MODE_FLAT, MODE_HIERARCHICAL, MODE_PARENTEDLIST, NAME`

Properties summary
`protected integer`	`$mode`		# The mode. The mode.
`protected string`	`$rootProviderName`		# The name of the data provider of the root elements. The name of the data provider of the root elements.
`protected string`	`$parentProviderName`		# The name of the data provider of the parent element. The name of the data provider of the parent element.
`protected string`	`$providerName`		# The name of the data provider of the elements being processed. The name of the data provider of the elements being processed.
`protected array`	`$additionalFilter`		# Array of filter rules. Array of filter rules.
`protected boolean`	`$isClosed`	`false`	# If true, adding of further records is prohibited. If true, adding of further records is prohibited.
`protected boolean`	`$isEditable`	`true`	# Boolean flag determining if this data container is editable. Boolean flag determining if this data container is editable.
`protected boolean`	`$isDeletable`	`true`	# Boolean flag determining if this data container is deletable. Boolean flag determining if this data container is deletable.
`protected boolean`	`$isCreatable`	`true`	# Determines if new entries may be created within this data container. Determines if new entries may be created within this data container.
`protected boolean`	`$switchToEditEnabled`		# Determines if the view shall switch automatically into edit mode. Determines if the view shall switch automatically into edit mode.

Namespaces

Classes

Interfaces

Class DefaultBasicDefinition

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

Implementation of

Parameters

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