From b037a852f842b2f79bef84f373c7dabdec90e839 Mon Sep 17 00:00:00 2001
From: Umherirrender <umherirrender_de.wp@web.de>
Date: Fri, 5 Jul 2019 22:14:51 +0200
Subject: [PATCH] Document SearchDatabase::doSearchTextInDB to return null

The function calling this abstract function allows to return null,
so it should be okay to return null here

The null for empty result in SearchOracle

Change-Id: I66a8fb3a4190bf5506f358a47f6f4833b1715c7f
---
 includes/search/SearchDatabase.php | 4 ++--
 includes/search/SearchMssql.php    | 4 ++--
 includes/search/SearchMySQL.php    | 4 ++--
 includes/search/SearchOracle.php   | 8 ++++----
 includes/search/SearchSqlite.php   | 4 ++--
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/includes/search/SearchDatabase.php b/includes/search/SearchDatabase.php
index 8ea356f77a..c444958fb5 100644
--- a/includes/search/SearchDatabase.php
+++ b/includes/search/SearchDatabase.php
@@ -61,7 +61,7 @@ abstract class SearchDatabase extends SearchEngine {
 	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	abstract protected function doSearchTextInDB( $term );
 
@@ -77,7 +77,7 @@ abstract class SearchDatabase extends SearchEngine {
 	 * Perform a title-only search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	abstract protected function doSearchTitleInDB( $term );
 
diff --git a/includes/search/SearchMssql.php b/includes/search/SearchMssql.php
index 6a23bb344f..3c0675fd78 100644
--- a/includes/search/SearchMssql.php
+++ b/includes/search/SearchMssql.php
@@ -33,7 +33,7 @@ class SearchMssql extends SearchDatabase {
 	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTextInDB( $term ) {
 		$dbr = $this->lb->getConnectionRef( DB_REPLICA );
@@ -46,7 +46,7 @@ class SearchMssql extends SearchDatabase {
 	 * Perform a title-only search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTitleInDB( $term ) {
 		$dbr = $this->lb->getConnectionRef( DB_REPLICA );
diff --git a/includes/search/SearchMySQL.php b/includes/search/SearchMySQL.php
index 4a6b93b209..ff213673f7 100644
--- a/includes/search/SearchMySQL.php
+++ b/includes/search/SearchMySQL.php
@@ -163,7 +163,7 @@ class SearchMySQL extends SearchDatabase {
 	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTextInDB( $term ) {
 		return $this->searchInternal( $term, true );
@@ -173,7 +173,7 @@ class SearchMySQL extends SearchDatabase {
 	 * Perform a title-only search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTitleInDB( $term ) {
 		return $this->searchInternal( $term, false );
diff --git a/includes/search/SearchOracle.php b/includes/search/SearchOracle.php
index a5d351bcd7..e8c0eb6132 100644
--- a/includes/search/SearchOracle.php
+++ b/includes/search/SearchOracle.php
@@ -64,11 +64,11 @@ class SearchOracle extends SearchDatabase {
 	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTextInDB( $term ) {
 		if ( $term == '' ) {
-			return new SqlSearchResultSet( false, '' );
+			return null;
 		}
 
 		$dbr = $this->lb->getConnectionRef( DB_REPLICA );
@@ -80,11 +80,11 @@ class SearchOracle extends SearchDatabase {
 	 * Perform a title-only search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTitleInDB( $term ) {
 		if ( $term == '' ) {
-			return new SqlSearchResultSet( false, '' );
+			return null;
 		}
 
 		$dbr = $this->lb->getConnectionRef( DB_REPLICA );
diff --git a/includes/search/SearchSqlite.php b/includes/search/SearchSqlite.php
index 3646b274ed..459a229f1e 100644
--- a/includes/search/SearchSqlite.php
+++ b/includes/search/SearchSqlite.php
@@ -161,7 +161,7 @@ class SearchSqlite extends SearchDatabase {
 	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTextInDB( $term ) {
 		return $this->searchInternal( $term, true );
@@ -171,7 +171,7 @@ class SearchSqlite extends SearchDatabase {
 	 * Perform a title-only search query and return a result set.
 	 *
 	 * @param string $term Raw search term
-	 * @return SqlSearchResultSet
+	 * @return SqlSearchResultSet|null
 	 */
 	protected function doSearchTitleInDB( $term ) {
 		return $this->searchInternal( $term, false );
-- 
2.20.1