From: Jeroen De Dauw <jeroendedauw@users.mediawiki.org>
Date: Thu, 12 Aug 2010 07:27:48 +0000 (+0000)
Subject: Documentation o_O
X-Git-Tag: 1.31.0-rc.0~35539
X-Git-Url: https://git.cyclocoop.org/%7B%7B%20url_for%28%27votes%27%2C%20votes=%27waiting%27%29%20%7D%7D?a=commitdiff_plain;h=539ab6f5e5f730a4dae78fa34780689897ec4675;p=lhc%2Fweb%2Fwiklou.git

Documentation o_O
---

diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php
index cacf6680fc..cf49c17bec 100644
--- a/includes/json/FormatJson.php
+++ b/includes/json/FormatJson.php
@@ -7,6 +7,15 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 }
 
 class FormatJson {
+	
+	/**
+	 * Returns the JSON representation of a value.
+	 * 
+	 * @param $value Mixed: the value being encoded. Can be any type except a resource.
+	 * @param $isHtml Boolean
+	 * 
+	 * @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
@@ -19,6 +28,17 @@ class FormatJson {
 		}
 	}
 
+	/**
+	 * 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();
@@ -31,4 +51,5 @@ class FormatJson {
 			return json_decode( $value, $assoc );
 		}
 	}
-}
+	
+}
\ No newline at end of file