From c361cb74fad3caff81d831f997fc08ccc78f1d6b Mon Sep 17 00:00:00 2001
From: Yuri Astrakhan <yurik@wikimedia.org>
Date: Sat, 27 Sep 2014 19:58:11 -0400
Subject: [PATCH] Added missing JsonFormat::parse() RELEASE NOTES, fixed docs

Constant values were changed to be above 0xFF - this way
we can easily decide to allow depth-parsing-limit to be OR-able:

  FormatJson::parse( $value, 30 | FormatJson::FORCE_ASSOC )

Follows-up Ic0eb0a7 and I1c4f37a.

Change-Id: I9bfd67a5ca4ea1d399821549c7e63ffdecd56ad1
---
 RELEASE-NOTES-1.24           |  1 +
 includes/json/FormatJson.php | 18 ++++++++++--------
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/RELEASE-NOTES-1.24 b/RELEASE-NOTES-1.24
index becc5a9f3f..1f4fcfee13 100644
--- a/RELEASE-NOTES-1.24
+++ b/RELEASE-NOTES-1.24
@@ -193,6 +193,7 @@ production.
 * (bug 69418) A MultiConfig implementation was added that supports fallback
   to multiple Config instances.
 * Update CSSJanus to v1.1.0.
+* Added FormatJson::parse() returning status with result or localized error message
 
 === Bug fixes in 1.24 ===
 * (bug 50572) MediaWiki:Blockip should support gender
diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php
index 2dbbc3083c..f3e5c76ddf 100644
--- a/includes/json/FormatJson.php
+++ b/includes/json/FormatJson.php
@@ -61,14 +61,14 @@ class FormatJson {
 	 *
 	 * @since 1.24
 	 */
-	const FORCE_ASSOC = 0x1;
+	const FORCE_ASSOC = 0x100;
 
 	/**
 	 * If set, attempts to fix invalid json.
 	 *
 	 * @since 1.24
 	 */
-	const TRY_FIXING = 0x2;
+	const TRY_FIXING = 0x200;
 
 	/**
 	 * Regex that matches whitespace inside empty arrays and objects.
@@ -130,14 +130,16 @@ class FormatJson {
 	}
 
 	/**
-	 * Decodes a JSON string.
+	 * Decodes a JSON string. It is recommended to use FormatJson::parse(), which returns more comprehensive
+	 * result in case of an error, and has more parsing options.
 	 *
 	 * @param string $value The JSON string being decoded
 	 * @param bool $assoc When true, returned objects will be converted into associative arrays.
 	 *
 	 * @return mixed The value encoded in JSON in appropriate PHP type.
-	 * `null` is returned if the JSON cannot be decoded or if the encoded data is deeper than
-	 * the recursion limit.
+	 * `null` is returned if $value represented `null`, if $value could not be decoded,
+	 * or if the encoded data was deeper than the recursion limit.
+	 * Use FormatJson::parse() to distinguish between types of `null` and to get proper error code.
 	 */
 	public static function decode( $value, $assoc = false ) {
 		return json_decode( $value, $assoc );
@@ -145,11 +147,11 @@ class FormatJson {
 
 	/**
 	 * Decodes a JSON string.
+	 * Unlike FormatJson::decode(), if $value represents null value, it will be properly decoded as valid.
 	 *
 	 * @param string $value The JSON string being decoded
-	 * @param int $options A bit field that allows FORCE_ASSOC, TRY_FIXING, WRAP_RESULT
-	 * For backward compatibility, FORCE_ASSOC is set to 1 to match the legacy 'true'
-	 * @return Status If good, the value is available in $result->getValue()
+	 * @param int $options A bit field that allows FORCE_ASSOC, TRY_FIXING
+	 * @return Status If valid JSON, the value is available in $result->getValue()
 	 */
 	public static function parse( $value, $options = 0 ) {
 		$assoc = ( $options & self::FORCE_ASSOC ) !== 0;
-- 
2.20.1