CirrusSearch\Search\SourceTextIndexField Class Reference

Inheritance diagram for CirrusSearch\Search\SourceTextIndexField:

Collaboration diagram for CirrusSearch\Search\SourceTextIndexField:

Public Member Functions
	__construct ( $name, $type, SearchConfig $config)
	getMapping (SearchEngine $engine)
Public Member Functions inherited from CirrusSearch\Search\TextIndexField
	__construct ( $name, $type, SearchConfig $config, $extra=[])
	setTextOptions ( $options)
	Set text options for this field if non-default.
Public Member Functions inherited from CirrusSearch\Search\CirrusIndexField
	setMappingFlags ( $flags)
	Set flags for specific mapping.

Additional Inherited Members
Static Public Member Functions inherited from CirrusSearch\Search\TextIndexField
static	getSimilarity (SearchConfig $config, $field, $analyzer=null)
	Get the field similarity.
Static Public Member Functions inherited from CirrusSearch\Search\CirrusIndexField
static	addIndexingHints (Document $doc, $fieldName, array $hints)
	Inspect SearchIndexField::getEngineHints() for indexing hints and forward them to special metadata in the document.
static	addNoopHandler (\Elastica\Param $doc, $field, $handler)
	Add a special metadata to $doc to control the noop_script.
static	getHint (\Elastica\Param $doc, $hint)
	Get the hint named $hint.
static	setHint (\Elastica\Param $doc, $hint, $value)
	Set the hint named $hint.
static	resetHints (Param $doc)
	Clear all hints.
Public Attributes inherited from CirrusSearch\Search\TextIndexField
const	POSITION_INCREMENT_GAP = 10
	Distance that lucene places between multiple values of the same field.
const	ENABLE_NORMS = 0x1000000
const	COPY_TO_SUGGEST = 0x2000000
const	SPEED_UP_HIGHLIGHTING = 0x4000000
const	SUPPORT_REGEX = 0x8000000
const	STRING_FIELD_MASK = 0xFFFFFF
Public Attributes inherited from CirrusSearch\Search\CirrusIndexField
const	DOC_HINT_PARAM = '_cirrus_hints'
	Name of the param on \Elastica\Document that contains hints about the noop_script handlers.
const	MULTILIST_HANDLER = 'multilist'
	name of the noop handler for multilist
const	MULTILIST_DELETE_GROUPING = '__DELETE_GROUPING__'
	magic word to instruct the noop plugin to cleanup a particular multilist group
const	NOOP_HINT = 'noop'
	Name of the hint as returned by SearchIndexField::getEngineHints()
Protected Member Functions inherited from CirrusSearch\Search\TextIndexField
	getTextOptions ( $mappingFlags)
	Get text options for this field.
	configureHighlighting (array &$field, array $subFields, $rootField=true)
	Adapt the field options according to the highlighter used.
	initFlags ()
	Init the field flags.
Protected Attributes inherited from CirrusSearch\Search\TextIndexField
	$extra
	$typeName = 'text'
	$allowTrigrams = false
Protected Attributes inherited from CirrusSearch\Search\CirrusIndexField
	$typeName = 'unknown'
	$config
	$mappingFlags

Constructor & Destructor Documentation

__construct()

CirrusSearch\Search\SourceTextIndexField::__construct	(		$name,
			$type,
		SearchConfig	$config )

Parameters

string	$name
string	$type
SearchConfig	$config

Reimplemented from CirrusSearch\Search\CirrusIndexField.

Member Function Documentation

getMapping()

CirrusSearch\Search\SourceTextIndexField::getMapping

(

SearchEngine

$engine

)

Parameters

SearchEngine

$engine

Returns

array|void

Reimplemented from CirrusSearch\Search\CirrusIndexField.

---

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

• includes/Search/SourceTextIndexField.php