MediaWiki  master
SearchSqlite Class Reference

Search engine hook for SQLite. More...

Inheritance diagram for SearchSqlite:
Collaboration diagram for SearchSqlite:

Public Member Functions

 legalSearchChars ( $type=self::CHARS_ALL)
 
 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...
 
- Public Member Functions inherited from SearchDatabase
 __construct (ILoadBalancer $lb)
 
 doSearchText ( $term)
 
 doSearchTitle ( $term)
 
- Public Member Functions inherited from SearchEngine
 augmentSearchResults (ISearchResultSet $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...
 

Protected Member Functions

 doSearchTextInDB ( $term)
 Perform a full text search query and return a result set. More...
 
 doSearchTitleInDB ( $term)
 Perform a title-only search query and return a result set. More...
 
 searchInternal ( $term, $fulltext)
 
- Protected Member Functions inherited from SearchDatabase
 doSearchTextInDB ( $term)
 Perform a full text search query and return a result set. More...
 
 doSearchTitleInDB ( $term)
 Perform a title-only search query and return a result set. More...
 
 extractNamespacePrefix ( $term)
 Extract the optional namespace prefix and set self::namespaces accordingly and return the query string. More...
 
 filter ( $text)
 Return a 'cleaned up' search string. 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...
 

Private Member Functions

 fulltextSearchSupported ()
 Whether fulltext search is supported by current schema. More...
 
 getCountQuery ( $filteredTerm, $fulltext)
 
 getIndexField ( $fulltext)
 Picks which field to index on, depending on what type of query. More...
 
 getQuery ( $filteredTerm, $fulltext)
 Construct the full SQL query to do the search. More...
 
 limitResult ( $sql)
 Returns a query with limit for number of results set. More...
 
 parseQuery ( $filteredText, $fulltext)
 Parse the user's query and transform it into an SQL fragment which will become part of a WHERE clause. More...
 
 queryMain ( $filteredTerm, $fulltext)
 Get the base part of the search query. More...
 
 queryNamespaces ()
 Return a partial WHERE clause to limit the search to the given namespaces. More...
 
 regexTerm ( $string, $wildcard)
 

Additional Inherited Members

- 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...
 
- 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...
 
- Static Protected Member Functions inherited from SearchEngine
static defaultNearMatcher ()
 Get near matcher for default SearchEngine. More...
 
- Protected Attributes inherited from SearchDatabase
IDatabase $db
 (backwards compatibility) More...
 
ILoadBalancer $lb
 
string [] $searchTerms = []
 search terms More...
 
- Protected Attributes inherited from SearchEngine
array $features = []
 Feature values. More...
 
int $limit = 10
 
int $offset = 0
 
string [] $searchTerms = []
 
bool $showSuggestion = true
 

Detailed Description

Search engine hook for SQLite.

Definition at line 30 of file SearchSqlite.php.

Member Function Documentation

◆ doSearchTextInDB()

SearchSqlite::doSearchTextInDB (   $term)
protected

Perform a full text search query and return a result set.

Parameters
string$termRaw search term
Returns
SqlSearchResultSet|null

Definition at line 170 of file SearchSqlite.php.

References searchInternal().

◆ doSearchTitleInDB()

SearchSqlite::doSearchTitleInDB (   $term)
protected

Perform a title-only search query and return a result set.

Parameters
string$termRaw search term
Returns
SqlSearchResultSet|null

Definition at line 180 of file SearchSqlite.php.

References searchInternal().

◆ fulltextSearchSupported()

SearchSqlite::fulltextSearchSupported ( )
private

Whether fulltext search is supported by current schema.

Returns
bool

Definition at line 35 of file SearchSqlite.php.

References $dbr, and DB_REPLICA.

Referenced by searchInternal(), update(), and updateTitle().

◆ getCountQuery()

SearchSqlite::getCountQuery (   $filteredTerm,
  $fulltext 
)
private

Definition at line 273 of file SearchSqlite.php.

References $dbr, DB_REPLICA, parseQuery(), and queryNamespaces().

Referenced by searchInternal().

◆ getIndexField()

SearchSqlite::getIndexField (   $fulltext)
private

Picks which field to index on, depending on what type of query.

Parameters
bool$fulltext
Returns
string

Definition at line 252 of file SearchSqlite.php.

Referenced by parseQuery().

◆ getQuery()

SearchSqlite::getQuery (   $filteredTerm,
  $fulltext 
)
private

Construct the full SQL query to do the search.

The guts shoulds be constructed in queryMain()

Parameters
string$filteredTerm
bool$fulltext
Returns
string

Definition at line 240 of file SearchSqlite.php.

References limitResult(), queryMain(), and queryNamespaces().

Referenced by searchInternal().

◆ legalSearchChars()

SearchSqlite::legalSearchChars (   $type = self::CHARS_ALL)

Definition at line 155 of file SearchSqlite.php.

References $type.

Referenced by parseQuery().

◆ limitResult()

SearchSqlite::limitResult (   $sql)
private

Returns a query with limit for number of results set.

Parameters
string$sql
Returns
string

Definition at line 227 of file SearchSqlite.php.

References $dbr, and DB_REPLICA.

Referenced by getQuery().

◆ parseQuery()

SearchSqlite::parseQuery (   $filteredText,
  $fulltext 
)
private

Parse the user's query and transform it into an SQL fragment which will become part of a WHERE clause.

Parameters
string$filteredText
bool$fulltext
Returns
string

Definition at line 55 of file SearchSqlite.php.

References $dbr, DB_REPLICA, getIndexField(), legalSearchChars(), regexTerm(), and wfDebug().

Referenced by getCountQuery(), and queryMain().

◆ queryMain()

SearchSqlite::queryMain (   $filteredTerm,
  $fulltext 
)
private

Get the base part of the search query.

Parameters
string$filteredTerm
bool$fulltext
Returns
string

Definition at line 263 of file SearchSqlite.php.

References $dbr, DB_REPLICA, and parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchSqlite::queryNamespaces ( )
private

Return a partial WHERE clause to limit the search to the given namespaces.

Returns
string

Definition at line 209 of file SearchSqlite.php.

References $dbr, SearchEngine\$namespaces, and DB_REPLICA.

Referenced by getCountQuery(), and getQuery().

◆ regexTerm()

SearchSqlite::regexTerm (   $string,
  $wildcard 
)
private

Definition at line 138 of file SearchSqlite.php.

Referenced by parseQuery().

◆ searchInternal()

SearchSqlite::searchInternal (   $term,
  $fulltext 
)
protected

◆ update()

SearchSqlite::update (   $id,
  $title,
  $text 
)

Create or update the search index record for the given page.

Title and text should be pre-processed.

Parameters
int$id
string$title
string$text

Definition at line 292 of file SearchSqlite.php.

References $title, DB_MASTER, and fulltextSearchSupported().

◆ updateTitle()

SearchSqlite::updateTitle (   $id,
  $title 
)

Update a search index record's title only.

Title should be pre-processed.

Parameters
int$id
string$title

Definition at line 315 of file SearchSqlite.php.

References $title, DB_MASTER, and fulltextSearchSupported().


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