joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions

Updated the internal documentation.

Browse source
This commit is contained in:
Josh Sherman 2010-11-24 23:42:02 -05:00
parent 072afaf936
commit d754757eee
56 changed files with 951 additions and 993 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/PICKLES/Config.html
View file

@ -128,7 +128,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">149</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">208</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -233,7 +233,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">176</span>)
<span class="method-title">__get</span> (line <span class="line-number">235</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -264,7 +264,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">162</span>)
<span class="method-title">__set</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -308,7 +308,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

6
docs/PICKLES/Controller.html
View file

@ -150,7 +150,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">246</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">351</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -179,7 +179,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">prepareVariables</span> (line <span class="line-number">257</span>)
<span class="method-title">prepareVariables</span> (line <span class="line-number">362</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -218,7 +218,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

6
docs/PICKLES/Database.html
View file

@ -60,7 +60,7 @@
<div class="method-definition">
<span class="method-result">Database</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
([<span class="var-type"><a href="../PICKLES/String.html">String</a></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
</div>
</div>
@ -163,7 +163,7 @@
<span class="method-name">
__construct
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
([<span class="var-type"><a href="../PICKLES/String.html">String</a></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
@ -195,7 +195,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

61
docs/PICKLES/Database_Common.html
View file

@ -139,7 +139,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Database_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -149,6 +149,11 @@
<span class="method-result">boolean</span>
<a href="#close" title="details" class="method-name">close</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getDriver" title="details" class="method-name">getDriver</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -204,7 +209,7 @@
</div>
<div class="info-box-body">
<a name="var$connection" id="$connection"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -226,7 +231,7 @@
</div>
<a name="var$database" id="$database"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -248,7 +253,7 @@
</div>
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -290,7 +295,7 @@
</div>
<a name="var$hostname" id="$hostname"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -312,7 +317,7 @@
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -334,7 +339,7 @@
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -368,7 +373,7 @@
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -390,7 +395,7 @@
</div>
<a name="var$socket" id="$socket"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -412,7 +417,7 @@
</div>
<a name="var$username" id="$username"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -462,7 +467,7 @@
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
@ -500,10 +505,10 @@
</ul>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">197</span>)
<span class="method-title">close</span> (line <span class="line-number">210</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -537,12 +542,38 @@
: Closes database connection
</li>
</ul>
</div>
<a name="methodgetDriver" id="getDriver"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getDriver</span> (line <span class="line-number">187</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Driver</p>
<p class="description"><p>Returns the name of the driver in use. Used by the Model class to determine which path to take when interfacing with the Database object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> name of the driver in use</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getDriver
</span>
()
</div>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">188</span>)
<span class="method-title">open</span> (line <span class="line-number">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -766,7 +797,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

60
docs/PICKLES/Database_Mongo.html
View file

@ -71,7 +71,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#close" title="details" class="method-name">close</a>
@ -80,12 +80,7 @@
<div class="method-definition">
<span class="method-result">void</span>
<a href="#fetch" title="details" class="method-name">fetch</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$return_type</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#fetchAll" title="details" class="method-name">fetchAll</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>])
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -110,7 +105,7 @@
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -192,7 +187,7 @@
<A NAME='method_detail'></A>
<a name="methodclose" id="close"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">87</span>)
@ -224,14 +219,14 @@
</div>
<a name="methodfetch" id="fetch"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">106</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch a single row from the database</p>
<p class="short-description">Fetch records from the database</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -241,45 +236,7 @@
<span class="method-name">
fetch
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$return_type</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$query</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$fields</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$return_type</span> </li>
</ul>
</div>
<a name="methodfetchAll" id="fetchAll"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetchAll</span> (line <span class="line-number">127</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetches all rows as an array</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
fetchAll
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>])
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
@ -335,6 +292,7 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
@ -356,7 +314,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

92
docs/PICKLES/Database_PDO_Common.html
View file

@ -116,7 +116,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Database_PDO_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -135,17 +135,7 @@
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#fetch" title="details" class="method-name">fetch</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$return_type</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#fetchAll" title="details" class="method-name">fetchAll</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#fetchColumn" title="details" class="method-name">fetchColumn</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$return_type</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -322,7 +312,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">107</span>)
<span class="method-title">close</span> (line <span class="line-number">110</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -354,7 +344,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">execute</span> (line <span class="line-number">124</span>)
<span class="method-title">execute</span> (line <span class="line-number">127</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -388,11 +378,11 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">206</span>)
<span class="method-title">fetch</span> (line <span class="line-number">209</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch a single row from the database</p>
<p class="short-description">Fetch records from the database</p>
<ul class="tags">
<li><span class="field">return:</span> based on return type</li>
<li><span class="field">access:</span> public</li>
@ -403,7 +393,7 @@
<span class="method-name">
fetch
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$return_type</span> = <span class="var-default">null</span>])
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$return_type</span>)
</div>
<ul class="parameters">
@ -419,71 +409,6 @@
</ul>
</div>
<a name="methodfetchAll" id="fetchAll"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">fetchAll</span> (line <span class="line-number">255</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetches all rows as an array</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
fetchAll
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
</ul>
</div>
<a name="methodfetchColumn" id="fetchColumn"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetchColumn</span> (line <span class="line-number">243</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch a single column from the database</p>
<p class="description"><p>This method assumes you want the first column in your select. If you need 2 or more columns you should simply use fetch().</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
fetchColumn
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
</ul>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="evenrow">
@ -524,6 +449,7 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
@ -545,7 +471,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

5
docs/PICKLES/Database_PDO_MySQL.html
View file

@ -233,8 +233,6 @@
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodexecute">Database_PDO_Common::execute()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchAll">Database_PDO_Common::fetchAll()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchColumn">Database_PDO_Common::fetchColumn()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
@ -242,6 +240,7 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
@ -263,7 +262,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

11
docs/PICKLES/Database_PDO_PostgreSQL.html
View file

@ -84,7 +84,7 @@
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -112,7 +112,7 @@
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -140,7 +140,7 @@
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -233,8 +233,6 @@
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodexecute">Database_PDO_Common::execute()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchAll">Database_PDO_Common::fetchAll()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchColumn">Database_PDO_Common::fetchColumn()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
@ -242,6 +240,7 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
@ -263,7 +262,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

9
docs/PICKLES/Database_PDO_SQLite.html
View file

@ -80,7 +80,7 @@
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -108,7 +108,7 @@
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -204,8 +204,6 @@
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodexecute">Database_PDO_Common::execute()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchAll">Database_PDO_Common::fetchAll()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodfetchColumn">Database_PDO_Common::fetchColumn()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
@ -213,6 +211,7 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
@ -234,7 +233,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

75
docs/PICKLES/Display_Common.html
View file

@ -55,12 +55,6 @@
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_RSS.html">Display_RSS</a></td>
<td>
RSS Display
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_PHP.html">Display_PHP</a></td>
@ -143,11 +137,16 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Display_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">JSON</span>
<a href="#jsonEncode" title="details" class="method-name">jsonEncode</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
@ -193,7 +192,7 @@
</div>
<div class="info-box-body">
<a name="var$child_template" id="$child_template"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -215,7 +214,7 @@
</div>
<a name="var$css_class" id="$css_class"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -237,7 +236,7 @@
</div>
<a name="var$extension" id="$extension"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -268,7 +267,7 @@
</div>
<a name="var$js_basename" id="$js_basename"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -290,7 +289,7 @@
</div>
<a name="var$meta_data" id="$meta_data"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -312,7 +311,7 @@
</div>
<a name="var$module_return" id="$module_return"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -334,7 +333,7 @@
</div>
<a name="var$parent_template" id="$parent_template"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -384,7 +383,7 @@
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">87</span>)
@ -413,12 +412,42 @@
<dd>Constructor</dd>
</dl>
</div>
<a name="methodjsonEncode" id="jsonEncode"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">jsonEncode</span> (line <span class="line-number">204</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">JSON Encode</p>
<p class="description"><p>Encodes module return data 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">todo:</span> This really should be moved into some sort of converter class. I couldn't settle on a name, so it will live here for now.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">JSON</span>
<span class="method-name">
jsonEncode
</span>
()
</div>
</div>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">188</span>)
<span class="method-title">render</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -442,10 +471,6 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a>
: Render the RSS feed data
</li>
<li>
<a href="../PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a>
: Renders the PHP templated pages
</li>
@ -463,7 +488,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setMetaData</span> (line <span class="line-number">153</span>)
<span class="method-title">setMetaData</span> (line <span class="line-number">159</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -493,7 +518,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">setModuleReturn</span> (line <span class="line-number">165</span>)
<span class="method-title">setModuleReturn</span> (line <span class="line-number">171</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -523,7 +548,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">137</span>)
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">143</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -562,7 +587,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">178</span>)
<span class="method-title">templateExists</span> (line <span class="line-number">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -607,7 +632,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

3
docs/PICKLES/Display_JSON.html
View file

@ -168,6 +168,7 @@
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a></span><br>
@ -187,7 +188,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

3
docs/PICKLES/Display_PHP.html
View file

@ -245,6 +245,7 @@
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a></span><br>
@ -264,7 +265,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

194
docs/PICKLES/Display_RSS.html
View file

@ -1,194 +0,0 @@
<?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 Display_RSS</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 Display_RSS</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-vars">Vars</a>
| <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">RSS Display</p>
<p class="description"><p>Displays data in RSS version 2.0 format. There are currently no plans to support older versions of the RSS specification or alternative feed types like ATOM.</p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://cyber.law.harvard.edu/rss/rss.html">http://cyber.law.harvard.edu/rss/rss.html</a></li>
<li><span class="field">todo:</span> This display type is totally jacked, no lie.</li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Display---RSS.php.html">/classes/Display/RSS.php</a> (line <span class="field">28</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
--Display_RSS</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> |
<a href="#sec-vars">Vars</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">
<span class="method-result">void</span>
<a href="#render" title="details" class="method-name">render</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$child_template">Display_Common::$child_template</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$css_class">Display_Common::$css_class</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$js_basename">Display_Common::$js_basename</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$meta_data">Display_Common::$meta_data</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$parent_template">Display_Common::$parent_template</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</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-vars">Vars</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="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">38</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Render the RSS feed data</p>
<p class="description"><p>Uses a combination of configuration options and a properly formatted data array to create an RSS v2.0 feed.</p></p>
<ul class="tags">
<li><span class="field">todo:</span> Error handling is non-existant.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
render
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
<dd>Rendering Method</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetTemplateVariables">Display_Common::setTemplateVariables()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodtemplateExists">Display_Common::templateExists()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

5
docs/PICKLES/Display_XML.html
View file

@ -133,7 +133,7 @@
<A NAME='method_detail'></A>
<a name="methodrender" id="render"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">35</span>)
@ -168,6 +168,7 @@
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a></span><br>
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a></span><br>
@ -187,7 +188,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

12
docs/PICKLES/Dynamic.html
View file

@ -23,9 +23,9 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dynamic Class</p>
<p class="description"><p>Handles generating links to static content that are a timestamp injected as to avoid hard caching. Also minifies content where applicable.</p></p>
<p class="description"><p>Handles generating links to static content that are a timestamp injected as to avoid hard caching. Also minifies content where applicable.</p><p>Note: you will want to add a mod_rewrite line to your .htaccess to support the routing to the filenames with the timestamp injected:</p><p>RewriteRule ^(.+)\.([\d]+)\.(css|js|gif|png|jpg|jpeg)$ /$1.$3 [NC,QSA]</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Dynamic.php.html">/classes/Dynamic.php</a> (line <span class="field">24</span>)
Located in <a class="field" href="_classes---Dynamic.php.html">/classes/Dynamic.php</a> (line <span class="field">29</span>)
</p>
@ -115,7 +115,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">css</span> (line <span class="line-number">185</span>)
<span class="method-title">css</span> (line <span class="line-number">194</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -149,7 +149,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">js</span> (line <span class="line-number">96</span>)
<span class="method-title">js</span> (line <span class="line-number">101</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -187,7 +187,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">ref</span> (line <span class="line-number">35</span>)
<span class="method-title">ref</span> (line <span class="line-number">40</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -229,7 +229,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/Error.html
View file

@ -104,7 +104,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/Form.html
View file

@ -612,7 +612,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/Log.html
View file

@ -323,7 +323,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

211
docs/PICKLES/Model.html
View file

@ -23,7 +23,7 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Model Class</p>
<p class="description"><p>This is a parent class that all PICKLES data models should be extending. The only thing it does currently is establish a database object for the data models to use.</p></p>
<p class="description"><p>This is a parent class that all PICKLES data models should be extending. When using the class as designed, objects will function as active record pattern objects.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Model.php.html">/classes/Model.php</a> (line <span class="field">25</span>)
</p>
@ -50,7 +50,11 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$collection" title="details" class="var-name">$collection</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$conditions" title="details" class="var-name">$conditions</a>
</div>
@ -122,7 +126,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Model</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -144,24 +148,34 @@
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<a href="#end" title="details" class="method-name">end</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#first" title="details" class="method-name">first</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<a href="#last" title="details" class="method-name">last</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<a href="#next" title="details" class="method-name">next</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<a href="#prev" title="details" class="method-name">prev</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#reset" title="details" class="method-name">reset</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
@ -185,14 +199,37 @@
</div>
<div class="info-box-body">
<a name="var$conditions" id="$conditions"><!-- --></A>
<a name="var$collection" id="$collection"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$collection</span>
= <span class="var-default"> false</span> (line <span class="line-number">95</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Collection Name</p>
<p class="description"><p>For compatibility with the naming conventions used by MongoDB, the collection name can be specified. If the collection name is set, it will set the table name value to it and proceed as normal.</p></p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$conditions" id="$conditions"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$conditions</span>
= <span class="var-default"> false</span> (line <span class="line-number">97</span>)
= <span class="var-default"> false</span> (line <span class="line-number">111</span>)
</span>
</div>
@ -208,13 +245,13 @@
</div>
<a name="var$datasource" id="$datasource"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$datasource</span>
(line <span class="line-number">57</span>)
(line <span class="line-number">59</span>)
</span>
</div>
@ -230,13 +267,13 @@
</div>
<a name="var$delayed" id="$delayed"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$delayed</span>
= <span class="var-default"> false</span> (line <span class="line-number">65</span>)
= <span class="var-default"> false</span> (line <span class="line-number">67</span>)
</span>
</div>
@ -252,13 +289,13 @@
</div>
<a name="var$fields" id="$fields"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$fields</span>
= <span class="var-default"> '*'</span> (line <span class="line-number">73</span>)
= <span class="var-default"> '*'</span> (line <span class="line-number">75</span>)
</span>
</div>
@ -274,13 +311,13 @@
</div>
<a name="var$group" id="$group"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$group</span>
= <span class="var-default"> false</span> (line <span class="line-number">105</span>)
= <span class="var-default"> false</span> (line <span class="line-number">119</span>)
</span>
</div>
@ -296,13 +333,13 @@
</div>
<a name="var$having" id="$having"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$having</span>
= <span class="var-default"> false</span> (line <span class="line-number">113</span>)
= <span class="var-default"> false</span> (line <span class="line-number">127</span>)
</span>
</div>
@ -318,13 +355,13 @@
</div>
<a name="var$joins" id="$joins"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$joins</span>
= <span class="var-default"> false</span> (line <span class="line-number">89</span>)
= <span class="var-default"> false</span> (line <span class="line-number">103</span>)
</span>
</div>
@ -340,13 +377,13 @@
</div>
<a name="var$limit" id="$limit"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$limit</span>
= <span class="var-default"> false</span> (line <span class="line-number">129</span>)
= <span class="var-default"> false</span> (line <span class="line-number">143</span>)
</span>
</div>
@ -362,13 +399,13 @@
</div>
<a name="var$offset" id="$offset"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$offset</span>
= <span class="var-default"> false</span> (line <span class="line-number">137</span>)
= <span class="var-default"> false</span> (line <span class="line-number">151</span>)
</span>
</div>
@ -385,13 +422,13 @@
</div>
<a name="var$order" id="$order"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$order</span>
= <span class="var-default"> false</span> (line <span class="line-number">121</span>)
= <span class="var-default"> false</span> (line <span class="line-number">135</span>)
</span>
</div>
@ -407,13 +444,13 @@
</div>
<a name="var$record" id="$record"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$record</span>
= <span class="var-default"> null</span> (line <span class="line-number">152</span>)
= <span class="var-default"> null</span> (line <span class="line-number">174</span>)
</span>
</div>
@ -429,13 +466,13 @@
</div>
<a name="var$records" id="$records"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$records</span>
= <span class="var-default"> null</span> (line <span class="line-number">159</span>)
= <span class="var-default"> null</span> (line <span class="line-number">181</span>)
</span>
</div>
@ -451,13 +488,13 @@
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">145</span>)
= <span class="var-default"> null</span> (line <span class="line-number">159</span>)
</span>
</div>
@ -473,13 +510,13 @@
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$table</span>
= <span class="var-default"> false</span> (line <span class="line-number">81</span>)
= <span class="var-default"> false</span> (line <span class="line-number">83</span>)
</span>
</div>
@ -522,10 +559,10 @@
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">171</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">205</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -561,10 +598,10 @@
</div>
<a name="methodcommit" id="commit"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">538</span>)
<span class="method-title">commit</span> (line <span class="line-number">654</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -587,10 +624,10 @@
</div>
<a name="methodcount" id="count"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">count</span> (line <span class="line-number">486</span>)
<span class="method-title">count</span> (line <span class="line-number">536</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -612,10 +649,10 @@
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">586</span>)
<span class="method-title">delete</span> (line <span class="line-number">705</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -637,22 +674,49 @@
</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="oddrow">
<a name="methodend" id="end"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">516</span>)
<span class="method-title">end</span> (line <span class="line-number">618</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">First Record</p>
<p class="description"><p>Set the pointer to the first element of the record set.</p></p>
<p class="short-description">End Record</p>
<p class="description"><p>Set the pointer to the last element of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and end() worked)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<span class="method-name">
end
</span>
()
</div>
</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">606</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">First Record</p>
<p class="description"><p>Alias of reset(). &quot;first&quot; is more intuitive to me, but reset stays in line with the built in PHP functions.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and could be reset)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
first
</span>
@ -666,18 +730,19 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">last</span> (line <span class="line-number">526</span>)
<span class="method-title">last</span> (line <span class="line-number">638</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Last Record</p>
<p class="description"><p>Set the pointer to the last element of the record set.</p></p>
<p class="description"><p>Alias of end(). &quot;last&quot; is more intuitive to me, but end stays in line with the built in PHP functions.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and end() worked)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<span class="method-name">
last
</span>
@ -691,18 +756,19 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">next</span> (line <span class="line-number">496</span>)
<span class="method-title">next</span> (line <span class="line-number">548</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Next Record</p>
<p class="description"><p>Increment the record array to the next member of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not there was next element</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<span class="method-name">
next
</span>
@ -716,18 +782,19 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">prev</span> (line <span class="line-number">506</span>)
<span class="method-title">prev</span> (line <span class="line-number">567</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Previous Record</p>
<p class="description"><p>Decrement the record array to the next member of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not there was previous element</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-result">boolean</span>
<span class="method-name">
prev
</span>
@ -737,11 +804,37 @@
</div>
<a name="methodunescape" id="unescape"><!-- --></a>
<a name="methodreset" id="reset"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">603</span>)
<span class="method-title">reset</span> (line <span class="line-number">586</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reset Record</p>
<p class="description"><p>Set the pointer to the first element of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and could be reset)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
reset
</span>
()
</div>
</div>
<a name="methodunescape" id="unescape"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">753</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -783,7 +876,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

36
docs/PICKLES/Module.html
View file

@ -154,7 +154,7 @@
</div>
<div class="info-box-body">
<a name="var$ajax" id="$ajax"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -179,7 +179,7 @@
</div>
<a name="var$db" id="$db"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -201,7 +201,7 @@
</div>
<a name="var$description" id="$description"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -224,7 +224,7 @@
</div>
<a name="var$engine" id="$engine"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -248,7 +248,7 @@
</div>
<a name="var$keywords" id="$keywords"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -271,7 +271,7 @@
</div>
<a name="var$request" id="$request"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -297,7 +297,7 @@
</div>
<a name="var$secure" id="$secure"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -322,7 +322,7 @@
</div>
<a name="var$security" id="$security"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -345,7 +345,7 @@
</div>
<a name="var$session" id="$session"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -369,13 +369,13 @@
</div>
<a name="var$template" id="$template"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$template</span>
= <span class="var-default"> null</span> (line <span class="line-number">124</span>)
= <span class="var-default"> 'index'</span> (line <span class="line-number">124</span>)
</span>
</div>
@ -393,7 +393,7 @@
</div>
<a name="var$title" id="$title"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -443,7 +443,7 @@
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">150</span>)
@ -479,7 +479,7 @@
</div>
<a name="methodsetRequest" id="setRequest"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">setRequest</span> (line <span class="line-number">221</span>)
@ -509,7 +509,7 @@
</div>
<a name="method__default" id="__default"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">__default</span> (line <span class="line-number">171</span>)
@ -534,7 +534,7 @@
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">198</span>)
@ -565,7 +565,7 @@
</div>
<a name="method__set" id="__set"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">184</span>)
@ -612,7 +612,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

8
docs/PICKLES/Object.html
View file

@ -246,7 +246,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">78</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">91</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -295,7 +295,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">49</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">58</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -356,7 +356,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">99</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">112</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -389,7 +389,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

84
docs/PICKLES/Profiler.html
View file

@ -52,6 +52,11 @@
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#enabled" title="details" class="method-name">enabled</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$type</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#log" title="details" class="method-name">log</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">false</span>])
@ -66,8 +71,13 @@
<a href="#report" title="details" class="method-name">report</a>
()
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#timer" title="details" class="method-name">timer</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$timer</span>)
</div>
</div>
</div>
</div>
</div>
@ -82,11 +92,43 @@
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodenabled" id="enabled"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method enabled</span> (line <span class="line-number">101</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enabled</p>
<p class="description"><p>Checks if the profiler is set to boolean true or if the passed type is specified in the profiler configuration value.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the type is enabled</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
enabled
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$type</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$type</span><span class="var-description">: type(s) to check</span> </li>
</ul>
</div>
<a name="methodlog" id="log"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method log</span> (line <span class="line-number">83</span>)
<span class="method-title">static method log</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -123,7 +165,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method logQuery</span> (line <span class="line-number">134</span>)
<span class="method-title">static method logQuery</span> (line <span class="line-number">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -163,7 +205,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method report</span> (line <span class="line-number">180</span>)
<span class="method-title">static method report</span> (line <span class="line-number">279</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -184,6 +226,38 @@
</div>
<a name="methodtimer" id="timer"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method timer</span> (line <span class="line-number">248</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Timer</p>
<p class="description"><p>Logs the start and end of a timer.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not timer profiling is enabled</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
timer
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$timer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$timer</span><span class="var-description">: name of the timer</span> </li>
</ul>
</div>
@ -192,7 +266,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

108
docs/PICKLES/Security.html
View file

@ -24,9 +24,9 @@
<p class="short-description">Security Class</p>
<p class="description"><p>Collection of static methods for handling security within a website running on PICKLES. Requires sessions to be enabled.</p></p>
<ul class="tags">
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodsetLevel">setLevel</a><span class="src-sym">(</span><span class="src-str">'level'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodlogin">login</a><span class="src-sym">(</span><span class="src-num">10</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodisLevel">isLevel</a><span class="src-sym">(</span><span class="src-str">'level'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodisLevel">isLevel</a><span class="src-sym">(</span><span class="src-id">SECURITY_LEVEL_ADMIN</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
</ul>
<p class="notes">
@ -53,26 +53,31 @@
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#clearLevel" title="details" class="method-name">clearLevel</a>
()
<a href="#betweenLevel" title="details" class="method-name">betweenLevel</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$low</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$high</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#hasLevel" title="details" class="method-name">hasLevel</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$user_level</span> = <span class="var-default">null</span>])
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#isLevel" title="details" class="method-name">isLevel</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$access_level</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$user_level</span> = <span class="var-default">null</span>])
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#setLevel" title="details" class="method-name">setLevel</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$access_level</span>)
<a href="#login" title="details" class="method-name">login</a>
(<span class="var-type">$user_id</span>&nbsp;<span class="var-name">$user_id</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#logout" title="details" class="method-name">logout</a>
()
</div>
</div>
</div>
</div>
</div>
@ -87,18 +92,18 @@
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodclearLevel" id="clearLevel"><!-- --></a>
<a name="methodbetweenLevel" id="betweenLevel"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method clearLevel</span> (line <span class="line-number">112</span>)
<span class="method-title">static method betweenLevel</span> (line <span class="line-number">324</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clear Level</p>
<p class="description"><p>Clears out the security level.</p></p>
<p class="short-description">Between Level</p>
<p class="description"><p>Checks the user's access level against the passed range.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">return:</span> whether or not the user has access</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -106,11 +111,19 @@
static
<span class="method-result">boolean</span>
<span class="method-name">
clearLevel
betweenLevel
</span>
()
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$low</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$high</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$low</span><span class="var-description">: access level to be checked against</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$high</span><span class="var-description">: access level to be checked against</span> </li>
</ul>
</div>
@ -118,7 +131,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method hasLevel</span> (line <span class="line-number">161</span>)
<span class="method-title">static method hasLevel</span> (line <span class="line-number">286</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -135,16 +148,13 @@
<span class="method-name">
hasLevel
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$user_level</span> = <span class="var-default">null</span>])
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$access_level</span><span class="var-description">: access level to be checked against</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$user_level</span><span class="var-description">: optional user's access level</span> </li>
</ul>
@ -153,7 +163,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method isLevel</span> (line <span class="line-number">131</span>)
<span class="method-title">static method isLevel</span> (line <span class="line-number">249</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -170,32 +180,29 @@
<span class="method-name">
isLevel
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$access_level</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$user_level</span> = <span class="var-default">null</span>])
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$access_level</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-type">integer</span>
<span class="var-name">$access_level</span><span class="var-description">: access level to be checked against</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$user_level</span><span class="var-description">: optional user's access level</span> </li>
</ul>
</div>
<a name="methodsetLevel" id="setLevel"><!-- --></a>
<a name="methodlogin" id="login"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method setLevel</span> (line <span class="line-number">95</span>)
<span class="method-title">static method login</span> (line <span class="line-number">116</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Level</p>
<p class="description"><p>Sets the security level.</p></p>
<p class="short-description">Login</p>
<p class="description"><p>Creates a session variable containing the user ID and generated token. The token is also assigned to a cookie to be used when validating the security level.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, thrown exception on error</li>
<li><span class="field">return:</span> whether or not the login could be completed</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -203,18 +210,45 @@
static
<span class="method-result">boolean</span>
<span class="method-name">
setLevel
login
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$access_level</span>)
(<span class="var-type">$user_id</span>&nbsp;<span class="var-name">$user_id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$access_level</span><span class="var-description">: access level to set this session to</span> </li>
<span class="var-type">$user_id</span>
<span class="var-name">$user_id</span><span class="var-description">: ID of the user that's been logged in</span> </li>
</ul>
</div>
<a name="methodlogout" id="logout"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method logout</span> (line <span class="line-number">145</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logout</p>
<p class="description"><p>Clears out the security information in the session and the cookie.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
logout
</span>
()
</div>
</div>
@ -223,7 +257,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Config.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Controller.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---Common.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---Mongo.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---PDO---Common.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---PDO---MySQL.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---PDO---PostgreSQL.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database---PDO---SQLite.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Database.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Display---Common.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Display---JSON.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Display---PHP.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Display---RSS.php.html
View file

@ -1,68 +0,0 @@
<?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 page RSS.php</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="file-name">/classes/Display/RSS.php</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-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">RSS Display Class File for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_RSS.html">Display_RSS</a>
</td>
<td>
RSS Display
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Display---XML.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Dynamic.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Error.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Form.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Log.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Model.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Module.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Object.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Profiler.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_classes---Security.php.html
View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

56
docs/PICKLES/_pickles.php.html
View file

@ -52,7 +52,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
(line <span class="line-number">46</span>)
(line <span class="line-number">45</span>)
</span>
</div>
@ -66,7 +66,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
(line <span class="line-number">47</span>)
(line <span class="line-number">46</span>)
</span>
</div>
@ -80,7 +80,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
(line <span class="line-number">48</span>)
(line <span class="line-number">47</span>)
</span>
</div>
@ -94,7 +94,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_XML</span> = 'XML'
(line <span class="line-number">49</span>)
(line <span class="line-number">48</span>)
</span>
</div>
@ -108,7 +108,7 @@
<div>
<span class="const-title">
<span class="const-name">JSON_AVAILABLE</span> = function_exists('json_encode')
(line <span class="line-number">52</span>)
(line <span class="line-number">51</span>)
</span>
</div>
@ -255,20 +255,6 @@
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSMARTY_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SMARTY_PATH</span> = PRIVATE_PATH.'smarty/'
(line <span class="line-number">43</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
@ -284,10 +270,10 @@
</div>
<div class="info-box-body">
<a name="function__autoload" id="function__autoload"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="method-title">__autoload</span> (line <span class="line-number">121</span>)
<span class="method-title">__autoload</span> (line <span class="line-number">122</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -314,15 +300,15 @@
</div>
<a name="function__handleError" id="function__handleError"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="method-title">__handleError</span> (line <span class="line-number">158</span>)
<span class="method-title">__handleError</span> (line <span class="line-number">163</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Error handling function that thinks it's magical</p>
<p class="description"><p>Catches errors (warnings and the like) and throws it back out as an ErrorException. This really helps trapping complex errors that need a ton of sanity checks, just try / catch and you're good. Also, this isn't a magic function, but I opted to use the __ prefix to help avoid a naming collision since namespace support is 5.3+ and PICKLES strives to be 5.0+ compatible.</p><p>Keep in mind that fetal errors cannot and will not be handled.</p></p>
<p class="description"><p>Catches errors (warnings and the like) and throws it back out as an ErrorException. This really helps trapping complex errors that need a ton of sanity checks, just try / catch and you're good. Also, this isn't a magic function, but I opted to use the __ prefix to help avoid a naming collision since namespace support is 5.3+ and PICKLES strives to be 5.0+ compatible.</p><p>Keep in mind that fatal errors cannot and will not be handled.</p></p>
<ul class="tags">
<li><span class="field">return:</span> not really returned, but worth documenting</li>
</ul>
@ -332,39 +318,39 @@
<span class="method-name">
__handleError
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$line</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$context</span>)
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$errno</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$errstr</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$errfile</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$errline</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$errcontext</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$number</span><span class="var-description">: error number</span> </li>
<span class="var-name">$errno</span><span class="var-description">: the level of the error raised</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$string</span><span class="var-description">: error string (message)</span> </li>
<span class="var-name">$errstr</span><span class="var-description">: the error message</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span><span class="var-description">: name of the file with the error</span> </li>
<span class="var-name">$errfile</span><span class="var-description">: filename that the error was raised in</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$line</span><span class="var-description">: line number the error occurred on</span> </li>
<span class="var-name">$errline</span><span class="var-description">: line number the error was raised at</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$context</span><span class="var-description">: variables that were in play</span> </li>
<span class="var-name">$errcontext</span><span class="var-description">: array of every vairable that existed in scope</span> </li>
</ul>
</div>
<a name="function__handleException" id="function__handleException"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="method-title">__handleException</span> (line <span class="line-number">176</span>)
<span class="method-title">__handleException</span> (line <span class="line-number">185</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Exception handling function</p>
<p class="description"><p>Catches thrown exceptions and displays them.</p></p>
<p class="short-description">Top level exception handling function</p>
<p class="description"><p>Catches uncaught exceptions and displays them.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
@ -386,7 +372,7 @@
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

8
docs/classtrees_PICKLES.html
View file

@ -29,7 +29,7 @@
<li><a href="PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a></li><li><a href="PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a></li><li><a href="PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></li></ul></li>
</ul></li>
<li><a href="PICKLES/Display_Common.html">Display_Common</a><ul>
<li><a href="PICKLES/Display_JSON.html">Display_JSON</a></li><li><a href="PICKLES/Display_PHP.html">Display_PHP</a></li><li><a href="PICKLES/Display_RSS.html">Display_RSS</a></li><li><a href="PICKLES/Display_XML.html">Display_XML</a></li></ul></li>
<li><a href="PICKLES/Display_JSON.html">Display_JSON</a></li><li><a href="PICKLES/Display_PHP.html">Display_PHP</a></li><li><a href="PICKLES/Display_XML.html">Display_XML</a></li></ul></li>
<li><a href="PICKLES/Dynamic.html">Dynamic</a></li><li><a href="PICKLES/Form.html">Form</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
</ul>
@ -41,8 +41,12 @@
<ul>
<li><a href="PICKLES/Security.html">Security</a></li></ul>
<h2>Root class String</h2>
<ul>
<li><a href="PICKLES/String.html">String</a></li></ul>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

306
docs/elementindex.html
View file

@ -17,6 +17,7 @@
<br />
<div class="index-letter-menu">
<a class="index-letter" href="elementindex.html#a">a</a>
<a class="index-letter" href="elementindex.html#b">b</a>
<a class="index-letter" href="elementindex.html#c">c</a>
<a class="index-letter" href="elementindex.html#d">d</a>
<a class="index-letter" href="elementindex.html#e">e</a>
@ -63,6 +64,21 @@
<div class="index-item-description">PDO Attributes</div>
</dd>
</dl>
<a name="b"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">b</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">betweenLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodbetweenLevel">Security::betweenLevel()</a> in Security.php</div>
<div class="index-item-description">Between Level</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">c</div>
@ -77,6 +93,13 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$child_template">Display_Common::$child_template</a> in Common.php</div>
<div class="index-item-description">Child (sub) Template</div>
</dd>
<dt class="field">
<span class="var-title">$collection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$collection">Model::$collection</a> in Model.php</div>
<div class="index-item-description">Collection Name</div>
</dd>
<dt class="field">
<span class="var-title">$conditions</span>
</dt>
@ -136,11 +159,11 @@
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="method-title">clearLevel</span>
<span class="method-title">close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodclearLevel">Security::clearLevel()</a> in Security.php</div>
<div class="index-item-description">Clear Level</div>
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a> in Mongo.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
@ -156,13 +179,6 @@
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a> in Common.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a> in Mongo.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">commit</span>
</dt>
@ -252,14 +268,7 @@
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a> in Common.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a> in Mongo.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a> in PostgreSQL.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
@ -273,21 +282,21 @@
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a> in PostgreSQL.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a> in Common.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a> in Mongo.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html#var$dsn">Database_PDO_MySQL::$dsn</a> in MySQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a> in PostgreSQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
@ -301,7 +310,14 @@
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a> in PostgreSQL.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a> in Common.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html#var$dsn">Database_PDO_MySQL::$dsn</a> in MySQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
@ -386,12 +402,6 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html">Display_Common</a> in Common.php</div>
<div class="index-item-description">Common Display Class</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
Display_JSON
</dt>
@ -399,6 +409,12 @@
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
</dt>
@ -412,19 +428,18 @@
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
Display_RSS
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_RSS.html">Display_RSS</a> in RSS.php</div>
<div class="index-item-description">RSS Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
</dd>
<dt class="field">
Display_XML
</dt>
@ -432,12 +447,6 @@
<div class="index-item-details"><a href="PICKLES/Display_XML.html">Display_XML</a> in XML.php</div>
<div class="index-item-description">XML Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">dobSelect</span>
</dt>
@ -471,14 +480,14 @@
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
@ -488,11 +497,18 @@
<div class="index-item-details"><a href="PICKLES/_classes---Error.php.html">Error.php</a> in Error.php</div>
</dd>
<dt class="field">
Error
<span class="method-title">enabled</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html">Error</a> in Error.php</div>
<div class="index-item-description">Error Class</div>
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodenabled">Profiler::enabled()</a> in Profiler.php</div>
<div class="index-item-description">Enabled</div>
</dd>
<dt class="field">
<span class="method-title">end</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodend">Model::end()</a> in Model.php</div>
<div class="index-item-description">End Record</div>
</dd>
<dt class="field">
<span class="method-title">error</span>
@ -501,6 +517,13 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methoderror">Log::error()</a> in Log.php</div>
<div class="index-item-description">Log Error</div>
</dd>
<dt class="field">
Error
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html">Error</a> in Error.php</div>
<div class="index-item-description">Error Class</div>
</dd>
<dt class="field">
<span class="method-title">execute</span>
</dt>
@ -540,36 +563,15 @@
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetch">Database_Mongo::fetch()</a> in Mongo.php</div>
<div class="index-item-description">Fetch a single row from the database</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a> in Common.php</div>
<div class="index-item-description">Fetch records from the database</div>
</dd>
<dt class="field">
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a> in Common.php</div>
<div class="index-item-description">Fetch a single row from the database</div>
</dd>
<dt class="field">
<span class="method-title">fetchAll</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetchAll">Database_PDO_Common::fetchAll()</a> in Common.php</div>
<div class="index-item-description">Fetches all rows as an array</div>
</dd>
<dt class="field">
<span class="method-title">fetchAll</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetchAll">Database_Mongo::fetchAll()</a> in Mongo.php</div>
<div class="index-item-description">Fetches all rows as an array</div>
</dd>
<dt class="field">
<span class="method-title">fetchColumn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetchColumn">Database_PDO_Common::fetchColumn()</a> in Common.php</div>
<div class="index-item-description">Fetch a single column from the database</div>
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetch">Database_Mongo::fetch()</a> in Mongo.php</div>
<div class="index-item-description">Fetch records from the database</div>
</dd>
<dt class="field">
<span class="method-title">first</span>
@ -585,6 +587,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html">Form</a> in Form.php</div>
<div class="index-item-description">Form Class</div>
</dd>
<dt class="field">
<span class="method-title">formatPhoneNumber</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodformatPhoneNumber">String::formatPhoneNumber()</a> in String.php</div>
<div class="index-item-description">Format Phone Number</div>
</dd>
</dl>
<a name="g"></a>
<div class="index-letter-section">
@ -601,17 +610,17 @@
<div class="index-item-description">Group</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
<span class="method-title">getDriver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a> in Common.php</div>
<div class="index-item-description">Get Driver</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Form.html#methodgetInstance">Form::getInstance()</a> in Form.php</div>
<div class="index-item-details"><a href="PICKLES/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</div>
</dd>
<dt class="field">
@ -628,6 +637,13 @@
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<div class="index-item-description">Get instance of the object</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Form.html#methodgetInstance">Form::getInstance()</a> in Form.php</div>
<div class="index-item-description">Get Instance</div>
</dd>
</dl>
<a name="h"></a>
<div class="index-letter-section">
@ -735,6 +751,13 @@
<div class="index-item-details"><a href="PICKLES/Dynamic.html#methodjs">Dynamic::js()</a> in Dynamic.php</div>
<div class="index-item-description">Generate Javascript Reference</div>
</dd>
<dt class="field">
<span class="method-title">jsonEncode</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a> in Common.php</div>
<div class="index-item-description">JSON Encode</div>
</dd>
<dt class="field">
<span class="const-title">JSON_AVAILABLE</span>
</dt>
@ -791,6 +814,13 @@
<div class="index-item-details"><a href="PICKLES/Config.html#methodload">Config::load()</a> in Config.php</div>
<div class="index-item-description">Loads a configuration file</div>
</dd>
<dt class="field">
Log
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
</dd>
<dt class="field">
<span class="method-title">log</span>
</dt>
@ -799,11 +829,18 @@
<div class="index-item-description">Log</div>
</dd>
<dt class="field">
Log
<span class="method-title">login</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
<div class="index-item-details"><a href="PICKLES/Security.html#methodlogin">Security::login()</a> in Security.php</div>
<div class="index-item-description">Login</div>
</dd>
<dt class="field">
<span class="method-title">logout</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodlogout">Security::logout()</a> in Security.php</div>
<div class="index-item-description">Logout</div>
</dd>
<dt class="field">
<span class="method-title">logQuery</span>
@ -939,14 +976,14 @@
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodopen">Database_Common::open()</a> in Common.php</div>
<div class="index-item-description">Opens database connection</div>
</dd>
<dt class="field">
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodopen">Database_Common::open()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a> in Common.php</div>
<div class="index-item-description">Opens database connection</div>
</dd>
<dt class="field">
@ -982,15 +1019,15 @@
<span class="var-title">$port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$port">Database_Common::$port</a> in Common.php</div>
<div class="index-item-description">Port number for the server</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a> in PostgreSQL.php</div>
<div class="index-item-description">Default port</div>
</dd>
<dt class="field">
<span class="var-title">$port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a> in PostgreSQL.php</div>
<div class="index-item-description">Default port</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$port">Database_Common::$port</a> in Common.php</div>
<div class="index-item-description">Port number for the server</div>
</dd>
<dt class="field">
<span class="var-title">$port</span>
@ -1136,21 +1173,22 @@
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$results">Database_Common::$results</a> in Common.php</div>
<div class="index-item-description">Results object for the executed statement</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$results">Model::$results</a> in Model.php</div>
<div class="index-item-description">Query Results</div>
</dd>
<dt class="field">
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$results">Model::$results</a> in Model.php</div>
<div class="index-item-description">Query Results</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$results">Database_Common::$results</a> in Common.php</div>
<div class="index-item-description">Results object for the executed statement</div>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
<span class="method-title">random</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---RSS.php.html">RSS.php</a> in RSS.php</div>
<div class="index-item-details"><a href="PICKLES/String.html#methodrandom">String::random()</a> in String.php</div>
<div class="index-item-description">Random</div>
</dd>
<dt class="field">
<span class="method-title">ref</span>
@ -1162,13 +1200,6 @@
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a> in RSS.php</div>
<div class="index-item-description">Render the RSS feed data</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_XML.html#methodrender">Display_XML::render()</a> in XML.php</div>
<div class="index-item-description">Renders the data in XML format</div>
@ -1184,15 +1215,15 @@
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Rendering Method</div>
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
<div class="index-item-description">Renders the data in JSON format</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
<div class="index-item-description">Renders the data in JSON format</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Rendering Method</div>
</dd>
<dt class="field">
<span class="method-title">report</span>
@ -1201,6 +1232,13 @@
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodreport">Profiler::report()</a> in Profiler.php</div>
<div class="index-item-description">Report</div>
</dd>
<dt class="field">
<span class="method-title">reset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodreset">Model::reset()</a> in Model.php</div>
<div class="index-item-description">Reset Record</div>
</dd>
</dl>
<a name="s"></a>
<div class="index-letter-section">
@ -1249,6 +1287,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Security.php.html">Security.php</a> in Security.php</div>
</dd>
<dt class="field">
<span class="include-title">String.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---String.php.html">String.php</a> in String.php</div>
</dd>
<dt class="field">
Security
</dt>
@ -1277,13 +1321,6 @@
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a> in Common.php</div>
<div class="index-item-description">Set Hostname</div>
</dd>
<dt class="field">
<span class="method-title">setLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodsetLevel">Security::setLevel()</a> in Security.php</div>
<div class="index-item-description">Set Level</div>
</dd>
<dt class="field">
<span class="method-title">setMetaData</span>
</dt>
@ -1377,12 +1414,6 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methodslowQuery">Log::slowQuery()</a> in Log.php</div>
<div class="index-item-description">Log Slow Query</div>
</dd>
<dt class="field">
<span class="const-title">SMARTY_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSMARTY_PATH">SMARTY_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">stateSelect</span>
</dt>
@ -1390,6 +1421,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodstateSelect">Form::stateSelect()</a> in Form.php</div>
<div class="index-item-description">State Select</div>
</dd>
<dt class="field">
String
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html">String</a> in String.php</div>
<div class="index-item-description">String Class</div>
</dd>
</dl>
<a name="t"></a>
<div class="index-letter-section">
@ -1440,6 +1478,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodtextarea">Form::textarea()</a> in Form.php</div>
<div class="index-item-description">Text Area</div>
</dd>
<dt class="field">
<span class="method-title">timer</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodtimer">Profiler::timer()</a> in Profiler.php</div>
<div class="index-item-description">Timer</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>
@ -1447,6 +1492,13 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methodtransaction">Log::transaction()</a> in Log.php</div>
<div class="index-item-description">Log Credit Card Transaction</div>
</dd>
<dt class="field">
<span class="method-title">truncate</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodtruncate">String::truncate()</a> in String.php</div>
<div class="index-item-description">Truncate</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
@ -1469,6 +1521,13 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methodunescape">Model::unescape()</a> in Model.php</div>
<div class="index-item-description">Unescape String</div>
</dd>
<dt class="field">
<span class="method-title">upperWords</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodupperWords">String::upperWords()</a> in String.php</div>
<div class="index-item-description">Upper Words</div>
</dd>
</dl>
<a name="w"></a>
<div class="index-letter-section">
@ -1524,7 +1583,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -1566,7 +1625,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -1622,7 +1681,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#function__handleException">__handleException()</a> in pickles.php</div>
<div class="index-item-description">Exception handling function</div>
<div class="index-item-description">Top level exception handling function</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
@ -1642,6 +1701,7 @@
<div class="index-letter-menu">
<a class="index-letter" href="elementindex.html#a">a</a>
<a class="index-letter" href="elementindex.html#b">b</a>
<a class="index-letter" href="elementindex.html#c">c</a>
<a class="index-letter" href="elementindex.html#d">d</a>
<a class="index-letter" href="elementindex.html#e">e</a>

306
docs/elementindex_PICKLES.html
View file

@ -14,6 +14,7 @@
<br />
<div class="index-letter-menu">
<a class="index-letter" href="elementindex_PICKLES.html#a">a</a>
<a class="index-letter" href="elementindex_PICKLES.html#b">b</a>
<a class="index-letter" href="elementindex_PICKLES.html#c">c</a>
<a class="index-letter" href="elementindex_PICKLES.html#d">d</a>
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>
@ -63,7 +64,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -105,7 +106,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -161,7 +162,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#function__handleException">__handleException()</a> in pickles.php</div>
<div class="index-item-description">Exception handling function</div>
<div class="index-item-description">Top level exception handling function</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
@ -200,6 +201,21 @@
<div class="index-item-description">PDO Attributes</div>
</dd>
</dl>
<a name="b"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">b</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">betweenLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodbetweenLevel">Security::betweenLevel()</a> in Security.php</div>
<div class="index-item-description">Between Level</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">c</div>
@ -214,6 +230,13 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$child_template">Display_Common::$child_template</a> in Common.php</div>
<div class="index-item-description">Child (sub) Template</div>
</dd>
<dt class="field">
<span class="var-title">$collection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$collection">Model::$collection</a> in Model.php</div>
<div class="index-item-description">Collection Name</div>
</dd>
<dt class="field">
<span class="var-title">$conditions</span>
</dt>
@ -273,11 +296,11 @@
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="method-title">clearLevel</span>
<span class="method-title">close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodclearLevel">Security::clearLevel()</a> in Security.php</div>
<div class="index-item-description">Clear Level</div>
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a> in Mongo.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
@ -293,13 +316,6 @@
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a> in Common.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a> in Mongo.php</div>
<div class="index-item-description">Closes database connection</div>
</dd>
<dt class="field">
<span class="method-title">commit</span>
</dt>
@ -389,14 +405,7 @@
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a> in Common.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a> in Mongo.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a> in PostgreSQL.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
@ -410,21 +419,21 @@
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a> in PostgreSQL.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a> in Common.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$driver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a> in Mongo.php</div>
<div class="index-item-description">Driver</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html#var$dsn">Database_PDO_MySQL::$dsn</a> in MySQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a> in PostgreSQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
@ -438,7 +447,14 @@
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a> in PostgreSQL.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a> in Common.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html#var$dsn">Database_PDO_MySQL::$dsn</a> in MySQL.php</div>
<div class="index-item-description">DSN format</div>
</dd>
<dt class="field">
@ -523,12 +539,6 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html">Display_Common</a> in Common.php</div>
<div class="index-item-description">Common Display Class</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
Display_JSON
</dt>
@ -536,6 +546,12 @@
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
</dt>
@ -549,19 +565,18 @@
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
Display_RSS
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_RSS.html">Display_RSS</a> in RSS.php</div>
<div class="index-item-description">RSS Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
</dd>
<dt class="field">
Display_XML
</dt>
@ -569,12 +584,6 @@
<div class="index-item-details"><a href="PICKLES/Display_XML.html">Display_XML</a> in XML.php</div>
<div class="index-item-description">XML Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">dobSelect</span>
</dt>
@ -608,14 +617,14 @@
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
@ -625,11 +634,18 @@
<div class="index-item-details"><a href="PICKLES/_classes---Error.php.html">Error.php</a> in Error.php</div>
</dd>
<dt class="field">
Error
<span class="method-title">enabled</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html">Error</a> in Error.php</div>
<div class="index-item-description">Error Class</div>
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodenabled">Profiler::enabled()</a> in Profiler.php</div>
<div class="index-item-description">Enabled</div>
</dd>
<dt class="field">
<span class="method-title">end</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodend">Model::end()</a> in Model.php</div>
<div class="index-item-description">End Record</div>
</dd>
<dt class="field">
<span class="method-title">error</span>
@ -638,6 +654,13 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methoderror">Log::error()</a> in Log.php</div>
<div class="index-item-description">Log Error</div>
</dd>
<dt class="field">
Error
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html">Error</a> in Error.php</div>
<div class="index-item-description">Error Class</div>
</dd>
<dt class="field">
<span class="method-title">execute</span>
</dt>
@ -677,36 +700,15 @@
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetch">Database_Mongo::fetch()</a> in Mongo.php</div>
<div class="index-item-description">Fetch a single row from the database</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a> in Common.php</div>
<div class="index-item-description">Fetch records from the database</div>
</dd>
<dt class="field">
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetch">Database_PDO_Common::fetch()</a> in Common.php</div>
<div class="index-item-description">Fetch a single row from the database</div>
</dd>
<dt class="field">
<span class="method-title">fetchAll</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetchAll">Database_PDO_Common::fetchAll()</a> in Common.php</div>
<div class="index-item-description">Fetches all rows as an array</div>
</dd>
<dt class="field">
<span class="method-title">fetchAll</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetchAll">Database_Mongo::fetchAll()</a> in Mongo.php</div>
<div class="index-item-description">Fetches all rows as an array</div>
</dd>
<dt class="field">
<span class="method-title">fetchColumn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodfetchColumn">Database_PDO_Common::fetchColumn()</a> in Common.php</div>
<div class="index-item-description">Fetch a single column from the database</div>
<div class="index-item-details"><a href="PICKLES/Database_Mongo.html#methodfetch">Database_Mongo::fetch()</a> in Mongo.php</div>
<div class="index-item-description">Fetch records from the database</div>
</dd>
<dt class="field">
<span class="method-title">first</span>
@ -722,6 +724,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html">Form</a> in Form.php</div>
<div class="index-item-description">Form Class</div>
</dd>
<dt class="field">
<span class="method-title">formatPhoneNumber</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodformatPhoneNumber">String::formatPhoneNumber()</a> in String.php</div>
<div class="index-item-description">Format Phone Number</div>
</dd>
</dl>
<a name="g"></a>
<div class="index-letter-section">
@ -738,17 +747,17 @@
<div class="index-item-description">Group</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
<span class="method-title">getDriver</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a> in Common.php</div>
<div class="index-item-description">Get Driver</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Form.html#methodgetInstance">Form::getInstance()</a> in Form.php</div>
<div class="index-item-details"><a href="PICKLES/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</div>
</dd>
<dt class="field">
@ -765,6 +774,13 @@
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<div class="index-item-description">Get instance of the object</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Form.html#methodgetInstance">Form::getInstance()</a> in Form.php</div>
<div class="index-item-description">Get Instance</div>
</dd>
</dl>
<a name="h"></a>
<div class="index-letter-section">
@ -872,6 +888,13 @@
<div class="index-item-details"><a href="PICKLES/Dynamic.html#methodjs">Dynamic::js()</a> in Dynamic.php</div>
<div class="index-item-description">Generate Javascript Reference</div>
</dd>
<dt class="field">
<span class="method-title">jsonEncode</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a> in Common.php</div>
<div class="index-item-description">JSON Encode</div>
</dd>
<dt class="field">
<span class="const-title">JSON_AVAILABLE</span>
</dt>
@ -928,6 +951,13 @@
<div class="index-item-details"><a href="PICKLES/Config.html#methodload">Config::load()</a> in Config.php</div>
<div class="index-item-description">Loads a configuration file</div>
</dd>
<dt class="field">
Log
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
</dd>
<dt class="field">
<span class="method-title">log</span>
</dt>
@ -936,11 +966,18 @@
<div class="index-item-description">Log</div>
</dd>
<dt class="field">
Log
<span class="method-title">login</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
<div class="index-item-details"><a href="PICKLES/Security.html#methodlogin">Security::login()</a> in Security.php</div>
<div class="index-item-description">Login</div>
</dd>
<dt class="field">
<span class="method-title">logout</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodlogout">Security::logout()</a> in Security.php</div>
<div class="index-item-description">Logout</div>
</dd>
<dt class="field">
<span class="method-title">logQuery</span>
@ -1076,14 +1113,14 @@
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodopen">Database_Common::open()</a> in Common.php</div>
<div class="index-item-description">Opens database connection</div>
</dd>
<dt class="field">
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodopen">Database_Common::open()</a> in Common.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a> in Common.php</div>
<div class="index-item-description">Opens database connection</div>
</dd>
<dt class="field">
@ -1119,15 +1156,15 @@
<span class="var-title">$port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$port">Database_Common::$port</a> in Common.php</div>
<div class="index-item-description">Port number for the server</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a> in PostgreSQL.php</div>
<div class="index-item-description">Default port</div>
</dd>
<dt class="field">
<span class="var-title">$port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a> in PostgreSQL.php</div>
<div class="index-item-description">Default port</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$port">Database_Common::$port</a> in Common.php</div>
<div class="index-item-description">Port number for the server</div>
</dd>
<dt class="field">
<span class="var-title">$port</span>
@ -1273,21 +1310,22 @@
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$results">Database_Common::$results</a> in Common.php</div>
<div class="index-item-description">Results object for the executed statement</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$results">Model::$results</a> in Model.php</div>
<div class="index-item-description">Query Results</div>
</dd>
<dt class="field">
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$results">Model::$results</a> in Model.php</div>
<div class="index-item-description">Query Results</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$results">Database_Common::$results</a> in Common.php</div>
<div class="index-item-description">Results object for the executed statement</div>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
<span class="method-title">random</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---RSS.php.html">RSS.php</a> in RSS.php</div>
<div class="index-item-details"><a href="PICKLES/String.html#methodrandom">String::random()</a> in String.php</div>
<div class="index-item-description">Random</div>
</dd>
<dt class="field">
<span class="method-title">ref</span>
@ -1299,13 +1337,6 @@
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a> in RSS.php</div>
<div class="index-item-description">Render the RSS feed data</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_XML.html#methodrender">Display_XML::render()</a> in XML.php</div>
<div class="index-item-description">Renders the data in XML format</div>
@ -1321,15 +1352,15 @@
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Rendering Method</div>
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
<div class="index-item-description">Renders the data in JSON format</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
<div class="index-item-description">Renders the data in JSON format</div>
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Rendering Method</div>
</dd>
<dt class="field">
<span class="method-title">report</span>
@ -1338,6 +1369,13 @@
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodreport">Profiler::report()</a> in Profiler.php</div>
<div class="index-item-description">Report</div>
</dd>
<dt class="field">
<span class="method-title">reset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodreset">Model::reset()</a> in Model.php</div>
<div class="index-item-description">Reset Record</div>
</dd>
</dl>
<a name="s"></a>
<div class="index-letter-section">
@ -1386,6 +1424,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Security.php.html">Security.php</a> in Security.php</div>
</dd>
<dt class="field">
<span class="include-title">String.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---String.php.html">String.php</a> in String.php</div>
</dd>
<dt class="field">
Security
</dt>
@ -1414,13 +1458,6 @@
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a> in Common.php</div>
<div class="index-item-description">Set Hostname</div>
</dd>
<dt class="field">
<span class="method-title">setLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodsetLevel">Security::setLevel()</a> in Security.php</div>
<div class="index-item-description">Set Level</div>
</dd>
<dt class="field">
<span class="method-title">setMetaData</span>
</dt>
@ -1514,12 +1551,6 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methodslowQuery">Log::slowQuery()</a> in Log.php</div>
<div class="index-item-description">Log Slow Query</div>
</dd>
<dt class="field">
<span class="const-title">SMARTY_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSMARTY_PATH">SMARTY_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">stateSelect</span>
</dt>
@ -1527,6 +1558,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodstateSelect">Form::stateSelect()</a> in Form.php</div>
<div class="index-item-description">State Select</div>
</dd>
<dt class="field">
String
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html">String</a> in String.php</div>
<div class="index-item-description">String Class</div>
</dd>
</dl>
<a name="t"></a>
<div class="index-letter-section">
@ -1577,6 +1615,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodtextarea">Form::textarea()</a> in Form.php</div>
<div class="index-item-description">Text Area</div>
</dd>
<dt class="field">
<span class="method-title">timer</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Profiler.html#methodtimer">Profiler::timer()</a> in Profiler.php</div>
<div class="index-item-description">Timer</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>
@ -1584,6 +1629,13 @@
<div class="index-item-details"><a href="PICKLES/Log.html#methodtransaction">Log::transaction()</a> in Log.php</div>
<div class="index-item-description">Log Credit Card Transaction</div>
</dd>
<dt class="field">
<span class="method-title">truncate</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodtruncate">String::truncate()</a> in String.php</div>
<div class="index-item-description">Truncate</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
@ -1606,6 +1658,13 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methodunescape">Model::unescape()</a> in Model.php</div>
<div class="index-item-description">Unescape String</div>
</dd>
<dt class="field">
<span class="method-title">upperWords</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/String.html#methodupperWords">String::upperWords()</a> in String.php</div>
<div class="index-item-description">Upper Words</div>
</dd>
</dl>
<a name="w"></a>
<div class="index-letter-section">
@ -1639,6 +1698,7 @@
<div class="index-letter-menu">
<a class="index-letter" href="elementindex_PICKLES.html#a">a</a>
<a class="index-letter" href="elementindex_PICKLES.html#b">b</a>
<a class="index-letter" href="elementindex_PICKLES.html#c">c</a>
<a class="index-letter" href="elementindex_PICKLES.html#d">d</a>
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>

28
docs/errors.html
View file

@ -9,8 +9,8 @@
</head>
<body>
<a href="#Post-parsing">Post-parsing</a><br>
<a href="#Config.php">Config.php</a><br>
<a href="#config.php">config.php</a><br>
<a href="#Config.php">Config.php</a><br>
<a href="#Controller.php">Controller.php</a><br>
<a href="#Database.php">Database.php</a><br>
<a href="#Dynamic.php">Dynamic.php</a><br>
@ -31,25 +31,25 @@
<a href="#pickles.php">pickles.php</a><br>
<a href="#PostgreSQL.php">PostgreSQL.php</a><br>
<a href="#Profiler.php">Profiler.php</a><br>
<a href="#RSS.php">RSS.php</a><br>
<a href="#SampleModel.php">SampleModel.php</a><br>
<a href="#Security.php">Security.php</a><br>
<a href="#SQLite.php">SQLite.php</a><br>
<a href="#String.php">String.php</a><br>
<a href="#XML.php">XML.php</a><br>
<a name="Common.php"></a>
<h1>Common.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Database_PDO_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Database_Common<br>
<a name="config.php"></a>
<h1>config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 63</b> - File "/home/josh/Source/pickles/launchpad/config.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<a name="Config.php"></a>
<h1>Config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 30</b> - no @package tag was used in a DocBlock for class Config<br>
<a name="config.php"></a>
<h1>config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 63</b> - File "/home/josh/Source/pickles/launchpad/config.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Controller.php"></a>
<h1>Controller.php</h1>
<h2>Warnings:</h2><br>
@ -61,7 +61,7 @@
<a name="Dynamic.php"></a>
<h1>Dynamic.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Dynamic<br>
<b>Warning on line 29</b> - no @package tag was used in a DocBlock for class Dynamic<br>
<a name="Error.php"></a>
<h1>Error.php</h1>
<h2>Warnings:</h2><br>
@ -86,7 +86,7 @@
<a name="index.phtml"></a>
<h1>index.phtml</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 13</b> - File "/home/josh/Source/pickles/launchpad/templates/index.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 13</b> - File "/home/josh/Source/pickles/launchpad/templates/__shared/index.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="JSON.php"></a>
<h1>JSON.php</h1>
<h2>Warnings:</h2><br>
@ -135,10 +135,6 @@
<h1>Profiler.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 34</b> - no @package tag was used in a DocBlock for class Profiler<br>
<a name="RSS.php"></a>
<h1>RSS.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Display_RSS<br>
<a name="SampleModel.php"></a>
<h1>SampleModel.php</h1>
<h2>Warnings:</h2><br>
@ -152,12 +148,16 @@
<h1>SQLite.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for class Database_PDO_SQLite<br>
<a name="String.php"></a>
<h1>String.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class String<br>
<a name="XML.php"></a>
<h1>XML.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 30</b> - no @package tag was used in a DocBlock for class Display_XML<br>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

2
docs/index.html
View file

@ -4,7 +4,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Generated by phpDocumentor on Sun, 17 Oct 2010 23:17:22 -0400 -->
<!-- Generated by phpDocumentor on Wed, 24 Nov 2010 23:41:51 -0500 -->
<title>PHP Interface Collection of Killer Libraries to Enhance Stuff</title>
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>

6
docs/li_PICKLES.html
View file

@ -35,7 +35,6 @@
<dd><a href='PICKLES/Display_Common.html' target='right'>Display_Common</a></dd>
<dd><a href='PICKLES/Display_JSON.html' target='right'>Display_JSON</a></dd>
<dd><a href='PICKLES/Display_PHP.html' target='right'>Display_PHP</a></dd>
<dd><a href='PICKLES/Display_RSS.html' target='right'>Display_RSS</a></dd>
<dd><a href='PICKLES/Display_XML.html' target='right'>Display_XML</a></dd>
<dd><a href='PICKLES/Dynamic.html' target='right'>Dynamic</a></dd>
<dd><a href='PICKLES/Error.html' target='right'>Error</a></dd>
@ -46,13 +45,14 @@
<dd><a href='PICKLES/Object.html' target='right'>Object</a></dd>
<dd><a href='PICKLES/Profiler.html' target='right'>Profiler</a></dd>
<dd><a href='PICKLES/Security.html' target='right'>Security</a></dd>
<dd><a href='PICKLES/String.html' target='right'>String</a></dd>
<dt class="folder-title">Functions</dt>
<dd><a href='PICKLES/_pickles.php.html#function__autoload' target='right'>__autoload</a></dd>
<dd><a href='PICKLES/_pickles.php.html#function__handleError' target='right'>__handleError</a></dd>
<dd><a href='PICKLES/_pickles.php.html#function__handleException' target='right'>__handleException</a></dd>
<dt class="folder-title">Files</dt>
<dd><a href='PICKLES/_classes---Database---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Display---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Database---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Config.php.html' target='right'>Config.php</a></dd>
<dd><a href='PICKLES/_classes---Controller.php.html' target='right'>Controller.php</a></dd>
@ -71,9 +71,9 @@
<dd><a href='PICKLES/_pickles.php.html' target='right'>pickles.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---PostgreSQL.php.html' target='right'>PostgreSQL.php</a></dd>
<dd><a href='PICKLES/_classes---Profiler.php.html' target='right'>Profiler.php</a></dd>
<dd><a href='PICKLES/_classes---Display---RSS.php.html' target='right'>RSS.php</a></dd>
<dd><a href='PICKLES/_classes---Security.php.html' target='right'>Security.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---SQLite.php.html' target='right'>SQLite.php</a></dd>
<dd><a href='PICKLES/_classes---String.php.html' target='right'>String.php</a></dd>
<dd><a href='PICKLES/_classes---Display---XML.php.html' target='right'>XML.php</a></dd>

2
docs/ric_MIT-LICENSE.txt.html
View file

@ -34,7 +34,7 @@ THE SOFTWARE.
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

105
docs/ric_README.md.html
View file

@ -10,89 +10,58 @@
<body>
<h1 align="center">README.md</h1>
<pre>
______ _____ _____ _ __ _ _____ _____
| ___ \_ _/ __ \| | / /| | | ___/ ___|
| |_/ / | | | / \/| |/ / | | | |__ \ `--.
| __/ | | | | | \ | | | __| `--. \
| | _| |_| \__/\| |\ \| |____| |___/\__/ /
\_| \___/ \____/\_| \_/\_____/\____/\____/
PHP Interface Collection of Killer Libraries to Enhance Stuff
===========================================================================
# PHP Interface Collection of Killer Libraries to Enhance Stuff
What is PICKLES?
----------------
## What is PICKLES?
The whole point behind PHP with PICKLES was for me (Josh Sherman) to take
a decade of PHP experience and a dozen or so of my own websites (all
running on different but similar custom systems of my own design) and build
a new framework / rapid development system that would be flexible enough to
run all of my sites off of a single shared code base. PICKLES runs in such a
way that the core files are completely separate from the site code it's
serving. So much so, that the core files should never really need to be
accessed after installation (unless you want to void your warranty and/or
make a global change to all of your sites), and each site you have running
will be nicely packaged in a directory all it's own. This keeps your sites
simple and tidy with no duplicated code for each site! In a site's
directory, models and modules (page logic) and templates are kept separate
from each other and everything is ran through a single entry point
controller.
PICKLES is an open source framework for the rapid development of web applications.
Okay, but why?
--------------
## Okay, but why?
Now I know you're wondering, &quot;why didn't you just use one of the
preexisting and already established PHP frameworks that are out there?&quot; I
do have a handful of reasons for that, but those are personal gripes based
on a limited number of experiences and I won't be going into detail
about them. The main reason for developing my own framework is that I am,
and also have been, a very do it yourself type when it comes to coding, and
typically very proud of my coding accomplishments. Also, because all of the
sites I had previously written shared a lot of the same concepts and in
some cases, the same bits of code, it made a heck of a lot more sense for
me to develop a new system based around some of the better concepts from
previous outings than to rebuild my sites inside of another framework.
I could have went with any number of existing frameworks, but I opted to build my own because I like to code. I've built quite a few sites from the ground up over the years, and I wanted to roll that experience into a single system that I could not only use for my sites, but share with the world.
Get the facts!
--------------
## Wait, what, it's not MVC?
* PICKLES will only run on PHP 5.0.0 or greater. There are no plans to
ever support PHP 4.x.y (or below) as those versions have reached end of
life, so please don't ask.
PICKLES is in fact not a true MVC system and won't be masquerading around as one (yeah, I know, I borrowed some naming conventions). PICKLES does have a main controller that handles incoming page views. The controller loads a module that contains all of the business logic (optionally interacting with data models) and then execution is passed off to the display layer. The display layer gives the user what they asked for (even if they didn't say please). This is how web pages work, and there has never been a reason for me to force PICKLES into the MVC box just for the hell of it.
* PICKLES is not Model-View-Controller (MVC). It was developed around
concepts (as well as some naming conventions) of the MVC design pattern
but does not entirely conform to my own understanding of MVC. I'm from
the school of thought that there's not a single hammer for every nail,
so there's no point in forcing PICKLES into the MVC box for the sake of
it. PICKLES strives to provide a modular system for developing websites
while keeping the display elements separated from any database calls and
other logic. That isn't necessarily a bad thing, it just means that
PICKLES isn't all that trendy because it lacks a silly buzzword that's a
bit overused at this point.
## Requirements
* PICKLES supports rendering Smarty template pages, returning JSON data
and RSS feeds (currently only supports version 2.0) and is fully capable
of running from the command line modes.
### Required Software
* PICKLES is coded fairly close to the PEAR coding standards and is fully
documented in DocBlock notation.
* Apache (should run on 1.3+)
* Apache Module mod_rewrite
* PHP 5.0+
* Included with PICKLES are shared CSS files (foundation classes and one to
do a full CSS reset) and shared JavaScript files with includes jQuery
(and some plug-ins / add-ons) and a core JavaScript file which includes
automatic AJAXing of forms and some other niceties.
### Highly Recommended Software
* Writing error free code is very important to me, so any PHP development I
do is made to be E_STRICT compatible. This means that not only is PICKLES
code free of any errors, it is free of warnings as well.
* PHP 5.2.0+ for native JSON support or PECL JSON 1.2.1 (included)
* Depending on your server, any number of sites can be ran off of a single
PICKLES install!
### Optional Software
* MySQL with PDO and PDO_MYSQL drivers
* PostgreSQL with PDO and PDO_PGSQL drivers
* SQLite 3 with PDO and PDO_SQLITE drivers
* Mongo with Mongo driver and PECL Mongo 1.0.10 (included)
## Installation
Installation is quite simple as there is no installer to run, and all server configuration options can be set in your index.php for your site.
1. Download the source [[http://github.com/joshtronic/pickles/zipball/master]] (or clone the repository)
2. Place the code anywhere you'd like (that's at least 2 directories up from the root of your website). I recommend using /usr/share/pickles
3. Open the launchpad directory and you will find a sample site ready to be copied and pasted to wherever the site you set up is located.
- The directory public will need to be renamed to whatever you've set up your document root as.
- The file apache.conf will give you some insight to how configure Apache, or you can just set the include path in public/index.php
4. At this point you should have a very rudimentary site up and running.
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:51 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

10
docs/todolist.html
View file

@ -27,16 +27,16 @@
<ul>
<li>Currently only the DOB select is using this code, if another select comes along the DOB-centric logic will need to be moved.</li>
</ul>
<h3><a href="PICKLES/Display_RSS.html">Display_RSS</a></h3>
<h3><a href="PICKLES/String.html#methodformatPhoneNumber">String::formatPhoneNumber()</a></h3>
<ul>
<li>This display type is totally jacked, no lie.</li>
<li>Allow a format to be passed in, perhaps make it configurable in config.php</li>
</ul>
<h3><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a></h3>
<h3><a href="PICKLES/Display_Common.html#methodjsonEncode">Display_Common::jsonEncode()</a></h3>
<ul>
<li>Error handling is non-existant.</li>
<li>This really should be moved into some sort of converter class. I couldn't settle on a name, so it will live here for now.</li>
</ul>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>