CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder Class Reference

Inheritance diagram for CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder:

Collaboration diagram for CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder:

Public Member Functions
	__construct ( $fieldName, $target, $priority=self::DEFAULT_TARGET_PRIORITY)
	merge (HighlightedField $other)
	@inheritDoc
	skipIfLastMatched ()
Public Member Functions inherited from CirrusSearch\Search\Fetch\BaseHighlightedField
	__construct ( $fieldName, $highlighterType, $target, $priority=self::DEFAULT_TARGET_PRIORITY)
	addOption ( $option, $value)
	addMatchedField ( $field)
	setOrder ( $order)
	setNumberOfFragments ( $numberOfFragments)
	setFragmenter ( $fragmenter)
	setFragmentSize ( $fragmentSize)
	setNoMatchSize ( $noMatchSize)
	setHighlightQuery (AbstractQuery $highlightQuery)
	getHighlightQuery ()
	setOptions (array $options)
	getOptions ()
	getNumberOfFragments ()
	getHighlighterType ()
	getFragmenter ()
	getFragmentSize ()
	getNoMatchSize ()
	getMatchedFields ()
	getOrder ()
	toArray ()
Public Member Functions inherited from CirrusSearch\Search\Fetch\HighlightedField
	getFieldName ()
	getTarget ()
	getPriority ()
	getType ()

Static Public Member Functions
static	entireValue ()
static	redirectAndHeadings ()
static	text ()
static	getFactories ()

Public Attributes
const	EXPERIMENTAL_HL_TYPE = 'experimental'
Public Attributes inherited from CirrusSearch\Search\Fetch\BaseHighlightedField
const	TYPE = 'highlighting'
const	FVH_HL_TYPE = 'fvh'
Public Attributes inherited from CirrusSearch\Search\Fetch\HighlightedField
const	DEFAULT_TARGET_PRIORITY = 100
	Priority for properties that are doc dependent (e.g.
const	QUERY_DEPENDENT_TARGET_PRIORITY = 200
	Priority for properties that are query dependent (highlight in content)
const	EXPERT_SYNTAX_PRIORITY = 300
	Priority for properties that are query dependent and triggered using search keywords (intitle:foo highlight)
const	TARGET_TITLE_SNIPPET = ArrayCirrusSearchResult::TITLE_SNIPPET
const	TARGET_REDIRECT_SNIPPET = ArrayCirrusSearchResult::REDIRECT_SNIPPET
const	TARGET_CATEGORY_SNIPPET = ArrayCirrusSearchResult::CATEGORY_SNIPPET
const	TARGET_MAIN_SNIPPET = ArrayCirrusSearchResult::TEXT_SNIPPET
const	TARGET_SECTION_SNIPPET = ArrayCirrusSearchResult::SECTION_SNIPPET
const	COSTLY_EXPERT_SYNTAX_PRIORITY = 400
	Priority for properties are query dependent and triggered using costly search keywords (for intitle:/foo[0-9]/ intitle:bar we will prefer the highlight on the regex over the simple intitle:bar)

Additional Inherited Members
Protected Member Functions inherited from CirrusSearch\Search\Fetch\BaseHighlightedField
	matchPlainFields ()
	Helper function to populate the matchedFields array with the additional .plain field.
Protected Attributes inherited from CirrusSearch\Search\Fetch\BaseHighlightedField
	$options = []

Constructor & Destructor Documentation

__construct()

CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::__construct	(		$fieldName,
			$target,
			$priority = self::DEFAULT_TARGET_PRIORITY )

Parameters

string	$fieldName
string	$target
int	$priority

Member Function Documentation

entireValue()

static CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::entireValue ( )

static

Returns

callable

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

getFactories()

static CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::getFactories ( )

static

Returns

array

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

merge()

CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::merge

(

HighlightedField

$other

)

@inheritDoc

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

redirectAndHeadings()

static CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::redirectAndHeadings ( )

static

Returns

callable

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

skipIfLastMatched()

CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::skipIfLastMatched

(

)

Returns

ExperimentalHighlightedFieldBuilder

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

text()

static CirrusSearch\Search\Fetch\ExperimentalHighlightedFieldBuilder::text ( )

static

Returns

callable

Reimplemented from CirrusSearch\Search\Fetch\BaseHighlightedField.

---

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

• includes/Search/Fetch/ExperimentalHighlightedFieldBuilder.php