From 7da29196d3b690ec617340df4d4613804dd3bbe8 Mon Sep 17 00:00:00 2001 From: Omar Kilani Date: Tue, 31 Jan 2006 09:00:47 +0000 Subject: [PATCH] Add some documentation to the JSON extension. --- ext/json/README | 76 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 ext/json/README diff --git a/ext/json/README b/ext/json/README new file mode 100644 index 0000000000..d680b0c592 --- /dev/null +++ b/ext/json/README @@ -0,0 +1,76 @@ +json 1.2.0 +========== + +This extension implements the JavaScript Object Notation (JSON) +data-interchange format as specified in [0]. + +Two functions are implemented: encoding and decoding. The decoding +is handled by a parser based on JSON_checker[1] by Douglas Crockford. + + +Function overview +----------------- + + string json_encode ( mixed value ) + +json_encode returns a string containing the JSON representation of value. +value can be any type except a resource. + + mixed json_decode ( string json, [bool assoc] ) + +json_decode takes a JSON string and converts it into a PHP variable. +When assoc is given, and evaluates to TRUE, json_decode() will return +any objects as associative arrays. + + +Example usage +------------- + +$arr = array("a"=>1,"b"=>2,"c"=>3,"d"=>4,"e"=>5); +echo json_encode($arr); + +---> {"a":1,"b":2,"c":3,"d":4,"e":5} + +$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}'; +var_dump(json_decode($json)); + +---> object(stdClass)#1 (5) { + ["a"]=> + int(1) + ["b"]=> + int(2) + ["c"]=> + int(3) + ["d"]=> + int(4) + ["e"]=> + int(5) + } + +$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}'; +var_dump(json_decode($json, true)); + +---> array(5) { + ["a"]=> + int(1) + ["b"]=> + int(2) + ["c"]=> + int(3) + ["d"]=> + int(4) + ["e"]=> + int(5) + } + + +Authors +------- + +Omar Kilani + + +--- + +[0] http://www.crockford.com/JSON/draft-jsonorg-json-00.txt +[1] http://www.crockford.com/JSON/JSON_checker/ -- 2.40.0