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

Updated the docs

Browse source
This commit is contained in:
Josh Sherman 2010-10-14 20:53:44 -04:00
parent 1cd61dda42
commit 3fb1e8d3d0
55 changed files with 4645 additions and 2191 deletions
Download patch file Download diff file Expand all files Collapse all files

118
docs/PICKLES/Config.html
View file

@ -16,23 +16,26 @@
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<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">Config Class</p>
<p class="description"><p>Handles loading the site's configuration file (if available).</p></p>
<p class="description"><p>Handles loading the site's configuration file (if available). At the moment this class is a very skewed Singleton. The plan is to eventually extend this out to support multiple configuration files, and the ability to load in custom config files on the fly as well. The core of PICKLES uses the class as a Singleton so we're not loading the configuration multiple times per page load.</p></p>
<ul class="tags">
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$config&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../PICKLES/Config.html">Config</a></span><span class="src-sym">(</span><span class="src-var">$filename</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Config.php.html">/classes/Config.php</a> (line <span class="field">25</span>)
Located in <a class="field" href="_classes---Config.php.html">/classes/Config.php</a> (line <span class="field">30</span>)
</p>
<pre></pre>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Config</pre>
</div>
</div>
@ -45,20 +48,23 @@
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
<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">object self::$instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
()
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Config'</span>])
</div>
<div class="method-definition">
<span class="method-result">Config</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.ini'</span>])
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.php'</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -71,7 +77,7 @@
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<span class="method-result">void</span>
<a href="#__set" title="details" class="method-name">__set</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
@ -79,29 +85,57 @@
</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>
<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-method-summary">Methods</a> (<span class="disabled">details</span>)
<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="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">89</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">149</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get instance of the object</p>
<p class="description"><p>Instantiates a new object if one isn't already available, then returns the instance.</p></p>
<p class="description"><p>Let's the parent class do all the work</p></p>
<ul class="tags">
<li><span class="field">return:</span> instance of the Config</li>
<li><span class="field">return:</span> instance of the Config class</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -111,23 +145,34 @@
<span class="method-name">
getInstance
</span>
()
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Config'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class to instantiate</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></dt>
<dd>Get Instance</dd>
</dl>
</div>
<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">51</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">47</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Calls the parent constructor and loads the pass file</p></p>
<p class="description"><p>Calls the parent constructor and loads the passed file.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -137,7 +182,7 @@
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.ini'</span>])
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.php'</span>])
</div>
<ul class="parameters">
@ -146,20 +191,25 @@
<span class="var-name">$filename</span><span class="var-description">: optional Filename of the config</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodload" id="load"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">load</span> (line <span class="line-number">65</span>)
<span class="method-title">load</span> (line <span class="line-number">60</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads a configuration file</p>
<p class="description"><p>Handles the potential loading of the configuration file and sanitizing the boolean strings into actual boolean values.</p></p>
<ul class="tags">
<li><span class="field">return:</span> Success of the load process</li>
<li><span class="field">return:</span> success of the load process</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -180,10 +230,10 @@
</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">123</span>)
<span class="method-title">__get</span> (line <span class="line-number">176</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -211,22 +261,21 @@
</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">108</span>)
<span class="method-title">__set</span> (line <span class="line-number">162</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic Setter Method</p>
<p class="description"><p>Prohibits the direct modification of module variables.</p></p>
<ul class="tags">
<li><span class="field">return:</span> false</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">void</span>
<span class="method-name">
__set
</span>
@ -244,13 +293,22 @@
</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>
<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 Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

16
docs/PICKLES/Controller.html
View file

@ -94,6 +94,9 @@
<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>
@ -113,7 +116,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">36</span>)
@ -144,10 +147,10 @@
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">191</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -173,10 +176,10 @@
</div>
<a name="methodprepareVariables" id="prepareVariables"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">prepareVariables</span> (line <span class="line-number">201</span>)
<span class="method-title">prepareVariables</span> (line <span class="line-number">231</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -206,6 +209,7 @@
<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>
@ -214,7 +218,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

285
docs/PICKLES/Database.html
View file

@ -22,10 +22,10 @@
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database Abstraction Layer for MySQL</p>
<p class="description"><p>All database usage inside PICKLES-based sites should be done via the database object that is a part of every model ($this-&gt;db). Because the database object can execute raw SQL, there should be no limitations.</p></p>
<p class="short-description">Database Factory</p>
<p class="description"><p>Generic class to simplify connecting to a database. All database objects should be created by this class to future proof against any internal changes to PICKLES.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Database.php.html">/classes/Database.php</a> (line <span class="field">26</span>)
Located in <a class="field" href="_classes---Database.php.html">/classes/Database.php</a> (line <span class="field">25</span>)
</p>
@ -51,48 +51,18 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">object self::$instance</span>
<div class="method-definition">
static <span class="method-result">object instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
()
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">Database</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span> = <span class="var-default">null</span>])
([<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<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">integer</span>
<a href="#execute" title="details" class="method-name">execute</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</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">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>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
</div>
</div>
</div>
</div>
@ -115,6 +85,9 @@
<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>
@ -133,43 +106,54 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">139</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">54</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get instance of the object</p>
<p class="description"><p>Instantiates a new object if one isn't already available, then returns the instance.</p></p>
<p class="short-description">Get instance</p>
<p class="description"><p>Looks up the datasource using the passed name and gets an instance of it. Allows for easy sharing of certain classes within the system to avoid the extra overhead of creating new objects each time. Also avoids the hassle of passing around variables (yeah I know, very global-ish)</p></p>
<ul class="tags">
<li><span class="field">return:</span> instance of the Database</li>
<li><span class="field">return:</span> of the class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object self::$instance</span>
<span class="method-result">object instance</span>
<span class="method-name">
getInstance
</span>
()
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name of the datasource</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></dt>
<dd>Get Instance</dd>
</dl>
</div>
<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">99</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">35</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Sets up our connection variables</p></p>
<p class="description"><p>Attempts to get an instance of the passed database type or attempts to use a default specified in the config.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -179,22 +163,13 @@
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span> = <span class="var-default">null</span>])
([<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$hostname</span><span class="var-description">: optional hostname to connect to</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$username</span><span class="var-description">: optional username to use</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: optional password to use</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$database</span><span class="var-description">: optional database to connect to</span> </li>
<span class="var-name">$name</span><span class="var-description">: optional name of the connection to use</span> </li>
</ul>
<hr class="separator" />
@ -204,193 +179,6 @@
<dd>Constructor</dd>
</dl>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">195</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes database connection</p>
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
<ul class="tags">
<li><span class="field">return:</span> always true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
close
</span>
()
</div>
</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">execute</span> (line <span class="line-number">212</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes an SQL Statement</p>
<p class="description"><p>Executes a standard or prepared query based on passed parameters. All queries are logged to a file as well as timed and logged in the execution time is over 1 second.</p></p>
<ul class="tags">
<li><span class="field">return:</span> ID of the last inserted row or sequence number</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
execute
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</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 execute</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="methodfetch" id="fetch"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">294</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch a single row 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>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<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>])
</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>
<li>
<span class="var-type">string</span>
<span class="var-name">$return_type</span><span class="var-description">: optional type of return set</span> </li>
</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">343</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">331</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">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">157</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens database connection</p>
<p class="description"><p>Establishes a connection to the MySQL database based on the configuration options that are available in the Config object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
open
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
@ -398,6 +186,7 @@
<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>
@ -406,7 +195,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

754
docs/PICKLES/Database_Common.html Normal file
View file

@ -0,0 +1,754 @@
<?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 Database_Common</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 Database_Common</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-descendents">Descendents</a>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">Common Database Abstraction Layer</p>
<p class="description"><p>Parent class that our database driver classes should be extending. Contains basic functionality for instantiation and interfacing.</p></p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Database---Common.php.html">/classes/Database/Common.php</a> (line <span class="field">24</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Database_Common</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</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"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></td>
<td>
PDO Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">object</span>
<a href="#$connection" title="details" class="var-name">$connection</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$database" title="details" class="var-name">$database</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$driver" title="details" class="var-name">$driver</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$hostname" title="details" class="var-name">$hostname</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$password" title="details" class="var-name">$password</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$port" title="details" class="var-name">$port</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$results" title="details" class="var-name">$results</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$socket" title="details" class="var-name">$socket</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$username" title="details" class="var-name">$username</a>
</div>
</div>
</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-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">Database_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<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">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setDatabase" title="details" class="method-name">setDatabase</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setHostname" title="details" class="method-name">setHostname</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPassword" title="details" class="method-name">setPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPort" title="details" class="method-name">setPort</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setSocket" title="details" class="method-name">setSocket</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$socket</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setUsername" title="details" class="method-name">setUsername</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</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-descendents">Descendents</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">
<a name="var$connection" id="$connection"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$connection</span>
= <span class="var-default"> null</span> (line <span class="line-number">88</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Connection resource</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$database" id="$database"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$database</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database name for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
(line <span class="line-number">32</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$driver">Database_PDO_MySQL::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a>
: Driver
</li>
</ul>
</div>
<a name="var$hostname" id="$hostname"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$hostname</span>
= <span class="var-default"> 'localhost'</span> (line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hostname for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$password</span>
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Password for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Port number for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$port">Database_PDO_MySQL::$port</a>
: Default port
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a>
: Default port
</li>
</ul>
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">96</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Results object for the executed statement</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$socket" id="$socket"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$socket</span>
= <span class="var-default"> null</span> (line <span class="line-number">56</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">UNIX socket for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$username" id="$username"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$username</span>
= <span class="var-default"> null</span> (line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Username for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<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>
<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-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Database_Common</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">197</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes database connection</p>
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
<ul class="tags">
<li><span class="field">return:</span> always true</li>
<li><span class="field">abstract:</span> </li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
close
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a>
: Closes database connection
</li>
</ul>
</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>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens database connection</p>
<p class="description"><p>Establishes a connection to the MySQL database based on the configuration options that are available in the Config object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
<li><span class="field">abstract:</span> </li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
open
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a>
: Opens database connection
</li>
</ul>
</div>
<a name="methodsetDatabase" id="setDatabase"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setDatabase</span> (line <span class="line-number">174</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Database</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">
setDatabase
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$database</span><span class="var-description">: database for the database</span> </li>
</ul>
</div>
<a name="methodsetHostname" id="setHostname"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setHostname</span> (line <span class="line-number">124</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Hostname</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">
setHostname
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$hostname</span><span class="var-description">: hostname for the database</span> </li>
</ul>
</div>
<a name="methodsetPassword" id="setPassword"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPassword</span> (line <span class="line-number">164</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Password</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">
setPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password for the database</span> </li>
</ul>
</div>
<a name="methodsetPort" id="setPort"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setPort</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Port</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">
setPort
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$port</span><span class="var-description">: port for the database</span> </li>
</ul>
</div>
<a name="methodsetSocket" id="setSocket"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setSocket</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Socket</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">
setSocket
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$socket</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$socket</span><span class="var-description">: name of the UNIX socket</span> </li>
</ul>
</div>
<a name="methodsetUsername" id="setUsername"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setUsername</span> (line <span class="line-number">154</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Username</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">
setUsername
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$username</span><span class="var-description">: username for the database</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>
<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 Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

551
docs/PICKLES/Database_PDO_Common.html Normal file
View file

@ -0,0 +1,551 @@
<?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 Database_PDO_Common</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 Database_PDO_Common</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-descendents">Descendents</a>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">PDO Abstraction Layer</p>
<p class="description"><p>Parent class for any of our database classes that use PDO.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---Common.php.html">/classes/Database/PDO/Common.php</a> (line <span class="field">23</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
--Database_PDO_Common</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</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"><a href="../PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a></td>
<td>
MySQL Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></td>
<td>
SQLite Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a></td>
<td>
PostgreSQL Database Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$attributes" title="details" class="var-name">$attributes</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$dsn" title="details" class="var-name">$dsn</a>
</div>
</div>
</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-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">Database_PDO_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<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">integer</span>
<a href="#execute" title="details" class="method-name">execute</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</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">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>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</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-descendents">Descendents</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">
<a name="var$attributes" id="$attributes"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$attributes</span>
= <span class="var-default">array(<br /> PDO::ATTR_PERSISTENT =&gt; true,<br /> PDO::ATTR_ERRMODE =&gt; PDO::ERRMODE_EXCEPTION,<br /> PDO::NULL_EMPTY_STRING =&gt; true<br /> )</span> (line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PDO Attributes</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
(line <span class="line-number">31</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DSN format</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$dsn">Database_PDO_MySQL::$dsn</a>
: DSN format
</li>
<li>
<a href="../PICKLES/Database_PDO_SQLite.html#var$dsn">Database_PDO_SQLite::$dsn</a>
: DSN format
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a>
: DSN format
</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</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-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">48</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Database_PDO_Common</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">107</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes database connection</p>
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
<ul class="tags">
<li><span class="field">return:</span> always true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
close
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></dt>
<dd>Closes database connection</dd>
</dl>
</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">execute</span> (line <span class="line-number">124</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes an SQL Statement</p>
<p class="description"><p>Executes a standard or prepared query based on passed parameters. All queries are logged to a file as well as timed and logged in the execution time is over 1 second.</p></p>
<ul class="tags">
<li><span class="field">return:</span> ID of the last inserted row or sequence number</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
execute
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</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 execute</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="methodfetch" id="fetch"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">206</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch a single row 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>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<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>])
</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>
<li>
<span class="var-type">string</span>
<span class="var-name">$return_type</span><span class="var-description">: optional type of return set</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">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="evenrow">
<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="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">67</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens database connection</p>
<p class="description"><p>Establishes a connection to the database based on the set configuration options.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
open
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></dt>
<dd>Opens database connection</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<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#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>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</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 Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

269
docs/PICKLES/Database_PDO_MySQL.html Normal file
View file

@ -0,0 +1,269 @@
<?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 Database_PDO_MySQL</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 Database_PDO_MySQL</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">MySQL Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---MySQL.php.html">/classes/Database/PDO/MySQL.php</a> (line <span class="field">21</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
--<a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a>
|
--Database_PDO_MySQL</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$driver" title="details" class="var-name">$driver</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$dsn" title="details" class="var-name">$dsn</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$port" title="details" class="var-name">$port</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> |
<span class="disabled">Vars</span>
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_mysql'</span> (line <span class="line-number">29</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></dt>
<dd>Driver</dd>
</dl>
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'mysql:host=[[hostname]];port=[[port]];unix_socket=[[socket]];dbname=[[database]]'</span> (line <span class="line-number">37</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DSN format</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a></dt>
<dd>DSN format</dd>
</dl>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> 3306</span> (line <span class="line-number">45</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default port</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></dt>
<dd>Port number for the server</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_PDO_Common.html#var$attributes">Database_PDO_Common::$attributes</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<span class="disabled">Methods</span>
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a></span><br>
<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 =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<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#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>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</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 Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

269
docs/PICKLES/Database_PDO_PostgreSQL.html Normal file
View file

@ -0,0 +1,269 @@
<?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 Database_PDO_PostgreSQL</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 Database_PDO_PostgreSQL</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PostgreSQL Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---PostgreSQL.php.html">/classes/Database/PDO/PostgreSQL.php</a> (line <span class="field">21</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
--<a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a>
|
--Database_PDO_PostgreSQL</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$driver" title="details" class="var-name">$driver</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$dsn" title="details" class="var-name">$dsn</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$port" title="details" class="var-name">$port</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> |
<span class="disabled">Vars</span>
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_pgsql'</span> (line <span class="line-number">29</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></dt>
<dd>Driver</dd>
</dl>
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'pgsql:host=[[hostname]];port=[[port]];dbname=[[database]];user=[[username]];password=[[password]]'</span> (line <span class="line-number">37</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DSN format</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a></dt>
<dd>DSN format</dd>
</dl>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> 5432</span> (line <span class="line-number">45</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default port</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></dt>
<dd>Port number for the server</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_PDO_Common.html#var$attributes">Database_PDO_Common::$attributes</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<span class="disabled">Methods</span>
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a></span><br>
<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 =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<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#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>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</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 Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

240
docs/PICKLES/Database_PDO_SQLite.html Normal file
View file

@ -0,0 +1,240 @@
<?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 Database_PDO_SQLite</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 Database_PDO_SQLite</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SQLite Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---SQLite.php.html">/classes/Database/PDO/SQLite.php</a> (line <span class="field">21</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
--<a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a>
|
--Database_PDO_SQLite</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$driver" title="details" class="var-name">$driver</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$dsn" title="details" class="var-name">$dsn</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> |
<span class="disabled">Vars</span>
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_sqlite'</span> (line <span class="line-number">29</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></dt>
<dd>Driver</dd>
</dl>
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'sqlite:[[hostname]]'</span> (line <span class="line-number">37</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DSN format</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_PDO_Common.html#var$dsn">Database_PDO_Common::$dsn</a></dt>
<dd>DSN format</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_PDO_Common.html#var$attributes">Database_PDO_Common::$attributes</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<span class="disabled">Methods</span>
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a></span><br>
<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 =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<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#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>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</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 Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

91
docs/PICKLES/Display_Common.html
View file

@ -98,7 +98,7 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$child_template" title="details" class="var-name">$child_template</a>
</div>
@ -113,6 +113,10 @@
<div class="var-title">
<span class="var-type">array</span>
<a href="#$js_basename" title="details" class="var-name">$js_basename</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$meta_data" title="details" class="var-name">$meta_data</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
@ -139,7 +143,7 @@
</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>
@ -149,6 +153,11 @@
<span class="method-result">void</span>
<a href="#render" title="details" class="method-name">render</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setMetaData" title="details" class="method-name">setMetaData</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$meta_data</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
@ -280,17 +289,39 @@
</div>
<a name="var$module_return" id="$module_return"><!-- --></A>
<a name="var$meta_data" id="$meta_data"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$module_return</span>
<span class="var-name">$meta_data</span>
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Meta Data</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$module_return" id="$module_return"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$module_return</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Module Return Data</p>
<ul class="tags">
@ -303,7 +334,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">
@ -330,6 +361,9 @@
<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>
@ -350,10 +384,10 @@
<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">79</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">87</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -381,10 +415,10 @@
</div>
<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">168</span>)
<span class="method-title">render</span> (line <span class="line-number">188</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -424,12 +458,42 @@
: Renders the data in XML format
</li>
</ul>
</div>
<a name="methodsetMetaData" id="setMetaData"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setMetaData</span> (line <span class="line-number">153</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Meta Data</p>
<p class="description"><p>Sets the meta data from the module so the display class can use it</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">
setMetaData
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$meta_data</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$meta_data</span><span class="var-description">: key/value array of data</span> </li>
</ul>
</div>
<a name="methodsetModuleReturn" id="setModuleReturn"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setModuleReturn</span> (line <span class="line-number">145</span>)
<span class="method-title">setModuleReturn</span> (line <span class="line-number">165</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -459,7 +523,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">129</span>)
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">137</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -498,7 +562,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">158</span>)
<span class="method-title">templateExists</span> (line <span class="line-number">178</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -534,6 +598,7 @@
<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>
@ -542,7 +607,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

10
docs/PICKLES/Display_JSON.html
View file

@ -96,6 +96,9 @@
</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>
@ -108,6 +111,9 @@
<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>
@ -163,6 +169,7 @@
<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>
@ -171,6 +178,7 @@
<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>
@ -179,7 +187,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

16
docs/PICKLES/Display_PHP.html
View file

@ -101,7 +101,7 @@
</div>
<div class="info-box-body">
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -142,6 +142,9 @@
</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>
@ -154,6 +157,9 @@
<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>
@ -173,7 +179,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">58</span>)
@ -203,7 +209,7 @@
</div>
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">43</span>)
@ -240,6 +246,7 @@
<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>
@ -248,6 +255,7 @@
<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>
@ -256,7 +264,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

12
docs/PICKLES/Display_RSS.html
View file

@ -95,6 +95,9 @@
</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>
@ -107,6 +110,9 @@
<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>
@ -126,7 +132,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">38</span>)
@ -164,6 +170,7 @@
<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>
@ -172,6 +179,7 @@
<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>
@ -180,7 +188,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

12
docs/PICKLES/Display_XML.html
View file

@ -96,6 +96,9 @@
</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>
@ -108,6 +111,9 @@
<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>
@ -127,7 +133,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>)
@ -163,6 +169,7 @@
<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>
@ -171,6 +178,7 @@
<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>
@ -179,7 +187,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

53
docs/PICKLES/Error.html
View file

@ -16,8 +16,7 @@
<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>)
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
@ -29,9 +28,7 @@
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Error</pre>
<pre></pre>
</div>
</div>
@ -44,10 +41,7 @@
<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>)
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
@ -61,44 +55,19 @@
</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>)
<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="evenrow">
<div class="method-header">
<span class="method-title">static method fatal</span> (line <span class="line-number">33</span>)
@ -129,21 +98,13 @@
</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>
<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 Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

74
docs/PICKLES/Form.html
View file

@ -51,7 +51,12 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">object instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Form'</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#dateSelect" title="details" class="method-name">dateSelect</a>
@ -62,7 +67,7 @@
<a href="#dobSelect" title="details" class="method-name">dobSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'dob'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<div class="method-definition">
<span class="method-result">string</span>
<a href="#hiddenInput" title="details" class="method-name">hiddenInput</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
@ -125,6 +130,9 @@
<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>
@ -142,12 +150,50 @@
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">35</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Instance</p>
<p class="description"><p>Gets an instance of the Form class</p></p>
<ul class="tags">
<li><span class="field">return:</span> of the class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object instance</span>
<span class="method-name">
getInstance
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Form'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class to get an instance of</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></dt>
<dd>Get Instance</dd>
</dl>
</div>
<a name="methoddateSelect" id="dateSelect"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">dateSelect</span> (line <span class="line-number">235</span>)
<span class="method-title">dateSelect</span> (line <span class="line-number">272</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -194,7 +240,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">dobSelect</span> (line <span class="line-number">308</span>)
<span class="method-title">dobSelect</span> (line <span class="line-number">345</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -234,7 +280,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">hiddenInput</span> (line <span class="line-number">54</span>)
<span class="method-title">hiddenInput</span> (line <span class="line-number">68</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -274,7 +320,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">input</span> (line <span class="line-number">38</span>)
<span class="method-title">input</span> (line <span class="line-number">52</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -317,7 +363,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">options</span> (line <span class="line-number">103</span>)
<span class="method-title">options</span> (line <span class="line-number">116</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -325,7 +371,6 @@
<p class="description"><p>Generates the option elements from the passed array</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the options</li>
<li><span class="field">todo:</span> Add support for optgroup</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -352,7 +397,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">phoneInput</span> (line <span class="line-number">340</span>)
<span class="method-title">phoneInput</span> (line <span class="line-number">377</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -391,7 +436,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">polarSelect</span> (line <span class="line-number">323</span>)
<span class="method-title">polarSelect</span> (line <span class="line-number">360</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -430,7 +475,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">select</span> (line <span class="line-number">88</span>)
<span class="method-title">select</span> (line <span class="line-number">102</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -473,7 +518,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">stateSelect</span> (line <span class="line-number">146</span>)
<span class="method-title">stateSelect</span> (line <span class="line-number">183</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -513,7 +558,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">textarea</span> (line <span class="line-number">71</span>)
<span class="method-title">textarea</span> (line <span class="line-number">85</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -558,6 +603,7 @@
<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>
@ -566,7 +612,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

51
docs/PICKLES/Log.html
View file

@ -16,8 +16,7 @@
<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>)
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
@ -29,9 +28,7 @@
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Log</pre>
<pre></pre>
</div>
</div>
@ -44,10 +41,7 @@
<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>)
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
@ -91,38 +85,13 @@
</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>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
@ -348,21 +317,13 @@
</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>
<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 Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

428
docs/PICKLES/Model.html
View file

@ -16,8 +16,7 @@
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
@ -37,31 +36,6 @@
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</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"><a href="../PICKLES/Post.html">Post</a></td>
<td>
Post Model
</td>
</tr>
</table>
</div>
</div>
<a name="sec-var-summary"></a>
@ -69,7 +43,6 @@
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
@ -77,17 +50,33 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$count" title="details" class="var-name">$count</a>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$conditions" title="details" class="var-name">$conditions</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$data" title="details" class="var-name">$data</a>
<span class="var-type">string</span>
<a href="#$datasource" title="details" class="var-name">$datasource</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
<span class="var-type">boolean</span>
<a href="#$delayed" title="details" class="var-name">$delayed</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$fields" title="details" class="var-name">$fields</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$group" title="details" class="var-name">$group</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$having" title="details" class="var-name">$having</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$joins" title="details" class="var-name">$joins</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
@ -95,7 +84,11 @@
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$order_by" title="details" class="var-name">$order_by</a>
<a href="#$offset" title="details" class="var-name">$offset</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$order" title="details" class="var-name">$order</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
@ -107,14 +100,10 @@
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$reserved" title="details" class="var-name">$reserved</a>
<a href="#$results" title="details" class="var-name">$results</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$select" title="details" class="var-name">$select</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$table" title="details" class="var-name">$table</a>
</div>
</div>
@ -126,7 +115,6 @@
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
@ -134,11 +122,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">mixed</span>&nbsp;<span class="var-name">$conditions</span> = <span class="var-default">null</span>])
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -146,8 +134,8 @@
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#commitRecord" title="details" class="method-name">commitRecord</a>
<span class="method-result">void</span>
<a href="#count" title="details" class="method-name">count</a>
()
</div>
<div class="method-definition">
@ -179,16 +167,6 @@
<span class="method-result">string</span>
<a href="#unescape" title="details" class="method-name">unescape</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#__get" title="details" class="method-name">__get</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__set" title="details" class="method-name">__set</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
</div>
</div>
@ -199,7 +177,6 @@
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
@ -208,19 +185,19 @@
</div>
<div class="info-box-body">
<a name="var$count" id="$count"><!-- --></A>
<a name="var$conditions" id="$conditions"><!-- --></A>
<div class="evenrow">
<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">105</span>)
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Record Count</p>
<p class="short-description">Conditions</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -230,19 +207,19 @@
</div>
<a name="var$data" id="$data"><!-- --></A>
<a name="var$datasource" id="$datasource"><!-- --></A>
<div class="oddrow">
<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">81</span>)
<span class="var-type">string</span>
<span class="var-name">$datasource</span>
(line <span class="line-number">57</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Data</p>
<p class="short-description">Datasource</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -252,19 +229,107 @@
</div>
<a name="var$db" id="$db"><!-- --></A>
<a name="var$delayed" id="$delayed"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<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">33</span>)
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database</p>
<p class="short-description">Delayed Insert</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$fields" id="$fields"><!-- --></A>
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Field List</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$group" id="$group"><!-- --></A>
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Group</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$having" id="$having"><!-- --></A>
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Having</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$joins" id="$joins"><!-- --></A>
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Joins</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -281,14 +346,13 @@
<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">73</span>)
= <span class="var-default"> false</span> (line <span class="line-number">129</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Limit Results</p>
<p class="short-description">Limit</p>
<ul class="tags">
<li><span class="field">var:</span> integer, string or array</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -297,52 +361,66 @@
</div>
<a name="var$order_by" id="$order_by"><!-- --></A>
<a name="var$offset" id="$offset"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$order_by</span>
= <span class="var-default"> null</span> (line <span class="line-number">65</span>)
<span class="var-name">$offset</span>
= <span class="var-default"> false</span> (line <span class="line-number">137</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Order By Clause</p>
<p class="short-description">Offset</p>
<ul class="tags">
<li><span class="field">var:</span> (string or array)</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$order" id="$order"><!-- --></A>
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Order</p>
<ul class="tags">
<li><span class="field">var:</span> string, array</li>
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Post.html#var$order_by">Post::$order_by</a>
: Columns to Order By
</li>
</ul>
</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">89</span>)
= <span class="var-default"> null</span> (line <span class="line-number">152</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Record Array</p>
<p class="short-description">Record</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -351,42 +429,20 @@
</div>
<a name="var$records" id="$records"><!-- --></A>
<div class="evenrow">
<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">97</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Records Array</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$reserved" id="$reserved"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$reserved</span>
= <span class="var-default">array('SELECT', 'TABLE', 'ORDER BY', 'LIMIT')</span> (line <span class="line-number">41</span>)
<span class="var-name">$records</span>
= <span class="var-default"> null</span> (line <span class="line-number">159</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reserved Variables</p>
<p class="short-description">Records</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -394,21 +450,20 @@
</div>
<a name="var$select" id="$select"><!-- --></A>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$select</span>
= <span class="var-default"> '*'</span> (line <span class="line-number">57</span>)
<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>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Select [Column] List</p>
<p class="short-description">Query Results</p>
<ul class="tags">
<li><span class="field">var:</span> string, array</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -422,9 +477,9 @@
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">mixed</span>
<span class="var-name">$table</span>
= <span class="var-default"> null</span> (line <span class="line-number">49</span>)
= <span class="var-default"> false</span> (line <span class="line-number">81</span>)
</span>
</div>
@ -436,14 +491,6 @@
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Post.html#var$table">Post::$table</a>
: Table Name
</li>
</ul>
</div>
@ -453,6 +500,9 @@
<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>
@ -464,7 +514,6 @@
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
@ -476,12 +525,12 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">116</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">171</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Creates a new (empty) object or creates the record set from the passed parameters. The record and records arrays are populated as well as the count variable.</p></p>
<p class="description"><p>Creates a new (empty) object or creates the record set from the passed arguments. The record and records arrays are populated as well as the count variable.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -491,13 +540,16 @@
<span class="method-name">
__construct
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conditions</span> = <span class="var-default">null</span>])
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$conditions</span><span class="var-description">: optional key/values for the WHERE cause</span> </li>
<span class="var-name">$type_or_parameters</span><span class="var-description">: optional type of query or parameters</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$parameters</span><span class="var-description">: optional data to create a query from</span> </li>
</ul>
<hr class="separator" />
@ -512,15 +564,14 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">410</span>)
<span class="method-title">commit</span> (line <span class="line-number">538</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Commit</p>
<p class="description"><p>Commits the record to the database. Intelligently does an UPDATE or INSERT INTO.</p></p>
<p class="description"><p>Inserts or updates a record in the database.</p></p>
<ul class="tags">
<li><span class="field">return:</span> results of the query</li>
<li><span class="field">deprecated:</span> Deprecated is commitRecord() is even implemented</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -535,26 +586,24 @@
</div>
<a name="methodcommitRecord" id="commitRecord"><!-- --></a>
<a name="methodcount" id="count"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">commitRecord</span> (line <span class="line-number">303</span>)
<span class="method-title">count</span> (line <span class="line-number">486</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Commit Record</p>
<p class="description"><p>Commits a record to the database. Intelligently does an UPDATE or INSERT INTO.</p></p>
<p class="short-description">Count Records</p>
<p class="description"><p>Counts the records</p></p>
<ul class="tags">
<li><span class="field">return:</span> results of the query</li>
<li><span class="field">todo:</span> This will replace commit() eventually will add commitAll();</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">void</span>
<span class="method-name">
commitRecord
count
</span>
()
</div>
@ -566,7 +615,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">345</span>)
<span class="method-title">delete</span> (line <span class="line-number">586</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -592,7 +641,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">279</span>)
<span class="method-title">first</span> (line <span class="line-number">516</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -617,7 +666,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">last</span> (line <span class="line-number">289</span>)
<span class="method-title">last</span> (line <span class="line-number">526</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -642,7 +691,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">next</span> (line <span class="line-number">259</span>)
<span class="method-title">next</span> (line <span class="line-number">496</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -667,7 +716,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">prev</span> (line <span class="line-number">269</span>)
<span class="method-title">prev</span> (line <span class="line-number">506</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -692,7 +741,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">454</span>)
<span class="method-title">unescape</span> (line <span class="line-number">603</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -718,70 +767,6 @@
</ul>
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">363</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic Getter</p>
<p class="description"><p>Overrides the built in PHP getter and checks our data variable for the variable or returns false. The data array is loaded via the magic setter.</p></p>
<ul class="tags">
<li><span class="field">return:</span> requested variable, the entire data array or false</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
__get
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$variable</span><span class="var-description">: name of the variable</span> </li>
</ul>
</div>
<a name="method__set" id="__set"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">388</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic Setter</p>
<p class="description"><p>Overrides the built in PHP setter so that we can assign variables to our private data array (avoids conflicts with the object variables).</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">
__set
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$variable</span><span class="var-description">: name of the variable</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: value for the variable</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
@ -789,6 +774,7 @@
<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>
@ -797,7 +783,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

94
docs/PICKLES/Module.html
View file

@ -51,10 +51,6 @@
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">boolean,</span>
<a href="#$access" title="details" class="var-name">$access</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$ajax" title="details" class="var-name">$ajax</a>
</div>
@ -81,6 +77,10 @@
<div class="var-title">
<span class="var-type">boolean,</span>
<a href="#$secure" title="details" class="var-name">$secure</a>
</div>
<div class="var-title">
<span class="var-type">boolean,</span>
<a href="#$security" title="details" class="var-name">$security</a>
</div>
<div class="var-title">
<span class="var-type">boolean,</span>
@ -132,7 +132,7 @@
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<span class="method-result">void</span>
<a href="#__set" title="details" class="method-name">__set</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
@ -153,32 +153,9 @@
</div>
<div class="info-box-body">
<a name="var$access" id="$access"><!-- --></A>
<a name="var$ajax" id="$ajax"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<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">68</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access level of the page</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$ajax" id="$ajax"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
@ -202,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">
@ -213,7 +190,7 @@
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database</p>
<p class="short-description">Database object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -224,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">
@ -247,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">
@ -271,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">
@ -294,13 +271,13 @@
</div>
<a name="var$request" id="$request"><!-- --></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">$request</span>
= <span class="var-default"> null</span> (line <span class="line-number">137</span>)
= <span class="var-default"> null</span> (line <span class="line-number">138</span>)
</span>
</div>
@ -309,6 +286,7 @@
<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> Not even sure I want to implement this at this point</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>
@ -319,13 +297,13 @@
</div>
<a name="var$secure" id="$secure"><!-- --></A>
<div class="evenrow">
<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">79</span>)
= <span class="var-default"> null</span> (line <span class="line-number">71</span>)
</span>
</div>
@ -342,6 +320,29 @@
</div>
<a name="var$security" id="$security"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$security</span>
= <span class="var-default"> null</span> (line <span class="line-number">79</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security settings of the page</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$session" id="$session"><!-- --></A>
<div class="oddrow">
@ -420,6 +421,9 @@
<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>
@ -442,7 +446,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">149</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">150</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -478,7 +482,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">setRequest</span> (line <span class="line-number">222</span>)
<span class="method-title">setRequest</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -508,7 +512,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__default</span> (line <span class="line-number">170</span>)
<span class="method-title">__default</span> (line <span class="line-number">171</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -533,7 +537,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">199</span>)
<span class="method-title">__get</span> (line <span class="line-number">198</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -571,12 +575,11 @@
<p class="short-description">Magic Setter Method</p>
<p class="description"><p>Prohibits the direct modification of module variables.</p></p>
<ul class="tags">
<li><span class="field">return:</span> false</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">void</span>
<span class="method-name">
__set
</span>
@ -600,6 +603,7 @@
<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>
@ -608,7 +612,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

137
docs/PICKLES/Object.html
View file

@ -24,9 +24,9 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Object Class</p>
<p class="description"><p>Every non-Singleton-based class needs to extend this class. Any models will extend the Model class which entends the Object class already. This class handles getting an instance of the Config object so that it's available. Also provides a getter and setter for variables.</p></p>
<p class="description"><p>Every instantiated class in PICKLES should be extending this class. By doing so the class is automatically hooked into the profiler, and the object will have access to some common components as well.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Object.php.html">/classes/Object.php</a> (line <span class="field">27</span>)
Located in <a class="field" href="_classes---Object.php.html">/classes/Object.php</a> (line <span class="field">25</span>)
</p>
@ -58,9 +58,9 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Log.html">Log</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Database_Common.html">Database_Common</a></td>
<td>
Log Class
Common Database Abstraction Layer
</td>
</tr>
<tr>
@ -78,7 +78,13 @@
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
<td>
Database Abstraction Layer for MySQL
Database Factory
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Config.html">Config</a></td>
<td>
Config Class
</td>
</tr>
<tr>
@ -92,12 +98,6 @@
<td>
Model Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Error.html">Error</a></td>
<td>
Error Class
</td>
</tr>
</table>
</div>
@ -117,11 +117,15 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
static <span class="var-type">mixed</span>
<a href="#$instances" title="details" class="var-name">$instances</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$config" title="details" class="var-name">$config</a>
</div>
</div>
</div>
</div>
</div>
@ -138,7 +142,12 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">object instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">Object</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -149,7 +158,7 @@
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
</div>
</div>
</div>
</div>
@ -167,14 +176,36 @@
</div>
<div class="info-box-body">
<a name="var$config" id="$config"><!-- --></A>
<a name="var$instances" id="$instances"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$instances</span>
= <span class="var-default">array()</span> (line <span class="line-number">34</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Object Instances</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$config" id="$config"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$config</span>
= <span class="var-default"> null</span> (line <span class="line-number">35</span>)
= <span class="var-default"> null</span> (line <span class="line-number">42</span>)
</span>
</div>
@ -205,12 +236,60 @@
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">42</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">78</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Instance</p>
<p class="description"><p>Gets an instance of the passed class. Allows for easy sharing of certain classes within the system to avoid the extra overhead of creating new objects each time. Also avoids the hassle of passing around variables.</p></p>
<ul class="tags">
<li><span class="field">return:</span> of the class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object instance</span>
<span class="method-name">
getInstance
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database.html#methodgetInstance">Database::getInstance()</a>
: Get instance
</li>
<li>
<a href="../PICKLES/Config.html#methodgetInstance">Config::getInstance()</a>
: Get instance of the object
</li>
<li>
<a href="../PICKLES/Form.html#methodgetInstance">Form::getInstance()</a>
: Get Instance
</li>
</ul>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">49</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -238,6 +317,14 @@
: Constructor
</li>
<li>
<a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Module.html#method__construct">Module::__construct()</a>
: Constructor
</li>
@ -250,16 +337,20 @@
: Constructor
</li>
<li>
<a href="../PICKLES/Config.html#method__construct">Config::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Model.html#method__construct">Model::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">56</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">99</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -292,7 +383,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

226
docs/PICKLES/Post.html
View file

@ -1,226 +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 Post</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 Post</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Post Model</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>
<p class="notes">
Located in <a class="field" href="_sample-site---models---Post.php.html">/sample-site/models/Post.php</a> (line <span class="field">17</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Model.html">Model</a>
|
--Post</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$order_by" title="details" class="var-name">$order_by</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$table" title="details" class="var-name">$table</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> |
<span class="disabled">Vars</span>
|
<a href="#sec-methods">Methods</a>
</div>
<div class="info-box-body">
<a name="var$order_by" id="$order_by"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$order_by</span>
= <span class="var-default"> 'posted_at DESC'</span> (line <span class="line-number">33</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Columns to Order By</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Model.html#var$order_by">Model::$order_by</a></dt>
<dd>Order By Clause</dd>
</dl>
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$table</span>
= <span class="var-default"> 'pickles_posts'</span> (line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Table Name</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Model.html#var$table">Model::$table</a></dt>
<dd>Table Name</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Model.html">Model</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$count">Model::$count</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$data">Model::$data</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$db">Model::$db</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$limit">Model::$limit</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$record">Model::$record</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$records">Model::$records</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$reserved">Model::$reserved</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Model.html#var$select">Model::$select</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>
</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<span class="disabled">Methods</span>
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Model.html">Model</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Model.html#method__construct">Model::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodcommit">Model::commit()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methoddelete">Model::delete()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodfirst">Model::first()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodlast">Model::last()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodnext">Model::next()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodprev">Model::prev()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#methodunescape">Model::unescape()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#method__get">Model::__get()</a></span><br>
<span class="method-name"><a href="../PICKLES/Model.html#method__set">Model::__set()</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#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

22
docs/PICKLES/Profiler.html
View file

@ -22,13 +22,15 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Profiler Class</p>
<p class="description"><p>The Profiler class is statically interfaced with and allows for in depth profiling of a site. By default profiling is off, but can be enabled in the config.ini for a site. Out of the box the profiler will report on every class object in the system that extends the code Object class.</p><p>Note: I really wanted to use PHP Quick Profiler by Ryan Campbell of Particletree but it kept barking out errors when I tried to use it. Here's a link anyway: http://particletree.com/features/php-quick-profiler/</p></p>
<p class="description"><p>The Profiler class is statically interfaced with and allows for in depth profiling of a site. By default profiling is off, but can be enabled in the config.ini for a site. Out of the box the profiler will report on every class object in the system that extends the code Object class.</p><p>Note: I really wanted to use PHP Quick Profiler by Ryan Campbell of Particletree but it kept barking out errors when I tried to use it with E_STRICT turned on. Here's a link anyway since it looks awesome: http://particletree.com/features/php-quick-profiler/</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/Profiler.html">Profiler</a></span><span class="src-sym">::</span><a href="../PICKLES/Profiler.html#methodlog">log</a><span class="src-sym">(</span><span class="src-str">'started&nbsp;stuff'</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/Profiler.html">Profiler</a></span><span class="src-sym">::</span><a href="../PICKLES/Profiler.html#methodlog">log</a><span class="src-sym">(</span><span class="src-str">'some&nbsp;action&nbsp;you&nbsp;want&nbsp;to&nbsp;track'</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/Profiler.html">Profiler</a></span><span class="src-sym">::</span><a href="../PICKLES/Profiler.html#methodlog">log</a><span class="src-sym">(</span><span class="src-var">$object</span><span class="src-sym">,&nbsp;</span><span class="src-str">'methodName'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Profiler.php.html">/classes/Profiler.php</a> (line <span class="field">32</span>)
Located in <a class="field" href="_classes---Profiler.php.html">/classes/Profiler.php</a> (line <span class="field">34</span>)
</p>
@ -81,10 +83,10 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodlog" id="log"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method log</span> (line <span class="line-number">81</span>)
<span class="method-title">static method log</span> (line <span class="line-number">83</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -118,10 +120,10 @@
</div>
<a name="methodlogQuery" id="logQuery"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method logQuery</span> (line <span class="line-number">132</span>)
<span class="method-title">static method logQuery</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -158,10 +160,10 @@
</div>
<a name="methodreport" id="report"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method report</span> (line <span class="line-number">178</span>)
<span class="method-title">static method report</span> (line <span class="line-number">180</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -190,7 +192,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

229
docs/PICKLES/Security.html Normal file
View file

@ -0,0 +1,229 @@
<?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 Security</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 Security</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">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>
</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>
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Security.php.html">/classes/Security.php</a> (line <span class="field">27</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#clearLevel" title="details" class="method-name">clearLevel</a>
()
</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>])
</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>])
</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>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodclearLevel" id="clearLevel"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method clearLevel</span> (line <span class="line-number">112</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clear Level</p>
<p class="description"><p>Clears out the security level.</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">
clearLevel
</span>
()
</div>
</div>
<a name="methodhasLevel" id="hasLevel"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method hasLevel</span> (line <span class="line-number">161</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Has Level</p>
<p class="description"><p>Checks the user's access level against the passed level.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the user has access</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">
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>])
</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>
</div>
<a name="methodisLevel" id="isLevel"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method isLevel</span> (line <span class="line-number">131</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is Level</p>
<p class="description"><p>Checks the user's access level is exactly the passed level</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the user is that level</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">
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>])
</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 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>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method setLevel</span> (line <span class="line-number">95</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Level</p>
<p class="description"><p>Sets 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">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
setLevel
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$access_level</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>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Configuration Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Single Entry Controller</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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Database---Common.php.html Normal file
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 Common.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/Database/Common.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">Common Database 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/Database_Common.html">Database_Common</a>
</td>
<td>
Common Database Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Database---PDO---Common.php.html Normal file
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 Common.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/Database/PDO/Common.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">PDO 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/Database_PDO_Common.html">Database_PDO_Common</a>
</td>
<td>
PDO Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Database---PDO---MySQL.php.html Normal file
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 MySQL.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/Database/PDO/MySQL.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">MySQL 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/Database_PDO_MySQL.html">Database_PDO_MySQL</a>
</td>
<td>
MySQL Database Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Database---PDO---PostgreSQL.php.html Normal file
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 PostgreSQL.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/Database/PDO/PostgreSQL.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">PostgreSQL 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/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a>
</td>
<td>
PostgreSQL Database Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Database---PDO---SQLite.php.html Normal file
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 SQLite.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/Database/PDO/SQLite.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">SQLite 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/Database_PDO_SQLite.html">Database_PDO_SQLite</a>
</td>
<td>
SQLite Database Abstraction Layer
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -50,7 +50,7 @@
<a href="../PICKLES/Database.html">Database</a>
</td>
<td>
Database Abstraction Layer for MySQL
Database Factory
</td>
</tr>
</table>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Common Display Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">JSON Display Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PHP Display Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<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 GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">XML Display Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logging System 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Model Parent Class 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Module Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Object Class File 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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -21,12 +21,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Profiler</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>
<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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://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>
<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>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

18
docs/PICKLES/_sample-site---models---Post.php.html → docs/PICKLES/_classes---Security.php.html
View file

@ -3,13 +3,13 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page Post.php</title>
<title>Docs for page Security.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">/sample-site/models/Post.php</h2>
<h2 class="file-name">/classes/Security.php</h2>
<a name="sec-description"></a>
<div class="info-box">
@ -20,6 +20,14 @@
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security System 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>
@ -39,10 +47,10 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Post.html">Post</a>
<a href="../PICKLES/Security.html">Security</a>
</td>
<td>
Post Model
Security Class
</td>
</tr>
</table>
@ -54,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

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

@ -22,14 +22,14 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Core PICKLES Include File</p>
<p class="description"><p>This is the file that you include on the page you're instantiating the controller from (typically index.php). The path to the PICKLES code base is established as well as the path that Smarty will use to store the compiled pages.</p><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>
<p class="description"><p>This is the file that you include on the page you're instantiating the controller from (typically index.php). The path to the PICKLES code base is established as well as the path that Smarty will use to store the compiled pages.</p><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@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
<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://phpwithpickles.org">http://phpwithpickles.org</a></li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once&nbsp;</span><span class="src-str">'pickles.php'</span><span class="src-sym">;</span></div></li>
</ol></div></li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</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>
@ -47,12 +47,12 @@
</div>
<div class="info-box-body">
<a name="defineDISPLAY_JSON"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
(line <span class="line-number">59</span>)
(line <span class="line-number">46</span>)
</span>
</div>
@ -61,179 +61,11 @@
</div>
<a name="defineDISPLAY_PHP"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
(line <span class="line-number">60</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">61</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">62</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">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineLOG_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">LOG_PATH</span> = PRIVATE_PATH.'logs/'
(line <span class="line-number">55</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_CLASS_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_CLASS_PATH</span> = PICKLES_PATH.'classes/'
(line <span class="line-number">44</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_PATH</span> = dirname(__FILE__).'/'
(line <span class="line-number">43</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_START_TIME"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_START_TIME</span> = microtime(true)
(line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePRIVATE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">PRIVATE_PATH</span> = SITE_PATH.'private/'
(line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_CLASS_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_CLASS_PATH</span> = SITE_PATH.'classes/'
(line <span class="line-number">49</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_MODEL_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">SITE_MODEL_PATH</span> = SITE_PATH.'models/'
(line <span class="line-number">50</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_MODULE_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_MODULE_PATH</span> = SITE_PATH.'modules/'
(line <span class="line-number">51</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">SITE_PATH</span> = getcwd().'/../'
(line <span class="line-number">47</span>)
</span>
</div>
@ -242,12 +74,40 @@
</div>
<a name="defineSITE_TEMPLATE_PATH"><!-- --></a>
<a name="defineDISPLAY_RSS"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
(line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_XML"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_TEMPLATE_PATH</span> = SITE_PATH.'templates/'
<span class="const-name">DISPLAY_XML</span> = 'XML'
(line <span class="line-number">49</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineJSON_AVAILABLE"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">JSON_AVAILABLE</span> = function_exists('json_encode')
(line <span class="line-number">52</span>)
</span>
</div>
@ -256,13 +116,153 @@
</div>
<a name="defineSMARTY_PATH"><!-- --></a>
<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">42</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_CLASS_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_CLASS_PATH</span> = PICKLES_PATH.'classes/'
(line <span class="line-number">31</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_PATH</span> = dirname(__FILE__).'/'
(line <span class="line-number">30</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePICKLES_START_TIME"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">PICKLES_START_TIME</span> = microtime(true)
(line <span class="line-number">27</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="definePRIVATE_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">PRIVATE_PATH</span> = SITE_PATH.'private/'
(line <span class="line-number">41</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">36</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">37</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">38</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineSITE_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">SITE_PATH</span> = getcwd().'/../'
(line <span class="line-number">34</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">39</span>)
</span>
</div>
<!-- ========== 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">56</span>)
(line <span class="line-number">43</span>)
</span>
</div>
@ -284,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">77</span>)
<span class="method-title">__autoload</span> (line <span class="line-number">121</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -314,15 +314,15 @@
</div>
<a name="function__handleError" id="function__handleError"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="method-title">__handleError</span> (line <span class="line-number">112</span>)
<span class="method-title">__handleError</span> (line <span class="line-number">158</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>
<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>
<ul class="tags">
<li><span class="field">return:</span> not really returned, but worth documenting</li>
</ul>
@ -354,12 +354,39 @@
</ul>
</div>
<a name="function__handleException" id="function__handleException"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">__handleException</span> (line <span class="line-number">176</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>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__handleException
</span>
(<span class="var-type">object</span>&nbsp;<span class="var-name">$exception</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">object</span>
<span class="var-name">$exception</span><span class="var-description">: the exception</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:51 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

24
docs/classtrees_PICKLES.html
View file

@ -13,26 +13,36 @@
<H2>
</H2>
<h2>Root class Config</h2>
<h2>Root class Error</h2>
<ul>
<li><a href="PICKLES/Config.html">Config</a></li></ul>
<li><a href="PICKLES/Error.html">Error</a></li></ul>
<h2>Root class Log</h2>
<ul>
<li><a href="PICKLES/Log.html">Log</a></li></ul>
<h2>Root class Object</h2>
<ul>
<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/Config.html">Config</a></li><li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Database_Common.html">Database_Common</a><ul>
<li><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a><ul>
<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/Error.html">Error</a></li><li><a href="PICKLES/Form.html">Form</a></li><li><a href="PICKLES/Log.html">Log</a></li><li><a href="PICKLES/Model.html">Model</a><ul>
<li><a href="PICKLES/Post.html">Post</a></li></ul></li>
<li><a href="PICKLES/Module.html">Module</a></li></ul></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>
<h2>Root class Profiler</h2>
<ul>
<li><a href="PICKLES/Profiler.html">Profiler</a></li></ul>
<h2>Root class Security</h2>
<ul>
<li><a href="PICKLES/Security.html">Security</a></li></ul>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

570
docs/elementindex.html
View file

@ -48,13 +48,6 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$access</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$access">Module::$access</a> in Module.php</div>
<div class="index-item-description">Access level of the page</div>
</dd>
<dt class="field">
<span class="var-title">$ajax</span>
</dt>
@ -62,6 +55,13 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$ajax">Module::$ajax</a> in Module.php</div>
<div class="index-item-description">AJAX</div>
</dd>
<dt class="field">
<span class="var-title">$attributes</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$attributes">Database_PDO_Common::$attributes</a> in Common.php</div>
<div class="index-item-description">PDO Attributes</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
@ -77,6 +77,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">$conditions</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$conditions">Model::$conditions</a> in Model.php</div>
<div class="index-item-description">Conditions</div>
</dd>
<dt class="field">
<span class="var-title">$config</span>
</dt>
@ -85,11 +92,11 @@
<div class="index-item-description">Instance of the Config object</div>
</dd>
<dt class="field">
<span class="var-title">$count</span>
<span class="var-title">$connection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$count">Model::$count</a> in Model.php</div>
<div class="index-item-description">Record Count</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a> in Common.php</div>
<div class="index-item-description">Connection resource</div>
</dd>
<dt class="field">
<span class="var-title">$css_class</span>
@ -113,14 +120,40 @@
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<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="method-title">clearLevel</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>
</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.html#methodclose">Database::close()</a> in Database.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodclose">Database_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_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">
@ -130,13 +163,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommit">Model::commit()</a> in Model.php</div>
<div class="index-item-description">Commit</div>
</dd>
<dt class="field">
<span class="method-title">commitRecord</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a> in Model.php</div>
<div class="index-item-description">Commit Record</div>
</dd>
<dt class="field">
Config
</dt>
@ -151,6 +177,13 @@
<div class="index-item-details"><a href="PICKLES/Controller.html">Controller</a> in Controller.php</div>
<div class="index-item-description">Controller Class</div>
</dd>
<dt class="field">
<span class="method-title">count</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodcount">Model::count()</a> in Model.php</div>
<div class="index-item-description">Count Records</div>
</dd>
</dl>
<a name="d"></a>
<div class="index-letter-section">
@ -160,25 +193,32 @@
</div>
<dl>
<dt class="field">
<span class="var-title">$data</span>
<span class="var-title">$database</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$data">Model::$data</a> in Model.php</div>
<div class="index-item-description">Data</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$database">Database_Common::$database</a> in Common.php</div>
<div class="index-item-description">Database name for the server</div>
</dd>
<dt class="field">
<span class="var-title">$db</span>
<span class="var-title">$datasource</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$db">Model::$db</a> in Model.php</div>
<div class="index-item-description">Database</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$datasource">Model::$datasource</a> in Model.php</div>
<div class="index-item-description">Datasource</div>
</dd>
<dt class="field">
<span class="var-title">$db</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$db">Module::$db</a> in Module.php</div>
<div class="index-item-description">Database</div>
<div class="index-item-description">Database object</div>
</dd>
<dt class="field">
<span class="var-title">$delayed</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$delayed">Model::$delayed</a> in Model.php</div>
<div class="index-item-description">Delayed Insert</div>
</dd>
<dt class="field">
<span class="var-title">$description</span>
@ -187,6 +227,62 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$description">Module::$description</a> in Module.php</div>
<div class="index-item-description">Meta description</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_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">
<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_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a> in SQLite.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_PDO_MySQL.html#var$driver">Database_PDO_MySQL::$driver</a> in MySQL.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_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_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">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_SQLite.html#var$dsn">Database_PDO_SQLite::$dsn</a> in SQLite.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">
<span class="include-title">Database.php</span>
</dt>
@ -198,7 +294,42 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html">Database</a> in Database.php</div>
<div class="index-item-description">Database Abstraction Layer for MySQL</div>
<div class="index-item-description">Database Factory</div>
</dd>
<dt class="field">
Database_Common
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html">Database_Common</a> in Common.php</div>
<div class="index-item-description">Common Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_Common
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a> in Common.php</div>
<div class="index-item-description">PDO Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_MySQL
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a> in MySQL.php</div>
<div class="index-item-description">MySQL Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_PostgreSQL
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a> in PostgreSQL.php</div>
<div class="index-item-description">PostgreSQL Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_SQLite
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a> in SQLite.php</div>
<div class="index-item-description">SQLite Database Abstraction Layer</div>
</dd>
<dt class="field">
<span class="method-title">dateSelect</span>
@ -221,12 +352,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>
@ -235,10 +360,10 @@
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
<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_PHP">DISPLAY_PHP</a> in pickles.php</div>
<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_PHP
@ -248,11 +373,10 @@
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
Display_RSS
<span class="const-title">DISPLAY_PHP</span>
</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>
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_PHP">DISPLAY_PHP</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
@ -260,6 +384,13 @@
<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">
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_XML</span>
</dt>
@ -333,7 +464,7 @@
<span class="method-title">execute</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodexecute">Database::execute()</a> in Database.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodexecute">Database_PDO_Common::execute()</a> in Common.php</div>
<div class="index-item-description">Executes an SQL Statement</div>
</dd>
</dl>
@ -344,6 +475,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$fields</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$fields">Model::$fields</a> in Model.php</div>
<div class="index-item-description">Field List</div>
</dd>
<dt class="field">
<span class="include-title">Form.php</span>
</dt>
@ -361,21 +499,21 @@
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetch">Database::fetch()</a> in Database.php</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 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.html#methodfetchAll">Database::fetchAll()</a> in Database.php</div>
<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">fetchColumn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
<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>
</dd>
<dt class="field">
@ -400,12 +538,33 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$group</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$group">Model::$group</a> in Model.php</div>
<div class="index-item-description">Group</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/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</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>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodgetInstance">Database::getInstance()</a> in Database.php</div>
<div class="index-item-description">Get instance of the object</div>
<div class="index-item-description">Get instance</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
@ -422,6 +581,27 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$having</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$having">Model::$having</a> in Model.php</div>
<div class="index-item-description">Having</div>
</dd>
<dt class="field">
<span class="var-title">$hostname</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a> in Common.php</div>
<div class="index-item-description">Hostname for the server</div>
</dd>
<dt class="field">
<span class="method-title">hasLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodhasLevel">Security::hasLevel()</a> in Security.php</div>
<div class="index-item-description">Has Level</div>
</dd>
<dt class="field">
<span class="method-title">hiddenInput</span>
</dt>
@ -437,6 +617,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$instances</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Object.html#var$instances">Object::$instances</a> in Object.php</div>
<div class="index-item-description">Object Instances</div>
</dd>
<dt class="field">
<span class="method-title">information</span>
</dt>
@ -451,6 +638,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodinput">Form::input()</a> in Form.php</div>
<div class="index-item-description">Input</div>
</dd>
<dt class="field">
<span class="method-title">isLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodisLevel">Security::isLevel()</a> in Security.php</div>
<div class="index-item-description">Is Level</div>
</dd>
</dl>
<a name="j"></a>
<div class="index-letter-section">
@ -459,6 +653,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$joins</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$joins">Model::$joins</a> in Model.php</div>
<div class="index-item-description">Joins</div>
</dd>
<dt class="field">
<span class="var-title">$js_basename</span>
</dt>
@ -506,7 +707,7 @@
</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>
<div class="index-item-description">Limit</div>
</dd>
<dt class="field">
<span class="include-title">Log.php</span>
@ -563,6 +764,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$meta_data</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$meta_data">Display_Common::$meta_data</a> in Common.php</div>
<div class="index-item-description">Meta Data</div>
</dd>
<dt class="field">
<span class="var-title">$module_return</span>
</dt>
@ -570,6 +778,12 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a> in Common.php</div>
<div class="index-item-description">Module Return Data</div>
</dd>
<dt class="field">
<span class="include-title">MySQL.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---MySQL.php.html">MySQL.php</a> in MySQL.php</div>
</dd>
<dt class="field">
<span class="include-title">Model.php</span>
</dt>
@ -620,18 +834,18 @@
</div>
<dl>
<dt class="field">
<span class="var-title">$order_by</span>
<span class="var-title">$offset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html#var$order_by">Post::$order_by</a> in Post.php</div>
<div class="index-item-description">Columns to Order By</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$offset">Model::$offset</a> in Model.php</div>
<div class="index-item-description">Offset</div>
</dd>
<dt class="field">
<span class="var-title">$order_by</span>
<span class="var-title">$order</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$order_by">Model::$order_by</a> in Model.php</div>
<div class="index-item-description">Order By Clause</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$order">Model::$order</a> in Model.php</div>
<div class="index-item-description">Order</div>
</dd>
<dt class="field">
<span class="include-title">Object.php</span>
@ -650,7 +864,14 @@
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodopen">Database::open()</a> in Database.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_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">
@ -675,6 +896,40 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$parent_template">Display_Common::$parent_template</a> in Common.php</div>
<div class="index-item-description">Parent Template</div>
</dd>
<dt class="field">
<span class="var-title">$password</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$password">Database_Common::$password</a> in Common.php</div>
<div class="index-item-description">Password for the server</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_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>
</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>
</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_MySQL.html#var$port">Database_PDO_MySQL::$port</a> in MySQL.php</div>
<div class="index-item-description">Default port</div>
</dd>
<dt class="field">
<span class="include-title">PostgreSQL.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---PostgreSQL.php.html">PostgreSQL.php</a> in PostgreSQL.php</div>
</dd>
<dt class="field">
<span class="include-title">PHP.php</span>
</dt>
@ -732,13 +987,6 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodpolarSelect">Form::polarSelect()</a> in Form.php</div>
<div class="index-item-description">Polar Select</div>
</dd>
<dt class="field">
Post
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html">Post</a> in Post.php</div>
<div class="index-item-description">Post Model</div>
</dd>
<dt class="field">
<span class="method-title">prepareVariables</span>
</dt>
@ -765,12 +1013,6 @@
<div class="index-item-details"><a href="PICKLES/Profiler.html">Profiler</a> in Profiler.php</div>
<div class="index-item-description">Profiler Class</div>
</dd>
<dt class="field">
<span class="include-title">Post.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_sample-site---models---Post.php.html">Post.php</a> in Post.php</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
@ -799,14 +1041,14 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$record">Model::$record</a> in Model.php</div>
<div class="index-item-description">Record Array</div>
<div class="index-item-description">Record</div>
</dd>
<dt class="field">
<span class="var-title">$records</span>
</dt>
<dd class="index-item-body">
<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>
<div class="index-item-description">Records</div>
</dd>
<dt class="field">
<span class="var-title">$request</span>
@ -816,11 +1058,18 @@
<div class="index-item-description">Request Data</div>
</dd>
<dt class="field">
<span class="var-title">$reserved</span>
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$reserved">Model::$reserved</a> in Model.php</div>
<div class="index-item-description">Reserved Variables</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="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>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
@ -839,8 +1088,8 @@
<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>
<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>
@ -860,8 +1109,8 @@
<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_XML.html#methodrender">Display_XML::render()</a> in XML.php</div>
<div class="index-item-description">Renders the data in XML format</div>
</dd>
<dt class="field">
<span class="method-title">report</span>
@ -886,11 +1135,11 @@
<div class="index-item-description">Secure</div>
</dd>
<dt class="field">
<span class="var-title">$select</span>
<span class="var-title">$security</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$select">Model::$select</a> in Model.php</div>
<div class="index-item-description">Select [Column] List</div>
<div class="index-item-details"><a href="PICKLES/Module.html#var$security">Module::$security</a> in Module.php</div>
<div class="index-item-description">Security settings of the page</div>
</dd>
<dt class="field">
<span class="var-title">$session</span>
@ -899,6 +1148,32 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$session">Module::$session</a> in Module.php</div>
<div class="index-item-description">Session</div>
</dd>
<dt class="field">
<span class="var-title">$socket</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a> in Common.php</div>
<div class="index-item-description">UNIX socket for the server</div>
</dd>
<dt class="field">
<span class="include-title">SQLite.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---SQLite.php.html">SQLite.php</a> in SQLite.php</div>
</dd>
<dt class="field">
<span class="include-title">Security.php</span>
</dt>
<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">
Security
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html">Security</a> in Security.php</div>
<div class="index-item-description">Security Class</div>
</dd>
<dt class="field">
<span class="method-title">select</span>
</dt>
@ -906,6 +1181,34 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodselect">Form::select()</a> in Form.php</div>
<div class="index-item-description">Select</div>
</dd>
<dt class="field">
<span class="method-title">setDatabase</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a> in Common.php</div>
<div class="index-item-description">Set Database</div>
</dd>
<dt class="field">
<span class="method-title">setHostname</span>
</dt>
<dd class="index-item-body">
<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>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a> in Common.php</div>
<div class="index-item-description">Set Meta Data</div>
</dd>
<dt class="field">
<span class="method-title">setModuleReturn</span>
</dt>
@ -913,6 +1216,20 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a> in Common.php</div>
<div class="index-item-description">Set Module Return</div>
</dd>
<dt class="field">
<span class="method-title">setPassword</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a> in Common.php</div>
<div class="index-item-description">Set Password</div>
</dd>
<dt class="field">
<span class="method-title">setPort</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a> in Common.php</div>
<div class="index-item-description">Set Port</div>
</dd>
<dt class="field">
<span class="method-title">setRequest</span>
</dt>
@ -920,6 +1237,13 @@
<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="method-title">setSocket</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a> in Common.php</div>
<div class="index-item-description">Set Socket</div>
</dd>
<dt class="field">
<span class="method-title">setTemplateVariables</span>
</dt>
@ -927,6 +1251,13 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetTemplateVariables">Display_Common::setTemplateVariables()</a> in Common.php</div>
<div class="index-item-description">Set Template Variables</div>
</dd>
<dt class="field">
<span class="method-title">setUsername</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</a> in Common.php</div>
<div class="index-item-description">Set Username</div>
</dd>
<dt class="field">
<span class="const-title">SITE_CLASS_PATH</span>
</dt>
@ -988,13 +1319,6 @@
<dt class="field">
<span class="var-title">$table</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html#var$table">Post::$table</a> in Post.php</div>
<div class="index-item-description">Table Name</div>
</dd>
<dt class="field">
<span class="var-title">$table</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$table">Model::$table</a> in Model.php</div>
<div class="index-item-description">Table Name</div>
@ -1049,6 +1373,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$username</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$username">Database_Common::$username</a> in Common.php</div>
<div class="index-item-description">Username for the server</div>
</dd>
<dt class="field">
<span class="method-title">unescape</span>
</dt>
@ -1111,28 +1442,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<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-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.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">
@ -1145,10 +1455,45 @@
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__construct">Config::__construct()</a> in Config.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<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-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__default</span>
</dt>
@ -1179,13 +1524,6 @@
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__get">Model::__get()</a> in Model.php</div>
<div class="index-item-description">Magic Getter</div>
</dd>
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__get">Config::__get()</a> in Config.php</div>
<div class="index-item-description">Magic Getter Method</div>
@ -1198,18 +1536,18 @@
<div class="index-item-description">Error handling function that thinks it's magical</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
<span class="method-title">__handleException</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__set">Config::__set()</a> in Config.php</div>
<div class="index-item-description">Magic Setter Method</div>
<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>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__set">Model::__set()</a> in Model.php</div>
<div class="index-item-description">Magic Setter</div>
<div class="index-item-details"><a href="PICKLES/Config.html#method__set">Config::__set()</a> in Config.php</div>
<div class="index-item-description">Magic Setter Method</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>

570
docs/elementindex_PICKLES.html
View file

@ -63,28 +63,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<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-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.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">
@ -97,10 +76,45 @@
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__construct">Config::__construct()</a> in Config.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a> in Common.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
<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-description">Constructor</div>
</dd>
<dt class="field">
<span class="method-title">__default</span>
</dt>
@ -131,13 +145,6 @@
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__get">Model::__get()</a> in Model.php</div>
<div class="index-item-description">Magic Getter</div>
</dd>
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__get">Config::__get()</a> in Config.php</div>
<div class="index-item-description">Magic Getter Method</div>
@ -150,18 +157,18 @@
<div class="index-item-description">Error handling function that thinks it's magical</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
<span class="method-title">__handleException</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#method__set">Config::__set()</a> in Config.php</div>
<div class="index-item-description">Magic Setter Method</div>
<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>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#method__set">Model::__set()</a> in Model.php</div>
<div class="index-item-description">Magic Setter</div>
<div class="index-item-details"><a href="PICKLES/Config.html#method__set">Config::__set()</a> in Config.php</div>
<div class="index-item-description">Magic Setter Method</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
@ -178,13 +185,6 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$access</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$access">Module::$access</a> in Module.php</div>
<div class="index-item-description">Access level of the page</div>
</dd>
<dt class="field">
<span class="var-title">$ajax</span>
</dt>
@ -192,6 +192,13 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$ajax">Module::$ajax</a> in Module.php</div>
<div class="index-item-description">AJAX</div>
</dd>
<dt class="field">
<span class="var-title">$attributes</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#var$attributes">Database_PDO_Common::$attributes</a> in Common.php</div>
<div class="index-item-description">PDO Attributes</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
@ -207,6 +214,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">$conditions</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$conditions">Model::$conditions</a> in Model.php</div>
<div class="index-item-description">Conditions</div>
</dd>
<dt class="field">
<span class="var-title">$config</span>
</dt>
@ -215,11 +229,11 @@
<div class="index-item-description">Instance of the Config object</div>
</dd>
<dt class="field">
<span class="var-title">$count</span>
<span class="var-title">$connection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$count">Model::$count</a> in Model.php</div>
<div class="index-item-description">Record Count</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a> in Common.php</div>
<div class="index-item-description">Connection resource</div>
</dd>
<dt class="field">
<span class="var-title">$css_class</span>
@ -243,14 +257,40 @@
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="include-title">Common.php</span>
</dt>
<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="method-title">clearLevel</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>
</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.html#methodclose">Database::close()</a> in Database.php</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodclose">Database_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_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">
@ -260,13 +300,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommit">Model::commit()</a> in Model.php</div>
<div class="index-item-description">Commit</div>
</dd>
<dt class="field">
<span class="method-title">commitRecord</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a> in Model.php</div>
<div class="index-item-description">Commit Record</div>
</dd>
<dt class="field">
Config
</dt>
@ -281,6 +314,13 @@
<div class="index-item-details"><a href="PICKLES/Controller.html">Controller</a> in Controller.php</div>
<div class="index-item-description">Controller Class</div>
</dd>
<dt class="field">
<span class="method-title">count</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#methodcount">Model::count()</a> in Model.php</div>
<div class="index-item-description">Count Records</div>
</dd>
</dl>
<a name="d"></a>
<div class="index-letter-section">
@ -290,25 +330,32 @@
</div>
<dl>
<dt class="field">
<span class="var-title">$data</span>
<span class="var-title">$database</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$data">Model::$data</a> in Model.php</div>
<div class="index-item-description">Data</div>
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$database">Database_Common::$database</a> in Common.php</div>
<div class="index-item-description">Database name for the server</div>
</dd>
<dt class="field">
<span class="var-title">$db</span>
<span class="var-title">$datasource</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$db">Model::$db</a> in Model.php</div>
<div class="index-item-description">Database</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$datasource">Model::$datasource</a> in Model.php</div>
<div class="index-item-description">Datasource</div>
</dd>
<dt class="field">
<span class="var-title">$db</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$db">Module::$db</a> in Module.php</div>
<div class="index-item-description">Database</div>
<div class="index-item-description">Database object</div>
</dd>
<dt class="field">
<span class="var-title">$delayed</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$delayed">Model::$delayed</a> in Model.php</div>
<div class="index-item-description">Delayed Insert</div>
</dd>
<dt class="field">
<span class="var-title">$description</span>
@ -317,6 +364,62 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$description">Module::$description</a> in Module.php</div>
<div class="index-item-description">Meta description</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_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">
<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_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a> in SQLite.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_PDO_MySQL.html#var$driver">Database_PDO_MySQL::$driver</a> in MySQL.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_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_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">
<span class="var-title">$dsn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_SQLite.html#var$dsn">Database_PDO_SQLite::$dsn</a> in SQLite.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">
<span class="include-title">Database.php</span>
</dt>
@ -328,7 +431,42 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html">Database</a> in Database.php</div>
<div class="index-item-description">Database Abstraction Layer for MySQL</div>
<div class="index-item-description">Database Factory</div>
</dd>
<dt class="field">
Database_Common
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html">Database_Common</a> in Common.php</div>
<div class="index-item-description">Common Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_Common
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a> in Common.php</div>
<div class="index-item-description">PDO Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_MySQL
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a> in MySQL.php</div>
<div class="index-item-description">MySQL Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_PostgreSQL
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a> in PostgreSQL.php</div>
<div class="index-item-description">PostgreSQL Database Abstraction Layer</div>
</dd>
<dt class="field">
Database_PDO_SQLite
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a> in SQLite.php</div>
<div class="index-item-description">SQLite Database Abstraction Layer</div>
</dd>
<dt class="field">
<span class="method-title">dateSelect</span>
@ -351,12 +489,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>
@ -365,10 +497,10 @@
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
<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_PHP">DISPLAY_PHP</a> in pickles.php</div>
<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_PHP
@ -378,11 +510,10 @@
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
Display_RSS
<span class="const-title">DISPLAY_PHP</span>
</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>
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_PHP">DISPLAY_PHP</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
@ -390,6 +521,13 @@
<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">
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_XML</span>
</dt>
@ -463,7 +601,7 @@
<span class="method-title">execute</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodexecute">Database::execute()</a> in Database.php</div>
<div class="index-item-details"><a href="PICKLES/Database_PDO_Common.html#methodexecute">Database_PDO_Common::execute()</a> in Common.php</div>
<div class="index-item-description">Executes an SQL Statement</div>
</dd>
</dl>
@ -474,6 +612,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$fields</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$fields">Model::$fields</a> in Model.php</div>
<div class="index-item-description">Field List</div>
</dd>
<dt class="field">
<span class="include-title">Form.php</span>
</dt>
@ -491,21 +636,21 @@
<span class="method-title">fetch</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetch">Database::fetch()</a> in Database.php</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 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.html#methodfetchAll">Database::fetchAll()</a> in Database.php</div>
<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">fetchColumn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
<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>
</dd>
<dt class="field">
@ -530,12 +675,33 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$group</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$group">Model::$group</a> in Model.php</div>
<div class="index-item-description">Group</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/Object.html#methodgetInstance">Object::getInstance()</a> in Object.php</div>
<div class="index-item-description">Get Instance</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>
<dt class="field">
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodgetInstance">Database::getInstance()</a> in Database.php</div>
<div class="index-item-description">Get instance of the object</div>
<div class="index-item-description">Get instance</div>
</dd>
<dt class="field">
<span class="method-title">getInstance</span>
@ -552,6 +718,27 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$having</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$having">Model::$having</a> in Model.php</div>
<div class="index-item-description">Having</div>
</dd>
<dt class="field">
<span class="var-title">$hostname</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a> in Common.php</div>
<div class="index-item-description">Hostname for the server</div>
</dd>
<dt class="field">
<span class="method-title">hasLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodhasLevel">Security::hasLevel()</a> in Security.php</div>
<div class="index-item-description">Has Level</div>
</dd>
<dt class="field">
<span class="method-title">hiddenInput</span>
</dt>
@ -567,6 +754,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$instances</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Object.html#var$instances">Object::$instances</a> in Object.php</div>
<div class="index-item-description">Object Instances</div>
</dd>
<dt class="field">
<span class="method-title">information</span>
</dt>
@ -581,6 +775,13 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodinput">Form::input()</a> in Form.php</div>
<div class="index-item-description">Input</div>
</dd>
<dt class="field">
<span class="method-title">isLevel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html#methodisLevel">Security::isLevel()</a> in Security.php</div>
<div class="index-item-description">Is Level</div>
</dd>
</dl>
<a name="j"></a>
<div class="index-letter-section">
@ -589,6 +790,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$joins</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$joins">Model::$joins</a> in Model.php</div>
<div class="index-item-description">Joins</div>
</dd>
<dt class="field">
<span class="var-title">$js_basename</span>
</dt>
@ -636,7 +844,7 @@
</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>
<div class="index-item-description">Limit</div>
</dd>
<dt class="field">
<span class="include-title">Log.php</span>
@ -693,6 +901,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$meta_data</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$meta_data">Display_Common::$meta_data</a> in Common.php</div>
<div class="index-item-description">Meta Data</div>
</dd>
<dt class="field">
<span class="var-title">$module_return</span>
</dt>
@ -700,6 +915,12 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a> in Common.php</div>
<div class="index-item-description">Module Return Data</div>
</dd>
<dt class="field">
<span class="include-title">MySQL.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---MySQL.php.html">MySQL.php</a> in MySQL.php</div>
</dd>
<dt class="field">
<span class="include-title">Model.php</span>
</dt>
@ -750,18 +971,18 @@
</div>
<dl>
<dt class="field">
<span class="var-title">$order_by</span>
<span class="var-title">$offset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html#var$order_by">Post::$order_by</a> in Post.php</div>
<div class="index-item-description">Columns to Order By</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$offset">Model::$offset</a> in Model.php</div>
<div class="index-item-description">Offset</div>
</dd>
<dt class="field">
<span class="var-title">$order_by</span>
<span class="var-title">$order</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$order_by">Model::$order_by</a> in Model.php</div>
<div class="index-item-description">Order By Clause</div>
<div class="index-item-details"><a href="PICKLES/Model.html#var$order">Model::$order</a> in Model.php</div>
<div class="index-item-description">Order</div>
</dd>
<dt class="field">
<span class="include-title">Object.php</span>
@ -780,7 +1001,14 @@
<span class="method-title">open</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#methodopen">Database::open()</a> in Database.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_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">
@ -805,6 +1033,40 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$parent_template">Display_Common::$parent_template</a> in Common.php</div>
<div class="index-item-description">Parent Template</div>
</dd>
<dt class="field">
<span class="var-title">$password</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$password">Database_Common::$password</a> in Common.php</div>
<div class="index-item-description">Password for the server</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_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>
</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>
</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_MySQL.html#var$port">Database_PDO_MySQL::$port</a> in MySQL.php</div>
<div class="index-item-description">Default port</div>
</dd>
<dt class="field">
<span class="include-title">PostgreSQL.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---PostgreSQL.php.html">PostgreSQL.php</a> in PostgreSQL.php</div>
</dd>
<dt class="field">
<span class="include-title">PHP.php</span>
</dt>
@ -862,13 +1124,6 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodpolarSelect">Form::polarSelect()</a> in Form.php</div>
<div class="index-item-description">Polar Select</div>
</dd>
<dt class="field">
Post
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html">Post</a> in Post.php</div>
<div class="index-item-description">Post Model</div>
</dd>
<dt class="field">
<span class="method-title">prepareVariables</span>
</dt>
@ -895,12 +1150,6 @@
<div class="index-item-details"><a href="PICKLES/Profiler.html">Profiler</a> in Profiler.php</div>
<div class="index-item-description">Profiler Class</div>
</dd>
<dt class="field">
<span class="include-title">Post.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_sample-site---models---Post.php.html">Post.php</a> in Post.php</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
@ -929,14 +1178,14 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$record">Model::$record</a> in Model.php</div>
<div class="index-item-description">Record Array</div>
<div class="index-item-description">Record</div>
</dd>
<dt class="field">
<span class="var-title">$records</span>
</dt>
<dd class="index-item-body">
<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>
<div class="index-item-description">Records</div>
</dd>
<dt class="field">
<span class="var-title">$request</span>
@ -946,11 +1195,18 @@
<div class="index-item-description">Request Data</div>
</dd>
<dt class="field">
<span class="var-title">$reserved</span>
<span class="var-title">$results</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$reserved">Model::$reserved</a> in Model.php</div>
<div class="index-item-description">Reserved Variables</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="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>
</dd>
<dt class="field">
<span class="include-title">RSS.php</span>
@ -969,8 +1225,8 @@
<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>
<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>
@ -990,8 +1246,8 @@
<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_XML.html#methodrender">Display_XML::render()</a> in XML.php</div>
<div class="index-item-description">Renders the data in XML format</div>
</dd>
<dt class="field">
<span class="method-title">report</span>
@ -1016,11 +1272,11 @@
<div class="index-item-description">Secure</div>
</dd>
<dt class="field">
<span class="var-title">$select</span>
<span class="var-title">$security</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$select">Model::$select</a> in Model.php</div>
<div class="index-item-description">Select [Column] List</div>
<div class="index-item-details"><a href="PICKLES/Module.html#var$security">Module::$security</a> in Module.php</div>
<div class="index-item-description">Security settings of the page</div>
</dd>
<dt class="field">
<span class="var-title">$session</span>
@ -1029,6 +1285,32 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$session">Module::$session</a> in Module.php</div>
<div class="index-item-description">Session</div>
</dd>
<dt class="field">
<span class="var-title">$socket</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a> in Common.php</div>
<div class="index-item-description">UNIX socket for the server</div>
</dd>
<dt class="field">
<span class="include-title">SQLite.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Database---PDO---SQLite.php.html">SQLite.php</a> in SQLite.php</div>
</dd>
<dt class="field">
<span class="include-title">Security.php</span>
</dt>
<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">
Security
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Security.html">Security</a> in Security.php</div>
<div class="index-item-description">Security Class</div>
</dd>
<dt class="field">
<span class="method-title">select</span>
</dt>
@ -1036,6 +1318,34 @@
<div class="index-item-details"><a href="PICKLES/Form.html#methodselect">Form::select()</a> in Form.php</div>
<div class="index-item-description">Select</div>
</dd>
<dt class="field">
<span class="method-title">setDatabase</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a> in Common.php</div>
<div class="index-item-description">Set Database</div>
</dd>
<dt class="field">
<span class="method-title">setHostname</span>
</dt>
<dd class="index-item-body">
<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>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetMetaData">Display_Common::setMetaData()</a> in Common.php</div>
<div class="index-item-description">Set Meta Data</div>
</dd>
<dt class="field">
<span class="method-title">setModuleReturn</span>
</dt>
@ -1043,6 +1353,20 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetModuleReturn">Display_Common::setModuleReturn()</a> in Common.php</div>
<div class="index-item-description">Set Module Return</div>
</dd>
<dt class="field">
<span class="method-title">setPassword</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a> in Common.php</div>
<div class="index-item-description">Set Password</div>
</dd>
<dt class="field">
<span class="method-title">setPort</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a> in Common.php</div>
<div class="index-item-description">Set Port</div>
</dd>
<dt class="field">
<span class="method-title">setRequest</span>
</dt>
@ -1050,6 +1374,13 @@
<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="method-title">setSocket</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a> in Common.php</div>
<div class="index-item-description">Set Socket</div>
</dd>
<dt class="field">
<span class="method-title">setTemplateVariables</span>
</dt>
@ -1057,6 +1388,13 @@
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodsetTemplateVariables">Display_Common::setTemplateVariables()</a> in Common.php</div>
<div class="index-item-description">Set Template Variables</div>
</dd>
<dt class="field">
<span class="method-title">setUsername</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</a> in Common.php</div>
<div class="index-item-description">Set Username</div>
</dd>
<dt class="field">
<span class="const-title">SITE_CLASS_PATH</span>
</dt>
@ -1118,13 +1456,6 @@
<dt class="field">
<span class="var-title">$table</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Post.html#var$table">Post::$table</a> in Post.php</div>
<div class="index-item-description">Table Name</div>
</dd>
<dt class="field">
<span class="var-title">$table</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Model.html#var$table">Model::$table</a> in Model.php</div>
<div class="index-item-description">Table Name</div>
@ -1179,6 +1510,13 @@
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$username</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database_Common.html#var$username">Database_Common::$username</a> in Common.php</div>
<div class="index-item-description">Username for the server</div>
</dd>
<dt class="field">
<span class="method-title">unescape</span>
</dt>

81
docs/errors.html
View file

@ -36,7 +36,6 @@
<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="#Environment.php">Environment.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>
@ -50,7 +49,6 @@
<a href="#image.php">image.php</a><br>
<a href="#image_req.php">image_req.php</a><br>
<a href="#index.php">index.php</a><br>
<a href="#index.phtml">index.phtml</a><br>
<a href="#interfaces_test.php">interfaces_test.php</a><br>
<a href="#JSON.php">JSON.php</a><br>
<a href="#live_test.php">live_test.php</a><br>
@ -59,6 +57,7 @@
<a href="#mock_objects_test.php">mock_objects_test.php</a><br>
<a href="#Model.php">Model.php</a><br>
<a href="#Module.php">Module.php</a><br>
<a href="#MySQL.php">MySQL.php</a><br>
<a href="#newsession.php">newsession.php</a><br>
<a href="#Object.php">Object.php</a><br>
<a href="#page_test.php">page_test.php</a><br>
@ -66,9 +65,7 @@
<a href="#parse_error_test.php">parse_error_test.php</a><br>
<a href="#PHP.php">PHP.php</a><br>
<a href="#pickles.php">pickles.php</a><br>
<a href="#Post.php">Post.php</a><br>
<a href="#posts.php">posts.php</a><br>
<a href="#posts.phtml">posts.phtml</a><br>
<a href="#PostgreSQL.php">PostgreSQL.php</a><br>
<a href="#process.php">process.php</a><br>
<a href="#Profiler.php">Profiler.php</a><br>
<a href="#rand.php">rand.php</a><br>
@ -80,11 +77,13 @@
<a href="#RSS.php">RSS.php</a><br>
<a href="#sample_posteddata.php">sample_posteddata.php</a><br>
<a href="#search.php">search.php</a><br>
<a href="#Security.php">Security.php</a><br>
<a href="#shell_test.php">shell_test.php</a><br>
<a href="#shell_tester_test.php">shell_tester_test.php</a><br>
<a href="#simpletest_test.php">simpletest_test.php</a><br>
<a href="#socket_test.php">socket_test.php</a><br>
<a href="#spl_examples.php">spl_examples.php</a><br>
<a href="#SQLite.php">SQLite.php</a><br>
<a href="#standalone.php">standalone.php</a><br>
<a href="#tag_test.php">tag_test.php</a><br>
<a href="#test.php">test.php</a><br>
@ -174,18 +173,18 @@
<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 "@code" used<br>
<b>Warning on line 39</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 51</b> - Unknown tag "@code" used<br>
<b>Warning on line 51</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 70</b> - Unknown tag "@code" used<br>
<b>Warning on line 70</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 134</b> - Unknown tag "@code" 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 "@code" 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 176</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 176</b> - Unknown tag "@code" used<br>
@ -201,29 +200,29 @@
<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 49</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 68</b> - Unknown tag "@code" used<br>
<b>Warning on line 49</b> - Unknown tag "@code" used<br>
<b>Warning on line 68</b> - Unknown tag "@endcode" 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 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 "@endcode" used<br>
<b>Warning on line 172</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 172</b> - Unknown tag "@code" used<br>
<b>Warning on line 215</b> - Unknown tag "@endcode" 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 270</b> - Unknown tag "@endcode" used<br>
<b>Warning on line 270</b> - Unknown tag "@code" 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 310</b> - Unknown tag "@code" used<br>
<b>Warning on line 582</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.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>
@ -240,6 +239,8 @@
<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 Database_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<a name="compatibility_test.php"></a>
<h1>compatibility_test.php</h1>
@ -251,7 +252,7 @@
<a name="Config.php"></a>
<h1>Config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Config<br>
<b>Warning on line 30</b> - no @package tag was used in a DocBlock for class Config<br>
<a name="content3-slow.php"></a>
<h1>content3-slow.php</h1>
<h2>Warnings:</h2><br>
@ -273,7 +274,7 @@
<a name="Database.php"></a>
<h1>Database.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 26</b> - no @package tag was used in a DocBlock for class Database<br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Database<br>
<a name="detached_test.php"></a>
<h1>detached_test.php</h1>
<h2>Warnings:</h2><br>
@ -305,10 +306,6 @@
<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="Environment.php"></a>
<h1>Environment.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 4</b> - File "/home/josh/Source/pickles/classes/Environment.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>
@ -401,12 +398,7 @@
<a name="index.php"></a>
<h1>index.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 7</b> - File "/home/josh/Source/pickles/sample-site/public/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 65</b> - File "/home/josh/Source/pickles/vendors/jquery-validate-1.7/demo/captcha/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="index.phtml"></a>
<h1>index.phtml</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 13</b> - File "/home/josh/Source/pickles/sample-site/templates/index.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="interfaces_test.php"></a>
<h1>interfaces_test.php</h1>
<h2>Warnings:</h2><br>
@ -472,6 +464,12 @@
<h1>Module.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Module<br>
<a name="MySQL.php"></a>
<h1>MySQL.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for class Database_PDO_MySQL<br>
<h2>Errors:</h2><br>
<b>Error on line 44</b> - @access was passed neither "public" nor "private." Was passed: "proceted"<br>
<a name="newsession.php"></a>
<h1>newsession.php</h1>
<h2>Warnings:</h2><br>
@ -479,7 +477,7 @@
<a name="Object.php"></a>
<h1>Object.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Object<br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Object<br>
<a name="page_test.php"></a>
<h1>page_test.php</h1>
<h2>Warnings:</h2><br>
@ -515,20 +513,13 @@
<a name="pickles.php"></a>
<h1>pickles.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - Page-level DocBlock precedes "define PICKLES_START_TIME", use another DocBlock to document the source element<br>
<a name="Post.php"></a>
<h1>Post.php</h1>
<b>Warning on line 26</b> - Page-level DocBlock precedes "define PICKLES_START_TIME", use another DocBlock to document the source element<br>
<a name="PostgreSQL.php"></a>
<h1>PostgreSQL.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 17</b> - DocBlock would be page-level, but precedes class "Post", use another DocBlock to document the file<br>
<a name="posts.php"></a>
<h1>posts.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class posts<br>
<b>Warning on line 12</b> - File "/home/josh/Source/pickles/sample-site/modules/posts.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="posts.phtml"></a>
<h1>posts.phtml</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 22</b> - File "/home/josh/Source/pickles/sample-site/templates/posts.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for class Database_PDO_PostgreSQL<br>
<h2>Errors:</h2><br>
<b>Error on line 44</b> - @access was passed neither "public" nor "private." Was passed: "proceted"<br>
<a name="process.php"></a>
<h1>process.php</h1>
<h2>Warnings:</h2><br>
@ -536,7 +527,7 @@
<a name="Profiler.php"></a>
<h1>Profiler.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 32</b> - no @package tag was used in a DocBlock for class Profiler<br>
<b>Warning on line 34</b> - no @package tag was used in a DocBlock for class Profiler<br>
<a name="rand.php"></a>
<h1>rand.php</h1>
<h2>Warnings:</h2><br>
@ -596,6 +587,10 @@
<h1>search.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 639</b> - File "/home/josh/Source/pickles/vendors/jquery-ui-1.8.4/development-bundle/demos/autocomplete/search.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Security.php"></a>
<h1>Security.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Security<br>
<a name="shell_test.php"></a>
<h1>shell_test.php</h1>
<h2>Warnings:</h2><br>
@ -627,6 +622,10 @@
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class IteratorImplementation<br>
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class IteratorAggregateImplementation<br>
<b>Warning on line 14</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/support/spl_examples.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="SQLite.php"></a>
<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="standalone.php"></a>
<h1>standalone.php</h1>
<h2>Warnings:</h2><br>
@ -741,7 +740,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 Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 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 Fri, 01 Oct 2010 23:27:50 -0400 -->
<!-- Generated by phpDocumentor on Thu, 14 Oct 2010 20:15: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>

15
docs/li_PICKLES.html
View file

@ -26,6 +26,11 @@
<dd><a href='PICKLES/Config.html' target='right'>Config</a></dd>
<dd><a href='PICKLES/Controller.html' target='right'>Controller</a></dd>
<dd><a href='PICKLES/Database.html' target='right'>Database</a></dd>
<dd><a href='PICKLES/Database_Common.html' target='right'>Database_Common</a></dd>
<dd><a href='PICKLES/Database_PDO_Common.html' target='right'>Database_PDO_Common</a></dd>
<dd><a href='PICKLES/Database_PDO_MySQL.html' target='right'>Database_PDO_MySQL</a></dd>
<dd><a href='PICKLES/Database_PDO_PostgreSQL.html' target='right'>Database_PDO_PostgreSQL</a></dd>
<dd><a href='PICKLES/Database_PDO_SQLite.html' target='right'>Database_PDO_SQLite</a></dd>
<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>
@ -37,13 +42,16 @@
<dd><a href='PICKLES/Model.html' target='right'>Model</a></dd>
<dd><a href='PICKLES/Module.html' target='right'>Module</a></dd>
<dd><a href='PICKLES/Object.html' target='right'>Object</a></dd>
<dd><a href='PICKLES/Post.html' target='right'>Post</a></dd>
<dd><a href='PICKLES/Profiler.html' target='right'>Profiler</a></dd>
<dd><a href='PICKLES/Security.html' target='right'>Security</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---PDO---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---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>
@ -53,12 +61,15 @@
<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>
<dd><a href='PICKLES/_classes---Module.php.html' target='right'>Module.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---MySQL.php.html' target='right'>MySQL.php</a></dd>
<dd><a href='PICKLES/_classes---Object.php.html' target='right'>Object.php</a></dd>
<dd><a href='PICKLES/_classes---Display---PHP.php.html' target='right'>PHP.php</a></dd>
<dd><a href='PICKLES/_pickles.php.html' target='right'>pickles.php</a></dd>
<dd><a href='PICKLES/_sample-site---models---Post.php.html' target='right'>Post.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---Display---XML.php.html' target='right'>XML.php</a></dd>

2
docs/packages.html
View file

@ -18,8 +18,6 @@
<a href="ric_README.html" target="right">README</a>
| <a href="ric_COPYING.html" target="right">COPYING</a>
| <a href="ric_INSTALL.html" target="right">INSTALL</a>
</td>

693
docs/ric_COPYING.html
View file

@ -1,693 +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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<h1 align="center">COPYING</h1>
<pre>
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. &lt;http://fsf.org/&gt;
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
&quot;This License&quot; refers to version 3 of the GNU General Public License.
&quot;Copyright&quot; also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
&quot;The Program&quot; refers to any copyrightable work licensed under this
License. Each licensee is addressed as &quot;you&quot;. &quot;Licensees&quot; and
&quot;recipients&quot; may be individuals or organizations.
To &quot;modify&quot; a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a &quot;modified version&quot; of the
earlier work or a work &quot;based on&quot; the earlier work.
A &quot;covered work&quot; means either the unmodified Program or a work based
on the Program.
To &quot;propagate&quot; a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To &quot;convey&quot; a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays &quot;Appropriate Legal Notices&quot;
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The &quot;source code&quot; for a work means the preferred form of the work
for making modifications to it. &quot;Object code&quot; means any non-source
form of a work.
A &quot;Standard Interface&quot; means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The &quot;System Libraries&quot; of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
&quot;Major Component&quot;, in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The &quot;Corresponding Source&quot; for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
&quot;keep intact all notices&quot;.
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
&quot;aggregate&quot; if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A &quot;User Product&quot; is either (1) a &quot;consumer product&quot;, which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, &quot;normally used&quot; refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
&quot;Installation Information&quot; for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
&quot;Additional permissions&quot; are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered &quot;further
restrictions&quot; within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An &quot;entity transaction&quot; is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A &quot;contributor&quot; is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's &quot;contributor version&quot;.
A contributor's &quot;essential patent claims&quot; are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, &quot;control&quot; includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a &quot;patent license&quot; is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To &quot;grant&quot; such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. &quot;Knowingly relying&quot; means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is &quot;discriminatory&quot; if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License &quot;or any later version&quot; applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM &quot;AS IS&quot; WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the &quot;copyright&quot; line and a pointer to where the full notice is found.
&lt;one line to give the program's name and a brief idea of what it does.&gt;
Copyright (C) &lt;year&gt; &lt;name of author&gt;
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
&lt;program&gt; Copyright (C) &lt;year&gt; &lt;name of author&gt;
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an &quot;about box&quot;.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a &quot;copyright disclaimer&quot; for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
&lt;http://www.gnu.org/licenses/&gt;.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
&lt;http://www.gnu.org/philosophy/why-not-lgpl.html&gt;.
</pre>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

2
docs/ric_INSTALL.html
View file

@ -39,7 +39,7 @@ Installation Guide
</pre>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

2
docs/ric_README.html
View file

@ -92,7 +92,7 @@ Get the facts!
</pre>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

11
docs/todolist.html
View file

@ -17,15 +17,12 @@
<h3><a href="PICKLES/Module.html#var$request">Module::$request</a></h3>
<ul>
<li>Currently the super globals are not being cleared out</li>
<li>Not even sure I want to implement this at this point</li>
</ul>
<h3><a href="PICKLES/Module.html#var$secure">Module::$secure</a></h3>
<ul>
<li>Implement this functionality</li>
</ul>
<h3><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a></h3>
<ul>
<li>This will replace commit() eventually will add commitAll();</li>
</ul>
<h3><a href="PICKLES/Form.html#methoddateSelect">Form::dateSelect()</a></h3>
<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>
@ -34,16 +31,12 @@
<ul>
<li>This display type is totally jacked, no lie.</li>
</ul>
<h3><a href="PICKLES/Form.html#methodoptions">Form::options()</a></h3>
<ul>
<li>Add support for optgroup</li>
</ul>
<h3><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a></h3>
<ul>
<li>Error handling is non-existant.</li>
</ul>
<p class="notes" id="credit">
Documentation generated on Fri, 01 Oct 2010 23:27:52 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Thu, 14 Oct 2010 20:15:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>