mirror of
https://github.com/php/php-src.git
synced 2024-11-28 04:14:26 +08:00
Add some documentation to the JSON extension.
This commit is contained in:
parent
73cead23a5
commit
7da29196d3
76
ext/json/README
Normal file
76
ext/json/README
Normal file
@ -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 <omar@php.net>
|
||||
|
||||
|
||||
---
|
||||
|
||||
[0] http://www.crockford.com/JSON/draft-jsonorg-json-00.txt
|
||||
[1] http://www.crockford.com/JSON/JSON_checker/
|
Loading…
Reference in New Issue
Block a user