MediaWiki REL1_34
SearchIndexField.php
Go to the documentation of this file.
1<?php
6interface SearchIndexField {
7 /*
8 * Field types
9 */
18 const INDEX_TYPE_TEXT = 'text';
23 const INDEX_TYPE_KEYWORD = 'keyword';
24 const INDEX_TYPE_INTEGER = 'integer';
25 const INDEX_TYPE_NUMBER = 'number';
26 const INDEX_TYPE_DATETIME = 'datetime';
27 const INDEX_TYPE_NESTED = 'nested';
28 const INDEX_TYPE_BOOL = 'bool';
29
36 const INDEX_TYPE_SHORT_TEXT = 'short_text';
37
44 const FLAG_CASEFOLD = 1;
45
51 const FLAG_SCORING = 2;
52
57
61 const FLAG_NO_INDEX = 8;
62
68 public function getMapping( SearchEngine $engine );
69
77 public function setFlag( $flag, $unset = false );
78
84 public function checkFlag( $flag );
85
92 public function merge( SearchIndexField $that );
93
109 public function getEngineHints( SearchEngine $engine );
110}
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.