pickles/docs/PICKLES/Convert.html

157 lines
No EOL
6.4 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Convert</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Convert</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert Class</p>
<p class="description"><p>Collection of statically called methods to help aid in converting formats.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Convert.php.html">/classes/Convert.php</a> (line <span class="field">23</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#arrayToXML" title="details" class="method-name">arrayToXML</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$array</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">0</span>])
</div>
<div class="method-definition">
static <span class="method-result">JSON</span>
<a href="#toJSON" title="details" class="method-name">toJSON</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodarrayToXML" id="arrayToXML"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method arrayToXML</span> (line <span class="line-number">80</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Array to XML</p>
<p class="description"><p>Converts an array into XML tags (recursive). This method expects the passed array to be formatted very specifically to accomodate the fact that an array's format isn't quite the same as well-formed XML.</p><p>Input Array = array('children' =&gt; array( 'child' =&gt; array( array('name' =&gt; 'Wendy Darling'), array('name' =&gt; 'John Darling'), array('name' =&gt; 'Michael Darling') ) ))</p><p>Output XML = &lt;children&gt; &lt;child&gt;&lt;name&gt;Wendy Darling&lt;/name&gt;&lt;/child&gt; &lt;child&gt;&lt;name&gt;John Darling&lt;/name&gt;&lt;/child&gt; &lt;child&gt;&lt;name&gt;Michael Darling&lt;/name&gt;&lt;/child&gt; &lt;/children&gt;</p></p>
<ul class="tags">
<li><span class="field">return:</span> generated XML</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
arrayToXML
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$array</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$array</span><span class="var-description">: array to convert into XML</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$format</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$level</span> </li>
</ul>
</div>
<a name="methodtoJSON" id="toJSON"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method toJSON</span> (line <span class="line-number">41</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">To JSON</p>
<p class="description"><p>Encodes passed variable as JSON.</p><p>Requires PHP 5 &gt;= 5.2.0 or PECL json &gt;= 1.2.0 Note: PECL json 1.2.1 is included /vendors</p></p>
<ul class="tags">
<li><span class="field">return:</span> encoded string</li>
<li><span class="field">link:</span> <a href="http://json.org/">http://json.org/</a></li>
<li><span class="field">link:</span> <a href="http://pecl.php.net/package/json">http://pecl.php.net/package/json</a></li>
<li><span class="field">link:</span> <a href="http://us.php.net/json_encode">http://us.php.net/json_encode</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">JSON</span>
<span class="method-name">
toJSON
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$variable</span><span class="var-description">: variable to convert</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>