<?php
-# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
-# http://www.mediawiki.org/
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * Mssql search engine
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Search
+ */
/**
* Search engine hook base class for Mssql (ConText).
- * @addtogroup Search
+ * @ingroup Search
*/
class SearchMssql extends SearchEngine {
+ /**
+ * Creates an instance of this class
+ * @param $db DatabaseMssql: database object
+ */
function __construct( $db ) {
- $this->db = $db;
+ parent::__construct( $db );
}
/**
* Perform a full text search query and return a result set.
*
- * @param string $term - Raw search term
+ * @param $term String: raw search term
* @return MssqlSearchResultSet
* @access public
*/
/**
* Perform a title-only search query and return a result set.
*
- * @param string $term - Raw search term
+ * @param $term String: raw search term
* @return MssqlSearchResultSet
* @access public
*/
/**
* Return a partial WHERE clause to exclude redirects, if so set
- * @return string
+ *
+ * @return String
* @private
*/
function queryRedirect() {
/**
* Return a partial WHERE clause to limit the search to the given namespaces
- * @return string
- * @private
+ *
+ * @return String
+ * @private
*/
function queryNamespaces() {
$namespaces = implode( ',', $this->namespaces );
/**
* Return a LIMIT clause to limit results on the query.
- * @return string
- * @private
+ *
+ * @param $sql string
+ *
+ * @return String
*/
function queryLimit( $sql ) {
return $this->db->limitResult( $sql, $this->limit, $this->offset );
/**
* Does not do anything for generic search engine
* subclasses may define this though
- * @return string
- * @private
+ *
+ * @return String
*/
function queryRanking( $filteredTerm, $fulltext ) {
return ' ORDER BY ftindex.[RANK] DESC'; // return ' ORDER BY score(1)';
/**
* Construct the full SQL query to do the search.
* The guts shoulds be constructed in queryMain()
- * @param string $filteredTerm
- * @param bool $fulltext
- * @private
+ *
+ * @param $filteredTerm String
+ * @param $fulltext Boolean
+ * @return String
*/
function getQuery( $filteredTerm, $fulltext ) {
return $this->queryLimit( $this->queryMain( $filteredTerm, $fulltext ) . ' ' .
$this->queryRanking( $filteredTerm, $fulltext ) . ' ' );
}
-
/**
* Picks which field to index on, depending on what type of query.
- * @param bool $fulltext
+ *
+ * @param $fulltext Boolean
* @return string
*/
function getIndexField( $fulltext ) {
/**
* Get the base part of the search query.
*
- * @param string $filteredTerm
- * @param bool $fulltext
- * @return string
+ * @param $filteredTerm String
+ * @param $fulltext Boolean
+ * @return String
* @private
*/
function queryMain( $filteredTerm, $fulltext ) {
$match = $this->parseQuery( $filteredTerm, $fulltext );
$page = $this->db->tableName( 'page' );
$searchindex = $this->db->tableName( 'searchindex' );
-
+
return 'SELECT page_id, page_namespace, page_title, ftindex.[RANK]' .
"FROM $page,FREETEXTTABLE($searchindex , $match, LANGUAGE 'English') as ftindex " .
'WHERE page_id=ftindex.[KEY] ';
}
- /** @todo document */
+ /** @todo document
+ * @return string
+ */
function parseQuery( $filteredText, $fulltext ) {
global $wgContLang;
$lc = SearchEngine::legalSearchChars();
$this->searchTerms = array();
- # FIXME: This doesn't handle parenthetical expressions.
+ # @todo FIXME: This doesn't handle parenthetical expressions.
$m = array();
$q = array();
* Create or update the search index record for the given page.
* Title and text should be pre-processed.
*
- * @param int $id
- * @param string $title
- * @param string $text
+ * @param $id Integer
+ * @param $title String
+ * @param $text String
+ * @return bool|ResultWrapper
*/
function update( $id, $title, $text ) {
// We store the column data as UTF-8 byte order marked binary stream
- // because we are invoking the plain text IFilter on it so that, and we want it
+ // because we are invoking the plain text IFilter on it so that, and we want it
// to properly decode the stream as UTF-8. SQL doesn't support UTF8 as a data type
// but the indexer will correctly handle it by this method. Since all we are doing
// is passing this data to the indexer and never retrieving it via PHP, this will save space
* Update a search index record's title only.
* Title should be pre-processed.
*
- * @param int $id
- * @param string $title
+ * @param $id Integer
+ * @param $title String
+ * @return bool|ResultWrapper
*/
function updateTitle( $id, $title ) {
$table = $this->db->tableName( 'searchindex' );
}
/**
- * @addtogroup Search
+ * @ingroup Search
*/
class MssqlSearchResultSet extends SearchResultSet {
function __construct( $resultSet, $terms ) {
dépôts / lhc / web / wiklou.git / blobdiff