EmailFilterGambit  

class EmailFilterGambit extends AbstractRegexGambit implements FilterInterface

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
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.

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 35
getGambitPattern()

The regex pattern to match the bit against.

at line 23
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 match(string $bit)

Match the bit against this gambit.

Parameters

string $bit

Return Value

array

at line 43
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

at line 48
string getFilterKey()

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

Return Value

string

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

Filters a query.

Parameters

FilterState $filterState
string $filterValue
bool $negate

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

Parameters

Builder $query
$rawEmail
bool $negate