includes/search/SearchDatabase.php

   1 <?php
   2 /**
   3  * Database search engine
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Search
  22  */
  23
  24 /**
  25  * Base search engine base class for database-backed searches
  26  * @ingroup Search
  27  * @since 1.23
  28  */
  29 class SearchDatabase extends SearchEngine {
  30         /**
  31          * @var IDatabase Slave database for reading from for results
  32          */
  33         protected $db;
  34
  35         /**
  36          * Constructor
  37          * @param IDatabase $db The database to search from
  38          */
  39         public function __construct( IDatabase $db = null ) {
  40                 if ( $db ) {
  41                         $this->db = $db;
  42                 } else {
  43                         $this->db = wfGetDB( DB_REPLICA );
  44                 }
  45         }
  46
  47         /**
  48          * Return a 'cleaned up' search string
  49          *
  50          * @param string $text
  51          * @return string
  52          */
  53         protected function filter( $text ) {
  54                 $lc = $this->legalSearchChars();
  55                 return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
  56         }
  57 }