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

Implementing the Database class.

Browse source 
* Updated the Database class to work like a Singleton with a getInstance() method.

 * The Database class does not have a private constructor so it can still be instantiated in case someone needs to do so.

 * Replaced Logger class with Log class.

 * Updated Module to have an instance of the Database object as well as the Model class.

 * In my perfect vision for usage, the Module classes should never talk directly to the database, but do so via Models, but I know that's asking a lot, so I'm leaving in some options for folks.

 * Updated documentation.
This commit is contained in:
Josh Sherman 2010-03-16 22:54:21 -04:00
parent 8c1ecea92b
commit cda9c7d28e
43 changed files with 1672 additions and 789 deletions
Download patch file Download diff file Expand all files Collapse all files

34
classes/Database.php
View file

@ -25,6 +25,19 @@
*/
class Database extends Object
{
/**
* Instance of the Database object
*
* Within the PICKLES system, the database instance is shared, but the
* Database constructor is not private, just in case someone wants to
* create new Database objects.
*
* @static
* @access private
* @var object
*/
private static $instance;
/**
* Hostname for the MySQL Server
*
@ -114,6 +127,25 @@ class Database extends Object
}
}
/**
* Get instance of the object
*
* Instantiates a new object if one isn't already available, then
* returns the instance.
*
* @static
* @return object self::$instance instance of the Database
*/
public static function getInstance()
{
if (!isset(self::$instance) || empty(self::$instance))
{
self::$instance = new Database();
}
return self::$instance;
}
/**
* Opens database connection
*
@ -180,7 +212,7 @@ class Database extends Object
public function execute($sql, $input_parameters = null)
{
$this->open();
Log::query($sql);
// Checks if the query is blank

155
classes/Log.php Normal file
View file

@ -0,0 +1,155 @@
<?php
/**
* Logging System for PICKLES
*
* PHP version 5
*
* Licensed under the GNU General Public License Version 3
* Redistribution of these files must retain the above copyright notice.
*
* @package PICKLES
* @author Josh Sherman <josh@phpwithpickles.org>
* @copyright Copyright 2007-2010, Gravity Boulevard, LLC
* @license http://www.gnu.org/licenses/gpl.html GPL v3
* @link http://phpwithpickles.org
*/
/**
* Log Class
*
* Standardized logging methods for ease of reporting.
*/
class Log extends Object
{
/**
* Log Information
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function information($message)
{
return self::write('information', $message);
}
/**
* Log Warning
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function warning($message)
{
return self::write('warning', $message);
}
/**
* Log Error
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function error($message)
{
return self::write('error', $message);
}
/**
* Log Slow Query
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function slowQuery($message)
{
return self::write('slow_query', $message);
}
/**
* Log Credit Card Transaction
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function transaction($message)
{
return self::write('transaction', $message);
}
/**
* Log PHP Error
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function phpError($message, $time = false)
{
return self::write('php_error', $message, false, $time);
}
/**
* Log SQL Query
*
* @static
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
public static function query($message)
{
return self::write('query', $message);
}
/**
* Write Message to Log File
*
* @static
* @access private
* @param string $message message to log
* @return boolean whether or not the write was successful
*/
private static function write($log_type, $message, $format = true, $time = false)
{
$config = Config::getInstance();
$log_path = $config->log_path . date('/Y/m/d/', ($time == false ? time() : $time));
if (!file_exists($log_path))
{
mkdir($log_path, 0777, true);
}
$log_file = $log_path . $log_type . '.log';
// @todo May want to go back to this old format, not sure yet
/*
$message = '[' . date('r') . '] '
. (trim($_SERVER['REMOTE_ADDR']) != '' ? '[client ' . $_SERVER['REMOTE_ADDR'] . '] ' : null)
. (trim($_SERVER['REQUEST_URI']) != '' ? '[uri ' . $_SERVER['REQUEST_URI'] . '] ' : null)
. '[script ' . $_SERVER['SCRIPT_NAME'] . '] ' . $message;
*/
$message .= "\n";
if ($format == true)
{
$backtrace = debug_backtrace();
rsort($backtrace);
$frame = $backtrace[strpos($backtrace[0]['file'], 'index.php') === false ? 0 : 1];
return file_put_contents($log_file, date('H:i:s') . ' ' . str_replace(getcwd(), '', $frame['file']) . ':' . $frame['line'] . ' ' . $message, FILE_APPEND);
}
else
{
return file_put_contents($log_file, $message, FILE_APPEND);
}
}
}
?>

35
classes/Logger.php
View file

@ -1,35 +0,0 @@
<?php
/**
* Logger Class File for PICKLES
*
* PHP version 5
*
* Licensed under the GNU General Public License Version 3
* Redistribution of these files must retain the above copyright notice.
*
* @package PICKLES
* @author Josh Sherman <josh@phpwithpickles.org>
* @copyright Copyright 2007-2010, Gravity Boulevard, LLC
* @license http://www.gnu.org/licenses/gpl.html GPL v3
* @link http://phpwithpickles.org
*/
/**
* Logger Class
*/
class Logger extends Object {
public static function write($type, $message, $class = null) {
if (!file_exists(LOG_PATH)) { mkdir(LOG_PATH, 0777, true); }
$message = '[' . date('r') . '] '
. (trim($_SERVER['REMOTE_ADDR']) != '' ? '[client ' . $_SERVER['REMOTE_ADDR'] . '] ' : null)
. (trim($_SERVER['REQUEST_URI']) != '' ? '[uri ' . $_SERVER['REQUEST_URI'] . '] ' : null)
. '[script ' . $_SERVER['SCRIPT_NAME'] . '] ' . $message;
file_put_contents(LOG_PATH . $type . '.log', $message . "\n", FILE_APPEND);
}
}
?>

2
classes/Model.php
View file

@ -102,7 +102,7 @@ class Model extends Object
{
parent::__construct();
$this->db = new Database();
$this->db = Database::getInstance();
if (isset($data))
{

10
classes/Module.php
View file

@ -28,6 +28,14 @@
*/
class Module extends Object
{
/**
* Database
*
* @access protected
* @var object
*/
protected $db = null;
/**
* Page title
*
@ -132,6 +140,8 @@ class Module extends Object
{
parent::__construct();
$this->db = Database::getInstance();
if ($autorun === true)
{
$this->__default();

130
docs/PICKLES/Config.html
View file

@ -22,13 +22,13 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Config Class</p>
<p class="description"><p>Handles loading a configuration file and parsing the data for any public nodes that need to be made available to the viewer.</p></p>
<p class="description"><p>Handles loading the site's configuration file (if available).</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">;&nbsp;</span><span class="src-comm">//&nbsp;$filename&nbsp;is&nbsp;optional,&nbsp;default&nbsp;=&nbsp;../config.xml</span></div></li>
<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">27</span>)
Located in <a class="field" href="_classes---Config.php.html">/classes/Config.php</a> (line <span class="field">25</span>)
</p>
@ -49,31 +49,31 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<div class="method-definition">
static <span class="method-result">object self::$instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
()
</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">$file</span> = <span class="var-default">'../config.xml'</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#disabled" title="details" class="method-name">disabled</a>
()
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.ini'</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#load" title="details" class="method-name">load</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#module" title="details" class="method-name">module</a>
()
<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">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</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>
</div>
</div>
@ -94,7 +94,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">109</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">86</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -122,7 +122,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">45</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">51</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -137,48 +137,22 @@
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">'../config.xml'</span>])
([<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'../config.ini'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span><span class="var-description">: Filename of the config file (optional)</span> </li>
<span class="var-name">$filename</span><span class="var-description">: optional Filename of the config</span> </li>
</ul>
</div>
<a name="methoddisabled" id="disabled"><!-- --></a>
<a name="methodload" id="load"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">disabled</span> (line <span class="line-number">126</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets status of site</p>
<p class="description"><p>Checks the site-&gt;disabled variable for truth.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the site is disabled</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
disabled
</span>
()
</div>
</div>
<a name="methodload" id="load"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">load</span> (line <span class="line-number">60</span>)
<span class="method-title">load</span> (line <span class="line-number">66</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -195,39 +169,79 @@
<span class="method-name">
load
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span><span class="var-description">: Filename of the XML file to be loaded</span> </li>
<span class="var-name">$filename</span><span class="var-description">: filename of the config file</span> </li>
</ul>
</div>
<a name="methodmodule" id="module"><!-- --></a>
<div class="oddrow">
<a name="method__get" id="__get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">module</span> (line <span class="line-number">136</span>)
<span class="method-title">__get</span> (line <span class="line-number">120</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets default module</p>
<p class="short-description">Magic Getter Method</p>
<p class="description"><p>Attempts to load the config variable. If it's not set, will override the variable with boolean false.</p></p>
<ul class="tags">
<li><span class="field">return:</span> default module or null</li>
<li><span class="field">return:</span> value of the variable or boolean false</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-result">mixed</span>
<span class="method-name">
module
__get
</span>
()
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</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 variable requested</span> </li>
</ul>
</div>
<a name="method__set" id="__set"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">105</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-name">
__set
</span>
(<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>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name of the variable to be set</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: value of the variable to be set</span> </li>
</ul>
</div>
@ -237,7 +251,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

2
docs/PICKLES/Controller.html
View file

@ -146,7 +146,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

68
docs/PICKLES/Database.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 self::$instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
()
</div>
<div class="method-definition">
<span class="method-result">Database</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -82,7 +87,7 @@
<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">
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
@ -127,12 +132,39 @@
</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="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">86</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">139</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>
<ul class="tags">
<li><span class="field">return:</span> instance of the Database</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-name">
getInstance
</span>
()
</div>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">99</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -174,10 +206,10 @@
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">163</span>)
<span class="method-title">close</span> (line <span class="line-number">195</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -200,10 +232,10 @@
</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">execute</span> (line <span class="line-number">180</span>)
<span class="method-title">execute</span> (line <span class="line-number">212</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -234,10 +266,10 @@
</div>
<a name="methodfetch" id="fetch"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">234</span>)
<span class="method-title">fetch</span> (line <span class="line-number">266</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -270,10 +302,10 @@
</div>
<a name="methodfetchAll" id="fetchAll"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">fetchAll</span> (line <span class="line-number">283</span>)
<span class="method-title">fetchAll</span> (line <span class="line-number">315</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -302,10 +334,10 @@
</div>
<a name="methodfetchColumn" id="fetchColumn"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">fetchColumn</span> (line <span class="line-number">271</span>)
<span class="method-title">fetchColumn</span> (line <span class="line-number">303</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -335,10 +367,10 @@
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">125</span>)
<span class="method-title">open</span> (line <span class="line-number">157</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -373,7 +405,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

154
docs/PICKLES/Display_Common.html
View file

@ -24,12 +24,12 @@
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Common Display Class</p>
<p class="description"><p>This is the class that each viewer class should be extending from.</p></p>
<p class="description"><p>This is the parent class class that each display class should be extending and executing parent::render()</p></p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Display---Common.php.html">/classes/Display/Common.php</a> (line <span class="field">25</span>)
Located in <a class="field" href="_classes---Display---Common.php.html">/classes/Display/Common.php</a> (line <span class="field">24</span>)
</p>
@ -98,13 +98,17 @@
</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="#$extension" title="details" class="var-name">$extension</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$module_return" title="details" class="var-name">$module_return</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$template" title="details" class="var-name">$template</a>
<a href="#$templates" title="details" class="var-name">$templates</a>
</div>
</div>
</div>
@ -123,21 +127,26 @@
</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>
(<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$module_return</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#prepare" title="details" class="method-name">prepare</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#prepare" title="details" class="method-name">prepare</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$module_return</span>)
</div>
<div class="method-definition">
<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">boolean</span>
<a href="#templateExists" title="details" class="method-name">templateExists</a>
()
</div>
</div>
</div>
@ -157,14 +166,48 @@
</div>
<div class="info-box-body">
<a name="var$module_return" id="$module_return"><!-- --></A>
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$extension</span>
= <span class="var-default"> false</span> (line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template Extension</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/Display_PHP.html#var$extension">Display_PHP::$extension</a>
: Template Extension
</li>
<li>
<a href="../PICKLES/Display_Smarty.html#var$extension">Display_Smarty::$extension</a>
: Template Extension
</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">41</span>)
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
</span>
</div>
@ -179,19 +222,19 @@
</div>
<a name="var$template" id="$template"><!-- --></A>
<div class="oddrow">
<a name="var$templates" id="$templates"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$template</span>
= <span class="var-default"> null</span> (line <span class="line-number">33</span>)
<span class="var-name">$templates</span>
= <span class="var-default"> null</span> (line <span class="line-number">32</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template</p>
<p class="short-description">Templates</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -227,10 +270,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">48</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">55</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -245,17 +288,9 @@
<span class="method-name">
__construct
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$module_return</span>)
()
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$template</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$module_return</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
@ -264,23 +299,16 @@
<dd>Constructor</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a>
</li>
</ul>
</div>
<a name="methodprepare" id="prepare"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">prepare</span> (line <span class="line-number">83</span>)
<span class="method-title">prepare</span> (line <span class="line-number">103</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Preparation for display</p>
<p class="short-description">Preparation Method</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -290,31 +318,26 @@
<span class="method-name">
prepare
</span>
()
(<span class="var-type">array</span>&nbsp;<span class="var-name">$module_return</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$module_return</span><span class="var-description">: data returned by the module</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a>
</li>
<li>
<a href="../PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a>
</li>
</ul>
</div>
<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">78</span>)
<span class="method-title">render</span> (line <span class="line-number">113</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Abstract rendering function that is overloaded within the loaded viewer</p>
<p class="short-description">Rendering Method</p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
<li><span class="field">access:</span> public</li>
@ -350,6 +373,31 @@
: Render the Smarty generated pages
</li>
</ul>
</div>
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">93</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template Exists</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not we have any templates defined</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
templateExists
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
@ -364,7 +412,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

12
docs/PICKLES/Display_JSON.html
View file

@ -86,10 +86,13 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -115,7 +118,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">33</span>)
@ -140,7 +143,7 @@
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
<dd>Rendering Method</dd>
</dl>
</div>
@ -152,6 +155,7 @@
<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#methodprepare">Display_Common::prepare()</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#methodtemplateExists">Display_Common::templateExists()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -164,7 +168,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

108
docs/PICKLES/Display_PHP.html
View file

@ -16,16 +16,16 @@
<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-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">PHP Display</p>
<p class="description"><p>Displays the associated PHP templates for the Model. This is very similar to the Smarty viewer, but less overhead since it's straight PHP. The PHP viewer also utilizes a different caching system than Smarty. The general rules around the caching will be the same though.</p></p>
<p class="description"><p>Displays the associated PHP templates for the Model. This is very similar to the Smarty viewer, but less overhead since it's straight PHP. The PHP viewer also utilizes a different caching system than Smarty. The general rules around the caching will be the same though.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Display---PHP.php.html">/classes/Display/PHP.php</a> (line <span class="field">27</span>)
Located in <a class="field" href="_classes---Display---PHP.php.html">/classes/Display/PHP.php</a> (line <span class="field">26</span>)
</p>
@ -40,27 +40,41 @@
<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-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="#$extension" title="details" class="var-name">$extension</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-vars">Vars</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">void</span>
<a href="#prepare" title="details" class="method-name">prepare</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#render" title="details" class="method-name">render</a>
()
</div>
@ -81,7 +95,37 @@
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$extension</span>
= <span class="var-default"> 'phtml'</span> (line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template Extension</p>
<p class="description"><p>I know there's some controversy amoungst my peers concerning the usage of the .phtml extension for these PHP template files. If you would prefer .php or .tpl extensions, feel free to void your warranty and change it here.</p></p>
<ul class="tags">
<li><span class="field">var:</span> file extension for the template files</li>
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a></dt>
<dd>Template Extension</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
@ -89,7 +133,7 @@
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -107,47 +151,18 @@
<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-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="methodprepare" id="prepare"><!-- --></a>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">prepare</span> (line <span class="line-number">29</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
prepare
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></dt>
<dd>Preparation for display</dd>
</dl>
</div>
<a name="methodrender" id="render"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">47</span>)
<span class="method-title">render</span> (line <span class="line-number">44</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -169,7 +184,7 @@
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
<dd>Rendering Method</dd>
</dl>
</div>
@ -181,6 +196,7 @@
<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#methodprepare">Display_Common::prepare()</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#methodtemplateExists">Display_Common::templateExists()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -193,7 +209,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

12
docs/PICKLES/Display_RSS.html
View file

@ -85,10 +85,13 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -114,7 +117,7 @@
<A NAME='method_detail'></A>
<a name="methodrender" id="render"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">39</span>)
@ -141,7 +144,7 @@
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
<dd>Rendering Method</dd>
</dl>
</div>
@ -153,6 +156,7 @@
<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#methodprepare">Display_Common::prepare()</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#methodtemplateExists">Display_Common::templateExists()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -165,7 +169,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

172
docs/PICKLES/Display_Smarty.html
View file

@ -16,7 +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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
@ -43,36 +43,40 @@
<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-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="#$extension" title="details" class="var-name">$extension</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-vars">Vars</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">Display_Smarty</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span>&nbsp;<span class="var-name">$config</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$error</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getSmartyObject" title="details" class="method-name">getSmartyObject</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#prepare" title="details" class="method-name">prepare</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#render" title="details" class="method-name">render</a>
()
@ -94,7 +98,35 @@
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$extension</span>
= <span class="var-default"> 'tpl'</span> (line <span class="line-number">41</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Template Extension</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/Display_Common.html#var$extension">Display_Common::$extension</a></dt>
<dd>Template Extension</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
<blockquote>
@ -102,7 +134,7 @@
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -120,107 +152,18 @@
<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-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">29</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Display_Smarty</span>
<span class="method-name">
__construct
</span>
(<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span>&nbsp;<span class="var-name">$config</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$error</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span>
<span class="var-name">$config</span> </li>
<li>
<span class="var-type">Error</span>
<span class="var-name">$error</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodgetSmartyObject" id="getSmartyObject"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getSmartyObject</span> (line <span class="line-number">164</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
getSmartyObject
</span>
()
</div>
</div>
<a name="methodprepare" id="prepare"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">prepare</span> (line <span class="line-number">47</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
prepare
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></dt>
<dd>Preparation for display</dd>
</dl>
</div>
<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">82</span>)
<span class="method-title">render</span> (line <span class="line-number">46</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -242,7 +185,7 @@
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
<dd>Rendering Method</dd>
</dl>
</div>
@ -254,6 +197,7 @@
<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#methodprepare">Display_Common::prepare()</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#methodtemplateExists">Display_Common::templateExists()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
@ -266,7 +210,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

367
docs/PICKLES/Log.html Normal file
View file

@ -0,0 +1,367 @@
<?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 Log</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 Log</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Class</p>
<p class="description"><p>Standardized logging methods for ease of reporting.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Log.php.html">/classes/Log.php</a> (line <span class="field">23</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Log</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#error" title="details" class="method-name">error</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#information" title="details" class="method-name">information</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#phpError" title="details" class="method-name">phpError</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#query" title="details" class="method-name">query</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#slowQuery" title="details" class="method-name">slowQuery</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#transaction" title="details" class="method-name">transaction</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#warning" title="details" class="method-name">warning</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methoderror" id="error"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method error</span> (line <span class="line-number">56</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Error</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
error
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<a name="methodinformation" id="information"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method information</span> (line <span class="line-number">32</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Information</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
information
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<a name="methodphpError" id="phpError"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method phpError</span> (line <span class="line-number">92</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log PHP Error</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
phpError
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$time</span> </li>
</ul>
</div>
<a name="methodquery" id="query"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method query</span> (line <span class="line-number">104</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log SQL Query</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
query
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<a name="methodslowQuery" id="slowQuery"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method slowQuery</span> (line <span class="line-number">68</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Slow Query</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
slowQuery
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<a name="methodtransaction" id="transaction"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method transaction</span> (line <span class="line-number">80</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Credit Card Transaction</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
transaction
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<a name="methodwarning" id="warning"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method warning</span> (line <span class="line-number">44</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Warning</p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the write was successful</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">
warning
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

151
docs/PICKLES/Logger.html
View file

@ -1,151 +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 Logger</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 Logger</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logger Class</p>
<p class="notes">
Located in <a class="field" href="_classes---Logger.php.html">/classes/Logger.php</a> (line <span class="field">21</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Logger</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#write" title="details" class="method-name">write</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>])
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodwrite" id="write"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method write</span> (line <span class="line-number">23</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
write
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$message</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$class</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

36
docs/PICKLES/Model.html
View file

@ -162,7 +162,7 @@
</div>
<div class="info-box-body">
<a name="var$columns" id="$columns"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -185,7 +185,7 @@
</div>
<a name="var$count" id="$count"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -207,7 +207,7 @@
</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -229,7 +229,7 @@
</div>
<a name="var$db" id="$db"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -251,7 +251,7 @@
</div>
<a name="var$order_by" id="$order_by"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -274,7 +274,7 @@
</div>
<a name="var$record" id="$record"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -296,7 +296,7 @@
</div>
<a name="var$records" id="$records"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
@ -318,7 +318,7 @@
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -364,7 +364,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">101</span>)
@ -403,7 +403,7 @@
</div>
<a name="methodcommit" id="commit"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">340</span>)
@ -430,7 +430,7 @@
</div>
<a name="methodcommitRecord" id="commitRecord"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">commitRecord</span> (line <span class="line-number">233</span>)
@ -457,7 +457,7 @@
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">275</span>)
@ -483,7 +483,7 @@
</div>
<a name="methodnext" id="next"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">next</span> (line <span class="line-number">209</span>)
@ -508,7 +508,7 @@
</div>
<a name="methodprev" id="prev"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">prev</span> (line <span class="line-number">219</span>)
@ -533,7 +533,7 @@
</div>
<a name="methodunescape" id="unescape"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">384</span>)
@ -564,7 +564,7 @@
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">293</span>)
@ -595,7 +595,7 @@
</div>
<a name="method__set" id="__set"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">318</span>)
@ -640,7 +640,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

232
docs/PICKLES/Module.html
View file

@ -50,36 +50,44 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">boolean</span>
<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">array</span>
<span class="var-type">boolean</span>
<a href="#$ajax" title="details" class="var-name">$ajax</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
<div class="var-title">
<span class="var-type">string,</span>
<a href="#$description" title="details" class="var-name">$description</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<a href="#$engine" title="details" class="var-name">$engine</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<a href="#$keywords" title="details" class="var-name">$keywords</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
<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">string</span>
<span class="var-type">boolean,</span>
<a href="#$session" title="details" class="var-name">$session</a>
</div>
<div class="var-title">
<span class="var-type">string,</span>
<a href="#$template" title="details" class="var-name">$template</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<a href="#$title" title="details" class="var-name">$title</a>
</div>
</div>
@ -98,7 +106,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Module</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -108,6 +116,16 @@
<span class="method-result">void</span>
<a href="#__default" title="details" class="method-name">__default</a>
()
</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">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</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>
</div>
</div>
@ -127,21 +145,21 @@
</div>
<div class="info-box-body">
<a name="var$access" id="$access"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-type">boolean,</span>
<span class="var-name">$access</span>
= <span class="var-default"> false</span> (line <span class="line-number">59</span>)
= <span class="var-default"> null</span> (line <span class="line-number">69</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access level of the page</p>
<p class="description"><p>Defaults to false which is everybody, even anonymous</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -150,13 +168,13 @@
</div>
<a name="var$ajax" id="$ajax"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-type">boolean</span>
<span class="var-name">$ajax</span>
= <span class="var-default"> false</span> (line <span class="line-number">79</span>)
= <span class="var-default"> null</span> (line <span class="line-number">102</span>)
</span>
</div>
@ -164,7 +182,31 @@
<p class="short-description">AJAX</p>
<p class="description"><p>Whether or not the page must be loaded via AJAX and if so, what pages are allowed to access it and the request method.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> or array, null by default</li>
<li><span class="field">todo:</span> Implement this functionality</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$db" id="$db"><!-- --></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">37</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -177,16 +219,17 @@
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<span class="var-name">$description</span>
(line <span class="line-number">43</span>)
= <span class="var-default"> null</span> (line <span class="line-number">53</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Meta description</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -199,17 +242,18 @@
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<span class="var-name">$engine</span>
= <span class="var-default"> DISPLAY_PHP</span> (line <span class="line-number">88</span>)
= <span class="var-default"> null</span> (line <span class="line-number">113</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default display engine</p>
<p class="description"><p>Defaults to PHP but could be set to Smarty, JSON, XML or RSS.</p></p>
<p class="description"><p>Defaults to null but could be set to Smarty, JSON, XML or RSS. Value is overwritten by the config value if not set by the module.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -222,16 +266,17 @@
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<span class="var-name">$keywords</span>
(line <span class="line-number">50</span>)
= <span class="var-default"> null</span> (line <span class="line-number">61</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Meta keywords (comma separated)</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -244,17 +289,43 @@
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-type">boolean,</span>
<span class="var-name">$secure</span>
= <span class="var-default"> false</span> (line <span class="line-number">69</span>)
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Secure</p>
<p class="description"><p>Whether or not the page should be loaded via SSL. Not currently being used. Defaults to false, non-SSL.</p></p>
<p class="description"><p>Whether or not the page should be loaded via SSL.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">todo:</span> Implement this functionality</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$session" id="$session"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$session</span>
= <span class="var-default"> null</span> (line <span class="line-number">90</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Session</p>
<p class="description"><p>Whether or not a session should be established.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -263,21 +334,22 @@
</div>
<a name="var$template" id="$template"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<span class="var-name">$template</span>
= <span class="var-default"> 'index'</span> (line <span class="line-number">98</span>)
= <span class="var-default"> null</span> (line <span class="line-number">126</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default template</p>
<p class="description"><p>Defaults to 'index' but could be set to any valid template basename. The display engine determines what the file extension should be.</p></p>
<p class="description"><p>Defaults to null but could be set to any valid template basename. The value is overwritten by the config value if not set by the module. The display engine determines what the file extension should be.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -286,20 +358,21 @@
</div>
<a name="var$title" id="$title"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-type">string,</span>
<span class="var-name">$title</span>
(line <span class="line-number">36</span>)
= <span class="var-default"> null</span> (line <span class="line-number">45</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Page title</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
</ul>
@ -332,10 +405,10 @@
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">111</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">139</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -368,10 +441,10 @@
</div>
<a name="method__default" id="__default"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">__default</span> (line <span class="line-number">130</span>)
<span class="method-title">__default</span> (line <span class="line-number">160</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -391,6 +464,71 @@
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">189</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic Getter Method</p>
<p class="description"><p>Attempts to load the module variable. If it's not set, will attempt to load from the config.</p></p>
<ul class="tags">
<li><span class="field">return:</span> value of the variable or boolean false</li>
<li><span class="field">access:</span> public</li>
</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">$name</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 variable requested</span> </li>
</ul>
</div>
<a name="method__set" id="__set"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">174</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-name">
__set
</span>
(<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>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name of the variable to be set</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: value of the variable to be set</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
@ -405,7 +543,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

13
docs/PICKLES/Object.html
View file

@ -61,9 +61,9 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Logger.html">Logger</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Log.html">Log</a></td>
<td>
Logger Class
Log Class
</td>
</tr>
<tr>
@ -154,7 +154,7 @@
</div>
<div class="info-box-body">
<a name="var$config" id="$config"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
@ -193,7 +193,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">44</span>)
@ -224,9 +224,6 @@
: Constructor
</li>
<li>
<a href="../PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a>
</li>
<li>
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
: Constructor
</li>
@ -250,7 +247,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -26,7 +26,6 @@
<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">todo:</span> Add support for .php and .ini config files (auto scan directory?)</li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
</ul>
@ -63,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

12
docs/PICKLES/_classes---Logger.php.html → docs/PICKLES/_classes---Log.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 Logger.php</title>
<title>Docs for page Log.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/Logger.php</h2>
<h2 class="file-name">/classes/Log.php</h2>
<a name="sec-description"></a>
<div class="info-box">
@ -20,7 +20,7 @@
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logger Class File for PICKLES</p>
<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>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>&gt;</li>
@ -47,10 +47,10 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Logger.html">Logger</a>
<a href="../PICKLES/Log.html">Log</a>
</td>
<td>
Logger Class
Log Class
</td>
</tr>
</table>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

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

@ -46,13 +46,27 @@
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="defineDISPLAY_JSON"><!-- --></a>
<a name="defineCLASS_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">CLASS_PATH</span> = PICKLES_PATH.'classes/'
(line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineDISPLAY_JSON"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
(line <span class="line-number">39</span>)
(line <span class="line-number">51</span>)
</span>
</div>
@ -66,7 +80,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
(line <span class="line-number">40</span>)
(line <span class="line-number">52</span>)
</span>
</div>
@ -80,7 +94,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
(line <span class="line-number">41</span>)
(line <span class="line-number">53</span>)
</span>
</div>
@ -94,7 +108,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_SMARTY</span> = 'Smarty'
(line <span class="line-number">42</span>)
(line <span class="line-number">54</span>)
</span>
</div>
@ -108,7 +122,7 @@
<div>
<span class="const-title">
<span class="const-name">DISPLAY_XML</span> = 'XML'
(line <span class="line-number">43</span>)
(line <span class="line-number">55</span>)
</span>
</div>
@ -122,7 +136,35 @@
<div>
<span class="const-title">
<span class="const-name">LOG_PATH</span> = PRIVATE_PATH.'logs/'
(line <span class="line-number">35</span>)
(line <span class="line-number">47</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineMODEL_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">MODEL_PATH</span> = SITE_PATH.'models/'
(line <span class="line-number">42</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineMODULE_PATH"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">MODULE_PATH</span> = SITE_PATH.'modules/'
(line <span class="line-number">43</span>)
</span>
</div>
@ -136,7 +178,7 @@
<div>
<span class="const-title">
<span class="const-name">PICKLES_PATH</span> = dirname(__FILE__).'/'
(line <span class="line-number">32</span>)
(line <span class="line-number">37</span>)
</span>
</div>
@ -150,7 +192,7 @@
<div>
<span class="const-title">
<span class="const-name">PRIVATE_PATH</span> = SITE_PATH.'private/'
(line <span class="line-number">34</span>)
(line <span class="line-number">46</span>)
</span>
</div>
@ -164,7 +206,7 @@
<div>
<span class="const-title">
<span class="const-name">SITE_PATH</span> = getcwd().'/../'
(line <span class="line-number">33</span>)
(line <span class="line-number">38</span>)
</span>
</div>
@ -178,7 +220,21 @@
<div>
<span class="const-title">
<span class="const-name">SMARTY_PATH</span> = PRIVATE_PATH.'smarty/'
(line <span class="line-number">36</span>)
(line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineTEMPLATE_PATH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">TEMPLATE_PATH</span> = SITE_PATH.'templates/'
(line <span class="line-number">44</span>)
</span>
</div>
@ -200,10 +256,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">55</span>)
<span class="method-title">__autoload</span> (line <span class="line-number">67</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -233,7 +289,7 @@
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

2
docs/PICKLES/_scripts---pickle.php.html
View file

@ -37,7 +37,7 @@
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>

4
docs/classtrees_PICKLES.html
View file

@ -22,11 +22,11 @@
<li><a href="PICKLES/Object.html">Object</a><ul>
<li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Display_Common.html">Display_Common</a><ul>
<li><a href="PICKLES/Display_JSON.html">Display_JSON</a></li><li><a href="PICKLES/Display_PHP.html">Display_PHP</a></li><li><a href="PICKLES/Display_RSS.html">Display_RSS</a></li><li><a href="PICKLES/Display_Smarty.html">Display_Smarty</a></li></ul></li>
<li><a href="PICKLES/Logger.html">Logger</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
<li><a href="PICKLES/Log.html">Log</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
</ul>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

272
docs/elementindex.html
View file

@ -22,6 +22,7 @@
<a class="index-letter" href="elementindex.html#e">e</a>
<a class="index-letter" href="elementindex.html#f">f</a>
<a class="index-letter" href="elementindex.html#g">g</a>
<a class="index-letter" href="elementindex.html#i">i</a>
<a class="index-letter" href="elementindex.html#j">j</a>
<a class="index-letter" href="elementindex.html#k">k</a>
<a class="index-letter" href="elementindex.html#l">l</a>
@ -29,6 +30,7 @@
<a class="index-letter" href="elementindex.html#n">n</a>
<a class="index-letter" href="elementindex.html#o">o</a>
<a class="index-letter" href="elementindex.html#p">p</a>
<a class="index-letter" href="elementindex.html#q">q</a>
<a class="index-letter" href="elementindex.html#r">r</a>
<a class="index-letter" href="elementindex.html#s">s</a>
<a class="index-letter" href="elementindex.html#t">t</a>
@ -105,6 +107,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="const-title">CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineCLASS_PATH">CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
@ -162,6 +170,13 @@
<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>
</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>
</dd>
<dt class="field">
<span class="var-title">$description</span>
</dt>
@ -189,13 +204,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methoddelete">Model::delete()</a> in Model.php</div>
<div class="index-item-description">Delete Record</div>
</dd>
<dt class="field">
<span class="method-title">disabled</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methoddisabled">Config::disabled()</a> in Config.php</div>
<div class="index-item-description">Gets status of site</div>
</dd>
<dt class="field">
Display_Common
</dt>
@ -203,12 +211,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>
@ -216,6 +218,12 @@
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
</dt>
@ -229,6 +237,12 @@
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
</dd>
<dt class="field">
Display_RSS
</dt>
@ -237,10 +251,11 @@
<div class="index-item-description">RSS Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
Display_Smarty
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
<div class="index-item-description">Smarty Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_SMARTY</span>
@ -248,13 +263,6 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_SMARTY">DISPLAY_SMARTY</a> in pickles.php</div>
</dd>
<dt class="field">
Display_Smarty
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
<div class="index-item-description">Smarty Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
@ -276,6 +284,34 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$engine">Module::$engine</a> in Module.php</div>
<div class="index-item-description">Default display engine</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#var$extension">Display_Smarty::$extension</a> in Smarty.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="method-title">error</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methoderror">Log::error()</a> in Log.php</div>
<div class="index-item-description">Log Error</div>
</dd>
<dt class="field">
<span class="method-title">execute</span>
</dt>
@ -324,14 +360,30 @@
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<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>
</dd>
<dt class="field">
<span class="method-title">getSmartyObject</span>
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodgetSmartyObject">Display_Smarty::getSmartyObject()</a> in Smarty.php</div>
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<div class="index-item-description">Get instance of the object</div>
</dd>
</dl>
<a name="i"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">i</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">information</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodinformation">Log::information()</a> in Log.php</div>
<div class="index-item-description">Log Information</div>
</dd>
</dl>
<a name="j"></a>
@ -371,10 +423,10 @@
</div>
<dl>
<dt class="field">
<span class="include-title">Logger.php</span>
<span class="include-title">Log.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Logger.php.html">Logger.php</a> in Logger.php</div>
<div class="index-item-details"><a href="PICKLES/_classes---Log.php.html">Log.php</a> in Log.php</div>
</dd>
<dt class="field">
<span class="method-title">load</span>
@ -384,11 +436,11 @@
<div class="index-item-description">Loads a configuration file</div>
</dd>
<dt class="field">
Logger
Log
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Logger.html">Logger</a> in Logger.php</div>
<div class="index-item-description">Logger Class</div>
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
</dd>
<dt class="field">
<span class="const-title">LOG_PATH</span>
@ -430,6 +482,12 @@
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
<div class="index-item-description">Model Class</div>
</dd>
<dt class="field">
<span class="const-title">MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODEL_PATH">MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
Module
</dt>
@ -438,11 +496,10 @@
<div class="index-item-description">Module Class</div>
</dd>
<dt class="field">
<span class="method-title">module</span>
<span class="const-title">MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methodmodule">Config::module()</a> in Config.php</div>
<div class="index-item-description">Gets default module</div>
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODULE_PATH">MODULE_PATH</a> in pickles.php</div>
</dd>
</dl>
<a name="n"></a>
@ -508,6 +565,13 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---PHP.php.html">PHP.php</a> in PHP.php</div>
</dd>
<dt class="field">
<span class="method-title">phpError</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodphpError">Log::phpError()</a> in Log.php</div>
<div class="index-item-description">Log PHP Error</div>
</dd>
<dt class="field">
<span class="include-title">pickles.php</span>
</dt>
@ -525,19 +589,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a> in Common.php</div>
<div class="index-item-description">Preparation for display</div>
</dd>
<dt class="field">
<span class="method-title">prepare</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a> in PHP.php</div>
</dd>
<dt class="field">
<span class="method-title">prepare</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a> in Smarty.php</div>
<div class="index-item-description">Preparation Method</div>
</dd>
<dt class="field">
<span class="method-title">prev</span>
@ -559,6 +611,21 @@
<div class="index-item-details"><a href="PICKLES/_scripts---pickle.php.html">pickle.php</a> in pickle.php</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">q</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">query</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodquery">Log::query()</a> in Log.php</div>
<div class="index-item-description">Log SQL Query</div>
</dd>
</dl>
<a name="r"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">r</div>
@ -612,7 +679,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Abstract rendering function that is overloaded within the loaded viewer</div>
<div class="index-item-description">Rendering Method</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
@ -636,6 +703,13 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$secure">Module::$secure</a> in Module.php</div>
<div class="index-item-description">Secure</div>
</dd>
<dt class="field">
<span class="var-title">$session</span>
</dt>
<dd class="index-item-body">
<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="include-title">Smarty.php</span>
</dt>
@ -648,6 +722,13 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">slowQuery</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodslowQuery">Log::slowQuery()</a> in Log.php</div>
<div class="index-item-description">Log Slow Query</div>
</dd>
<dt class="field">
<span class="const-title">SMARTY_PATH</span>
</dt>
@ -672,17 +753,17 @@
<dt class="field">
<span class="var-title">$template</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$template">Display_Common::$template</a> in Common.php</div>
<div class="index-item-description">Template</div>
</dd>
<dt class="field">
<span class="var-title">$template</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$template">Module::$template</a> in Module.php</div>
<div class="index-item-description">Default template</div>
</dd>
<dt class="field">
<span class="var-title">$templates</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a> in Common.php</div>
<div class="index-item-description">Templates</div>
</dd>
<dt class="field">
<span class="var-title">$title</span>
</dt>
@ -690,6 +771,26 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$title">Module::$title</a> in Module.php</div>
<div class="index-item-description">Page title</div>
</dd>
<dt class="field">
<span class="method-title">templateExists</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodtemplateExists">Display_Common::templateExists()</a> in Common.php</div>
<div class="index-item-description">Template Exists</div>
</dd>
<dt class="field">
<span class="const-title">TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineTEMPLATE_PATH">TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodtransaction">Log::transaction()</a> in Log.php</div>
<div class="index-item-description">Log Credit Card Transaction</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
@ -714,10 +815,11 @@
</div>
<dl>
<dt class="field">
<span class="method-title">write</span>
<span class="method-title">warning</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Logger.html#methodwrite">Logger::write()</a> in Logger.php</div>
<div class="index-item-details"><a href="PICKLES/Log.html#methodwarning">Log::warning()</a> in Log.php</div>
<div class="index-item-description">Log Warning</div>
</dd>
</dl>
<a name="_"></a>
@ -738,20 +840,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a> in Smarty.php</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/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
<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">
@ -765,14 +854,14 @@
<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-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.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-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">
@ -786,7 +875,14 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.php</div>
<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/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -799,10 +895,38 @@
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__get">Module::__get()</a> in Module.php</div>
<div class="index-item-description">Magic Getter Method</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/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>
</dd>
<dt class="field">
<span class="method-title">__set</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>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__set">Module::__set()</a> in Module.php</div>
<div class="index-item-description">Magic Setter Method</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
@ -819,6 +943,7 @@
<a class="index-letter" href="elementindex.html#e">e</a>
<a class="index-letter" href="elementindex.html#f">f</a>
<a class="index-letter" href="elementindex.html#g">g</a>
<a class="index-letter" href="elementindex.html#i">i</a>
<a class="index-letter" href="elementindex.html#j">j</a>
<a class="index-letter" href="elementindex.html#k">k</a>
<a class="index-letter" href="elementindex.html#l">l</a>
@ -826,6 +951,7 @@
<a class="index-letter" href="elementindex.html#n">n</a>
<a class="index-letter" href="elementindex.html#o">o</a>
<a class="index-letter" href="elementindex.html#p">p</a>
<a class="index-letter" href="elementindex.html#q">q</a>
<a class="index-letter" href="elementindex.html#r">r</a>
<a class="index-letter" href="elementindex.html#s">s</a>
<a class="index-letter" href="elementindex.html#t">t</a>

272
docs/elementindex_PICKLES.html
View file

@ -19,6 +19,7 @@
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>
<a class="index-letter" href="elementindex_PICKLES.html#f">f</a>
<a class="index-letter" href="elementindex_PICKLES.html#g">g</a>
<a class="index-letter" href="elementindex_PICKLES.html#i">i</a>
<a class="index-letter" href="elementindex_PICKLES.html#j">j</a>
<a class="index-letter" href="elementindex_PICKLES.html#k">k</a>
<a class="index-letter" href="elementindex_PICKLES.html#l">l</a>
@ -26,6 +27,7 @@
<a class="index-letter" href="elementindex_PICKLES.html#n">n</a>
<a class="index-letter" href="elementindex_PICKLES.html#o">o</a>
<a class="index-letter" href="elementindex_PICKLES.html#p">p</a>
<a class="index-letter" href="elementindex_PICKLES.html#q">q</a>
<a class="index-letter" href="elementindex_PICKLES.html#r">r</a>
<a class="index-letter" href="elementindex_PICKLES.html#s">s</a>
<a class="index-letter" href="elementindex_PICKLES.html#t">t</a>
@ -52,20 +54,7 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a> in Smarty.php</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/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
<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">
@ -79,14 +68,14 @@
<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-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.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-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">
@ -100,7 +89,14 @@
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.php</div>
<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/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
<div class="index-item-description">Constructor</div>
</dd>
<dt class="field">
@ -113,10 +109,38 @@
<dt class="field">
<span class="method-title">__get</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__get">Module::__get()</a> in Module.php</div>
<div class="index-item-description">Magic Getter Method</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/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>
</dd>
<dt class="field">
<span class="method-title">__set</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>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#method__set">Module::__set()</a> in Module.php</div>
<div class="index-item-description">Magic Setter Method</div>
</dd>
<dt class="field">
<span class="method-title">__set</span>
</dt>
@ -193,6 +217,12 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
</dd>
<dt class="field">
<span class="const-title">CLASS_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineCLASS_PATH">CLASS_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">close</span>
</dt>
@ -250,6 +280,13 @@
<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>
</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>
</dd>
<dt class="field">
<span class="var-title">$description</span>
</dt>
@ -277,13 +314,6 @@
<div class="index-item-details"><a href="PICKLES/Model.html#methoddelete">Model::delete()</a> in Model.php</div>
<div class="index-item-description">Delete Record</div>
</dd>
<dt class="field">
<span class="method-title">disabled</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methoddisabled">Config::disabled()</a> in Config.php</div>
<div class="index-item-description">Gets status of site</div>
</dd>
<dt class="field">
Display_Common
</dt>
@ -291,12 +321,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>
@ -304,6 +328,12 @@
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
<div class="index-item-description">JSON Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_JSON</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_PHP</span>
</dt>
@ -317,6 +347,12 @@
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
<div class="index-item-description">PHP Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
</dd>
<dt class="field">
Display_RSS
</dt>
@ -325,10 +361,11 @@
<div class="index-item-description">RSS Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_RSS</span>
Display_Smarty
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
<div class="index-item-description">Smarty Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_SMARTY</span>
@ -336,13 +373,6 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_SMARTY">DISPLAY_SMARTY</a> in pickles.php</div>
</dd>
<dt class="field">
Display_Smarty
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
<div class="index-item-description">Smarty Display</div>
</dd>
<dt class="field">
<span class="const-title">DISPLAY_XML</span>
</dt>
@ -364,6 +394,34 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$engine">Module::$engine</a> in Module.php</div>
<div class="index-item-description">Default display engine</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$extension">Display_Common::$extension</a> in Common.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#var$extension">Display_Smarty::$extension</a> in Smarty.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="var-title">$extension</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#var$extension">Display_PHP::$extension</a> in PHP.php</div>
<div class="index-item-description">Template Extension</div>
</dd>
<dt class="field">
<span class="method-title">error</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methoderror">Log::error()</a> in Log.php</div>
<div class="index-item-description">Log Error</div>
</dd>
<dt class="field">
<span class="method-title">execute</span>
</dt>
@ -412,14 +470,30 @@
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<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>
</dd>
<dt class="field">
<span class="method-title">getSmartyObject</span>
<span class="method-title">getInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodgetSmartyObject">Display_Smarty::getSmartyObject()</a> in Smarty.php</div>
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
<div class="index-item-description">Get instance of the object</div>
</dd>
</dl>
<a name="i"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">i</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">information</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodinformation">Log::information()</a> in Log.php</div>
<div class="index-item-description">Log Information</div>
</dd>
</dl>
<a name="j"></a>
@ -459,10 +533,10 @@
</div>
<dl>
<dt class="field">
<span class="include-title">Logger.php</span>
<span class="include-title">Log.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Logger.php.html">Logger.php</a> in Logger.php</div>
<div class="index-item-details"><a href="PICKLES/_classes---Log.php.html">Log.php</a> in Log.php</div>
</dd>
<dt class="field">
<span class="method-title">load</span>
@ -472,11 +546,11 @@
<div class="index-item-description">Loads a configuration file</div>
</dd>
<dt class="field">
Logger
Log
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Logger.html">Logger</a> in Logger.php</div>
<div class="index-item-description">Logger Class</div>
<div class="index-item-details"><a href="PICKLES/Log.html">Log</a> in Log.php</div>
<div class="index-item-description">Log Class</div>
</dd>
<dt class="field">
<span class="const-title">LOG_PATH</span>
@ -518,6 +592,12 @@
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
<div class="index-item-description">Model Class</div>
</dd>
<dt class="field">
<span class="const-title">MODEL_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODEL_PATH">MODEL_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
Module
</dt>
@ -526,11 +606,10 @@
<div class="index-item-description">Module Class</div>
</dd>
<dt class="field">
<span class="method-title">module</span>
<span class="const-title">MODULE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Config.html#methodmodule">Config::module()</a> in Config.php</div>
<div class="index-item-description">Gets default module</div>
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineMODULE_PATH">MODULE_PATH</a> in pickles.php</div>
</dd>
</dl>
<a name="n"></a>
@ -596,6 +675,13 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_classes---Display---PHP.php.html">PHP.php</a> in PHP.php</div>
</dd>
<dt class="field">
<span class="method-title">phpError</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodphpError">Log::phpError()</a> in Log.php</div>
<div class="index-item-description">Log PHP Error</div>
</dd>
<dt class="field">
<span class="include-title">pickles.php</span>
</dt>
@ -613,19 +699,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a> in Common.php</div>
<div class="index-item-description">Preparation for display</div>
</dd>
<dt class="field">
<span class="method-title">prepare</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a> in PHP.php</div>
</dd>
<dt class="field">
<span class="method-title">prepare</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a> in Smarty.php</div>
<div class="index-item-description">Preparation Method</div>
</dd>
<dt class="field">
<span class="method-title">prev</span>
@ -647,6 +721,21 @@
<div class="index-item-details"><a href="PICKLES/_scripts---pickle.php.html">pickle.php</a> in pickle.php</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">q</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">query</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodquery">Log::query()</a> in Log.php</div>
<div class="index-item-description">Log SQL Query</div>
</dd>
</dl>
<a name="r"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">r</div>
@ -700,7 +789,7 @@
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
<div class="index-item-description">Abstract rendering function that is overloaded within the loaded viewer</div>
<div class="index-item-description">Rendering Method</div>
</dd>
<dt class="field">
<span class="method-title">render</span>
@ -724,6 +813,13 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$secure">Module::$secure</a> in Module.php</div>
<div class="index-item-description">Secure</div>
</dd>
<dt class="field">
<span class="var-title">$session</span>
</dt>
<dd class="index-item-body">
<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="include-title">Smarty.php</span>
</dt>
@ -736,6 +832,13 @@
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">slowQuery</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodslowQuery">Log::slowQuery()</a> in Log.php</div>
<div class="index-item-description">Log Slow Query</div>
</dd>
<dt class="field">
<span class="const-title">SMARTY_PATH</span>
</dt>
@ -760,17 +863,17 @@
<dt class="field">
<span class="var-title">$template</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$template">Display_Common::$template</a> in Common.php</div>
<div class="index-item-description">Template</div>
</dd>
<dt class="field">
<span class="var-title">$template</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Module.html#var$template">Module::$template</a> in Module.php</div>
<div class="index-item-description">Default template</div>
</dd>
<dt class="field">
<span class="var-title">$templates</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$templates">Display_Common::$templates</a> in Common.php</div>
<div class="index-item-description">Templates</div>
</dd>
<dt class="field">
<span class="var-title">$title</span>
</dt>
@ -778,6 +881,26 @@
<div class="index-item-details"><a href="PICKLES/Module.html#var$title">Module::$title</a> in Module.php</div>
<div class="index-item-description">Page title</div>
</dd>
<dt class="field">
<span class="method-title">templateExists</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodtemplateExists">Display_Common::templateExists()</a> in Common.php</div>
<div class="index-item-description">Template Exists</div>
</dd>
<dt class="field">
<span class="const-title">TEMPLATE_PATH</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineTEMPLATE_PATH">TEMPLATE_PATH</a> in pickles.php</div>
</dd>
<dt class="field">
<span class="method-title">transaction</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Log.html#methodtransaction">Log::transaction()</a> in Log.php</div>
<div class="index-item-description">Log Credit Card Transaction</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
@ -802,10 +925,11 @@
</div>
<dl>
<dt class="field">
<span class="method-title">write</span>
<span class="method-title">warning</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PICKLES/Logger.html#methodwrite">Logger::write()</a> in Logger.php</div>
<div class="index-item-details"><a href="PICKLES/Log.html#methodwarning">Log::warning()</a> in Log.php</div>
<div class="index-item-description">Log Warning</div>
</dd>
</dl>
@ -816,6 +940,7 @@
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>
<a class="index-letter" href="elementindex_PICKLES.html#f">f</a>
<a class="index-letter" href="elementindex_PICKLES.html#g">g</a>
<a class="index-letter" href="elementindex_PICKLES.html#i">i</a>
<a class="index-letter" href="elementindex_PICKLES.html#j">j</a>
<a class="index-letter" href="elementindex_PICKLES.html#k">k</a>
<a class="index-letter" href="elementindex_PICKLES.html#l">l</a>
@ -823,6 +948,7 @@
<a class="index-letter" href="elementindex_PICKLES.html#n">n</a>
<a class="index-letter" href="elementindex_PICKLES.html#o">o</a>
<a class="index-letter" href="elementindex_PICKLES.html#p">p</a>
<a class="index-letter" href="elementindex_PICKLES.html#q">q</a>
<a class="index-letter" href="elementindex_PICKLES.html#r">r</a>
<a class="index-letter" href="elementindex_PICKLES.html#s">s</a>
<a class="index-letter" href="elementindex_PICKLES.html#t">t</a>

18
docs/errors.html
View file

@ -49,7 +49,7 @@
<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>
<a href="#Logger.php">Logger.php</a><br>
<a href="#Log.php">Log.php</a><br>
<a href="#mock_objects.php">mock_objects.php</a><br>
<a href="#mock_objects_test.php">mock_objects_test.php</a><br>
<a href="#Model.php">Model.php</a><br>
@ -230,7 +230,7 @@
<a name="Common.php"></a>
<h1>Common.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<a name="compatibility_test.php"></a>
<h1>compatibility_test.php</h1>
<h2>Warnings:</h2><br>
@ -241,7 +241,7 @@
<a name="Config.php"></a>
<h1>Config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Config<br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Config<br>
<a name="Controller.php"></a>
<h1>Controller.php</h1>
<h2>Warnings:</h2><br>
@ -402,10 +402,10 @@
<h2>Warnings:</h2><br>
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class LiveHttpTestCase<br>
<b>Warning on line 46</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/live_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Logger.php"></a>
<h1>Logger.php</h1>
<a name="Log.php"></a>
<h1>Log.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 20</b> - no @package tag was used in a DocBlock for class Logger<br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Log<br>
<a name="mock_objects_test.php"></a>
<h1>mock_objects_test.php</h1>
<h2>Warnings:</h2><br>
@ -481,11 +481,11 @@
<a name="PHP.php"></a>
<h1>PHP.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Display_PHP<br>
<b>Warning on line 26</b> - no @package tag was used in a DocBlock for class Display_PHP<br>
<a name="pickles.php"></a>
<h1>pickles.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 31</b> - Page-level DocBlock precedes "define PICKLES_PATH", use another DocBlock to document the source element<br>
<b>Warning on line 36</b> - Page-level DocBlock precedes "define PICKLES_PATH", use another DocBlock to document the source element<br>
<a name="process.php"></a>
<h1>process.php</h1>
<h2>Warnings:</h2><br>
@ -690,7 +690,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 Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:08 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

2
docs/index.html
View file

@ -4,7 +4,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Generated by phpDocumentor on Sun, 14 Mar 2010 11:11:26 -0400 -->
<!-- Generated by phpDocumentor on Tue, 16 Mar 2010 22:38:07 -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>

4
docs/li_PICKLES.html
View file

@ -31,7 +31,7 @@
<dd><a href='PICKLES/Display_PHP.html' target='right'>Display_PHP</a></dd>
<dd><a href='PICKLES/Display_RSS.html' target='right'>Display_RSS</a></dd>
<dd><a href='PICKLES/Display_Smarty.html' target='right'>Display_Smarty</a></dd>
<dd><a href='PICKLES/Logger.html' target='right'>Logger</a></dd>
<dd><a href='PICKLES/Log.html' target='right'>Log</a></dd>
<dd><a href='PICKLES/Model.html' target='right'>Model</a></dd>
<dd><a href='PICKLES/Module.html' target='right'>Module</a></dd>
<dd><a href='PICKLES/Object.html' target='right'>Object</a></dd>
@ -43,7 +43,7 @@
<dd><a href='PICKLES/_classes---Controller.php.html' target='right'>Controller.php</a></dd>
<dd><a href='PICKLES/_classes---Database.php.html' target='right'>Database.php</a></dd>
<dd><a href='PICKLES/_classes---Display---JSON.php.html' target='right'>JSON.php</a></dd>
<dd><a href='PICKLES/_classes---Logger.php.html' target='right'>Logger.php</a></dd>
<dd><a href='PICKLES/_classes---Log.php.html' target='right'>Log.php</a></dd>
<dd><a href='PICKLES/_classes---Model.php.html' target='right'>Model.php</a></dd>
<dd><a href='PICKLES/_classes---Module.php.html' target='right'>Module.php</a></dd>
<dd><a href='PICKLES/_classes---Object.php.html' target='right'>Object.php</a></dd>

2
docs/ric_COPYING.html
View file

@ -687,7 +687,7 @@ Public License instead of this License. But first, please read
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:06 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

2
docs/ric_INSTALL.html
View file

@ -36,7 +36,7 @@ Installation Guide
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:06 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

55
docs/ric_README.html
View file

@ -26,7 +26,7 @@ What is PICKLES?
The whole point behind PHP with PICKLES was for me (Josh Sherman) to take
a decade of PHP experience and a dozen or so of my own websites (all
running on different but similar custom systems of my own design) and build
a new framework rapid development system that would be flexible enough to
a new framework / rapid development system that would be flexible enough to
run all of my sites off of a single shared codebase. PICKLES runs in such a
way that the core files are completely separate from the site code it's
serving. So much so, that the core files should never really need to be
@ -34,8 +34,9 @@ accessed after installation (unless you want to void your warranty and/or
make a global change to all of your sites), and each site you have running
will be nicely packaged in a directory all it's own. This keeps your sites
simple and tidy with no duplicated code for each site! In a site's
directory modules (pages) are kept seperate from templates and everything
is ran through a single entry point controller.
directory, models and modules (page logic) and templates are kept seperate
from eachother and everything is ran through a single entry point
controller.
Okay, but why?
--------------
@ -55,36 +56,32 @@ previous outings than to rebuild my sites inside of another framework.
Get the facts!
--------------
Please note that some of these may not be entirely accurate yet.
* PICKLES will only run on PHP 5.0.0 or greater. There are no plans to
ever support PHP 4.x.y (or below) as those versions have reached end of
life, so please don't ask.
* PICKLES will only run on PHP 5.0.0 or greater. There are no plans to
ever support PHP 4.x.y (or below) as those versions have reached end of
life, so please don't ask.
* PICKLES is not Model-View-Controller (MVC). It was developed around
concepts (as well as some naming conventions) of the MVC design pattern
but does not entirely conform to my own understanding of MVC. I'm from
the school of thought that there's not a single hammer for every nail,
so there's no point in forcing PICKLES into the MVC box for the sake of
it. PICKLES strives to provide a modular system for developing websites
while keeping the display elements separated from any database calls and
other logic. That isn't necessarily a bad thing, it just meants that
PICKLES isn't all that trendy because it lacks a silly buzzword that's a
bit overused at this point.
* PICKLES is not Model-View-Controller (MVC). It was developed around
concepts (as well as some naming conventions) of the MVC design pattern
but does not entirely conform to my own understanding of MVC. I'm from
the school of thought that there's not a single hammer for every nail,
so there's no point in forcing PICKLES into the MVC box for the sake of
it. PICKLES strives to provide a modular system for developing websites
while keeping the display elements separated from any database calls and
other logic. That isn't necessarily a bad thing, it just meants that
PICKLES isn't all that trendy because it lacks a silly buzzword that's a
bit overused at this point.
* PICKLES supports rendering Smarty template pages, returning JSON data
and RSS feeds (currently only supports version 2.0) and is fully capable
of running from the command line modes.
* PICKLES supports rendering Smarty template pages, returning JSON data
and RSS feeds (currently only supports version 2.0) and is fully capable
of running from the command line modes.
* PICKLES is coded fairly closely to the PEAR coding standards (sorry, I
like my fancy braces inline for class and function definitions) and is
fully documented in DocBlock notation.
* PICKLES is coded fairly close to the PEAR coding standards and is fully
documented in DocBlock notation.
* Included with PICKLES are shared CSS files (foundation classes and one to
do a full CSS reset) and shared JavaScript files with includes a very
trim AJAX library that handles a PICKLES-centric JSON object
automatically. If your dataset does not fit into that format, custom
handlers can be used instead.
do a full CSS reset) and shared JavaScript files with includes jQuery
(and some plugins / add-ons) and a core JavaScript file which includes
automatic AJAXing of forms and some other niceties.
* Writing error free code is very important to me, so any PHP development I
do is made to be E_STRICT compatible. This means that not only is PICKLES
@ -95,7 +92,7 @@ Please note that some of these may not be entirely accurate yet.
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:06 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

2
docs/ric_TODO.html
View file

@ -33,7 +33,7 @@ To Do List
</pre>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:06 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>

14
docs/todolist.html
View file

@ -10,14 +10,18 @@
<body>
<div align="center"><h1>Todo List</h1></div>
<h2>PICKLES</h2>
<h3><a href="PICKLES/Module.html#var$ajax">Module::$ajax</a></h3>
<ul>
<li>Implement this functionality</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/_classes---Config.php.html">Config.php</a></h3>
<ul>
<li>Add support for .php and .ini config files (auto scan directory?)</li>
</ul>
<h3><a href="PICKLES/Display_RSS.html">Display_RSS</a></h3>
<ul>
<li>Need to add support for RSS v1.0 as well as ATOM feeds. This may result in my abstracting out these classes a bit more (Probably a Feed viewer that would take a parameter to determine which type of of feed to use).</li>
@ -35,7 +39,7 @@
<li>Error handling is non-existant.</li>
</ul>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Mar 2010 11:11:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
Documentation generated on Tue, 16 Mar 2010 22:38:07 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</body>
</html>