class TypeFilter implements FilterInterface

Traits

Methods

array
asStringArray($filterValue, bool $multidimensional = false)

No description

string
asString($filterValue)

No description

int
asInt($filterValue)

No description

array
asIntArray($filterValue)

No description

bool
asBool($filterValue)

No description

string
getFilterKey()

<p>This filter will only be run when a query contains a filter param with this key.</p>

filter(FilterState $filterState, string $filterValue, bool $negate)

<p>Filters a query.</p>

Details

protected array asStringArray($filterValue, bool $multidimensional = false)

Parameters

$filterValue
bool $multidimensional

Return Value

array

Exceptions

ValidationException

protected string asString($filterValue)

Parameters

$filterValue

Return Value

string

Exceptions

ValidationException

protected int asInt($filterValue)

Parameters

$filterValue

Return Value

int

Exceptions

ValidationException

protected array asIntArray($filterValue)

Parameters

$filterValue

Return Value

array

Exceptions

ValidationException

protected bool asBool($filterValue)

Parameters

$filterValue

Return Value

bool

Exceptions

ValidationException

string getFilterKey()

<p>This filter will only be run when a query contains a filter param with this key.</p>

Return Value

string

filter(FilterState $filterState, string $filterValue, bool $negate)

<p>Filters a query.</p>

Parameters

FilterState $filterState
string $filterValue
bool $negate