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

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

 Methods

Apply the root condition to a model.

applyTo(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objModel) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Parameters

$objModel

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model that shall become a root model.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Get the condition as filter.

getFilterArray() : array

Returns

array

Get the condition setters.

getSetters() : array

Returns

array

Return the name of the source provider.

getSourceName() : string

Returns

string

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

matches(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objModel) : bool

Parameters

$objModel

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model to be tested.

Returns

bool

Set the condition as filter.

setFilterArray(array $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Parameters

$value

array

The filter rules to be used for finding root models.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Set the condition setters.

setSetters(array $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Parameters

$value

array

The values to be used when making a model a root model.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Set the name of the source provider.

setSourceName(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Parameters

$value

string

The data provider name.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface