MediaWiki  1.33.0
SearchDatabase.php
Go to the documentation of this file.
1 <?php
25 
31 abstract class SearchDatabase extends SearchEngine {
35  protected $db;
36 
40  public function __construct( IDatabase $db = null ) {
41  if ( $db ) {
42  $this->db = $db;
43  } else {
44  $this->db = wfGetDB( DB_REPLICA );
45  }
46  }
47 
52  final public function doSearchText( $term ) {
53  return $this->doSearchTextInDB( $this->extractNamespacePrefix( $term ) );
54  }
55 
62  abstract protected function doSearchTextInDB( $term );
63 
68  final public function doSearchTitle( $term ) {
69  return $this->doSearchTitleInDB( $this->extractNamespacePrefix( $term ) );
70  }
71 
78  abstract protected function doSearchTitleInDB( $term );
79 
86  protected function filter( $text ) {
87  // List of chars allowed in the search query.
88  // This must include chars used in the search syntax.
89  // Usually " (phrase) or * (wildcards) if supported by the engine
90  $lc = $this->legalSearchChars( self::CHARS_ALL );
91  return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
92  }
93 
100  final protected function extractNamespacePrefix( $term ) {
101  $queryAndNs = self::parseNamespacePrefixes( $term );
102  if ( $queryAndNs === false ) {
103  return $term;
104  }
105  $this->namespaces = $queryAndNs[1];
106  return $queryAndNs[0];
107  }
108 }
SearchEngine\legalSearchChars
static legalSearchChars( $type=self::CHARS_ALL)
Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.
Definition: SearchEngine.php:291
SearchEngine\parseNamespacePrefixes
static parseNamespacePrefixes( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
Parse some common prefixes: all (search everything) or namespace names.
Definition: SearchEngine.php:402
php
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
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
SearchDatabase
Base search engine base class for database-backed searches.
Definition: SearchDatabase.php:31
SearchDatabase\__construct
__construct(IDatabase $db=null)
Definition: SearchDatabase.php:40
namespaces
to move a page</td >< td > &*You are moving the page across namespaces
Definition: All_system_messages.txt:2670
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2636
SearchDatabase\doSearchTitle
doSearchTitle( $term)
Definition: SearchDatabase.php:68
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
$term
whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2878
SearchDatabase\extractNamespacePrefix
extractNamespacePrefix( $term)
Extract the optional namespace prefix and set self::namespaces accordingly and return the query strin...
Definition: SearchDatabase.php:100
SearchDatabase\doSearchText
doSearchText( $term)
Definition: SearchDatabase.php:52
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:34
SearchDatabase\$db
IDatabase $db
Replica database from which to read results.
Definition: SearchDatabase.php:35
SearchDatabase\doSearchTextInDB
doSearchTextInDB( $term)
Perform a full text search query and return a result set.
SearchDatabase\doSearchTitleInDB
doSearchTitleInDB( $term)
Perform a title-only search query and return a result set.
SearchDatabase\filter
filter( $text)
Return a 'cleaned up' search string.
Definition: SearchDatabase.php:86