Use consistent notation for "@todo FIXME". Should update http://svn.wikimedia.org...
[lhc/web/wiklou.git] / includes / json / FormatJson.php
1 <?php
2 /**
3 * Simple wrapper for json_econde and json_decode that falls back on Services_JSON class
4 *
5 * @file
6 */
7
8 if ( !defined( 'MEDIAWIKI' ) ) {
9 die( 1 );
10 }
11
12 require_once dirname( __FILE__ ) . '/Services_JSON.php';
13
14 class FormatJson {
15
16 /**
17 * Returns the JSON representation of a value.
18 *
19 * @param $value Mixed: the value being encoded. Can be any type except a resource.
20 * @param $isHtml Boolean
21 *
22 * @todo FIXME: "$isHtml" parameter's purpose is not documented. It appears to
23 * map to a parameter labeled "pretty-print output with indents and
24 * newlines" in Services_JSON::encode(), which has no string relation
25 * to HTML output.
26 *
27 * @return string
28 */
29 public static function encode( $value, $isHtml = false ) {
30 // Some versions of PHP have a broken json_encode, see PHP bug
31 // 46944. Test encoding an affected character (U+20000) to
32 // avoid this.
33 if ( !function_exists( 'json_encode' ) || $isHtml || strtolower( json_encode( "\xf0\xa0\x80\x80" ) ) != '"\ud840\udc00"' ) {
34 $json = new Services_JSON();
35 return $json->encode( $value, $isHtml );
36 } else {
37 return json_encode( $value );
38 }
39 }
40
41 /**
42 * Decodes a JSON string.
43 *
44 * @param $value String: the json string being decoded.
45 * @param $assoc Boolean: when true, returned objects will be converted into associative arrays.
46 *
47 * @return Mixed: the value encoded in json in appropriate PHP type.
48 * Values true, false and null (case-insensitive) are returned as true, false
49 * and &null; respectively. &null; is returned if the json cannot be
50 * decoded or if the encoded data is deeper than the recursion limit.
51 */
52 public static function decode( $value, $assoc = false ) {
53 if ( !function_exists( 'json_decode' ) ) {
54 if( $assoc )
55 $json = new Services_JSON( SERVICES_JSON_LOOSE_TYPE );
56 else
57 $json = new Services_JSON();
58 $jsonDec = $json->decode( $value );
59 return $jsonDec;
60 } else {
61 return json_decode( $value, $assoc );
62 }
63 }
64
65 }