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
Returns
|
public
integer
|
#
getMode( )
Get the mode the data definition is in.
Get the mode the data definition is in.
Returns
integer
|
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.
Be aware that there may be any number of in-between data sources, depending
on the defined ParentChildConditions
Note: This does only apply when in tree mode or parenting mode. For flat mode
this does not make sense.
Parameters
- $providerName
string
$providerName The name of the data provider of the root elements. Returns
|
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.
Be aware that there may be any number of in-between data sources, depending
on the defined ParentChildConditions
Note: This does only apply when in tree mode or parenting mode. For flat mode
this does not make sense.
Returns
string
|
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.
Note: This does only apply when in tree mode or parenting mode. For flat mode
this does not make sense.
Parameters
- $providerName
string
$providerName The name of the data provider of the parent element. Returns
|
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.
Note: This does only apply when in tree mode or parenting mode. For flat mode
this does not make sense.
Returns
string
|
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
|
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
|
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
|
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
|
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
|
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
Todo
isn't this a candidate for deprecation? See
BasicDefinitionInterface::setCreatable().
|
public
boolean
|
#
isClosed( )
Boolean flag determining if this data container is closed.
Boolean flag determining if this data container is closed.
True means, there may not be any records added or deleted, false means there
may be any record appended or deleted..
Returns
boolean
Todo
isn't this a candidate for deprecation? See
BasicDefinitionInterface::isCreatable().
|
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
|
public
boolean
|
#
isEditable( )
Boolean flag determining if this data container is editable.
Boolean flag determining if this data container is editable.
True means, the data records may be edited.
Returns
boolean
|
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
|
public
boolean
|
#
isDeletable( )
Boolean flag determining if this data container is deletable.
Boolean flag determining if this data container is deletable.
True means, the data records may be deleted.
Returns
boolean
|
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
|
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.
True means new entries may be created, false prohibits creation of new
entries.
Returns
boolean
|
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.
This most likely only affects parenting modes like trees etc.
Parameters
- $switchToEditEnabled
boolean
$switchToEditEnabled The flag - true means switch automatically to editing mode,
false allows listing. Returns
|
public
boolean
|
#
isSwitchToEditEnabled( )
Determines if the view shall switch automatically into edit mode.
Determines if the view shall switch automatically into edit mode.
This most likely only affects parenting modes like trees etc.
Returns
boolean
|