EmailFilterGambit  

class EmailFilterGambit extends AbstractRegexGambit implements FilterInterface

Traits

ValidateFilterTrait

Methods

getGambitPattern()

The regex pattern to match the bit against.

bool
apply(SearchState $search, string $bit)

Apply conditions to the searcher for a bit of the search string.

array|null
match(string $bit)

Match the bit against this gambit.

from AbstractRegexGambit
mixed
conditions(SearchState $search, array $matches, bool $negate)

Apply conditions to the search, given that the gambit was matched.

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

No description

from ValidateFilterTrait
string
asString($filterValue)

No description

from ValidateFilterTrait
int
asInt($filterValue)

No description

from ValidateFilterTrait
array
asIntArray($filterValue)

No description

from ValidateFilterTrait
bool
asBool($filterValue)

No description

from ValidateFilterTrait
string
getFilterKey()

This filter will only be run when a query contains a filter param with this key.

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

Filters a query.

constrain(Builder $query, $rawEmail, bool $negate)

No description

Details

at line 38
getGambitPattern()

The regex pattern to match the bit against.

at line 26
bool apply(SearchState $search, string $bit)

Apply conditions to the searcher for a bit of the search string.

Parameters

SearchState $search
string $bit The piece of the search string.

Return Value

bool Whether or not the gambit was active for this bit.

in AbstractRegexGambit at line 39
protected array|null match(string $bit)

Match the bit against this gambit.

Parameters

string $bit

Return Value

array|null

at line 46
protected mixed conditions(SearchState $search, array $matches, bool $negate)

Apply conditions to the search, given that the gambit was matched.

Parameters

SearchState $search The search object.
array $matches An array of matches from the search bit.
bool $negate Whether or not the bit was negated, and thus whether or not the conditions should be negated.

Return Value

mixed

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

Parameters

$filterValue
bool $multidimensional

Return Value

array

Exceptions

ValidationException

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

Parameters

$filterValue

Return Value

string

Exceptions

ValidationException

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

Parameters

$filterValue

Return Value

int

Exceptions

ValidationException

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

Parameters

$filterValue

Return Value

array

Exceptions

ValidationException

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

Parameters

$filterValue

Return Value

bool

Exceptions

ValidationException

at line 51
string getFilterKey()

This filter will only be run when a query contains a filter param with this key.

Return Value

string

at line 56
filter(FilterState $filterState, string $filterValue, bool $negate)

Filters a query.

Parameters

FilterState $filterState
string $filterValue
bool $negate

at line 65
protected constrain(Builder $query, $rawEmail, bool $negate)

Parameters

Builder $query
$rawEmail
bool $negate