Copied!

Filter

Filter.php : 19

Content & Location filtering input Filter.

Methods

public__clone()

Filter.php : 221 
public __clone() : mixed

public__construct()

Filter.php : 40

Build Filter.

 
public __construct([FilteringCriterion|null $criterion = null ][, array<string|int, mixed> $sortClauses = [] ])

It's recommended to skip arguments and use with... and andWith... methods to build Filter.

Parameters

Name Type Default value Description
$criterion FilteringCriterion|null null -
$sortClauses array<string|int, mixed> [] -
Tags
Throws
BadStateException

for invalid Sort Clause

publicandWithCriterion()

Filter.php : 106 
public andWithCriterion(FilteringCriterion $criterion) : self

Parameters

Name Type Default value Description
$criterion FilteringCriterion - -

Return values

self

publicgetCriterion()

Filter.php : 188 
public getCriterion() : FilteringCriterion|null

Return values

FilteringCriterion|null

publicgetLimit()

Filter.php : 216

Get limit set by sliceBy.

 
public getLimit() : int

Return values

int

publicgetOffset()

Filter.php : 206

Get offset set by sliceBy.

 
public getOffset() : int

Return values

int

publicgetSortClauses()

Filter.php : 196 
public getSortClauses() : array<string|int, FilteringSortClause>

Return values

array<string|int, FilteringSortClause>

publicorWithCriterion()

Filter.php : 123 
public orWithCriterion(FilteringCriterion $criterion) : self

Parameters

Name Type Default value Description
$criterion FilteringCriterion - -

Return values

self

publicreset()

Filter.php : 63

Reset Filter so it can be built from scratch.

 
public reset() : self

Return values

self

publicsliceBy()

Filter.php : 166

Request result dataset slice by setting page limit and offset.

 
public sliceBy(int $limit, int $offset) : self

Both values MUST be >=0.

Parameters

Name Type Default value Description
$limit int -

=0, use 0 for no limit.
$offset int - -

Return values

self

Tags
Throws
InvalidArgumentException

publicwithCriterion()

Filter.php : 87

Set filtering Criterion.

 
public withCriterion(FilteringCriterion $criterion) : self

If multiple Criteria are required, either use andWithCriterion/orWithCriterion or wrap them with Logical operator Criterion.

To re-build Criterion from scratch reset it first.

Parameters

Name Type Default value Description
$criterion FilteringCriterion - -

Return values

self

Tags
Throws
BadStateException

if Criterion is already set

See
LogicalOr
See
LogicalAnd

publicwithLimit()

Filter.php : 151 
public withLimit(int $limit) : self

Parameters

Name Type Default value Description
$limit int - -

Return values

self

publicwithOffset()

Filter.php : 144 
public withOffset(int $offset) : self

Parameters

Name Type Default value Description
$offset int - -

Return values

self

publicwithSortClause()

Filter.php : 137 
public withSortClause(FilteringSortClause $sortClause) : self

Parameters

Name Type Default value Description
$sortClause FilteringSortClause - -

Return values

self