Class RootCondition

Default implementation of a root condition.

DcGeneral\DataDefinition\ModelRelationship\AbstractCondition

DcGeneral\DataDefinition\ModelRelationship\RootCondition implements DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface

Namespace: DcGeneral\DataDefinition\ModelRelationship
Package: DcGeneral\DataDefinition\ModelRelationship
Located at DataDefinition/ModelRelationship/RootCondition.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` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::setFilterArray()`
`public array`	# `getFilterArray( )` Get the condition as filter. Get the condition as filter. Returns `array` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::getFilterArray()`
`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` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::setSetters()`
`public array`	# `getSetters( )` Get the condition setters. Get the condition setters. Returns `array` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::getSetters()`
`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` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::setSourceName()`
`public string`	# `getSourceName( )` Return the name of the source provider. Return the name of the source provider. Returns `string` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::getSourceName()`
`public DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface`	# `applyTo( ModelInterface $objModel )` Apply the root condition to a model. Apply the root condition to a model. Parameters `$objModel` `ModelInterface` $objModel The model that shall become a root model. Returns `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface` Throws `DcGeneral\Exception\DcGeneralRuntimeException` When an incomplete rule is encountered in the setters. Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::applyTo()`
`public boolean`	# `matches( 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` `ModelInterface` $objModel The model to be tested. Returns `boolean` Implementation of `DcGeneral\DataDefinition\ModelRelationship\RootConditionInterface::matches()`

Methods inherited from DcGeneral\DataDefinition\ModelRelationship\AbstractCondition
`checkAndFilter(), checkCondition(), checkOrFilter()`

Properties summary
`protected array`	`$filter`	# The filter rules to use. The filter rules to use.
`protected array`	`$setOn`	# The setter information to use when a model shall get marked as root item. The setter information to use when a model shall get marked as root item.
`protected string`	`$sourceProvider`	# The name of the table this condition is being applied to. The name of the table this condition is being applied to.

Namespaces

Classes

Interfaces

Class RootCondition

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of