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

Handy helper class to generate and manipulate filter arrays.

 Methods

Create a new instance.

__construct(array $filter, bool $isRoot) 

Parameters

$filter

array

Optional base filter array.

$isRoot

bool

Flag determining if the current filter is a root filter.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When an invalid filter array has been passed.

Check that the builder is not for a root filter.

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

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When the builder is for an root filter.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Check that an given argument is a valid operation.

checkValidOperation(string $operation) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Parameters

$operation

string

The operation to check.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When an invalid operation name has been passed.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Encapsulate the root with an Or condition and return the OR condition.

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

Returns

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

Create a new instance from an array.

fromArray(array $filter) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder
Static

Parameters

$filter

array

The initial filter array (optional).

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Create a new instance from an array for a root filter.

fromArrayForRoot(array $filter) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder
Static

Parameters

$filter

array

The initial filter array (optional).

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

Return the current filters.

getAllAsArray() : array

Returns

array

Instantiate the correct builder class from a given filter array.

getBuilderFromArray(array $filter, \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder $builder) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\BaseFilterBuilder
Static

Parameters

$filter

array

The filter.

$builder

\ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder

The builder instance.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException When an invalid operation is encountered.

Returns

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

Return the root AND condition.

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

Returns

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

Determine if this builder is for a root filter or not.

isRootFilter() : bool

Returns

bool

Check if an given argument is a valid operation.

isValidOperation(string $operation) : bool
Static

Parameters

$operation

string

The operation to check.

Returns

bool

 Properties

 

The current filter root (always an AND builder).

$filters : \ContaoCommunityAlliance\DcGeneral\DataDefinition\ModelRelationship\FilterBuilder\AndFilterBuilder
 

Flag determining if the current filter is a root filter or parent child filter.

$isRootFilter : bool