MediaWiki  master
MockCompletionSearchEngine Class Reference

SearchEngine implementation for returning mocked completion search results. More...

Inheritance diagram for MockCompletionSearchEngine:
Collaboration diagram for MockCompletionSearchEngine:

Public Member Functions

 completionSearchBackend ( $search)
 
- Public Member Functions inherited from SearchEngine
 augmentSearchResults (SearchResultSet $resultSet)
 Augment search results with extra data. More...
 
 completionSearch ( $search)
 Perform a completion search. More...
 
 completionSearchWithVariants ( $search)
 Perform a completion search with variants. More...
 
 defaultPrefixSearch ( $search)
 Simple prefix search for subpages. More...
 
 delete ( $id, $title)
 Delete an indexed page Title should be pre-processed. More...
 
 extractTitles (SearchSuggestionSet $completionResults)
 Extract titles from completion results. More...
 
 getFeatureData ( $feature)
 Way to retrieve custom data set by setFeatureData or by the engine itself. More...
 
 getNearMatcher (Config $config)
 Get service class to finding near matches. More...
 
 getProfiles ( $profileType, User $user=null)
 Get a list of supported profiles. More...
 
 getSearchIndexFields ()
 Get fields for search index. More...
 
 getSort ()
 Get the sort direction of the search results. More...
 
 getTextFromContent (Title $t, Content $c=null)
 Get the raw text for updating the index from a content object Nicer search backends could possibly do something cooler than just returning raw text. More...
 
 getValidSorts ()
 Get the valid sort directions. More...
 
 legalSearchChars ( $type=self::CHARS_ALL)
 Get chars legal for search. More...
 
 makeSearchFieldMapping ( $name, $type)
 Create a search field definition. More...
 
 normalizeText ( $string)
 When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index. More...
 
 replacePrefixes ( $query)
 Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces of this class accordingly. More...
 
 searchArchiveTitle ( $term)
 Perform a title search in the article archive. More...
 
 searchText ( $term)
 Perform a full text search query and return a result set. More...
 
 searchTitle ( $term)
 Perform a title-only search query and return a result set. More...
 
 setFeatureData ( $feature, $data)
 Way to pass custom data for engines. More...
 
 setLimitOffset ( $limit, $offset=0)
 Set the maximum number of results to return and how many to skip before returning the first. More...
 
 setNamespaces ( $namespaces)
 Set which namespaces the search should include. More...
 
 setShowSuggestion ( $showSuggestion)
 Set whether the searcher should try to build a suggestion. More...
 
 setSort ( $sort)
 Set the sort direction of the search results. More...
 
 supports ( $feature)
 
 textAlreadyUpdatedForIndex ()
 If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() and doesn't require SearchUpdate::updateText()'s rather silly handling, it should return true here instead. More...
 
 update ( $id, $title, $text)
 Create or update the search index record for the given page. More...
 
 updateTitle ( $id, $title)
 Update a search index record's title only. More...
 

Static Public Member Functions

static addMockResults ( $query, array $result)
 Allows returning arbitrary lists of titles for completion search. More...
 
static clearMockResults ()
 Reset any mocked results. More...
 
- Static Public Member Functions inherited from SearchEngine
static parseNamespacePrefixes ( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
 Parse some common prefixes: all (search everything) or namespace names. More...
 
static userHighlightPrefs ()
 Find snippet highlight settings for all users. More...
 

Static Private Attributes

static string [][] $results = []
 

Additional Inherited Members

- Public Attributes inherited from SearchEngine
int [] null $namespaces = [ NS_MAIN ]
 
string $prefix = ''
 
const CHARS_ALL = 1
 Integer flag for legalSearchChars: includes all chars allowed in a search query. More...
 
const CHARS_NO_SYNTAX = 2
 Integer flag for legalSearchChars: includes all chars allowed in a search term. More...
 
const COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
 Profile type for completionSearch. More...
 
const DEFAULT_SORT = 'relevance'
 
const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
 Profile type for query independent ranking features. More...
 
- Protected Member Functions inherited from SearchEngine
 completionSearchBackend ( $search)
 Perform a completion search. More...
 
 completionSearchBackendOverfetch ( $search)
 Perform an overfetch of completion search results. More...
 
 doSearchArchiveTitle ( $term)
 Perform a title search in the article archive. More...
 
 doSearchText ( $term)
 Perform a full text search query and return a result set. More...
 
 doSearchTitle ( $term)
 Perform a title-only search query and return a result set. More...
 
 normalizeNamespaces ( $search)
 Makes search simple string if it was namespaced. More...
 
 processCompletionResults ( $search, SearchSuggestionSet $suggestions)
 Process completion search results. More...
 
 simplePrefixSearch ( $search)
 Call out to simple search backend. More...
 
- Static Protected Member Functions inherited from SearchEngine
static defaultNearMatcher ()
 Get near matcher for default SearchEngine. More...
 
- Protected Attributes inherited from SearchEngine
array $features = []
 Feature values. More...
 
int $limit = 10
 
int $offset = 0
 
array string $searchTerms = []
 
bool $showSuggestion = true
 

Detailed Description

SearchEngine implementation for returning mocked completion search results.

Definition at line 6 of file MockCompletionSearchEngine.php.

Member Function Documentation

◆ addMockResults()

static MockCompletionSearchEngine::addMockResults (   $query,
array  $result 
)
static

Allows returning arbitrary lists of titles for completion search.

Provided results will be sliced based on offset/limit of query.

For results to exit the search engine they must pass Title::isKnown. Injecting into link cache is not enough, as LinkBatch will mark them bad, they need to be injected into the DB.

Parameters
string$querySearch term as seen in completionSearchBackend
string[]$result List of titles to respond to query with

Definition at line 28 of file MockCompletionSearchEngine.php.

References Title\newFromText().

Referenced by ApiQueryPrefixSearchTest\setUp(), and SearchEngineTest\testFiltersMissing().

◆ clearMockResults()

static MockCompletionSearchEngine::clearMockResults ( )
static

Reset any mocked results.

Definition at line 13 of file MockCompletionSearchEngine.php.

Referenced by ApiQueryPrefixSearchTest\setUp().

◆ completionSearchBackend()

MockCompletionSearchEngine::completionSearchBackend (   $search)

Member Data Documentation

◆ $results

string [][] MockCompletionSearchEngine::$results = []
staticprivate

Definition at line 8 of file MockCompletionSearchEngine.php.


The documentation for this class was generated from the following file: