CirrusSearch\Search\Fetch\HighlightFieldGenerator Interface Reference

Inheritance diagram for CirrusSearch\Search\Fetch\HighlightFieldGenerator:

Public Member Functions
	newRegexField ( $name, $target, $pattern, $caseInsensitive, $priority=HighlightedField::COSTLY_EXPERT_SYNTAX_PRIORITY)
	supportsRegexFields ()
	newHighlightField ( $name, $target, $priority=HighlightedField::DEFAULT_TARGET_PRIORITY)

Member Function Documentation

newHighlightField()

CirrusSearch\Search\Fetch\HighlightFieldGenerator::newHighlightField	(		$name,
			$target,
			$priority = HighlightedField::DEFAULT_TARGET_PRIORITY )

Parameters

string	$name
string	$target
int	$priority

Returns

BaseHighlightedField

Implemented in CirrusSearch\Search\Fetch\FetchPhaseConfigBuilder.

newRegexField()

CirrusSearch\Search\Fetch\HighlightFieldGenerator::newRegexField	(		$name,
			$target,
			$pattern,
			$caseInsensitive,
			$priority = HighlightedField::COSTLY_EXPERT_SYNTAX_PRIORITY )

Parameters

string	$name
string	$target
string	$pattern
bool	$caseInsensitive
int	$priority

Returns

BaseHighlightedField

See also

HighlightFieldGenerator::supportsRegexFields()

Implemented in CirrusSearch\Search\Fetch\FetchPhaseConfigBuilder.

supportsRegexFields()

CirrusSearch\Search\Fetch\HighlightFieldGenerator::supportsRegexFields

(

)

Returns

bool true if regex fields are supported

Implemented in CirrusSearch\Search\Fetch\FetchPhaseConfigBuilder.

---

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

• includes/Search/Fetch/HighlightFieldGenerator.php