AbstractRegexGambit  

abstract class AbstractRegexGambit implements GambitInterface

Methods

getGambitPattern()

<p>The regex pattern to match the bit against.</p>

bool
apply(SearchState $search, string $bit)

<p>Apply conditions to the searcher for a bit of the search string.</p>

array|null
match(string $bit)

<p>Match the bit against this gambit.</p>

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

<p>Apply conditions to the search, given that the gambit was matched.</p>

Details

at line 17
abstract protected getGambitPattern()

<p>The regex pattern to match the bit against.</p>

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

<p>Apply conditions to the searcher for a bit of the search string.</p>

Parameters

SearchState $search
string $bit <p>The piece of the search string.</p>

Return Value

bool <p>Whether or not the gambit was active for this bit.</p>

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

<p>Match the bit against this gambit.</p>

Parameters

string $bit

Return Value

array|null

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

<p>Apply conditions to the search, given that the gambit was matched.</p>

Parameters

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

Return Value

mixed