Remove debugging code accidentally committed in r86253
[lhc/web/wiklou.git] / includes / json / FormatJson.php
index f33bc62..6e58434 100644 (file)
@@ -1,29 +1,36 @@
 <?php
+/**
+ * Simple wrapper for json_econde and json_decode that falls back on Services_JSON class
+ *
+ * @file
+ */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        die( 1 );
 }
 
-/**
- * Simple wrapper for json_econde and json_decode that falls back on Services_JSON class
- */
-class FormatJson {
-
-       // Constants for decode() return types
-       const AS_OBJECT = true;
-       const AS_ARRAY = false;
+require_once dirname( __FILE__ ) . '/Services_JSON.php';
 
+class FormatJson {
+       
        /**
-        * Turn an array or object into a JSON string
-        * @param $value Mixed. Array or object to turn into JSON
-        * @param $isHtml bool ???
-        * @return <type>
+        * Returns the JSON representation of a value.
+        * 
+        * @param $value Mixed: the value being encoded. Can be any type except a resource.
+        * @param $isHtml Boolean
+        *
+        * @fixme "$isHtml" parameter's purpose is not documented. It appears to
+        *        map to a parameter labeled "pretty-print output with indents and
+        *        newlines" in Services_JSON::encode(), which has no string relation
+        *        to HTML output.
+        * 
+        * @return string
         */
        public static function encode( $value, $isHtml = false ) {
                // Some versions of PHP have a broken json_encode, see PHP bug
                // 46944. Test encoding an affected character (U+20000) to
                // avoid this.
-               if ( !function_exists( 'json_encode' ) || $isHtml || strtolower( json_encode( "\xf0\xa0\x80\x80" ) ) != '\ud840\udc00' ) {
+               if ( !function_exists( 'json_encode' ) || $isHtml || strtolower( json_encode( "\xf0\xa0\x80\x80" ) ) != '"\ud840\udc00"' ) {
                        $json = new Services_JSON();
                        return $json->encode( $value, $isHtml );
                } else {
@@ -32,21 +39,27 @@ class FormatJson {
        }
 
        /**
-        * Decode some JSON into an array or object
-        * @param $value String of Json
-        * @param $assoc bool One of AS_OBJECT or AS_ARRAY to specify return type
-        * @return Array or Object
+        * Decodes a JSON string.
+        * 
+        * @param $value String: the json string being decoded.
+        * @param $assoc Boolean: when true, returned objects will be converted into associative arrays.
+        * 
+        * @return Mixed: the value encoded in json in appropriate PHP type.
+        * Values true, false and null (case-insensitive) are returned as true, false
+        * and &null; respectively. &null; is returned if the json cannot be
+        * decoded or if the encoded data is deeper than the recursion limit.
         */
        public static function decode( $value, $assoc = false ) {
                if ( !function_exists( 'json_decode' ) ) {
-                       $json = new Services_JSON();
+                       if( $assoc )
+                               $json = new Services_JSON( SERVICES_JSON_LOOSE_TYPE );
+                       else
+                               $json = new Services_JSON();
                        $jsonDec = $json->decode( $value );
-                       if( $assoc ) {
-                               $jsonDec = wfObjectToArray( $jsonDec );
-                       }
                        return $jsonDec;
                } else {
                        return json_decode( $value, $assoc );
                }
        }
+       
 }