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

Handy helper class to generate and manipulate filter arrays.

This class is intended to be only used as base class of other filter builders.

 Methods

Ensure that the given property also equals the given value.

andPropertyEquals(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilderThe newly created filter.

Ensure that the given property also is greater than the given value.

andPropertyGreaterThan(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyGreaterThanFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyGreaterThanFilterBuilderThe newly created filter.

Ensure that the given property also is less than the given value.

andPropertyLessThan(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyLessThanFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyLessThanFilterBuilderThe newly created filter.

Ensure that the given property also is less than the given value.

andPropertyValueIn(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyValueInFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyValueInFilterBuilderThe newly created filter.

Ensure that the given property also is less than the given value.

andPropertyValueLike(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyValueInFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyValueInFilterBuilderThe newly created filter.

Ensure that the given property also equals the given remote property.

andRemotePropertyEquals(string $property, string $remoteProperty, bool $remoteIsValue) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilder

Parameters

$property

string

The name of the property.

$remoteProperty

string

The name of the remote property.

$remoteIsValue

bool

True if the passed remote value is a value, false if it is a property name.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilderThe newly created filter.

Ensure that the given property also is greater than the given remote property.

andRemotePropertyGreaterThan(string $property, string $remoteProperty, bool $remoteIsValue) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyGreaterThanFilterBuilder

Parameters

$property

string

The name of the property.

$remoteProperty

string

The name of the remote property.

$remoteIsValue

bool

True if the passed remote value is a value, false if it is a property name.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyGreaterThanFilterBuilderThe newly created filter.

Ensure that the given property also is less than the given remote property.

andRemotePropertyLessThan(string $property, string $remoteProperty, bool $remoteIsValue) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyLessThanFilterBuilder

Parameters

$property

string

The name of the property.

$remoteProperty

string

The name of the remote property.

$remoteIsValue

bool

True if the passed remote value is a value, false if it is a property name.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyLessThanFilterBuilderThe newly created filter.

Serialize the filter into an array.

get() : array

Returns

array

Get all the filter array for all filters from the current filter builder.

getAllAsArray() : array

Returns

array

Get the filter builder.

getBuilder() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Retrieve the parent.

getParent() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

Ensure that the given property also equals the given value.

orPropertyEquals(string $property, mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilder

Parameters

$property

string

The property name.

$value

mixed

The property value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\PropertyEqualsFilterBuilderThe newly created filter.

Set the filter builder.

setBuilder(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder $builder) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

Parameters

$builder

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

The filter builder.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

Set the parent and return self.

setParent(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren $parent) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

Parameters

$parent

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

The new parent.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

Move one level up in the filter hierarchy.

up() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren
SuppressWarnings (PHPMD.ShortMethodName)

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren

Encapsulate the given filter with AND and return it.

andEncapsulate(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder $filter) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

Parameters

$filter

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

The filter to encapsulate.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

Ensure this filter builder is encapsulated within an AND filter builder.

ensureAndEncapsulation() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\AndFilterBuilder

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\AndFilterBuilder

Ensure this filter builder is encapsulated within an AND filter builder.

ensureOrEncapsulation() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\OrFilterBuilder

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\OrFilterBuilder

Encapsulate the given filter with AND and return it.

orEncapsulate(\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder $filter) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

Parameters

$filter

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

The filter to encapsulate.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder

 Properties

 

The filter builder holding the scope.

$builder : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder
 

The current parenting Builder.

$parent : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\FilterBuilderWithChildren