API: ApiBase::PROP_* constants are deprecated
authorBrad Jorsch <bjorsch@wikimedia.org>
Wed, 24 Sep 2014 15:42:22 +0000 (11:42 -0400)
committerBrad Jorsch <bjorsch@wikimedia.org>
Wed, 24 Sep 2014 15:42:22 +0000 (11:42 -0400)
They should have been marked so along with Ie11a401d.

Change-Id: I029f81dabf89c1765fc514579f44a6a0c940b572

RELEASE-NOTES-1.24
includes/api/ApiBase.php

index 8733f94..43e0ae5 100644 (file)
@@ -350,6 +350,12 @@ production.
   * ApiFormatWddx
   * ApiFormatYaml
   * ApiTokens
+* The following class constants have been deprecated and may be removed in a
+  future release:
+  * ApiBase::PROP_ROOT
+  * ApiBase::PROP_LIST
+  * ApiBase::PROP_TYPE
+  * ApiBase::PROP_NULLABLE
 
 === Languages updated in 1.24 ===
 
index eafa9cc..7bc3f71 100644 (file)
@@ -65,16 +65,6 @@ abstract class ApiBase extends ContextSource {
        // Only applies if TYPE='integer' Use with extreme caution
        const PARAM_RANGE_ENFORCE = 9;
 
-       // Name of property group that is on the root element of the result,
-       // i.e. not part of a list
-       const PROP_ROOT = 'ROOT';
-       // Boolean, is the result multiple items? Defaults to true for query modules,
-       // to false for other modules
-       const PROP_LIST = 'LIST';
-       const PROP_TYPE = 0; // Type of the property, uses same format as PARAM_TYPE
-       // Boolean, can the property be not included in the result? Defaults to false
-       const PROP_NULLABLE = 1;
-
        const LIMIT_BIG1 = 500; // Fast query, std user limit
        const LIMIT_BIG2 = 5000; // Fast query, bot/sysop limit
        const LIMIT_SML1 = 50; // Slow query, std user limit
@@ -2245,6 +2235,15 @@ abstract class ApiBase extends ContextSource {
         * @{
         */
 
+       /// @deprecated since 1.24
+       const PROP_ROOT = 'ROOT';
+       /// @deprecated since 1.24
+       const PROP_LIST = 'LIST';
+       /// @deprecated since 1.24
+       const PROP_TYPE = 0;
+       /// @deprecated since 1.24
+       const PROP_NULLABLE = 1;
+
        /**
         * Formerly returned a string that identifies the version of the extending
         * class. Typically included the class name, the svn revision, timestamp,