MediaWiki  master
SearchIndexField.php
Go to the documentation of this file.
1 <?php
10 interface SearchIndexField {
11  /*
12  * Field types
13  */
22  public const INDEX_TYPE_TEXT = 'text';
27  public const INDEX_TYPE_KEYWORD = 'keyword';
28  public const INDEX_TYPE_INTEGER = 'integer';
29  public const INDEX_TYPE_NUMBER = 'number';
30  public const INDEX_TYPE_DATETIME = 'datetime';
31  public const INDEX_TYPE_NESTED = 'nested';
32  public const INDEX_TYPE_BOOL = 'bool';
33 
40  public const INDEX_TYPE_SHORT_TEXT = 'short_text';
41 
48  public const FLAG_CASEFOLD = 1;
49 
55  public const FLAG_SCORING = 2;
56 
60  public const FLAG_NO_HIGHLIGHT = 4;
61 
65  public const FLAG_NO_INDEX = 8;
66 
72  public function getMapping( SearchEngine $engine );
73 
81  public function setFlag( $flag, $unset = false );
82 
88  public function checkFlag( $flag );
89 
96  public function merge( SearchIndexField $that );
97 
113  public function getEngineHints( SearchEngine $engine );
114 }
Contain a class for special pages.
Definition of a mapping for the search index field.
merge(SearchIndexField $that)
Merge two field definitions if possible.
const FLAG_SCORING
This field contains secondary information, which is already present in other fields,...
setFlag( $flag, $unset=false)
Set global flag for this field.
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming.
const INDEX_TYPE_SHORT_TEXT
SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.
const INDEX_TYPE_KEYWORD
KEYWORD fields are indexed without any processing, so are appropriate for e.g.
const FLAG_CASEFOLD
Generic field flags.
getEngineHints(SearchEngine $engine)
A list of search engine hints for this field.
getMapping(SearchEngine $engine)
Get mapping for specific search engine.
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
const FLAG_NO_INDEX
Do not index this field, just store it.
checkFlag( $flag)
Check if flag is set.