SearchDatabase Class Reference
Base search engine base class for database-backed searches. More...
Inheritance diagram for SearchDatabase:
Collaboration diagram for SearchDatabase:
Public Member Functions | |
| __construct (DatabaseBase $db=null) | |
| Constructor. More... | |
 Public Member Functions inherited from SearchEngine | |
| delete ( $id, $title) | |
| Delete an indexed page Title should be pre-processed. More... | |
| filter ( $text) | |
| Return a 'cleaned up' search string. 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... | |
| 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. 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... | |
| 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... | |
| 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 Attributes | |
| DatabaseBase | $db |
| Slave database for reading from for results. More... | |
| Protected Attributes inherited from SearchEngine | |
| Array | $features = array() |
| Feature values *. More... | |
| $showSuggestion = true | |
Additional Inherited Members | |
| 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 | getOpenSearchTemplate () |
| Get OpenSearch suggestion template. More... | |
| static | getSearchTypes () |
| Return the search engines we support. More... | |
| static | helpNamespaces () |
| Return the help namespaces to be shown on Special:Search. More... | |
| static | legalSearchChars () |
| static | namespacesAsText ( $namespaces) |
| Get a list of namespace names useful for showing in tooltips and preferences. 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... | |
| Public Attributes inherited from SearchEngine | |
| $limit = 10 | |
| $namespaces = array( NS_MAIN ) | |
| $offset = 0 | |
| $prefix = '' | |
| $searchTerms = array() | |
Detailed Description
Base search engine base class for database-backed searches.
- Since
- 1.23
Definition at line 29 of file SearchDatabase.php.
Constructor & Destructor Documentation
◆ __construct()
| SearchDatabase::__construct | ( | DatabaseBase | $db = null | ) |
Constructor.
- Parameters
-
DatabaseBase $db The database to search from
Definition at line 38 of file SearchDatabase.php.
Member Data Documentation
◆ $db
|
protected |
Slave database for reading from for results.
Definition at line 32 of file SearchDatabase.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/search/SearchDatabase.php
