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

  • AbstractCondition
  • ParentChildCondition
  • RootCondition

Interfaces

  • ParentChildConditionInterface
  • RootConditionInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface RootConditionInterface

This interface holds the information about the characteristics of a root model.

Direct known implementers

DcGeneral\DataDefinition\ModelRelationship\RootCondition
Namespace: DcGeneral\DataDefinition\ModelRelationship
Package: DcGeneral\DataDefinition\ModelRelationship
Located at DataDefinition/ModelRelationship/RootConditionInterface.php
Methods summary
public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
# setFilterArray( array $value )

Set the condition as filter.

Set the condition as filter.

Parameters

$value
array
$value The filter rules to be used for finding root models.

Returns

DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
public array
# getFilterArray( )

Get the condition as filter.

Get the condition as filter.

Returns

array
public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
# setSetters( array $value )

Set the condition setters.

Set the condition setters.

Parameters

$value
array
$value The values to be used when making a model a root model.

Returns

DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
public array
# getSetters( )

Get the condition setters.

Get the condition setters.

Returns

array
public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
# setSourceName( string $value )

Set the name of the source provider.

Set the name of the source provider.

Parameters

$value
string
$value The data provider name.

Returns

DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
public string
# getSourceName( )

Return the name of the source provider.

Return the name of the source provider.

Returns

string
public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
# applyTo( DcGeneral\Data\ModelInterface $objModel )

Apply the root condition to a model.

Apply the root condition to a model.

Parameters

$objModel
DcGeneral\Data\ModelInterface
$objModel The model that shall become a root model.

Returns

DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface
public boolean
# matches( DcGeneral\Data\ModelInterface $objModel )

Test if the given model is indeed a root object according to this condition.

Test if the given model is indeed a root object according to this condition.

Parameters

$objModel
DcGeneral\Data\ModelInterface
$objModel The model to be tested.

Returns

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