Mark ApiQueryBase::getDirectionDescription as deprecated
authorBrad Jorsch <bjorsch@wikimedia.org>
Tue, 24 Nov 2015 15:06:56 +0000 (10:06 -0500)
committerBrad Jorsch <bjorsch@wikimedia.org>
Tue, 24 Nov 2015 15:06:56 +0000 (10:06 -0500)
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

RELEASE-NOTES-1.27
includes/api/ApiQueryBase.php

index 4a35948..4fcaca1 100644 (file)
@@ -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 ===
 
index 29fdfea..01968c2 100644 (file)
@@ -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.",
+               );
+       }
+
        /**@}*/
 }