Interface ContainerInterface

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.

Direct known implementers

DcGeneral\DataDefinition\DefaultContainer

Namespace: DcGeneral\DataDefinition
Package: DcGeneral\DataDefinition
Located at DataDefinition/ContainerInterface.php

Namespaces

Classes

Interfaces

Interface ContainerInterface

Direct known implementers

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

`public string`	# `getName( )` Return the name of the container. Return the name of the container. Returns `string`
`public boolean`	# `hasDefinition( string $definitionName )` Check if this container has a definition. Check if this container has a definition. Parameters `$definitionName` `string` $definitionName The name of the definition to check for. Returns `boolean`
`public DcGeneral\DataDefinition\ContainerInterface`	# `clearDefinitions( )` Clear all definitions from this container. Clear all definitions from this container. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setDefinitions( array $definitions )` Set the definitions of this container. Set the definitions of this container. Parameters `$definitions` `array\|DcGeneral\DataDefinition\Definition\DefinitionInterface[]` $definitions The definitons. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `addDefinitions( array $definitions )` Add multiple definitions to this container. Add multiple definitions to this container. Parameters `$definitions` `array\|DcGeneral\DataDefinition\Definition\DefinitionInterface[]` $definitions The definitons. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setDefinition( string $definitionName, DcGeneral\DataDefinition\Definition\DefinitionInterface $definition )` Set a definitions of this container. Set a definitions of this container. Parameters `$definitionName` `string` $definitionName The name of the definition. `$definition` `DcGeneral\DataDefinition\Definition\DefinitionInterface` $definition The definition. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `removeDefinition( string $definitionName )` Remove a definitions from this container. Remove a definitions from this container. Parameters `$definitionName` `string` $definitionName The name of the definition. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\DefinitionInterface`	# `getDefinition( string $definitionName )` Get a definitions of this container. Get a definitions of this container. Parameters `$definitionName` `string` $definitionName The name of the definition. Returns `DcGeneral\DataDefinition\Definition\DefinitionInterface`
`public array`	# `getDefinitionNames( )` Get a list of all definition names in this container. Get a list of all definition names in this container. Returns `array`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `hasBasicDefinition( )` Convenience method to check if a basic definition is contained. Convenience method to check if a basic definition is contained. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setBasicDefinition( DcGeneral\DataDefinition\Definition\BasicDefinitionInterface $basicDefinition )` Convenience method to set the basic definition. Convenience method to set the basic definition. Parameters `$basicDefinition` `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` $basicDefinition The basic definition to use. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`	# `getBasicDefinition( )` Convenience method to retrieve the basic definition. Convenience method to retrieve the basic definition. Returns `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface`
`public boolean`	# `hasPropertiesDefinition( )` Convenience method to check if there has been a properties definition defined. Convenience method to check if there has been a properties definition defined. Returns `boolean`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setPropertiesDefinition( DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface $propertiesDefinition )` Convenience method to set the properties definition to use. Convenience method to set the properties definition to use. Parameters `$propertiesDefinition` `DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface` $propertiesDefinition The properties definition to use. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface`	# `getPropertiesDefinition( )` Convenience method to retrieve the properties definition to use. Convenience method to retrieve the properties definition to use. Returns `DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface`
`public boolean`	# `hasPalettesDefinition( )` Convenience method to check if there has been a palettes definition defined. Convenience method to check if there has been a palettes definition defined. Returns `boolean`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setPalettesDefinition( DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface $palettesDefinition )` Convenience method to set the palettes definition to use. Convenience method to set the palettes definition to use. Parameters `$palettesDefinition` `DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface` $palettesDefinition The palettes definition to use. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface`	# `getPalettesDefinition( )` Convenience method to retrieve the palettes definition to use. Convenience method to retrieve the palettes definition to use. Returns `DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface`
`public boolean`	# `hasDataProviderDefinition( )` Convenience method to check if a data provider definition is contained. Convenience method to check if a data provider definition is contained. Returns `boolean`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setDataProviderDefinition( DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface $dataProviderDefinition )` Convenience method to set the data provider definition. Convenience method to set the data provider definition. Parameters `$dataProviderDefinition` `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface` $dataProviderDefinition The data provider definition to use. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface`	# `getDataProviderDefinition( )` Convenience method to retrieve the data provider definition. Convenience method to retrieve the data provider definition. Returns `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface`
`public boolean`	# `hasModelRelationshipDefinition( )` Convenience method to check if a data provider definition is contained. Convenience method to check if a data provider definition is contained. Returns `boolean`
`public DcGeneral\DataDefinition\ContainerInterface`	# `setModelRelationshipDefinition( DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface $definition )` Convenience method to set the data provider definition. Convenience method to set the data provider definition. Parameters `$definition` `DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface` $definition The model relationship definition to use. Returns `DcGeneral\DataDefinition\ContainerInterface`
`public DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface`	# `getModelRelationshipDefinition( )` Convenience method to retrieve the data provider definition. Convenience method to retrieve the data provider definition. Returns `DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface`