Services_JSON : [ ] [ ] [ ]

Class: Services_JSON

Source Location: /PhpExt/Lib/json.php

Class Services_JSON

Class Overview

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);

Located in /PhpExt/Lib/json.php [line 115]

Methods

[ Top ]

Method Summary

Services_JSON	Services_JSON()	constructs a new JSON instance
mixed	decode()	decodes a JSON string into appropriate variable
mixed	encode()	encodes an arbitrary variable into JSON format
void	isError()

[ Top ]

Methods

Constructor Services_JSON [line 133]

Services_JSON Services_JSON(
[int
$use = 0] 
)

constructs a new JSON instance

Parameters:

int

$use:

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()

[ Top ]

decode [line 484]

mixed decode(
string
$str 
)

decodes a JSON string into appropriate variable

Parameters:

string

$str:

JSON-formatted string

API Tags:

Return:	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

[ Top ]

encode [line 237]

mixed encode(
mixed
$var 
)

encodes an arbitrary variable into JSON format

Parameters:

mixed

$var:

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!

API Tags:

Return:	JSON string representation of input var or an error if a problem occurs
Access:	public

[ Top ]

isError [line 766]

void isError(

$data, [
$code = null] 
)

Parameters:

	$data:
	$code:

Information Tags:

Todo:

Ultimately, this should just call PEAR::isError()

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:56:05 -0500 by phpDocumentor 1.4.0