class AuthorFilterGambit extends AbstractRegexGambit implements FilterInterface

Properties

protected UserRepository $users

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.

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

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

__construct(UserRepository $users)

No description

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, $rawUsernames, $negate)

No description

Details

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.

Parameters

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

Return Value

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

protected array|null match(string $bit)

Match the bit against this gambit.

Parameters

string $bit

Return Value

array|null

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

__construct(UserRepository $users)

Parameters

UserRepository $users

string getFilterKey()

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

Return Value

string

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

Filters a query.

Parameters

FilterState $filterState
string $filterValue
bool $negate

protected constrain(Builder $query, $rawUsernames, $negate)

Parameters

Builder $query
$rawUsernames
$negate