More documentation!
[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 /**
15 * JSON formatter wrapper class
16 */
17 class FormatJson {
18
19 /**
20 * Returns the JSON representation of a value.
21 *
22 * @param $value Mixed: the value being encoded. Can be any type except a resource.
23 * @param $isHtml Boolean
24 *
25 * @todo FIXME: "$isHtml" parameter's purpose is not documented. It appears to
26 * map to a parameter labeled "pretty-print output with indents and
27 * newlines" in Services_JSON::encode(), which has no string relation
28 * to HTML output.
29 *
30 * @return string
31 */
32 public static function encode( $value, $isHtml = false ) {
33 // Some versions of PHP have a broken json_encode, see PHP bug
34 // 46944. Test encoding an affected character (U+20000) to
35 // avoid this.
36 if ( !function_exists( 'json_encode' ) || $isHtml || strtolower( json_encode( "\xf0\xa0\x80\x80" ) ) != '"\ud840\udc00"' ) {
37 $json = new Services_JSON();
38 return $json->encode( $value, $isHtml );
39 } else {
40 return json_encode( $value );
41 }
42 }
43
44 /**
45 * Decodes a JSON string.
46 *
47 * @param $value String: the json string being decoded.
48 * @param $assoc Boolean: when true, returned objects will be converted into associative arrays.
49 *
50 * @return Mixed: the value encoded in json in appropriate PHP type.
51 * Values true, false and null (case-insensitive) are returned as true, false
52 * and &null; respectively. &null; is returned if the json cannot be
53 * decoded or if the encoded data is deeper than the recursion limit.
54 */
55 public static function decode( $value, $assoc = false ) {
56 if ( !function_exists( 'json_decode' ) ) {
57 if( $assoc )
58 $json = new Services_JSON( SERVICES_JSON_LOOSE_TYPE );
59 else
60 $json = new Services_JSON();
61 $jsonDec = $json->decode( $value );
62 return $jsonDec;
63 } else {
64 return json_decode( $value, $assoc );
65 }
66 }
67
68 }