MediaWiki  master
SearchIndexField.php
Go to the documentation of this file.
1 <?php
6 interface 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 
56  const FLAG_NO_HIGHLIGHT = 4;
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 }
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming...
getEngineHints(SearchEngine $engine)
A list of search engine hints for this field.
merge(SearchIndexField $that)
Merge two field definitions if possible.
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
const FLAG_CASEFOLD
Generic field flags.
checkFlag( $flag)
Check if flag is set.
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2886
getMapping(SearchEngine $engine)
Get mapping for specific search engine.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const INDEX_TYPE_KEYWORD
KEYWORD fields are indexed without any processing, so are appropriate for e.g.
const FLAG_NO_INDEX
Do not index this field, just store it.
const FLAG_SCORING
This field contains secondary information, which is already present in other fields, but can be used for scoring.
Definition of a mapping for the search index field.
const INDEX_TYPE_SHORT_TEXT
SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.
setFlag( $flag, $unset=false)
Set global flag for this field.