MediaWiki
master
SearchIndexField.php
Go to the documentation of this file.
1
<?php
11
namespace
MediaWiki\Search
;
12
13
interface
SearchIndexField
{
14
/*
15
* Field types
16
*/
25
public
const
INDEX_TYPE_TEXT
=
'text'
;
30
public
const
INDEX_TYPE_KEYWORD
=
'keyword'
;
31
public
const
INDEX_TYPE_INTEGER
=
'integer'
;
32
public
const
INDEX_TYPE_NUMBER
=
'number'
;
33
public
const
INDEX_TYPE_DATETIME
=
'datetime'
;
34
public
const
INDEX_TYPE_NESTED
=
'nested'
;
35
public
const
INDEX_TYPE_BOOL
=
'bool'
;
36
43
public
const
INDEX_TYPE_SHORT_TEXT
=
'short_text'
;
44
51
public
const
FLAG_CASEFOLD
= 1;
52
58
public
const
FLAG_SCORING
= 2;
59
63
public
const
FLAG_NO_HIGHLIGHT
= 4;
64
68
public
const
FLAG_NO_INDEX
= 8;
69
75
public
function
getMapping
(
SearchEngine
$engine );
76
84
public
function
setFlag
( $flag, $unset =
false
);
85
91
public
function
checkFlag
( $flag );
92
99
public
function
merge
(
SearchIndexField
$that );
100
116
public
function
getEngineHints
(
SearchEngine
$engine );
117
}
118
120
class_alias( SearchIndexField::class,
'SearchIndexField'
);
MediaWiki\Search\SearchEngine
Contain a class for special pages.
Definition
SearchEngine.php:33
MediaWiki\Search\SearchIndexField
Definition
SearchIndexField.php:13
MediaWiki\Search\SearchIndexField\getEngineHints
getEngineHints(SearchEngine $engine)
A list of search engine hints for this field.
MediaWiki\Search\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:43
MediaWiki\Search\SearchIndexField\FLAG_SCORING
const FLAG_SCORING
This field contains secondary information, which is already present in other fields,...
Definition
SearchIndexField.php:58
MediaWiki\Search\SearchIndexField\checkFlag
checkFlag( $flag)
Check if flag is set.
MediaWiki\Search\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:25
MediaWiki\Search\SearchIndexField\FLAG_NO_INDEX
const FLAG_NO_INDEX
Do not index this field, just store it.
Definition
SearchIndexField.php:68
MediaWiki\Search\SearchIndexField\FLAG_CASEFOLD
const FLAG_CASEFOLD
Generic field flags.
Definition
SearchIndexField.php:51
MediaWiki\Search\SearchIndexField\getMapping
getMapping(SearchEngine $engine)
Get mapping for specific search engine.
MediaWiki\Search\SearchIndexField\INDEX_TYPE_INTEGER
const INDEX_TYPE_INTEGER
Definition
SearchIndexField.php:31
MediaWiki\Search\SearchIndexField\FLAG_NO_HIGHLIGHT
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
Definition
SearchIndexField.php:63
MediaWiki\Search\SearchIndexField\merge
merge(SearchIndexField $that)
Merge two field definitions if possible.
MediaWiki\Search\SearchIndexField\INDEX_TYPE_NUMBER
const INDEX_TYPE_NUMBER
Definition
SearchIndexField.php:32
MediaWiki\Search\SearchIndexField\INDEX_TYPE_BOOL
const INDEX_TYPE_BOOL
Definition
SearchIndexField.php:35
MediaWiki\Search\SearchIndexField\INDEX_TYPE_KEYWORD
const INDEX_TYPE_KEYWORD
KEYWORD fields are indexed without any processing, so are appropriate for e.g.
Definition
SearchIndexField.php:30
MediaWiki\Search\SearchIndexField\setFlag
setFlag( $flag, $unset=false)
Set global flag for this field.
MediaWiki\Search\SearchIndexField\INDEX_TYPE_DATETIME
const INDEX_TYPE_DATETIME
Definition
SearchIndexField.php:33
MediaWiki\Search\SearchIndexField\INDEX_TYPE_NESTED
const INDEX_TYPE_NESTED
Definition
SearchIndexField.php:34
MediaWiki\Search
Definition of a mapping for the search index field.
Definition
BaseSearchResultSet.php:3
includes
Search
SearchIndexField.php
Generated on Fri Jan 23 2026 03:26:21 for MediaWiki by
1.10.0