Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • AbstractConditionChain
  • DataProviderInformation
  • DefaultContainer

Interfaces

  • ConditionChainInterface
  • ConditionInterface
  • ContainerInterface
  • DataProviderInformationInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class DefaultContainer

Default implementation of a data definition container.

DcGeneral\DataDefinition\DefaultContainer implements DcGeneral\DataDefinition\ContainerInterface
Namespace: DcGeneral\DataDefinition
Package: DcGeneral\DataDefinition
Located at DataDefinition/DefaultContainer.php
Methods summary
public
# __construct( string $name )

Create a new default container.

Create a new default container.

Parameters

$name
string
$name The name of the container.
public string
# getName( )

Return the name of the container.

Return the name of the container.

Returns

string

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getName()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasDefinition()
public DcGeneral\DataDefinition\ContainerInterface
# clearDefinitions( )

Clear all definitions from this container.

Clear all definitions from this container.

Returns

DcGeneral\DataDefinition\ContainerInterface

Implementation of

DcGeneral\DataDefinition\ContainerInterface::clearDefinitions()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setDefinitions()
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

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When a passed definition does not implement the DefinitionInterface.

Implementation of

DcGeneral\DataDefinition\ContainerInterface::addDefinitions()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::removeDefinition()
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

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
Is thrown when there is no definition with this name.

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getDefinitionNames()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasBasicDefinition()
public DcGeneral\DataDefinition\ContainerInterface
# setBasicDefinition( DcGeneral\DataDefinition\Definition\BasicDefinitionInterface $definition )

Convenience method to set the basic definition.

Convenience method to set the basic definition.

Parameters

$definition
DcGeneral\DataDefinition\Definition\BasicDefinitionInterface
$basicDefinition The basic definition to use.

Returns

DcGeneral\DataDefinition\ContainerInterface

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setBasicDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getBasicDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasPropertiesDefinition()
public DcGeneral\DataDefinition\ContainerInterface
# setPropertiesDefinition( DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface $definition )

Convenience method to set the properties definition to use.

Convenience method to set the properties definition to use.

Parameters

$definition
DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface
$propertiesDefinition The properties definition to use.

Returns

DcGeneral\DataDefinition\ContainerInterface

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setPropertiesDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getPropertiesDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasPalettesDefinition()
public DcGeneral\DataDefinition\ContainerInterface
# setPalettesDefinition( DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface $definition )

Convenience method to set the palettes definition to use.

Convenience method to set the palettes definition to use.

Parameters

$definition
DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface
$palettesDefinition The palettes definition to use.

Returns

DcGeneral\DataDefinition\ContainerInterface

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setPalettesDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getPalettesDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasDataProviderDefinition()
public DcGeneral\DataDefinition\ContainerInterface
# setDataProviderDefinition( DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface $definition )

Convenience method to set the data provider definition.

Convenience method to set the data provider definition.

Parameters

$definition
DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface
$dataProviderDefinition The data provider definition to use.

Returns

DcGeneral\DataDefinition\ContainerInterface

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setDataProviderDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getDataProviderDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::hasModelRelationshipDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::setModelRelationshipDefinition()
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

Implementation of

DcGeneral\DataDefinition\ContainerInterface::getModelRelationshipDefinition()
Properties summary
protected string $name
#

The name of the container.

The name of the container.

protected DcGeneral\DataDefinition\Definition\DefinitionInterface[] $definitions
#

The contained definition instances.

The contained definition instances.

contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0