MediaWiki  master
SearchIndexField.php
Go to the documentation of this file.
1 <?php
6 interface SearchIndexField {
7  /*
8  * Field types
9  */
18  public const INDEX_TYPE_TEXT = 'text';
23  public const INDEX_TYPE_KEYWORD = 'keyword';
24  public const INDEX_TYPE_INTEGER = 'integer';
25  public const INDEX_TYPE_NUMBER = 'number';
26  public const INDEX_TYPE_DATETIME = 'datetime';
27  public const INDEX_TYPE_NESTED = 'nested';
28  public const INDEX_TYPE_BOOL = 'bool';
29 
36  public const INDEX_TYPE_SHORT_TEXT = 'short_text';
37 
44  public const FLAG_CASEFOLD = 1;
45 
51  public const FLAG_SCORING = 2;
52 
56  public const FLAG_NO_HIGHLIGHT = 4;
57 
61  public 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 }
SearchIndexField\INDEX_TYPE_KEYWORD
const INDEX_TYPE_KEYWORD
KEYWORD fields are indexed without any processing, so are appropriate for e.g.
Definition: SearchIndexField.php:23
SearchIndexField\checkFlag
checkFlag( $flag)
Check if flag is set.
SearchIndexField\FLAG_SCORING
const FLAG_SCORING
This field contains secondary information, which is already present in other fields,...
Definition: SearchIndexField.php:51
SearchIndexField\INDEX_TYPE_DATETIME
const INDEX_TYPE_DATETIME
Definition: SearchIndexField.php:26
SearchIndexField\INDEX_TYPE_SHORT_TEXT
const INDEX_TYPE_SHORT_TEXT
SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.
Definition: SearchIndexField.php:36
SearchIndexField\getEngineHints
getEngineHints(SearchEngine $engine)
A list of search engine hints for this field.
SearchIndexField\INDEX_TYPE_NESTED
const INDEX_TYPE_NESTED
Definition: SearchIndexField.php:27
SearchIndexField\FLAG_NO_INDEX
const FLAG_NO_INDEX
Do not index this field, just store it.
Definition: SearchIndexField.php:61
SearchIndexField\FLAG_CASEFOLD
const FLAG_CASEFOLD
Generic field flags.
Definition: SearchIndexField.php:44
SearchIndexField\merge
merge(SearchIndexField $that)
Merge two field definitions if possible.
SearchIndexField\INDEX_TYPE_NUMBER
const INDEX_TYPE_NUMBER
Definition: SearchIndexField.php:25
SearchIndexField\FLAG_NO_HIGHLIGHT
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
Definition: SearchIndexField.php:56
SearchIndexField\setFlag
setFlag( $flag, $unset=false)
Set global flag for this field.
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:36
SearchIndexField\INDEX_TYPE_BOOL
const INDEX_TYPE_BOOL
Definition: SearchIndexField.php:28
SearchIndexField\INDEX_TYPE_INTEGER
const INDEX_TYPE_INTEGER
Definition: SearchIndexField.php:24
SearchIndexField
Definition of a mapping for the search index field.
Definition: SearchIndexField.php:6
SearchIndexField\getMapping
getMapping(SearchEngine $engine)
Get mapping for specific search engine.
SearchIndexField\INDEX_TYPE_TEXT
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming.
Definition: SearchIndexField.php:18