Basic infrastructure of the field definition. More...

Inheritance diagram for SearchIndexFieldDefinition:

[legend]

Collaboration diagram for SearchIndexFieldDefinition:

[legend]

Public Member Functions

__construct ( $name, $type)

checkFlag ( $flag)

Check if flag is set.

getEngineHints (SearchEngine $engine)

A list of search engine hints for this field.Hints are usually specific to a search engine implementation and allow to fine control how the search engine will handle this particular field.For example some search engine permits some optimizations at index time by ignoring an update if the updated value does not change by more than X% on a numeric value.

Parameters

SearchEngine $engine

Returns: array an array of hints generally indexed by hint name. The type of values is search engine specific

Since: 1.30

getIndexType ()

getMapping (SearchEngine $engine)

getName ()

Get field name.

getSubfields ()

merge (SearchIndexField $that)

Merge two field definitions if possible.

setFlag ( $flag, $unset=false)

Set global flag for this field.

setMergeCallback ( $callback)

Set field-specific merge strategy.

setSubfields (array $subfields)

Protected Attributes
int	$flags = 0
	Bit flags for the field.

string	$name
	Name of the field.

SearchIndexFieldDefinition[]	$subfields = []
	Subfields.

string	$type
	Type of the field, one of the constants above.

Private Attributes
callable	$mergeCallback

Additional Inherited Members
Public Attributes inherited from SearchIndexField
const	FLAG_CASEFOLD = 1
	Generic field flags.

const	FLAG_NO_HIGHLIGHT = 4
	This field does not need highlight handling.

const	FLAG_NO_INDEX = 8
	Do not index this field, just store it.

const	FLAG_SCORING = 2
	This field contains secondary information, which is already present in other fields, but can be used for scoring.

const	INDEX_TYPE_BOOL = 'bool'

const	INDEX_TYPE_DATETIME = 'datetime'

const	INDEX_TYPE_INTEGER = 'integer'

const	INDEX_TYPE_KEYWORD = 'keyword'
	KEYWORD fields are indexed without any processing, so are appropriate for e.g.

const	INDEX_TYPE_NESTED = 'nested'

const	INDEX_TYPE_NUMBER = 'number'

const	INDEX_TYPE_SHORT_TEXT = 'short_text'
	SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.

const	INDEX_TYPE_TEXT = 'text'
	TEXT fields are suitable for natural language and may be subject to analysis such as stemming.

Detailed Description

Basic infrastructure of the field definition.

Specific engines should extend this class and at least, override the getMapping method, but can reuse other parts.

Stability: stable: to extend

Since: 1.28

Definition at line 12 of file SearchIndexFieldDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

SearchIndexFieldDefinition::__construct	(	$name,
		$type
	)

Parameters

string	$name	Field name
string	$type	Index type

Definition at line 50 of file SearchIndexFieldDefinition.php.

References $name, and $type.

Member Function Documentation

◆ checkFlag()

SearchIndexFieldDefinition::checkFlag ( $flag )

Check if flag is set.

Stability: stable: to override

Parameters

int $flag

Returns: int 0 if unset, !=0 if set

Implements SearchIndexField.

Definition at line 94 of file SearchIndexFieldDefinition.php.

◆ getEngineHints()

SearchIndexFieldDefinition::getEngineHints ( SearchEngine $engine )

A list of search engine hints for this field.Hints are usually specific to a search engine implementation and allow to fine control how the search engine will handle this particular field.For example some search engine permits some optimizations at index time by ignoring an update if the updated value does not change by more than X% on a numeric value.

Parameters

SearchEngine $engine