Updated documentation.

This commit is contained in:
Josh Sherman 2010-05-15 22:55:47 -04:00
parent a48706da4b
commit 8a97b80b07
42 changed files with 830 additions and 312 deletions

View file

@ -94,7 +94,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">86</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">90</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -184,7 +184,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">120</span>)
<span class="method-title">__get</span> (line <span class="line-number">124</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -215,7 +215,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">105</span>)
<span class="method-title">__set</span> (line <span class="line-number">109</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -251,7 +251,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -23,7 +23,7 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Controller Class</p>
<p class="description"><p>The heavy lifter of PICKLES, makes the calls to get the session and configuration loaded. Loads modules, serves up user authentication when the module asks for it, and loads the viewer that the module requested. Default values are present to make things easier on the user.</p></p>
<p class="description"><p>The heavy lifter of PICKLES, makes the calls to get the session and configuration loaded. Loads modules, serves up user authentication when the module asks for it, and loads the viewer that the module requested. Default values are present to make things easier on the user.</p></p>
<ul class="tags">
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-key">new&nbsp;</span><span class="src-id"><a href="../PICKLES/Controller.html">Controller</a></span><span class="src-sym">(</span><span class="src-var">$config</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
@ -111,7 +111,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>To make life a bit easier when using PICKLES, the Controller logic is executed automatically via use of a constructor.</p></p>
<p class="description"><p>To make life a bit easier when using PICKLES, the Controller logic is executed automatically via use of a constructor.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -146,7 +146,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -405,7 +405,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -55,18 +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_JSON.html">Display_JSON</a></td>
<td>
JSON Display
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_XML.html">Display_XML</a></td>
<td>
XML Display
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_RSS.html">Display_RSS</a></td>
@ -85,6 +73,18 @@
<td>
Smarty Display
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_JSON.html">Display_JSON</a></td>
<td>
JSON Display
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_XML.html">Display_XML</a></td>
<td>
XML Display
</td>
</tr>
</table>
</div>
@ -158,7 +158,7 @@
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<span class="method-result">integer</span>
<a href="#templateExists" title="details" class="method-name">templateExists</a>
()
</div>
@ -421,14 +421,6 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a>
: Renders the data in JSON format
</li>
<li>
<a href="../PICKLES/Display_XML.html#methodrender">Display_XML::render()</a>
: Renders the data in XML format
</li>
<li>
<a href="../PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a>
: Render the RSS feed data
</li>
@ -440,6 +432,14 @@
<a href="../PICKLES/Display_Smarty.html#methodrender">Display_Smarty::render()</a>
: Render the Smarty generated pages
</li>
<li>
<a href="../PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a>
: Renders the data in JSON format
</li>
<li>
<a href="../PICKLES/Display_XML.html#methodrender">Display_XML::render()</a>
: Renders the data in XML format
</li>
</ul>
</div>
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
@ -452,12 +452,12 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template Exists</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not we have any templates defined</li>
<li><span class="field">return:</span> the number of templates defined</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">integer</span>
<span class="method-name">
templateExists
</span>
@ -480,7 +480,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -124,7 +124,7 @@
<A NAME='method_detail'></A>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">35</span>)
@ -174,7 +174,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -215,7 +215,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -123,7 +123,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">39</span>)
@ -175,7 +175,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -99,7 +99,7 @@
</div>
<div class="info-box-body">
<a name="var$extension" id="$extension"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -166,7 +166,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">46</span>)
@ -216,7 +216,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -124,7 +124,7 @@
<A NAME='method_detail'></A>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">35</span>)
@ -174,7 +174,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

148
docs/PICKLES/Error.html Normal file
View file

@ -0,0 +1,148 @@
<?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 Error</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 Error</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">Error Class</p>
<p class="description"><p>Standardized error reporting, mostly used to display fatal errors.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Error.php.html">/classes/Error.php</a> (line <span class="field">23</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Error</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">
static <span class="method-result">void</span>
<a href="#fatal" title="details" class="method-name">fatal</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</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/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>
</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="methodfatal" id="fatal"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method fatal</span> (line <span class="line-number">33</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fatal Error</p>
<p class="description"><p>Displays a friendly error to the user via HTML, logs it then exits.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
fatal
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: the message to be displayed to the user</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== 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>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -128,7 +128,7 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methoderror" id="error"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method error</span> (line <span class="line-number">56</span>)
@ -159,7 +159,7 @@
</div>
<a name="methodinformation" id="information"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method information</span> (line <span class="line-number">32</span>)
@ -190,7 +190,7 @@
</div>
<a name="methodphpError" id="phpError"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method phpError</span> (line <span class="line-number">92</span>)
@ -224,7 +224,7 @@
</div>
<a name="methodquery" id="query"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method query</span> (line <span class="line-number">104</span>)
@ -255,7 +255,7 @@
</div>
<a name="methodslowQuery" id="slowQuery"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method slowQuery</span> (line <span class="line-number">68</span>)
@ -286,7 +286,7 @@
</div>
<a name="methodtransaction" id="transaction"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method transaction</span> (line <span class="line-number">80</span>)
@ -317,7 +317,7 @@
</div>
<a name="methodwarning" id="warning"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method warning</span> (line <span class="line-number">44</span>)
@ -361,7 +361,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -50,7 +50,7 @@
</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="#$columns" title="details" class="var-name">$columns</a>
</div>
@ -65,6 +65,10 @@
<div class="var-title">
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$limit" title="details" class="var-name">$limit</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
@ -98,11 +102,11 @@
</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>
([<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$return_data</span>)
([<span class="var-type">array</span>&nbsp;<span class="var-name">$conditions</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -118,6 +122,16 @@
<span class="method-result">boolean</span>
<a href="#delete" title="details" class="method-name">delete</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#first" title="details" class="method-name">first</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#last" title="details" class="method-name">last</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
@ -162,7 +176,7 @@
</div>
<div class="info-box-body">
<a name="var$columns" id="$columns"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -175,7 +189,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Column List</p>
<ul class="tags">
<li><span class="field">var:</span> string | array</li>
<li><span class="field">var:</span> string, array</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -185,13 +199,13 @@
</div>
<a name="var$count" id="$count"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$count</span>
= <span class="var-default"> 0</span> (line <span class="line-number">89</span>)
= <span class="var-default"> 0</span> (line <span class="line-number">97</span>)
</span>
</div>
@ -207,13 +221,13 @@
</div>
<a name="var$data" id="$data"><!-- --></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">$data</span>
= <span class="var-default"> null</span> (line <span class="line-number">65</span>)
= <span class="var-default"> null</span> (line <span class="line-number">73</span>)
</span>
</div>
@ -229,7 +243,7 @@
</div>
<a name="var$db" id="$db"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -249,6 +263,29 @@
</div>
<a name="var$limit" id="$limit"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$limit</span>
= <span class="var-default"> null</span> (line <span class="line-number">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Limit Results</p>
<ul class="tags">
<li><span class="field">var:</span> integer, string or array</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$order_by" id="$order_by"><!-- --></A>
<div class="oddrow">
@ -264,7 +301,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Order By Clause</p>
<ul class="tags">
<li><span class="field">var:</span> string | array</li>
<li><span class="field">var:</span> string, array</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -280,7 +317,7 @@
<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">73</span>)
= <span class="var-default"> null</span> (line <span class="line-number">81</span>)
</span>
</div>
@ -302,7 +339,7 @@
<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">81</span>)
= <span class="var-default"> null</span> (line <span class="line-number">89</span>)
</span>
</div>
@ -367,7 +404,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">108</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -382,16 +419,13 @@
<span class="method-name">
__construct
</span>
([<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$return_data</span>)
([<span class="var-type">array</span>&nbsp;<span class="var-name">$conditions</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$data</span><span class="var-description">: optional key/values for the WHERE cause</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$return_data</span><span class="var-description">: currently not in use</span> </li>
<span class="var-name">$conditions</span><span class="var-description">: optional key/values for the WHERE cause</span> </li>
</ul>
<hr class="separator" />
@ -406,7 +440,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">340</span>)
<span class="method-title">commit</span> (line <span class="line-number">403</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -433,7 +467,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">commitRecord</span> (line <span class="line-number">233</span>)
<span class="method-title">commitRecord</span> (line <span class="line-number">296</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -460,7 +494,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">275</span>)
<span class="method-title">delete</span> (line <span class="line-number">338</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -481,12 +515,62 @@
</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">272</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>
<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">
first
</span>
()
</div>
</div>
<a name="methodlast" id="last"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">last</span> (line <span class="line-number">282</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>
<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">
last
</span>
()
</div>
</div>
<a name="methodnext" id="next"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">next</span> (line <span class="line-number">209</span>)
<span class="method-title">next</span> (line <span class="line-number">252</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -511,7 +595,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">prev</span> (line <span class="line-number">219</span>)
<span class="method-title">prev</span> (line <span class="line-number">262</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -536,7 +620,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">384</span>)
<span class="method-title">unescape</span> (line <span class="line-number">447</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -567,7 +651,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">293</span>)
<span class="method-title">__get</span> (line <span class="line-number">356</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -598,7 +682,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">318</span>)
<span class="method-title">__set</span> (line <span class="line-number">381</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -640,7 +724,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -23,9 +23,9 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Module Class</p>
<p class="description"><p>This is a parent class that all PICKLES modules should be extending. Each module can specify it's own meta data and whether or not a user must be properly authenticated to view the page. Currently any pages without a template are treated as pages being requested via AJAX and the return will be JSON encoded. In the future this may need to be changed out for logic that allows the requested module to specify what display type(s) it can use.</p></p>
<p class="description"><p>This is a parent class that all PICKLES modules should be extending. Each module can specify it's own meta data and whether or not a user must be properly authenticated to view the page. Currently any pages without a template are treated as pages being requested via AJAX and the return will be JSON encoded. In the future this may need to be changed out for logic that allows the requested module to specify what display type(s) it can use.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Module.php.html">/classes/Module.php</a> (line <span class="field">29</span>)
Located in <a class="field" href="_classes---Module.php.html">/classes/Module.php</a> (line <span class="field">28</span>)
</p>
@ -50,7 +50,7 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">boolean,</span>
<a href="#$access" title="details" class="var-name">$access</a>
</div>
@ -73,6 +73,10 @@
<div class="var-title">
<span class="var-type">string,</span>
<a href="#$keywords" title="details" class="var-name">$keywords</a>
</div>
<div class="var-title">
<span class="var-type">array,</span>
<a href="#$request" title="details" class="var-name">$request</a>
</div>
<div class="var-title">
<span class="var-type">boolean,</span>
@ -106,11 +110,16 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Module</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$autorun</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#setRequest" title="details" class="method-name">setRequest</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$request</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
@ -151,7 +160,7 @@
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$access</span>
= <span class="var-default"> null</span> (line <span class="line-number">69</span>)
= <span class="var-default"> null</span> (line <span class="line-number">68</span>)
</span>
</div>
@ -174,13 +183,13 @@
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$ajax</span>
= <span class="var-default"> null</span> (line <span class="line-number">102</span>)
= <span class="var-default"> null</span> (line <span class="line-number">101</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">AJAX</p>
<p class="description"><p>Whether or not the page must be loaded via AJAX and if so, what pages are allowed to access it and the request method.</p></p>
<p class="description"><p>Whether or not the page must be loaded via AJAX and if so, what pages are allowed to access it and the request method.</p></p>
<ul class="tags">
<li><span class="field">var:</span> or array, null by default</li>
<li><span class="field">todo:</span> Implement this functionality</li>
@ -199,7 +208,7 @@
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$db</span>
= <span class="var-default"> null</span> (line <span class="line-number">37</span>)
= <span class="var-default"> null</span> (line <span class="line-number">36</span>)
</span>
</div>
@ -221,7 +230,7 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$description</span>
= <span class="var-default"> null</span> (line <span class="line-number">53</span>)
= <span class="var-default"> null</span> (line <span class="line-number">52</span>)
</span>
</div>
@ -244,13 +253,13 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$engine</span>
= <span class="var-default"> null</span> (line <span class="line-number">113</span>)
= <span class="var-default"> null</span> (line <span class="line-number">112</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default display engine</p>
<p class="description"><p>Defaults to null but could be set to Smarty, JSON, XML or RSS. Value is overwritten by the config value if not set by the module.</p></p>
<p class="description"><p>Defaults to null but could be set to Smarty, JSON, XML or RSS. Value is overwritten by the config value if not set by the module.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -268,7 +277,7 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$keywords</span>
= <span class="var-default"> null</span> (line <span class="line-number">61</span>)
= <span class="var-default"> null</span> (line <span class="line-number">60</span>)
</span>
</div>
@ -284,14 +293,39 @@
</div>
<a name="var$secure" id="$secure"><!-- --></A>
<a name="var$request" id="$request"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array,</span>
<span class="var-name">$request</span>
= <span class="var-default"> null</span> (line <span class="line-number">137</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Request Data</p>
<p class="description"><p>Modules should not interact with $_REQUEST, $_POST or $_GET directly as the contents could be unsafe. The Controller cleanses this data and sets it into this variable for safe access by the module.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">todo:</span> Currently the super globals are not being cleared out</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$secure" id="$secure"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$secure</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
= <span class="var-default"> null</span> (line <span class="line-number">79</span>)
</span>
</div>
@ -310,13 +344,13 @@
</div>
<a name="var$session" id="$session"><!-- --></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">$session</span>
= <span class="var-default"> null</span> (line <span class="line-number">90</span>)
= <span class="var-default"> null</span> (line <span class="line-number">89</span>)
</span>
</div>
@ -334,19 +368,19 @@
</div>
<a name="var$template" id="$template"><!-- --></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">$template</span>
= <span class="var-default"> null</span> (line <span class="line-number">126</span>)
= <span class="var-default"> null</span> (line <span class="line-number">124</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default template</p>
<p class="description"><p>Defaults to null but could be set to any valid template basename. The value is overwritten by the config value if not set by the module. The display engine determines what the file extension should be.</p></p>
<p class="description"><p>Defaults to null but could be set to any valid template basename. The value is overwritten by the config value if not set by the module. The display engine determines what the file extension should be.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -358,13 +392,13 @@
</div>
<a name="var$title" id="$title"><!-- --></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">$title</span>
= <span class="var-default"> null</span> (line <span class="line-number">45</span>)
= <span class="var-default"> null</span> (line <span class="line-number">44</span>)
</span>
</div>
@ -405,15 +439,15 @@
<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">139</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">149</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>The constructor does nothing by default but can be passed a boolean variable to tell it to automatically run the __default() method. This is typically used when a module is called outside of the scope of the controller (the registration page calls the login page in this manner.</p></p>
<p class="description"><p>The constructor does nothing by default but can be passed a boolean variable to tell it to automatically run the __default() method. This is typically used when a module is called outside of the scope of the controller (the registration page calls the login page in this manner.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -439,17 +473,47 @@
<dd>Constructor</dd>
</dl>
</div>
<a name="methodsetRequest" id="setRequest"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setRequest</span> (line <span class="line-number">237</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the Request</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the assignment was successful</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
setRequest
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$request</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$request</span><span class="var-description">: data to be loaded into the request variable</span> </li>
</ul>
</div>
<a name="method__default" id="__default"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__default</span> (line <span class="line-number">160</span>)
<span class="method-title">__default</span> (line <span class="line-number">170</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default &quot;Magic&quot; Method</p>
<p class="description"><p>This function is overloaded by the module. The __default() method is where you want to place any code that needs to be executed at runtime. The reason the code isn't in the constructor is because the module must be instantiated before the code is executed so that the controller script is aware of the authentication requirements.</p></p>
<p class="description"><p>This function is overloaded by the module. The __default() method is where you want to place any code that needs to be executed at runtime. The reason the code isn't in the constructor is because the module must be instantiated before the code is executed so that the controller script is aware of the authentication requirements.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -469,12 +533,12 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">189</span>)
<span class="method-title">__get</span> (line <span class="line-number">199</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic Getter Method</p>
<p class="description"><p>Attempts to load the module variable. If it's not set, will attempt to load from the config.</p></p>
<p class="description"><p>Attempts to load the module variable. If it's not set, will attempt to load from the config.</p></p>
<ul class="tags">
<li><span class="field">return:</span> value of the variable or boolean false</li>
<li><span class="field">access:</span> public</li>
@ -500,7 +564,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">174</span>)
<span class="method-title">__set</span> (line <span class="line-number">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -543,7 +607,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -65,6 +65,12 @@
<td>
Log Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Module.html">Module</a></td>
<td>
Module Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Controller.html">Controller</a></td>
@ -73,9 +79,9 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Module.html">Module</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
<td>
Module Class
Database Abstraction Layer for MySQL
</td>
</tr>
<tr>
@ -85,9 +91,9 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Error.html">Error</a></td>
<td>
Database Abstraction Layer for MySQL
Error Class
</td>
</tr>
</table>
@ -224,21 +230,21 @@
: Constructor
</li>
<li>
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Module.html#method__construct">Module::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Model.html#method__construct">Model::__construct()</a>
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Database.html#method__construct">Database::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Model.html#method__construct">Model::__construct()</a>
: Constructor
</li>
</ul>
</div>
@ -247,7 +253,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?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 Error.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/Error.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">Error Reporting for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 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@phpwithpickles.org">josh@phpwithpickles.org</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://phpwithpickles.org">http://phpwithpickles.org</a></li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</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/Error.html">Error</a>
</td>
<td>
Error Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -46,54 +46,12 @@
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="defineCLASS_PATH"><!-- --></a>
<a name="defineDISPLAY_JSON"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">CLASS_PATH</span> = PICKLES_PATH.'classes/'
(line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_JSON"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
(line <span class="line-number">51</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_PHP"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
(line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_RSS"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
(line <span class="line-number">53</span>)
</span>
</div>
@ -102,12 +60,12 @@
</div>
<a name="defineDISPLAY_SMARTY"><!-- --></a>
<div class="evenrow">
<a name="defineDISPLAY_PHP"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_SMARTY</span> = 'Smarty'
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
(line <span class="line-number">54</span>)
</span>
</div>
@ -116,12 +74,12 @@
</div>
<a name="defineDISPLAY_XML"><!-- --></a>
<div class="oddrow">
<a name="defineDISPLAY_RSS"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_XML</span> = 'XML'
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
(line <span class="line-number">55</span>)
</span>
</div>
@ -130,13 +88,41 @@
</div>
<a name="defineJSON_AVAILABLE"><!-- --></a>
<a name="defineDISPLAY_SMARTY"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_SMARTY</span> = 'Smarty'
(line <span class="line-number">56</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_XML"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_XML</span> = 'XML'
(line <span class="line-number">57</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineJSON_AVAILABLE"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">JSON_AVAILABLE</span> = function_exists('json_encode')
(line <span class="line-number">58</span>)
(line <span class="line-number">60</span>)
</span>
</div>
@ -145,26 +131,12 @@
</div>
<a name="defineLOG_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">LOG_PATH</span> = PRIVATE_PATH.'logs/'
(line <span class="line-number">47</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineMODEL_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">MODEL_PATH</span> = SITE_PATH.'models/'
(line <span class="line-number">42</span>)
<span class="const-name">LOG_PATH</span> = PRIVATE_PATH.'logs/'
(line <span class="line-number">49</span>)
</span>
</div>
@ -172,13 +144,13 @@
</div>
<a name="defineMODULE_PATH"><!-- --></a>
<a name="definePICKLES_CLASS_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">MODULE_PATH</span> = SITE_PATH.'modules/'
(line <span class="line-number">43</span>)
<span class="const-name">PICKLES_CLASS_PATH</span> = PICKLES_PATH.'classes/'
(line <span class="line-number">38</span>)
</span>
</div>
@ -206,7 +178,49 @@
<div>
<span class="const-title">
<span class="const-name">PRIVATE_PATH</span> = SITE_PATH.'private/'
(line <span class="line-number">46</span>)
(line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_CLASS_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">SITE_CLASS_PATH</span> = SITE_PATH.'classes/'
(line <span class="line-number">43</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_MODEL_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_MODEL_PATH</span> = SITE_PATH.'models/'
(line <span class="line-number">44</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_MODULE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">SITE_MODULE_PATH</span> = SITE_PATH.'modules/'
(line <span class="line-number">45</span>)
</span>
</div>
@ -215,12 +229,26 @@
</div>
<a name="defineSITE_PATH"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_PATH</span> = getcwd().'/../'
(line <span class="line-number">38</span>)
(line <span class="line-number">41</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_TEMPLATE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">SITE_TEMPLATE_PATH</span> = SITE_PATH.'templates/'
(line <span class="line-number">46</span>)
</span>
</div>
@ -234,21 +262,7 @@
<div>
<span class="const-title">
<span class="const-name">SMARTY_PATH</span> = PRIVATE_PATH.'smarty/'
(line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineTEMPLATE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">TEMPLATE_PATH</span> = SITE_PATH.'templates/'
(line <span class="line-number">44</span>)
(line <span class="line-number">50</span>)
</span>
</div>
@ -270,10 +284,10 @@
</div>
<div class="info-box-body">
<a name="function__autoload" id="function__autoload"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="method-title">__autoload</span> (line <span class="line-number">70</span>)
<span class="method-title">__autoload</span> (line <span class="line-number">72</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -303,7 +317,7 @@
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -37,7 +37,7 @@
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -22,11 +22,11 @@
<li><a href="PICKLES/Object.html">Object</a><ul>
<li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></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_Smarty.html">Display_Smarty</a></li><li><a href="PICKLES/Display_XML.html">Display_XML</a></li></ul></li>
<li><a href="PICKLES/Log.html">Log</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
<li><a href="PICKLES/Error.html">Error</a></li><li><a href="PICKLES/Log.html">Log</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
</ul>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -115,12 +115,6 @@
<dd class="index-item-body">
<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="const-title">CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineCLASS_PATH">CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
@ -320,6 +314,19 @@
<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">
<span class="include-title">Error.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Error.php.html">Error.php</a> in Error.php</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">error</span>
</dt>
@ -342,6 +349,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">fatal</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html#methodfatal">Error::fatal()</a> in Error.php</div>
<div class="index-item-description">Fatal Error</div>
</dd>
<dt class="field">
<span class="method-title">fetch</span>
</dt>
@ -363,6 +377,13 @@
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
<div class="index-item-description">Fetch a single column from the database</div>
</dd>
<dt class="field">
<span class="method-title">first</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodfirst">Model::first()</a> in Model.php</div>
<div class="index-item-description">First Record</div>
</dd>
</dl>
<a name="g"></a>
<div class="index-letter-section">
@ -450,12 +471,26 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$limit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$limit">Model::$limit</a> in Model.php</div>
<div class="index-item-description">Limit Results</div>
</dd>
<dt class="field">
<span class="include-title">Log.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Log.php.html">Log.php</a> in Log.php</div>
</dd>
<dt class="field">
<span class="method-title">last</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodlast">Model::last()</a> in Model.php</div>
<div class="index-item-description">Last Record</div>
</dd>
<dt class="field">
<span class="method-title">load</span>
</dt>
@ -510,12 +545,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
<div class="index-item-description">Model Class</div>
</dd>
<dt class="field">
<span class="const-title">MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODEL_PATH">MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
Module
</dt>
@ -523,12 +552,6 @@
<div class="index-item-details"><a href="PICKLES/Module.html">Module</a> in Module.php</div>
<div class="index-item-description">Module Class</div>
</dd>
<dt class="field">
<span class="const-title">MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODULE_PATH">MODULE_PATH</a> in pickles.php</div>
</dd>
</dl>
<a name="n"></a>
<div class="index-letter-section">
@ -606,6 +629,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html">pickles.php</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">PICKLES_CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#definePICKLES_CLASS_PATH">PICKLES_CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">PICKLES_PATH</span>
</dt>
@ -675,6 +704,13 @@
<div class="index-item-details"><a href="PICKLES/Model.html#var$records">Model::$records</a> in Model.php</div>
<div class="index-item-description">Records Array</div>
</dd>
<dt class="field">
<span class="var-title">$request</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$request">Module::$request</a> in Module.php</div>
<div class="index-item-description">Request Data</div>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
</dt>
@ -706,15 +742,15 @@
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
<div class="index-item-description">Renders the PHP templated pages</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_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
<div class="index-item-description">Renders the PHP templated pages</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
@ -751,12 +787,43 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---Smarty.php.html">Smarty.php</a> in Smarty.php</div>
</dd>
<dt class="field">
<span class="method-title">setRequest</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#methodsetRequest">Module::setRequest()</a> in Module.php</div>
<div class="index-item-description">Sets the Request</div>
</dd>
<dt class="field">
<span class="const-title">SITE_CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_CLASS_PATH">SITE_CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_MODEL_PATH">SITE_MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_MODULE_PATH">SITE_MODULE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_TEMPLATE_PATH">SITE_TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">slowQuery</span>
</dt>
@ -813,12 +880,6 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodtemplateExists">Display_Common::templateExists()</a> in Common.php</div>
<div class="index-item-description">Template Exists</div>
</dd>
<dt class="field">
<span class="const-title">TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineTEMPLATE_PATH">TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>

View file

@ -225,12 +225,6 @@
<dd class="index-item-body">
<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="const-title">CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineCLASS_PATH">CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
@ -430,6 +424,19 @@
<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">
<span class="include-title">Error.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Error.php.html">Error.php</a> in Error.php</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">error</span>
</dt>
@ -452,6 +459,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">fatal</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Error.html#methodfatal">Error::fatal()</a> in Error.php</div>
<div class="index-item-description">Fatal Error</div>
</dd>
<dt class="field">
<span class="method-title">fetch</span>
</dt>
@ -473,6 +487,13 @@
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
<div class="index-item-description">Fetch a single column from the database</div>
</dd>
<dt class="field">
<span class="method-title">first</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodfirst">Model::first()</a> in Model.php</div>
<div class="index-item-description">First Record</div>
</dd>
</dl>
<a name="g"></a>
<div class="index-letter-section">
@ -560,12 +581,26 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$limit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$limit">Model::$limit</a> in Model.php</div>
<div class="index-item-description">Limit Results</div>
</dd>
<dt class="field">
<span class="include-title">Log.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Log.php.html">Log.php</a> in Log.php</div>
</dd>
<dt class="field">
<span class="method-title">last</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodlast">Model::last()</a> in Model.php</div>
<div class="index-item-description">Last Record</div>
</dd>
<dt class="field">
<span class="method-title">load</span>
</dt>
@ -620,12 +655,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
<div class="index-item-description">Model Class</div>
</dd>
<dt class="field">
<span class="const-title">MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODEL_PATH">MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
Module
</dt>
@ -633,12 +662,6 @@
<div class="index-item-details"><a href="PICKLES/Module.html">Module</a> in Module.php</div>
<div class="index-item-description">Module Class</div>
</dd>
<dt class="field">
<span class="const-title">MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODULE_PATH">MODULE_PATH</a> in pickles.php</div>
</dd>
</dl>
<a name="n"></a>
<div class="index-letter-section">
@ -716,6 +739,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html">pickles.php</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">PICKLES_CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#definePICKLES_CLASS_PATH">PICKLES_CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">PICKLES_PATH</span>
</dt>
@ -785,6 +814,13 @@
<div class="index-item-details"><a href="PICKLES/Model.html#var$records">Model::$records</a> in Model.php</div>
<div class="index-item-description">Records Array</div>
</dd>
<dt class="field">
<span class="var-title">$request</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$request">Module::$request</a> in Module.php</div>
<div class="index-item-description">Request Data</div>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
</dt>
@ -816,15 +852,15 @@
<span class="method-title">render</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
<div class="index-item-description">Renders the PHP templated pages</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_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
<div class="index-item-description">Renders the PHP templated pages</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
@ -861,12 +897,43 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---Smarty.php.html">Smarty.php</a> in Smarty.php</div>
</dd>
<dt class="field">
<span class="method-title">setRequest</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#methodsetRequest">Module::setRequest()</a> in Module.php</div>
<div class="index-item-description">Sets the Request</div>
</dd>
<dt class="field">
<span class="const-title">SITE_CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_CLASS_PATH">SITE_CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_MODEL_PATH">SITE_MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_MODULE_PATH">SITE_MODULE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">SITE_TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_TEMPLATE_PATH">SITE_TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">slowQuery</span>
</dt>
@ -923,12 +990,6 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodtemplateExists">Display_Common::templateExists()</a> in Common.php</div>
<div class="index-item-description">Template Exists</div>
</dd>
<dt class="field">
<span class="const-title">TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineTEMPLATE_PATH">TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>

View file

@ -34,6 +34,7 @@
<a href="#emails.php">emails.php</a><br>
<a href="#empty_test_file.php">empty_test_file.php</a><br>
<a href="#encoding_test.php">encoding_test.php</a><br>
<a href="#Error.php">Error.php</a><br>
<a href="#errors_test.php">errors_test.php</a><br>
<a href="#events.php">events.php</a><br>
<a href="#exceptions_test.php">exceptions_test.php</a><br>
@ -165,8 +166,8 @@
<a name="ckeditor_php4.php"></a>
<h1>ckeditor_php4.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
<b>Warning on line 17</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
<b>Warning on line 18</b> - no @package tag was used in a DocBlock for class CKEditor<br>
<b>Warning on line 39</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 39</b> - Unknown tag "@code" used<br>
@ -174,9 +175,9 @@
<b>Warning on line 51</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 70</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 70</b> - Unknown tag "@code" used<br>
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 134</b> - Unknown tag "@code" used<br>
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 134</b> - Unknown tag "@code" used<br>
<b>Warning on line 176</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 176</b> - Unknown tag "@code" used<br>
@ -186,35 +187,35 @@
<b>Warning on line 219</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 274</b> - Unknown tag "@code" used<br>
<b>Warning on line 274</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 314</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 314</b> - Unknown tag "@code" used<br>
<b>Warning on line 314</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 592</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/ckeditor_php4.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="ckeditor_php5.php"></a>
<h1>ckeditor_php5.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
<b>Warning on line 17</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
<b>Warning on line 18</b> - no @package tag was used in a DocBlock for class CKEditor<br>
<b>Warning on line 37</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 37</b> - Unknown tag "@code" used<br>
<b>Warning on line 49</b> - Unknown tag "@code" used<br>
<b>Warning on line 37</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 49</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 68</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 49</b> - Unknown tag "@code" used<br>
<b>Warning on line 68</b> - Unknown tag "@code" used<br>
<b>Warning on line 130</b> - Unknown tag "@code" used<br>
<b>Warning on line 68</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 130</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 130</b> - Unknown tag "@code" used<br>
<b>Warning on line 130</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 130</b> - Unknown tag "@code" used<br>
<b>Warning on line 172</b> - Unknown tag "@code" used<br>
<b>Warning on line 172</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 215</b> - Unknown tag "@code" used<br>
<b>Warning on line 215</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 215</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 215</b> - Unknown tag "@code" used<br>
<b>Warning on line 215</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 270</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 215</b> - Unknown tag "@code" used<br>
<b>Warning on line 270</b> - Unknown tag "@code" used<br>
<b>Warning on line 310</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 270</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 310</b> - Unknown tag "@code" used<br>
<b>Warning on line 310</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 582</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/ckeditor_php5.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="collector_test.php"></a>
<h1>collector_test.php</h1>
@ -275,8 +276,8 @@
<a name="emails.php"></a>
<h1>emails.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 9</b> - File "/home/josh/Source/pickles/vendors/jquery-validate-1.7/demo/milk/emails.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 9</b> - File "/home/josh/Source/pickles/vendors/jquery-validate-1.7/demo/marketo/emails.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 9</b> - File "/home/josh/Source/pickles/vendors/jquery-validate-1.7/demo/milk/emails.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="empty_test_file.php"></a>
<h1>empty_test_file.php</h1>
<h2>Warnings:</h2><br>
@ -288,6 +289,10 @@
<b>Warning on line 31</b> - no @package tag was used in a DocBlock for class TestOfEncoding<br>
<b>Warning on line 194</b> - no @package tag was used in a DocBlock for class TestOfFormHeaders<br>
<b>Warning on line 212</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/encoding_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Error.php"></a>
<h1>Error.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Error<br>
<a name="errors_test.php"></a>
<h1>errors_test.php</h1>
<h2>Warnings:</h2><br>
@ -443,10 +448,11 @@
<a name="Module.php"></a>
<h1>Module.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 29</b> - no @package tag was used in a DocBlock for class Module<br>
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Module<br>
<a name="newsession.php"></a>
<h1>newsession.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 3</b> - Page-level DocBlock precedes "require 'rand.php'", use another DocBlock to document the source element<br>
<b>Warning on line 11</b> - File "/home/josh/Source/pickles/vendors/jquery-validate-1.7/demo/captcha/newsession.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Object.php"></a>
<h1>Object.php</h1>
@ -696,7 +702,7 @@
<h2>Errors:</h2><br>
<b>Error on line 467</b> - @access was passed neither "public" nor "private." Was passed: "public."<br>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</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 Sat, 27 Mar 2010 15:25:51 -0400 -->
<!-- Generated by phpDocumentor on Sat, 15 May 2010 22:55:16 -0400 -->
<title>PHP Interface Collection of Killer Libraries to Enhance Stuff</title>
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>

View file

@ -32,6 +32,7 @@
<dd><a href='PICKLES/Display_RSS.html' target='right'>Display_RSS</a></dd>
<dd><a href='PICKLES/Display_Smarty.html' target='right'>Display_Smarty</a></dd>
<dd><a href='PICKLES/Display_XML.html' target='right'>Display_XML</a></dd>
<dd><a href='PICKLES/Error.html' target='right'>Error</a></dd>
<dd><a href='PICKLES/Log.html' target='right'>Log</a></dd>
<dd><a href='PICKLES/Model.html' target='right'>Model</a></dd>
<dd><a href='PICKLES/Module.html' target='right'>Module</a></dd>
@ -43,6 +44,7 @@
<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>
<dd><a href='PICKLES/_classes---Database.php.html' target='right'>Database.php</a></dd>
<dd><a href='PICKLES/_classes---Error.php.html' target='right'>Error.php</a></dd>
<dd><a href='PICKLES/_classes---Display---JSON.php.html' target='right'>JSON.php</a></dd>
<dd><a href='PICKLES/_classes---Log.php.html' target='right'>Log.php</a></dd>
<dd><a href='PICKLES/_classes---Model.php.html' target='right'>Model.php</a></dd>

View file

@ -18,12 +18,12 @@
<a href="ric_README.html" target="right">README</a>
| <a href="ric_COPYING.html" target="right">COPYING</a>
| <a href="ric_TODO.html" target="right">TODO</a>
| <a href="ric_INSTALL.html" target="right">INSTALL</a>
| <a href="ric_COPYING.html" target="right">COPYING</a>
</td>
<td style="width: 2em">&nbsp;</td>
<td style="text-align: right">

View file

@ -687,7 +687,7 @@ Public License instead of this License. But first, please read
</pre>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -36,7 +36,7 @@ Installation Guide
</pre>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -27,24 +27,24 @@ 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 codebase. PICKLES runs in such a
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 seperate
from eachother and everything is ran through a single entry point
directory, models and modules (page logic) and templates are kept separate
from each other and everything is ran through a single entry point
controller.
Okay, but why?
--------------
Now I know you're wondering, &quot;why didn't you just use one of the
pre-existing and already established PHP frameworks that are out there?&quot; I
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 being going into detail
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
@ -67,7 +67,7 @@ Get the facts!
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 meants that
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.
@ -80,7 +80,7 @@ Get the facts!
* 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 plugins / add-ons) and a core JavaScript file which includes
(and some plug-ins / add-ons) and a core JavaScript file which includes
automatic AJAXing of forms and some other niceties.
* Writing error free code is very important to me, so any PHP development I
@ -92,7 +92,7 @@ Get the facts!
</pre>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -33,7 +33,7 @@ To Do List
</pre>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -14,6 +14,10 @@
<ul>
<li>Implement this functionality</li>
</ul>
<h3><a href="PICKLES/Module.html#var$request">Module::$request</a></h3>
<ul>
<li>Currently the super globals are not being cleared out</li>
</ul>
<h3><a href="PICKLES/Module.html#var$secure">Module::$secure</a></h3>
<ul>
<li>Implement this functionality</li>
@ -39,7 +43,7 @@
<li>Error handling is non-existant.</li>
</ul>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Mar 2010 15:25:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sat, 15 May 2010 22:55:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>