SearchIndexField Interface Reference

Definition of a mapping for the search index field. More...

Inheritance diagram for SearchIndexField:

Public Member Functions
	checkFlag ( $flag)
	Check if flag is set.
	getMapping (SearchEngine $engine)
	Get mapping for specific search engine.
	merge (SearchIndexField $that)
	Merge two field definitions if possible.
	setFlag ( $flag, $unset=false)
	Set global flag for this field.

Public Attributes
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 = 6
const	INDEX_TYPE_DATETIME = 4
const	INDEX_TYPE_INTEGER = 2
const	INDEX_TYPE_KEYWORD = 1
const	INDEX_TYPE_NESTED = 5
const	INDEX_TYPE_NUMBER = 3
const	INDEX_TYPE_SHORT_TEXT = 7
	SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.
const	INDEX_TYPE_TEXT = 0
	Field types.

Detailed Description

Definition of a mapping for the search index field.

Since

1.28

Definition at line 6 of file SearchIndexField.php.

Member Function Documentation

checkFlag()

SearchIndexField::checkFlag

(

$flag

)

Check if flag is set.

Parameters

$flag

Returns

int 0 if unset, !=0 if set

Implemented in NullIndexField, and SearchIndexFieldDefinition.

getMapping()

SearchIndexField::getMapping

(

SearchEngine

$engine

)

Get mapping for specific search engine.

Parameters

SearchEngine

$engine

Returns

array|null Null means this field does not map to anything

Implemented in DummySearchIndexFieldDefinition, NullIndexField, and SearchIndexFieldDefinition.

merge()

SearchIndexField::merge

(

SearchIndexField

$that

)

Merge two field definitions if possible.

Parameters

SearchIndexField

$that

Returns

SearchIndexField|false New definition or false if not mergeable.

Implemented in NullIndexField, and SearchIndexFieldDefinition.

setFlag()

SearchIndexField::setFlag	(		$flag,
			$unset = false
	)

Set global flag for this field.

Parameters

int	$flag	Bit flag to set/unset
bool	$unset	True if flag should be unset, false by default

Returns

$this

Implemented in NullIndexField, and SearchIndexFieldDefinition.

Member Data Documentation

FLAG_CASEFOLD

const SearchIndexField::FLAG_CASEFOLD = 1

Generic field flags.

This field is case-insensitive.

Definition at line 32 of file SearchIndexField.php.

Referenced by ContentHandler\getFieldsForSearchIndex(), and FileContentHandler\getFieldsForSearchIndex().

FLAG_NO_HIGHLIGHT

const SearchIndexField::FLAG_NO_HIGHLIGHT = 4

This field does not need highlight handling.

Definition at line 42 of file SearchIndexField.php.

Referenced by WikitextContentHandler\getFieldsForSearchIndex().

FLAG_NO_INDEX

const SearchIndexField::FLAG_NO_INDEX = 8

Do not index this field, just store it.

Definition at line 46 of file SearchIndexField.php.

FLAG_SCORING

const SearchIndexField::FLAG_SCORING = 2

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

Definition at line 38 of file SearchIndexField.php.

Referenced by WikitextContentHandler\getFieldsForSearchIndex().

INDEX_TYPE_BOOL

const SearchIndexField::INDEX_TYPE_BOOL = 6

Definition at line 16 of file SearchIndexField.php.

INDEX_TYPE_DATETIME

const SearchIndexField::INDEX_TYPE_DATETIME = 4

Definition at line 14 of file SearchIndexField.php.

INDEX_TYPE_INTEGER

const SearchIndexField::INDEX_TYPE_INTEGER = 2

Definition at line 12 of file SearchIndexField.php.

Referenced by FileContentHandler\getFieldsForSearchIndex().

INDEX_TYPE_KEYWORD

const SearchIndexField::INDEX_TYPE_KEYWORD = 1

Definition at line 11 of file SearchIndexField.php.

Referenced by ContentHandler\getFieldsForSearchIndex(), FileContentHandler\getFieldsForSearchIndex(), and TextContentHandler\getFieldsForSearchIndex().

INDEX_TYPE_NESTED

const SearchIndexField::INDEX_TYPE_NESTED = 5

Definition at line 15 of file SearchIndexField.php.

Referenced by SearchIndexFieldTest\getMergeCases().

INDEX_TYPE_NUMBER

const SearchIndexField::INDEX_TYPE_NUMBER = 3

Definition at line 13 of file SearchIndexField.php.

INDEX_TYPE_SHORT_TEXT

const SearchIndexField::INDEX_TYPE_SHORT_TEXT = 7

SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.

Generally a language agnostic analysis chain is used and aggressive splitting to increase recall. E.g suited for mime/type

Definition at line 24 of file SearchIndexField.php.

Referenced by FileContentHandler\getFieldsForSearchIndex().

INDEX_TYPE_TEXT

const SearchIndexField::INDEX_TYPE_TEXT = 0

Field types.

Definition at line 10 of file SearchIndexField.php.

Referenced by ContentHandler\getFieldsForSearchIndex(), FileContentHandler\getFieldsForSearchIndex(), WikitextContentHandler\getFieldsForSearchIndex(), SearchEngineTest\hookSearchIndexFields(), and SearchEngineTest\testSearchIndexFields().

---

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

• includes/search/SearchIndexField.php