contao-community-alliance/dc-general
Back to top  

This interface is the base of a data definition.

Within this interface, all the information about a data definition is to be found. Most commonly used definitions have their getter and setter defined in this interface, for those definitions that are not so common, please use the generic getter and setter using names.

 Methods

Add multiple definitions to this container.

addDefinitions(array|\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface[] $definitions) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definitions

array\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface[]

The definitons.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Clear all definitions from this container.

clearDefinitions() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to retrieve the basic definition.

getBasicDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

Convenience method to retrieve the data provider definition.

getDataProviderDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface

Get a definitions of this container.

getDefinition(string $definitionName) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface

Parameters

$definitionName

string

The name of the definition.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface

Get a list of all definition names in this container.

getDefinitionNames() : array

Returns

array

Convenience method to retrieve the data provider definition.

getModelRelationshipDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface

Return the name of the container.

getName() : string

Returns

string

Convenience method to retrieve the palettes definition to use.

getPalettesDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface

Convenience method to retrieve the properties definition to use.

getPropertiesDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface

Convenience method to check if a basic definition is contained.

hasBasicDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

Convenience method to check if a data provider definition is contained.

hasDataProviderDefinition() : bool

Returns

bool

Check if this container has a definition.

hasDefinition(string $definitionName) : bool

Parameters

$definitionName

string

The name of the definition to check for.

Returns

bool

Convenience method to check if a data provider definition is contained.

hasModelRelationshipDefinition() : bool

Returns

bool

Convenience method to check if there has been a palettes definition defined.

hasPalettesDefinition() : bool

Returns

bool

Convenience method to check if there has been a properties definition defined.

hasPropertiesDefinition() : bool

Returns

bool

Remove a definitions from this container.

removeDefinition(string $definitionName) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definitionName

string

The name of the definition.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to set the basic definition.

setBasicDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface $basicDefinition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$basicDefinition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\BasicDefinitionInterface

The basic definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to set the data provider definition.

setDataProviderDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface $definition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface

The data provider definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Set a definitions of this container.

setDefinition(string $definitionName, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface $definition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definitionName

string

The name of the definition.

$definition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface

The definition.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Set the definitions of this container.

setDefinitions(array|\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface[] $definitions) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definitions

array\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\DefinitionInterface[]

The definitons.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to set the data provider definition.

setModelRelationshipDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface $definition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$definition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface

The model relationship definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to set the palettes definition to use.

setPalettesDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface $palettesDefinition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$palettesDefinition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface

The palettes definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Convenience method to set the properties definition to use.

setPropertiesDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface $propertiesDefinition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface

Parameters

$propertiesDefinition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface

The properties definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ContainerInterface