+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>\r
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
- <html xmlns="http://www.w3.org/1999/xhtml">\r
- <head>\r
- <!-- template designed by Marco Von Ballmoos -->\r
- <title>Docs For Class Services_JSON</title>\r
- <link rel="stylesheet" href="../media/stylesheet.css" />\r
- <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>\r
- </head>\r
- <body>\r
- <div class="page-body"> \r
-<h2 class="class-name">Class Services_JSON</h2>\r
-\r
-<a name="sec-description"></a>\r
-<div class="info-box">\r
- <div class="info-box-title">Description</div>\r
- <div class="nav-bar">\r
- <span class="disabled">Description</span> |\r
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
- \r
- </div>\r
- <div class="info-box-body">\r
- <!-- ========== Info from phpDoc block ========= -->\r
-<p class="short-description">Converts to and from JSON format.</p>\r
-<p class="description"><p>Brief example of use:</p><p><pre><code><pre><br />1 <span class="src-comm">// create a new instance of Services_JSON</span><br />2 <span class="src-var">$json</span> = <span class="src-key">new</span> <a href="../Services_JSON/Services_JSON.html#methodServices_JSON">Services_JSON</a><span class="src-sym">(</span><span class="src-sym">)</span>;<br />3 <br />4 <span class="src-comm">// convert a complexe value to JSON notation, and send it to the browser</span><br />5 <span class="src-var">$value</span> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'foo'</span><span class="src-sym">,</span> <span class="src-str">'bar'</span><span class="src-sym">,</span> <span class="src-key">array</span><span class="src-sym">(</span><span class="src-num">1</span><span class="src-sym">,</span> <span class="src-num">2</span><span class="src-sym">,</span> <span class="src-str">'baz'</span><span class="src-sym">)</span><span class="src-sym">,</span> <span class="src-key">array</span><span class="src-sym">(</span><span class="src-num">3</span><span class="src-sym">,</span> <span class="src-key">array</span><span class="src-sym">(</span><span class="src-num">4</span><span class="src-sym">)</span><span class="src-sym">)</span><span class="src-sym">)</span>;<br />6 <span class="src-var">$output</span> = <span class="src-var">$json</span><span class="src-sym">-></span><a href="../Services_JSON/Services_JSON.html#methodencode">encode</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span>;<br />7 <br />8 print<span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</span>;<br />9 <span class="src-comm">// prints: ["foo","bar",[1,2,"baz"],[3,[4]]]</span><br />10 <br />11 <span class="src-comm">// accept incoming POST data, assumed to be in JSON notation</span><br />12 <span class="src-var">$input</span> = <a href="http://www.php.net/file_get_contents">file_get_contents</a><span class="src-sym">(</span><span class="src-str">'php://input'</span><span class="src-sym">,</span> <span class="src-num">1000000</span><span class="src-sym">)</span>;<br />13 <span class="src-var">$value</span> = <span class="src-var">$json</span><span class="src-sym">-></span><a href="../Services_JSON/Services_JSON.html#methoddecode">decode</a><span class="src-sym">(</span><span class="src-var">$input</span><span class="src-sym">)</span>;</pre></code></pre></p></p>\r
- <p class="notes">\r
- Located in <a class="field" href="_JSON_php.html">/JSON.php</a> (line <span class="field">115</span>)\r
- </p>\r
- \r
- \r
- <pre></pre>\r
- \r
- </div>\r
-</div>\r
-\r
-\r
-\r
- <a name="sec-method-summary"></a>\r
- <div class="info-box">\r
- <div class="info-box-title">Method Summary</span></div>\r
- <div class="nav-bar">\r
- <a href="#sec-description">Description</a> |\r
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)\r
- </div>\r
- <div class="info-box-body"> \r
- <div class="method-summary">\r
- \r
- <div class="method-definition">\r
- <span class="method-result">Services_JSON</span>\r
- <a href="#Services_JSON" title="details" class="method-name">Services_JSON</a>\r
- (<span class="var-type">int</span> <span class="var-name">$use</span>)\r
- </div>\r
- \r
- <div class="method-definition">\r
- <span class="method-result">mixed</span>\r
- <a href="#decode" title="details" class="method-name">decode</a>\r
- (<span class="var-type">string</span> <span class="var-name">$str</span>)\r
- </div>\r
- \r
- <div class="method-definition">\r
- <span class="method-result">mixed</span>\r
- <a href="#encode" title="details" class="method-name">encode</a>\r
- (<span class="var-type">mixed</span> <span class="var-name">$var</span>)\r
- </div>\r
- \r
- <div class="method-definition">\r
- <span class="method-result">void</span>\r
- <a href="#isError" title="details" class="method-name">isError</a>\r
- (<span class="var-type">mixed</span> <span class="var-name">$data</span>, [<span class="var-type">mixed</span> <span class="var-name">$code</span> = <span class="var-default">null</span>])\r
- </div>\r
- </div>\r
- </div>\r
- </div> \r
-\r
- \r
- <a name="sec-methods"></a>\r
- <div class="info-box">\r
- <div class="info-box-title">Methods</div>\r
- <div class="nav-bar">\r
- <a href="#sec-description">Description</a> |\r
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)\r
- \r
- </div>\r
- <div class="info-box-body">\r
- <A NAME='method_detail'></A>\r
-<a name="methodServices_JSON" id="Services_JSON"><!-- --></a>\r
-<div class="evenrow">\r
- \r
- <div class="method-header">\r
- <span class="method-title">Constructor Services_JSON</span> (line <span class="line-number">133</span>)\r
- </div> \r
- \r
- <!-- ========== Info from phpDoc block ========= -->\r
-<p class="short-description">constructs a new JSON instance</p>\r
- \r
- <div class="method-signature">\r
- <span class="method-result">Services_JSON</span>\r
- <span class="method-name">\r
- Services_JSON\r
- </span>\r
- (<span class="var-type">int</span> <span class="var-name">$use</span>)\r
- </div>\r
- \r
- <ul class="parameters">\r
- <li>\r
- <span class="var-type">int</span>\r
- <span class="var-name">$use</span><span class="var-description">: <p>object behavior flags; combine with boolean-OR</p><p>possible values: <ul><li>SERVICES_JSON_LOOSE_TYPE: loose typing.
- "{...}" syntax creates associative arrays
- instead of objects in decode().</li><li>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()</li></ul></p></span> </li>\r
- </ul>\r
- \r
- \r
- </div>\r
-<a name="methoddecode" id="decode"><!-- --></a>\r
-<div class="oddrow">\r
- \r
- <div class="method-header">\r
- <span class="method-title">decode</span> (line <span class="line-number">484</span>)\r
- </div> \r
- \r
- <!-- ========== Info from phpDoc block ========= -->\r
-<p class="short-description">decodes a JSON string into appropriate variable</p>\r
- <ul class="tags">\r
- <li><span class="field">return:</span> 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!</li>\r
- <li><span class="field">access:</span> public</li>\r
- </ul>\r
- \r
- <div class="method-signature">\r
- <span class="method-result">mixed</span>\r
- <span class="method-name">\r
- decode\r
- </span>\r
- (<span class="var-type">string</span> <span class="var-name">$str</span>)\r
- </div>\r
- \r
- <ul class="parameters">\r
- <li>\r
- <span class="var-type">string</span>\r
- <span class="var-name">$str</span><span class="var-description">: JSON-formatted string</span> </li>\r
- </ul>\r
- \r
- \r
- </div>\r
-<a name="methodencode" id="encode"><!-- --></a>\r
-<div class="evenrow">\r
- \r
- <div class="method-header">\r
- <span class="method-title">encode</span> (line <span class="line-number">237</span>)\r
- </div> \r
- \r
- <!-- ========== Info from phpDoc block ========= -->\r
-<p class="short-description">encodes an arbitrary variable into JSON format</p>\r
- <ul class="tags">\r
- <li><span class="field">return:</span> JSON string representation of input var or an error if a problem occurs</li>\r
- <li><span class="field">access:</span> public</li>\r
- </ul>\r
- \r
- <div class="method-signature">\r
- <span class="method-result">mixed</span>\r
- <span class="method-name">\r
- encode\r
- </span>\r
- (<span class="var-type">mixed</span> <span class="var-name">$var</span>)\r
- </div>\r
- \r
- <ul class="parameters">\r
- <li>\r
- <span class="var-type">mixed</span>\r
- <span class="var-name">$var</span><span class="var-description">: 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!</span> </li>\r
- </ul>\r
- \r
- \r
- </div>\r
-<a name="methodisError" id="isError"><!-- --></a>\r
-<div class="oddrow">\r
- \r
- <div class="method-header">\r
- <span class="method-title">isError</span> (line <span class="line-number">766</span>)\r
- </div> \r
- \r
- <!-- ========== Info from phpDoc block ========= -->\r
- <ul class="tags">\r
- <li><span class="field">todo:</span> Ultimately, this should just call PEAR::isError()</li>\r
- </ul>\r
- \r
- <div class="method-signature">\r
- <span class="method-result">void</span>\r
- <span class="method-name">\r
- isError\r
- </span>\r
- (<span class="var-type">mixed</span> <span class="var-name">$data</span>, [<span class="var-type">mixed</span> <span class="var-name">$code</span> = <span class="var-default">null</span>])\r
- </div>\r
- \r
- \r
- \r
- </div>\r
- \r
- </div>\r
- </div>\r
- \r
- <p class="notes" id="credit">\r
- Documentation generated on Tue, 27 Jun 2006 22:54:25 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>\r
- </p>\r
- </div></body>\r
-</html>
\ No newline at end of file
BGBM BDI Projects / geo.git / blobdiff