Merge "(bug 42089) meta=siteinfo should output the default content model"
[lhc/web/wiklou.git] / includes / search / SearchIBM_DB2.php
index d758718..368d900 100644 (file)
@@ -1,23 +1,25 @@
 <?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
-
 /**
+ * IBM DB2 search engine
+ *
+ * Copyright © 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
+ *
  * @file
  * @ingroup Search
  */
  * @ingroup Search
  */
 class SearchIBM_DB2 extends SearchEngine {
+
+       /**
+        * Creates an instance of this class
+        * @param $db DatabaseIbm_db2: database object
+        */
        function __construct($db) {
-               $this->db = $db;
+               parent::__construct( $db );
        }
 
        /**
@@ -84,7 +91,7 @@ class SearchIBM_DB2 extends SearchEngine {
         * Return a LIMIT clause to limit results on the query.
         * @return String
         */
-       function queryLimit($sql) {
+       function queryLimit( $sql ) {
                return $this->db->limitResult($sql, $this->limit, $this->offset);
        }
 
@@ -102,8 +109,9 @@ class SearchIBM_DB2 extends SearchEngine {
        /**
         * Construct the full SQL query to do the search.
         * The guts shoulds be constructed in queryMain()
-        * @param string $filteredTerm String
-        * @param bool $fulltext Boolean
+        * @param $filteredTerm String
+        * @param $fulltext Boolean
+        * @return String
         */
        function getQuery( $filteredTerm, $fulltext ) {
                return $this->queryLimit($this->queryMain($filteredTerm, $fulltext) . ' ' .
@@ -125,8 +133,8 @@ class SearchIBM_DB2 extends SearchEngine {
        /**
         * Get the base part of the search query.
         *
-        * @param string $filteredTerm String
-        * @param bool $fulltext Boolean
+        * @param $filteredTerm String
+        * @param $fulltext Boolean
         * @return String
         */
        function queryMain( $filteredTerm, $fulltext ) {
@@ -138,13 +146,15 @@ class SearchIBM_DB2 extends SearchEngine {
                        'WHERE page_id=si_page AND ' . $match;
        }
 
-       /** @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();
 
@@ -176,10 +186,10 @@ class SearchIBM_DB2 extends SearchEngine {
 
                $searchon = $this->db->strencode(join(',', $q));
                $field = $this->getIndexField($fulltext);
-               
+
                // requires Net Search Extender or equivalent
                //return " CONTAINS($field, '$searchon') > 0 ";
-               
+
                return " lcase($field) LIKE lcase('%$searchon%')";
        }