GroupFilter  

class GroupFilter implements FilterInterface

Traits

ValidateFilterTrait

Methods

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

No description

from ValidateFilterTrait
string
asString(string|array $filterValue)

No description

from ValidateFilterTrait
int
asInt(string|array $filterValue)

No description

from ValidateFilterTrait
array
asIntArray(string|array $filterValue)

No description

from ValidateFilterTrait
bool
asBool(string|array $filterValue)

No description

from ValidateFilterTrait
string
getFilterKey()

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

void
filter(SearchState $state, string|array $value, bool $negate)

<p>Filters a query.</p>

void
constrain(Builder $query, User $actor, string|array $rawQuery, bool $negate)

No description

Details

in ValidateFilterTrait at line 21
protected array asStringArray(string|array $filterValue, bool $multidimensional = false)

Parameters

string|array $filterValue
bool $multidimensional

Return Value

array

Exceptions

ValidationException

in ValidateFilterTrait at line 43
protected string asString(string|array $filterValue)

Parameters

string|array $filterValue

Return Value

string

Exceptions

ValidationException

in ValidateFilterTrait at line 55
protected int asInt(string|array $filterValue)

Parameters

string|array $filterValue

Return Value

int

Exceptions

ValidationException

in ValidateFilterTrait at line 68
protected array asIntArray(string|array $filterValue)

Parameters

string|array $filterValue

Return Value

array

Exceptions

ValidationException

in ValidateFilterTrait at line 78
protected bool asBool(string|array $filterValue)

Parameters

string|array $filterValue

Return Value

bool

Exceptions

ValidationException

at line 27
string getFilterKey()

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

Return Value

string

at line 32
void filter(SearchState $state, string|array $value, bool $negate)

<p>Filters a query.</p>

Parameters

SearchState $state
string|array $value
bool $negate

Return Value

void

at line 37
protected void constrain(Builder $query, User $actor, string|array $rawQuery, bool $negate)

Parameters

Builder $query
User $actor
string|array $rawQuery
bool $negate

Return Value

void