MediaWiki  REL1_31
SearchSqlite Class Reference

Search engine hook for SQLite. More...

Inheritance diagram for SearchSqlite:
Collaboration diagram for SearchSqlite:

Public 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)
 
 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...
 
 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 (IDatabase $db=null)
 
- 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...
 
 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...
 
 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...
 
 transformSearchTerm ( $term)
 Transform search term in cases when parts of the query came as different GET params (when supported), e.g. More...
 

Static Public Member Functions

static legalSearchChars ( $type=self::CHARS_ALL)
 Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure. More...
 
- Static Public Member Functions inherited from SearchEngine
static create ( $type=null)
 Load up the appropriate search engine class for the currently active database backend, and return a configured instance. More...
 
static defaultNamespaces ()
 An array of namespaces indexes to be searched by default. More...
 
static getNearMatch ( $searchterm)
 If an exact title match can be found, or a very slightly close match, return the title. More...
 
static getNearMatchResultSet ( $searchterm)
 Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet. More...
 
static getSearchTypes ()
 Return the search engines we support. More...
 
static namespacesAsText ( $namespaces)
 Get a list of namespace names useful for showing in tooltips and preferences. More...
 
static parseNamespacePrefixes ( $query)
 Parse some common prefixes: all (search everything) or namespace names. More...
 
static searchableNamespaces ()
 Make a list of searchable namespaces and their canonical names. More...
 
static userHighlightPrefs ()
 Find snippet highlight settings for all users. More...
 
static userNamespaces ( $user)
 Extract default namespaces to search from the given user's settings, returning a list of index numbers. More...
 

Protected Member Functions

 searchInternal ( $term, $fulltext)
 
- Protected Member Functions inherited from SearchDatabase
 filter ( $text)
 Return a 'cleaned up' search string. More...
 
- Protected Member Functions inherited from SearchEngine
 completionSearchBackend ( $search)
 Perform a completion search. 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...
 

Additional Inherited Members

- Public Attributes inherited from SearchEngine
int[] null $namespaces = [ NS_MAIN ]
 
string $prefix = ''
 
const CHARS_ALL = 1
 @const int flag for legalSearchChars: includes all chars allowed in a search query More...
 
const CHARS_NO_SYNTAX = 2
 @const int flag for legalSearchChars: includes all chars allowed in a search term More...
 
const COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
 @const string profile type for completionSearch More...
 
const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
 @const string 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
 Slave database for reading from for results. 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

Search engine hook for SQLite.

Definition at line 28 of file SearchSqlite.php.

Member Function Documentation

◆ fulltextSearchSupported()

SearchSqlite::fulltextSearchSupported ( )

Whether fulltext search is supported by current schema.

Returns
bool

Definition at line 33 of file SearchSqlite.php.

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

◆ getCountQuery()

SearchSqlite::getCountQuery (   $filteredTerm,
  $fulltext 
)

Definition at line 258 of file SearchSqlite.php.

References parseQuery(), and queryNamespaces().

Referenced by searchInternal().

◆ getIndexField()

SearchSqlite::getIndexField (   $fulltext)

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

Parameters
bool$fulltext
Returns
string

Definition at line 238 of file SearchSqlite.php.

Referenced by parseQuery().

◆ getQuery()

SearchSqlite::getQuery (   $filteredTerm,
  $fulltext 
)

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 226 of file SearchSqlite.php.

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

Referenced by searchInternal().

◆ legalSearchChars()

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

Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.

Parameters
int$typetype of search chars (see self::CHARS_ALL and self::CHARS_NO_SYNTAX). Defaults to CHARS_ALL
Returns
string

Reimplemented from SearchEngine.

Definition at line 144 of file SearchSqlite.php.

References $type.

Referenced by parseQuery().

◆ limitResult()

SearchSqlite::limitResult (   $sql)

Returns a query with limit for number of results set.

Parameters
string$sql
Returns
string

Definition at line 215 of file SearchSqlite.php.

Referenced by getQuery().

◆ parseQuery()

SearchSqlite::parseQuery (   $filteredText,
  $fulltext 
)

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 45 of file SearchSqlite.php.

References $term, $wgContLang, as, getIndexField(), global, legalSearchChars(), list, regexTerm(), and wfDebug().

Referenced by getCountQuery(), and queryMain().

◆ queryMain()

SearchSqlite::queryMain (   $filteredTerm,
  $fulltext 
)

Get the base part of the search query.

Parameters
string$filteredTerm
bool$fulltext
Returns
string

Definition at line 249 of file SearchSqlite.php.

References parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchSqlite::queryNamespaces ( )

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

Returns
string

Definition at line 198 of file SearchSqlite.php.

References SearchEngine\$namespaces, and namespaces.

Referenced by getCountQuery(), and getQuery().

◆ regexTerm()

SearchSqlite::regexTerm (   $string,
  $wildcard 
)

Definition at line 125 of file SearchSqlite.php.

References $wgContLang, and global.

Referenced by parseQuery().

◆ searchInternal()

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

◆ searchText()

SearchSqlite::searchText (   $term)

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

Parameters
string$termRaw search term
Returns
SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 159 of file SearchSqlite.php.

References $term, and searchInternal().

◆ searchTitle()

SearchSqlite::searchTitle (   $term)

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

Parameters
string$termRaw search term
Returns
SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 169 of file SearchSqlite.php.

References $term, and searchInternal().

◆ 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

Reimplemented from SearchEngine.

Definition at line 276 of file SearchSqlite.php.

References $title, DB_MASTER, fulltextSearchSupported(), and wfGetDB().

◆ updateTitle()

SearchSqlite::updateTitle (   $id,
  $title 
)

Update a search index record's title only.

Title should be pre-processed.

Parameters
int$id
string$title

Reimplemented from SearchEngine.

Definition at line 301 of file SearchSqlite.php.

References $title, DB_MASTER, fulltextSearchSupported(), and wfGetDB().


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