CirrusSearch\Query\PageIdFeature Class Reference

Filter by a set of page IDs. More...

Inheritance diagram for CirrusSearch\Query\PageIdFeature:

Collaboration diagram for CirrusSearch\Query\PageIdFeature:

Public Member Functions
	getFilterQuery (KeywordFeatureNode $node, QueryBuildingContext $context)
	@inheritDoc
	parseValue ( $key, $value, $quotedValue, $valueDelimiter, $suffix, WarningCollector $warningCollector)
	@inheritDoc
Public Member Functions inherited from CirrusSearch\Query\SimpleKeywordFeature
	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)
	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)

Public Attributes
const	MAX_VALUES = 1000
	Maximum number of IDs allowed.

Protected Member Functions
	doGetFilterQuery (array $parsedValue, SearchConfig $searchConfig)
	getKeywords ()
	@inheritDoc
	doApply (SearchContext $context, $key, $value, $quotedValue, $negated)
	@inheritDoc

Detailed Description

Filter by a set of page IDs.

This is useful for re-validating cached query results. Format: pageid:1|2|3

Member Function Documentation

doApply()

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

protected

@inheritDoc

Reimplemented from CirrusSearch\Query\SimpleKeywordFeature.

doGetFilterQuery()

CirrusSearch\Query\PageIdFeature::doGetFilterQuery ( array $parsedValue, SearchConfig $searchConfig )

protected

Parameters

array	$parsedValue
SearchConfig	$searchConfig

Returns

AbstractQuery|null

getFilterQuery()

CirrusSearch\Query\PageIdFeature::getFilterQuery	(	KeywordFeatureNode	$node,
		QueryBuildingContext	$context )

@inheritDoc

Implements CirrusSearch\Query\FilterQueryFeature.

getKeywords()

CirrusSearch\Query\PageIdFeature::getKeywords ( )

protected

@inheritDoc

Reimplemented from CirrusSearch\Query\SimpleKeywordFeature.

parseValue()

CirrusSearch\Query\PageIdFeature::parseValue	(		$key,
			$value,
			$quotedValue,
			$valueDelimiter,
			$suffix,
		WarningCollector	$warningCollector )

@inheritDoc

Reimplemented from CirrusSearch\Query\SimpleKeywordFeature.

---

The documentation for this class was generated from the following file:

• includes/Query/PageIdFeature.php