From: Brad Jorsch <bjorsch@wikimedia.org>
Date: Tue, 24 Nov 2015 15:06:56 +0000 (-0500)
Subject: Mark ApiQueryBase::getDirectionDescription as deprecated
X-Git-Tag: 1.31.0-rc.0~8893^2
X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=3812a3042339e58a35984ab729aa05f1b90534c3;p=lhc%2Fweb%2Fwiklou.git

Mark ApiQueryBase::getDirectionDescription as deprecated

This should have been marked as deprecated in 1.25 when
ApiBase::getParamDescription was deprecated, since that's its only use,
but it was overlooked at the time.

Change-Id: Ifd67c3e11188adebd3b6218df79a9dde967c4e17
---

diff --git a/RELEASE-NOTES-1.27 b/RELEASE-NOTES-1.27
index 4a35948bb5..4fcaca1754 100644
--- a/RELEASE-NOTES-1.27
+++ b/RELEASE-NOTES-1.27
@@ -115,6 +115,9 @@ production.
 ** ApiFormatDbg
 ** ApiFormatTxt
 ** ApiFormatYaml
+* ApiQueryBase::getDirectionDescription is now marked as deprecated. It should
+  have been so marked since 1.25 when ApiBase::getParamDescription was
+  deprecated, but was overlooked at the time.
 
 === Languages updated in 1.27 ===
 
diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php
index 29fdfea679..01968c2a4f 100644
--- a/includes/api/ApiQueryBase.php
+++ b/includes/api/ApiQueryBase.php
@@ -550,21 +550,6 @@ abstract class ApiQueryBase extends ApiBase {
 		return array( $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) );
 	}
 
-	/**
-	 * Gets the personalised direction parameter description
-	 *
-	 * @param string $p ModulePrefix
-	 * @param string $extraDirText Any extra text to be appended on the description
-	 * @return array
-	 */
-	public function getDirectionDescription( $p = '', $extraDirText = '' ) {
-		return array(
-			"In which direction to enumerate{$extraDirText}",
-			" newer          - List oldest first. Note: {$p}start has to be before {$p}end.",
-			" older          - List newest first (default). Note: {$p}start has to be later than {$p}end.",
-		);
-	}
-
 	/**
 	 * @param string $hash
 	 * @return bool
@@ -679,6 +664,22 @@ abstract class ApiQueryBase extends ApiBase {
 		return substr( $this->keyToTitle( $keyPart . 'x' ), 0, -1 );
 	}
 
+	/**
+	 * Gets the personalised direction parameter description
+	 *
+	 * @deprecated since 1.25 along with ApiBase::getParamDescription
+	 * @param string $p ModulePrefix
+	 * @param string $extraDirText Any extra text to be appended on the description
+	 * @return array
+	 */
+	public function getDirectionDescription( $p = '', $extraDirText = '' ) {
+		return array(
+			"In which direction to enumerate{$extraDirText}",
+			" newer          - List oldest first. Note: {$p}start has to be before {$p}end.",
+			" older          - List newest first (default). Note: {$p}start has to be later than {$p}end.",
+		);
+	}
+
 	/**@}*/
 }