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

  • DefaultBasicDefinition
  • DefaultDataProviderDefinition
  • DefaultModelRelationshipDefinition
  • DefaultPalettesDefinition
  • DefaultPropertiesDefinition

Interfaces

  • BasicDefinitionInterface
  • DataProviderDefinitionInterface
  • DefinitionInterface
  • ModelRelationshipDefinitionInterface
  • PalettesDefinitionInterface
  • PropertiesDefinitionInterface
  • ViewDefinitionInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface ModelRelationshipDefinitionInterface

This interface describes the relationships between data providers.

It holds a root condition for the root data provider and many parent child relationships.

DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface implements DcGeneral\DataDefinition\Definition\DefinitionInterface

Direct known implementers

DcGeneral\DataDefinition\Definition\DefaultModelRelationshipDefinition
Namespace: DcGeneral\DataDefinition\Definition
Package: DcGeneral\DataDefinition\Definition
Located at DataDefinition/Definition/ModelRelationshipDefinitionInterface.php
Methods summary
public DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface
# setRootCondition( DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface $condition )

Set the root condition for the current table.

Set the root condition for the current table.

Parameters

$condition
DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
$condition The root condition.

Returns

DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface
public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
# getRootCondition( )

Retrieve the root condition for the current table.

Retrieve the root condition for the current table.

Returns

DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
public DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface
# addChildCondition( DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface $condition )

Add a parent child condition.

Add a parent child condition.

Parameters

$condition
DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface
$condition The parent child condition.

Returns

DcGeneral\DataDefinition\Definition\ModelRelationshipDefinitionInterface
public DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface
# getChildCondition( string $srcProvider, string $dstProvider )

Retrieve the parent child condition for the current table.

Retrieve the parent child condition for the current table.

Parameters

$srcProvider
string
$srcProvider The parenting table.
$dstProvider
string
$dstProvider The child table.

Returns

DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface
public DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface[]
# getChildConditions( string $srcProvider = '' )

Retrieve the parent child conditions for the current table.

Retrieve the parent child conditions for the current table.

Parameters

$srcProvider
string
$srcProvider The parenting table for which child conditions shall be assembled for (optional).

Returns

DcGeneral\DataDefinition\ModelRelationship\ParentChildConditionInterface[]
Constants summary
string NAME 'model-relationships'
#

The name of the definition.

The name of the definition.

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