MediaWiki  master
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. More...
 
 getEngineHints (SearchEngine $engine)
 A list of search engine hints for this field. More...
 
 getMapping (SearchEngine $engine)
 Get mapping for specific search engine. More...
 
 merge (SearchIndexField $that)
 Merge two field definitions if possible. More...
 
 setFlag ($flag, $unset=false)
 Set global flag for this field. More...
 

Public Attributes

const FLAG_CASEFOLD = 1
 Generic field flags. More...
 
const FLAG_NO_HIGHLIGHT = 4
 This field does not need highlight handling. More...
 
const FLAG_NO_INDEX = 8
 Do not index this field, just store it. More...
 
const FLAG_SCORING = 2
 This field contains secondary information, which is already present in other fields, but can be used for scoring. More...
 
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. More...
 
const INDEX_TYPE_TEXT = 0
 Field types. More...
 

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

SearchIndexField::checkFlag (   $flag)

Check if flag is set.

Parameters
$flag
Returns
int 0 if unset, !=0 if set

Implemented in SearchIndexFieldDefinition, and NullIndexField.

SearchIndexField::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

Implemented in SearchIndexFieldDefinition, and NullIndexField.

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 SearchIndexFieldDefinition, DummySearchIndexFieldDefinition, and NullIndexField.

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 SearchIndexFieldDefinition, and NullIndexField.

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

Set global flag for this field.

Parameters
int$flagBit flag to set/unset
bool$unsetTrue if flag should be unset, false by default
Returns
$this

Implemented in SearchIndexFieldDefinition, and NullIndexField.

Member Data Documentation

const SearchIndexField::FLAG_CASEFOLD = 1

Generic field flags.

This field is case-insensitive.

Definition at line 32 of file SearchIndexField.php.

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

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().

const SearchIndexField::FLAG_NO_INDEX = 8

Do not index this field, just store it.

Definition at line 46 of file SearchIndexField.php.

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().

const SearchIndexField::INDEX_TYPE_BOOL = 6

Definition at line 16 of file SearchIndexField.php.

const SearchIndexField::INDEX_TYPE_DATETIME = 4

Definition at line 14 of file SearchIndexField.php.

const SearchIndexField::INDEX_TYPE_INTEGER = 2

Definition at line 12 of file SearchIndexField.php.

Referenced by FileContentHandler\getFieldsForSearchIndex().

const SearchIndexField::INDEX_TYPE_KEYWORD = 1
const SearchIndexField::INDEX_TYPE_NESTED = 5

Definition at line 15 of file SearchIndexField.php.

Referenced by SearchIndexFieldTest\getMergeCases().

const SearchIndexField::INDEX_TYPE_NUMBER = 3

Definition at line 13 of file SearchIndexField.php.

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().


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