Implements abstract handling of keyword features that are composed of a keyword followed by a colon then an optionally quoted value. More...

Inheritance diagram for CirrusSearch\Query\SimpleKeywordFeature:

Collaboration diagram for CirrusSearch\Query\SimpleKeywordFeature:

Public Member Functions
	getKeywordPrefixes ()

	allowEmptyValue ()
	Whether this keyword allows empty value.

	hasValue ()
	Whether this keyword can have a value.

	greedy ()
	Whether this keyword is greedy consuming the rest of the string.

	queryHeader ()
	Whether this keyword can appear only at the beginning of the query (excluding spaces)

	getFeatureName ( $key, $valueDelimiter)
	Determine the name of the feature being set in SearchContext::addSyntaxUsed Defaults to $key.

	getValueDelimiters ()
	List of value delimiters supported (must be an array of single byte char)

	parseValue ( $key, $value, $quotedValue, $valueDelimiter, $suffix, WarningCollector $warningCollector)
	Parse the value of the keyword.

	getCrossSearchStrategy (KeywordFeatureNode $node)

	expand (KeywordFeatureNode $node, SearchConfig $config, WarningCollector $warningCollector)

	doApplyExtended (SearchContext $context, $key, $value, $quotedValue, $negated, $delimiter, $suffix)
	Fully featured apply method which delegates to doApply by default.

	apply (SearchContext $context, $term)

Protected Member Functions
	getKeywords ()
	NOTE: will be removed once all implementations implement getKeywordStrings (transitional state to change the visibility of getKeywords())

	doApply (SearchContext $context, $key, $value, $quotedValue, $negated)
	Applies the detected keyword from the search term.

Detailed Description

Implements abstract handling of keyword features that are composed of a keyword followed by a colon then an optionally quoted value.

For consistency most query features should be implemented this way using the default getValueRegex() where possible.

Member Function Documentation

CirrusSearch\Query\SimpleKeywordFeature::allowEmptyValue ( )

Whether this keyword allows empty value.

CirrusSearch\Query\SimpleKeywordFeature::apply	(	SearchContext	$context,
			$term )

Parameters

SearchContext	$context
string	$term	Search query

CirrusSearch\Query\SimpleKeywordFeature::doApply	(	SearchContext	$context,
			$key,
			$value,
			$quotedValue,
			$negated )

abstractprotected

Applies the detected keyword from the search term.

May apply changes either to $context directly, or return a filter to be added.

Parameters

SearchContext	$context
string	$key	The keyword
string	$value	The value attached to the keyword with quotes stripped and escaped quotes un-escaped.
string	$quotedValue	The original value in the search string, including quotes if used
bool	$negated	Is the search negated? Not used to generate the returned AbstractQuery, that will be negated as necessary. Used for any other building/context necessary.

Returns: array Two element array, first an AbstractQuery or null to apply to the query. Second a boolean indicating if the quotedValue should be kept in the search string.

CirrusSearch\Query\SimpleKeywordFeature::doApplyExtended	(	SearchContext	$context,
			$key,
			$value,
			$quotedValue,
			$negated,
			$delimiter,
			$suffix )

Fully featured apply method which delegates to doApply by default.

Parameters

SearchContext	$context
string	$key	The keyword
string	$value	The value attached to the keyword with quotes stripped and escaped quotes un-escaped.
string	$quotedValue	The original value in the search string, including quotes if used
bool	$negated	Is the search negated? Not used to generate the returned AbstractQuery, that will be negated as necessary. Used for any other building/context necessary.
string	$delimiter	the delimiter char used to wrap the keyword value ('"' in intitle:"test")
string	$suffix	the optional suffix used after the value ('i' in insource:/regex/i)

Returns: array Two element array, first an AbstractQuery or null to apply to the query. Second a boolean indicating if the quotedValue should be kept in the search string.