core/xpdo/json/JSON.php
Converts to and from JSON format.
JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. This feature can also be found in Python. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, TCL, and many others. These properties make JSON an ideal data-interchange language.
This package provides a simple encoder and decoder for JSON notation. It is intended for use with client-side Javascript applications that make use of HTTPRequest to perform server communication functions - data can be encoded into JSON notation for use in a client-side javascript, or decoded from incoming Javascript requests. JSON format is native to Javascript, and can be directly eval()'ed with no further parsing overhead
All strings should be in ASCII or UTF-8 format!
LICENSE: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- Author
- Michal Migurski
- Author
- Matt Knapp
- Author
- Brett Stimmerman
- Category
- Copyright
- 2005 Michal Migurski
- License
- http://www.opensource.org/licenses/bsd-license.php
- Link
- http://pear.php.net/pepr/pepr-proposal-show.php?id=198
- Package
- xpdo
- Subpackage
- json
- Version
- CVS: $Id: JSON.php,v 1.31 2006/06/28 05:54:17 migurski Exp $
Constants
\Services_JSON
Converts to and from JSON format.
Brief example of use:
// create a new instance of Services_JSON
$json = new Services_JSON();
// convert a complexe value to JSON notation, and send it to the browser
$value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4)));
$output = $json->encode($value);
print($output);
// prints: ["foo","bar",[1,2,"baz"],[3,[4]]]
// accept incoming POST data, assumed to be in JSON notation
$input = file_get_contents('php://input', 1000000);
$value = $json->decode($input);
Methods


Services_JSON(
int $use
=
0
)
:
void
constructs a new JSON instance
Name | Type | Description |
---|---|---|
$use | int | object behavior flags; combine with boolean-OR possible values: - SERVICES_JSON_LOOSE_TYPE: loose typing. "{...}" syntax creates associative arrays instead of objects in decode(). - SERVICES_JSON_SUPPRESS_ERRORS: error suppression. Values which can't be encoded (e.g. resources) appear as NULL instead of throwing errors. By default, a deeply-nested resource will bubble up with an error, so all return values from encode() should be checked with isError() |


decode(
string $str
)
:
mixed
decodes a JSON string into appropriate variable
Name | Type | Description |
---|---|---|
$str | string | JSON-formatted string |
Type | Description |
---|---|
mixed | number, boolean, string, array, or object corresponding to given JSON input string. See argument 1 to Services_JSON() above for object-output behavior. Note that decode() always returns strings in ASCII or UTF-8 format! |
- Access
- public


encode(
mixed $var
)
:
mixed
encodes an arbitrary variable into JSON format
Name | Type | Description |
---|---|---|
$var | mixed | any number, boolean, string, array, or object to be encoded. see argument 1 to Services_JSON() above for array-parsing behavior. if var is a strng, note that encode() always expects it to be in ASCII or UTF-8 format! |
Type | Description |
---|---|
mixed | JSON string representation of input var or an error if a problem occurs |
- Access
- public


name_value(
string $name, mixed $value
)
:
string
array-walking function for use in generating JSON-formatted name-value pairs
Name | Type | Description |
---|---|---|
$name | string | name of key to use |
$value | mixed | reference to an array element to be encoded |
Type | Description |
---|---|
string | JSON-formatted name-value pair, like '"name":value' |
- Access
- private


reduce_string(
\$str $str
)
:
string
reduce a string by removing leading and trailing comments and whitespace
Name | Type | Description |
---|---|---|
$str | \$str | string string value to strip of comments and whitespace |
Type | Description |
---|---|
string | string value stripped of comments and whitespace |
- Access
- private


utf162utf8(
string $utf16
)
:
string
convert a string from one UTF-16 char to one UTF-8 char
Normally should be handled by mb_convert_encoding, but provides a slower PHP-only method for installations that lack the multibye string extension.
Name | Type | Description |
---|---|---|
$utf16 | string | UTF-16 character |
Type | Description |
---|---|
string | UTF-8 character |
- Access
- private


utf82utf16(
string $utf8
)
:
string
convert a string from one UTF-8 char to one UTF-16 char
Normally should be handled by mb_convert_encoding, but provides a slower PHP-only method for installations that lack the multibye string extension.
Name | Type | Description |
---|---|---|
$utf8 | string | UTF-8 character |
Type | Description |
---|---|
string | UTF-16 character |
- Access
- private