This commit is contained in:
GitHub Merge Button 2011-11-20 08:07:06 -08:00
commit 87c7e404df
78 changed files with 4843 additions and 1756 deletions

View file

@ -85,7 +85,6 @@ class Database extends Object
// Checks the driver is legit and scrubs the name
switch ($datasource['driver'])
{
case 'mongo': $class = 'Mongo'; break;
case 'pdo_mysql': $class = 'PDO_MySQL'; break;
case 'pdo_pgsql': $class = 'PDO_PostgreSQL'; break;
case 'pdo_sqlite': $class = 'PDO_SQLite'; break;

View file

@ -1,119 +0,0 @@
<?php
/**
* Mongo Class File for PICKLES
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2011, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link http://p.ickl.es
*/
/**
* Mongo Database Abstraction Layer
*
* This database class is still considered incomplete and very experimental.
*/
class Database_Mongo extends Database_Common
{
/**
* Driver
*
* @access protected
* @var string
*/
protected $driver = 'mongo';
/**
* Opens database connection
*
* Establishes a connection to the database based on the set configuration
* options.
*
* @return boolean true on success, throws an exception overwise
*/
public function open()
{
if ($this->connection === null)
{
// Assembles the server string
$server = 'mongodb://';
if (isset($this->username))
{
$server .= $this->username;
if (isset($this->password))
{
$server .= ':' . $this->password;
}
$server .= '@';
}
$server .= $this->hostname . ':' . $this->port . '/' . $this->database;
// Attempts to connect
try
{
$this->connection = new Mongo($server, array('persist' => 'pickles'));
// If we have database and collection, attempt to assign them
if (isset($this->database))
{
$this->connection = $this->connection->selectDB($this->database);
}
}
catch (Exception $exception)
{
throw new Exception('Unable to connect to Mongo database');
}
}
return true;
}
/**
* Closes database connection
*
* Sets the connection to null regardless of state.
*
* @return boolean always true
*/
public function close()
{
try
{
$this->connection->close();
}
catch (Exception $exception)
{
// Trapping error
}
$this->connection = null;
return true;
}
/**
* Fetch records from the database
*/
public function fetch($collection, $query = array(), $fields = array())
{
$this->open();
// Pulls the results based on the type
$results = $this->connection->$collection->find($query, $fields);
return $results;
}
}
?>

View file

@ -9,7 +9,7 @@
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2011, Josh Sherman
* @copyright Copyright 2007-2011, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link http://p.ickl.es
@ -238,15 +238,23 @@ class Model extends Object
*/
private $iterate = false;
/**
* Snapshot
*
* Snapshot of the object properties
*
* @access private
* @var array
*/
private $snapshot = array();
// }}}
// {{{ Class Constructor
/**
* Constructor
*
* Creates a new (empty) object or creates the record set from the passed
* arguments. The record and records arrays are populated as well as the
* count variable.
* Creates a new (empty) object or populates the record set.
*
* @param mixed $type_or_parameters optional type of query or parameters
* @param array $parameters optional data to create a query from
@ -260,12 +268,43 @@ class Model extends Object
// @todo Datasource has no way of being set
$this->db = Database::getInstance($this->datasource != '' ? $this->datasource : null);
$this->caching = $this->db->getCache();
if ($this->caching)
{
$this->cache = Cache::getInstance();
}
// Takes a snapshot of the [non-object] object properties
foreach ($this as $variable => $value)
{
if (!in_array($variable, array('db', 'cache', 'config', 'snapshot')))
{
$this->snapshot[$variable] = $value;
}
}
return $this->execute($type_or_parameters, $parameters);
}
// }}}
// {{{ Database Execution Methods
/**
* Execute
*
* Potentially populates the record set from the passed arguments.
*
* @param mixed $type_or_parameters optional type of query or parameters
* @param array $parameters optional data to create a query from
*/
public function execute($type_or_parameters = null, $parameters = null)
{
// Resets internal properties
foreach ($this->snapshot as $variable => $value)
{
$this->$variable = $value;
}
// Builds out the query
if ($type_or_parameters != null)
{
@ -299,56 +338,48 @@ class Model extends Object
$this->table = $this->collection;
}
// If we're using an RDBMS (not Mongo) proceed with using SQL to pull the data
if ($this->db->getDriver() != 'mongo')
// Starts with a basic SELECT ... FROM
$this->sql = array(
'SELECT ' . (is_array($this->fields) ? implode(', ', $this->fields) : $this->fields),
'FROM ' . $this->table,
);
switch ($type_or_parameters)
{
// Starts with a basic SELECT ... FROM
$this->sql = array(
'SELECT ' . (is_array($this->fields) ? implode(', ', $this->fields) : $this->fields),
'FROM ' . $this->table,
);
// Updates query to use COUNT syntax
case 'count':
$this->sql[0] = 'SELECT COUNT(*) AS count';
$this->generateQuery();
break;
switch ($type_or_parameters)
{
// Updates query to use COUNT syntax
case 'count':
$this->sql[0] = 'SELECT COUNT(*) AS count';
$this->generateQuery();
break;
// Adds the rest of the query
case 'all':
case 'list':
case 'indexed':
default:
$this->generateQuery();
break;
}
// Adds the rest of the query
case 'all':
case 'list':
case 'indexed':
default:
$this->generateQuery();
break;
}
$query_database = true;
$query_database = true;
if (isset($cache_key))
{
//$cached = $this->cache->get($cache_key);
}
if (isset($cache_key))
{
//$cached = $this->cache->get($cache_key);
}
if (isset($cached) && $cached)
{
$this->records = $cached;
}
else
{
$this->records = $this->db->fetch(implode(' ', $this->sql), (count($this->input_parameters) == 0 ? null : $this->input_parameters));
if (isset($cache_key))
{
//$this->cache->set($cache_key, $this->records);
}
}
if (isset($cached) && $cached)
{
$this->records = $cached;
}
else
{
throw new Exception('Sorry, Mongo support in the PICKLES Model is not quite ready yet');
$this->records = $this->db->fetch(implode(' ', $this->sql), (count($this->input_parameters) == 0 ? null : $this->input_parameters));
if (isset($cache_key))
{
//$this->cache->set($cache_key, $this->records);
}
}
$index_records = in_array($type_or_parameters, array('list', 'indexed'));
@ -886,7 +917,7 @@ class Model extends Object
if ($this->iterate == false)
{
$this->iterate = true;
// Resets the records, saves calling reset() when walking multiple times
$this->reset();
}
@ -953,7 +984,7 @@ class Model extends Object
{
$sql .= ' WHERE ' . $this->id . ' = :' . $this->id . ' LIMIT 1;';
$input_parameters[':' . $this->id] = $this->record[$this->id];
if ($this->caching)
{
//$this->cache->delete('PICKLES-' . $this->datasource . '-' . $this->table . '-' . $this->record[$this->id]);

View file

@ -0,0 +1,233 @@
<?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 API_Common</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class API_Common</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-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">Common API Interface</p>
<p class="description"><p>Parent class that our API interface classes should be extending. Contains execution of parental functions but may contain more down the road.</p></p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
</ul>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">24</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--API_Common</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/API_Google_Profanity.html">API_Google_Profanity</a></td>
<td>
Google Profanity API Interface
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/API_Tinychat.html">API_Tinychat</a></td>
<td>
Tinychat API Interface
</td>
</tr>
</table>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">API_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">29</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">API_Common</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/API_Tinychat.html#method__construct">API_Tinychat::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">37</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__destruct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></dt>
<dd>Destructor</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,162 @@
<?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 API_Google_Profanity</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 API_Google_Profanity</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">Google Profanity API Interface</p>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">61</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/API_Common.html">API_Common</a>
|
--API_Google_Profanity</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="#check" title="details" class="method-name">check</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$word</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>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodcheck" id="check"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method check</span> (line <span class="line-number">72</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check</p>
<p class="description"><p>Checks if a word is considered profanity.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the word is profanity</li>
<li><span class="field">usage:</span> API_Google_Profanity::check('fuck'); // returns true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
check
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$word</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$word</span><span class="var-description">: word to check</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/API_Common.html">API_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/API_Common.html#method__construct">API_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/API_Common.html#method__destruct">API_Common::__destruct()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,387 @@
<?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 API_Tinychat</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 API_Tinychat</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">Tinychat API Interface</p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tinychat.com/developer/docs">http://tinychat.com/developer/docs</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">107</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/API_Common.html">API_Common</a>
|
--API_Tinychat</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">API_Tinychat</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#generateHTML" title="details" class="method-name">generateHTML</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$join</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nick</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$change</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$login</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$oper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$owner</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$bcast</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$api</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$colorbk</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$tcdisplay</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$autoop</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$urlsuper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$langdefault</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#listRooms" title="details" class="method-name">listRooms</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#roomInfo" title="details" class="method-name">roomInfo</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$with_ip</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#setBroadcastPassword" title="details" class="method-name">setBroadcastPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#setRoomPassword" title="details" class="method-name">setRoomPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</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>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">130</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Assigns our public and secret keys from the configuration.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">API_Tinychat</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/API_Common.html#method__construct">API_Common::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodgenerateHTML" id="generateHTML"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">generateHTML</span> (line <span class="line-number">241</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate HTML</p>
<p class="description"><p>Creates the HTML to place a chat on a site.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">todo:</span> List params...</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
generateHTML
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$join</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nick</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$change</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$login</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$oper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$owner</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$bcast</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$api</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$colorbk</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$tcdisplay</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$autoop</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$urlsuper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$langdefault</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$room</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$join</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$nick</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$change</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$login</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$oper</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$owner</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$bcast</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$api</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$colorbk</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$tcdisplay</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$autoop</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$urlsuper</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$langdefault</span> </li>
</ul>
</div>
<a name="methodlistRooms" id="listRooms"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">listRooms</span> (line <span class="line-number">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List Rooms</p>
<p class="description"><p>Pulls all rooms for the API application.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
listRooms
</span>
()
</div>
</div>
<a name="methodroomInfo" id="roomInfo"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">roomInfo</span> (line <span class="line-number">198</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Room Info</p>
<p class="description"><p>Pulls the information for a room.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
roomInfo
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$with_ip</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$with_ip</span><span class="var-description">: whether or not to include users IP addresses</span> </li>
</ul>
</div>
<a name="methodsetBroadcastPassword" id="setBroadcastPassword"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setBroadcastPassword</span> (line <span class="line-number">228</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Broadcast Password</p>
<p class="description"><p>Sets the password to allow broadcasting in the room. Only users with the correct password will be able to broadcast.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
setBroadcastPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password to use, blank for no password</span> </li>
</ul>
</div>
<a name="methodsetRoomPassword" id="setRoomPassword"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setRoomPassword</span> (line <span class="line-number">213</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Room Password</p>
<p class="description"><p>Sets the password for the room, only users with the correct password will be able to enter.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
setRoomPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password to use, blank for no password</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/API_Common.html">API_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/API_Common.html#method__construct">API_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/API_Common.html#method__destruct">API_Common::__destruct()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

432
docs/PICKLES/Cache.html Normal file
View file

@ -0,0 +1,432 @@
<?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 Cache</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 Cache</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">Cache Class</p>
<p class="description"><p>Wrapper class for Memcache() to allow for better error handling when the Memcached server is unavailable. Designed around the syntax for Memcached() to allow for an easier transistion to the aforementioned in the future. I don't entirely remember specifics, but the reason for not using Memcached() was due to an unexplainable bug in the version in the repository for Ubuntu 10.04 LTS. Memcached() does support more of the memcached protocol and will eventually be what PICKLES uses.</p><p>Requires php5-memcache</p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://www.memcached.org/">http://www.memcached.org/</a></li>
<li><span class="field">link:</span> <a href="http://packages.ubuntu.com/lucid/php5-memcache">http://packages.ubuntu.com/lucid/php5-memcache</a></li>
<li><span class="field">link:</span> <a href="http://us.php.net/manual/en/book.memcache.php">http://us.php.net/manual/en/book.memcache.php</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">301</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Cache</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">object self::$instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Cache'</span>])
</div>
<div class="method-definition">
<span class="method-result">Cache</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#delete" title="details" class="method-name">delete</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#get" title="details" class="method-name">get</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#increment" title="details" class="method-name">increment</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#open" title="details" class="method-name">open</a>
()
</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">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">300</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$expiration</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>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">376</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Instance</p>
<p class="description"><p>Let's the parent class do all the work.</p></p>
<ul class="tags">
<li><span class="field">return:</span> instance of the Cache class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object self::$instance</span>
<span class="method-name">
getInstance
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Cache'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class to instantiate</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></dt>
<dd>Get Instance</dd>
</dl>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">335</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Sets up our connection variables.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Cache</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$hostname</span><span class="var-description">: optional hostname to connect to</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$database</span><span class="var-description">: optional port to use</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$port</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">359</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destructor</p>
<p class="description"><p>Closes the connection when the object dies.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__destruct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></dt>
<dd>Destructor</dd>
</dl>
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">447</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete Key</p>
<p class="description"><p>Deletes the specified key.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of deleting the key</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
delete
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to delete</span> </li>
</ul>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">get</span> (line <span class="line-number">405</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Key</p>
<p class="description"><p>Gets the value of the key and returns it.</p></p>
<ul class="tags">
<li><span class="field">return:</span> value of the requested key, false if not set</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">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to retrieve</span> </li>
</ul>
</div>
<a name="methodincrement" id="increment"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">increment</span> (line <span class="line-number">466</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Increment Key</p>
<p class="description"><p>Increments the value of an existing key.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of incrementing the key</li>
<li><span class="field">todo:</span> Wondering if I should check the key and set to 1 if it's new</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
increment
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to increment</span> </li>
</ul>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">386</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens Connection</p>
<p class="description"><p>Establishes a connection to the memcached server.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
open
</span>
()
</div>
</div>
<a name="methodset" id="set"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">set</span> (line <span class="line-number">429</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Key</p>
<p class="description"><p>Sets key to the specified value. I've found that compression can lead to issues with integers and can slow down the storage and retrieval of data (defeats the purpose of caching if you ask me) and isn't supported. I've also been burned by data inadvertantly being cached for infinity, hence the 5 minute default.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of writing the data to the key</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">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">300</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$expiration</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to set</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: value to set</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$expiration</span><span class="var-description">: optional expiration, defaults to 5 minutes</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$expire</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -29,7 +29,7 @@
</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">30</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">504</span>)
</p>
@ -128,7 +128,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">252</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">737</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -167,7 +167,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">47</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">521</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -203,7 +203,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">load</span> (line <span class="line-number">85</span>)
<span class="method-title">load</span> (line <span class="line-number">559</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -233,7 +233,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">279</span>)
<span class="method-title">__get</span> (line <span class="line-number">764</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -264,7 +264,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">265</span>)
<span class="method-title">__set</span> (line <span class="line-number">750</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -308,7 +308,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -29,7 +29,7 @@
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Controller.php.html">/classes/Controller.php</a> (line <span class="field">28</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">800</span>)
</p>
@ -119,7 +119,7 @@
<div class="evenrow">
<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">820</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -150,7 +150,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">433</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">1189</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -181,7 +181,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">prepareVariables</span> (line <span class="line-number">453</span>)
<span class="method-title">prepareVariables</span> (line <span class="line-number">1209</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -223,7 +223,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<p class="short-description">Convert Class</p>
<p class="description"><p>Collection of statically called methods to help aid in converting formats.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Convert.php.html">/classes/Convert.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1248</span>)
</p>
@ -75,7 +75,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method arrayToXML</span> (line <span class="line-number">80</span>)
<span class="method-title">static method arrayToXML</span> (line <span class="line-number">1305</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -113,7 +113,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method toJSON</span> (line <span class="line-number">41</span>)
<span class="method-title">static method toJSON</span> (line <span class="line-number">1266</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -151,7 +151,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Database Factory</p>
<p class="description"><p>Generic class to simplify connecting to a database. All database objects should be created by this class to future proof against any internal changes to PICKLES.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Database.php.html">/classes/Database.php</a> (line <span class="field">25</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1996</span>)
</p>
@ -109,7 +109,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">54</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">2025</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -148,7 +148,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">35</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">2006</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -195,7 +195,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -29,7 +29,7 @@
<li><span class="field">abstract:</span> </li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Database---Common.php.html">/classes/Database/Common.php</a> (line <span class="field">24</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1392</span>)
</p>
@ -55,12 +55,6 @@
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_Mongo.html">Database_Mongo</a></td>
<td>
Mongo Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></td>
@ -86,7 +80,11 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$cache" title="details" class="var-name">$cache</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$connection" title="details" class="var-name">$connection</a>
</div>
@ -139,7 +137,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Database_Common</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -149,6 +147,11 @@
<span class="method-result">boolean</span>
<a href="#close" title="details" class="method-name">close</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getCache" title="details" class="method-name">getCache</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
@ -159,6 +162,11 @@
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setCache" title="details" class="method-name">setCache</a>
(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
@ -208,14 +216,36 @@
</div>
<div class="info-box-body">
<a name="var$connection" id="$connection"><!-- --></A>
<a name="var$cache" id="$cache"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$cache</span>
= <span class="var-default"> false</span> (line <span class="line-number">1456</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Whether or not to use caching</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$connection" id="$connection"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$connection</span>
= <span class="var-default"> null</span> (line <span class="line-number">88</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1464</span>)
</span>
</div>
@ -237,7 +267,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$database</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1448</span>)
</span>
</div>
@ -259,7 +289,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
(line <span class="line-number">32</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1400</span>)
</span>
</div>
@ -275,19 +305,15 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$driver">Database_PDO_MySQL::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a>
<a href="../PICKLES/Database_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a>
: Driver
</li>
</ul>
@ -301,7 +327,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$hostname</span>
= <span class="var-default"> 'localhost'</span> (line <span class="line-number">40</span>)
= <span class="var-default"> 'localhost'</span> (line <span class="line-number">1408</span>)
</span>
</div>
@ -323,7 +349,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$password</span>
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1440</span>)
</span>
</div>
@ -345,7 +371,7 @@
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1416</span>)
</span>
</div>
@ -379,7 +405,7 @@
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">96</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1472</span>)
</span>
</div>
@ -401,7 +427,7 @@
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$socket</span>
= <span class="var-default"> null</span> (line <span class="line-number">56</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1424</span>)
</span>
</div>
@ -423,7 +449,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$username</span>
= <span class="var-default"> null</span> (line <span class="line-number">64</span>)
= <span class="var-default"> null</span> (line <span class="line-number">1432</span>)
</span>
</div>
@ -470,7 +496,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">1477</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -508,7 +534,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">210</span>)
<span class="method-title">close</span> (line <span class="line-number">1608</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -534,20 +560,42 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a>
: Closes database connection
</li>
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a>
: Closes database connection
</li>
</ul>
</div>
<a name="methodgetDriver" id="getDriver"><!-- --></a>
<a name="methodgetCache" id="getCache"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getDriver</span> (line <span class="line-number">187</span>)
<span class="method-title">getCache</span> (line <span class="line-number">1585</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Cache</p>
<p class="description"><p>Returns the status of caching for this datasource.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not to use the cache</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getCache
</span>
()
</div>
</div>
<a name="methodgetDriver" id="getDriver"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getDriver</span> (line <span class="line-number">1573</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -570,10 +618,10 @@
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">201</span>)
<span class="method-title">open</span> (line <span class="line-number">1599</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -599,20 +647,45 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#methodopen">Database_Mongo::open()</a>
: Opens database connection
</li>
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a>
: Opens database connection
</li>
</ul>
</div>
<a name="methodsetCache" id="setCache"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setCache</span> (line <span class="line-number">1560</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Cache</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setCache
</span>
(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$cache</span><span class="var-description">: whether or not to use cache</span> </li>
</ul>
</div>
<a name="methodsetDatabase" id="setDatabase"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setDatabase</span> (line <span class="line-number">174</span>)
<span class="method-title">setDatabase</span> (line <span class="line-number">1550</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -641,7 +714,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setHostname</span> (line <span class="line-number">124</span>)
<span class="method-title">setHostname</span> (line <span class="line-number">1500</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -670,7 +743,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">setPassword</span> (line <span class="line-number">164</span>)
<span class="method-title">setPassword</span> (line <span class="line-number">1540</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -699,7 +772,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPort</span> (line <span class="line-number">134</span>)
<span class="method-title">setPort</span> (line <span class="line-number">1510</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -728,7 +801,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">setSocket</span> (line <span class="line-number">144</span>)
<span class="method-title">setSocket</span> (line <span class="line-number">1520</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -757,7 +830,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setUsername</span> (line <span class="line-number">154</span>)
<span class="method-title">setUsername</span> (line <span class="line-number">1530</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -797,7 +870,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -1,321 +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 Database_Mongo</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Database_Mongo</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Mongo Database Abstraction Layer</p>
<p class="description"><p>This database class is still considered incomplete and very experimental.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Database---Mongo.php.html">/classes/Database/Mongo.php</a> (line <span class="field">23</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
--Database_Mongo</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-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="#$driver" title="details" class="var-name">$driver</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-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">boolean</span>
<a href="#close" title="details" class="method-name">close</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#fetch" title="details" class="method-name">fetch</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'mongo'</span> (line <span class="line-number">31</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></dt>
<dd>Driver</dd>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<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="methodclose" id="close"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">89</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes database connection</p>
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
<ul class="tags">
<li><span class="field">return:</span> always true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
close
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></dt>
<dd>Closes database connection</dd>
</dl>
</div>
<a name="methodfetch" id="fetch"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">108</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch records from the database</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
fetch
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$collection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$collection</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$query</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$fields</span> </li>
</ul>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">41</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens database connection</p>
<p class="description"><p>Establishes a connection to the database based on the set configuration options.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
open
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></dt>
<dd>Opens database connection</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -26,7 +26,7 @@
<p class="short-description">PDO Abstraction Layer</p>
<p class="description"><p>Parent class for any of our database classes that use PDO.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---Common.php.html">/classes/Database/PDO/Common.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1631</span>)
</p>
@ -60,18 +60,18 @@
<td>
MySQL Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></td>
<td>
SQLite Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a></td>
<td>
PostgreSQL Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></td>
<td>
SQLite Database Abstraction Layer
</td>
</tr>
</table>
</div>
@ -167,7 +167,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$attributes</span>
= <span class="var-default">array(<br /> PDO::ATTR_PERSISTENT =&gt; true,<br /> PDO::ATTR_ERRMODE =&gt; PDO::ERRMODE_EXCEPTION,<br /> PDO::NULL_EMPTY_STRING =&gt; true<br /> )</span> (line <span class="line-number">39</span>)
= <span class="var-default">array(<br /> PDO::ATTR_PERSISTENT =&gt; true,<br /> PDO::ATTR_ERRMODE =&gt; PDO::ERRMODE_EXCEPTION,<br /> PDO::NULL_EMPTY_STRING =&gt; true<br /> )</span> (line <span class="line-number">1647</span>)
</span>
</div>
@ -189,7 +189,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
(line <span class="line-number">31</span>)
(line <span class="line-number">1639</span>)
</span>
</div>
@ -209,11 +209,11 @@
: DSN format
</li>
<li>
<a href="../PICKLES/Database_PDO_SQLite.html#var$dsn">Database_PDO_SQLite::$dsn</a>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a>
: DSN format
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$dsn">Database_PDO_PostgreSQL::$dsn</a>
<a href="../PICKLES/Database_PDO_SQLite.html#var$dsn">Database_PDO_SQLite::$dsn</a>
: DSN format
</li>
</ul>
@ -225,6 +225,9 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$cache">Database_Common::$cache</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
@ -282,7 +285,7 @@
<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">1656</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -312,7 +315,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">110</span>)
<span class="method-title">close</span> (line <span class="line-number">1718</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -344,7 +347,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">execute</span> (line <span class="line-number">127</span>)
<span class="method-title">execute</span> (line <span class="line-number">1735</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -378,7 +381,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">fetch</span> (line <span class="line-number">220</span>)
<span class="method-title">fetch</span> (line <span class="line-number">1831</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -414,7 +417,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">67</span>)
<span class="method-title">open</span> (line <span class="line-number">1675</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -449,8 +452,10 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetCache">Database_Common::getCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetCache">Database_Common::setCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
@ -471,7 +476,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">MySQL Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---MySQL.php.html">/classes/Database/PDO/MySQL.php</a> (line <span class="field">21</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1865</span>)
</p>
@ -90,7 +90,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_mysql'</span> (line <span class="line-number">29</span>)
= <span class="var-default"> 'pdo_mysql'</span> (line <span class="line-number">1873</span>)
</span>
</div>
@ -118,7 +118,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'mysql:host=[[hostname]];port=[[port]];unix_socket=[[socket]];dbname=[[database]]'</span> (line <span class="line-number">37</span>)
= <span class="var-default"> 'mysql:host=[[hostname]];port=[[port]];unix_socket=[[socket]];dbname=[[database]]'</span> (line <span class="line-number">1881</span>)
</span>
</div>
@ -146,7 +146,7 @@
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> 3306</span> (line <span class="line-number">45</span>)
= <span class="var-default"> 3306</span> (line <span class="line-number">1889</span>)
</span>
</div>
@ -178,6 +178,9 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$cache">Database_Common::$cache</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
@ -240,8 +243,10 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetCache">Database_Common::getCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetCache">Database_Common::setCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
@ -262,7 +267,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PostgreSQL Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---PostgreSQL.php.html">/classes/Database/PDO/PostgreSQL.php</a> (line <span class="field">21</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1910</span>)
</p>
@ -84,13 +84,13 @@
</div>
<div class="info-box-body">
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_pgsql'</span> (line <span class="line-number">29</span>)
= <span class="var-default"> 'pdo_pgsql'</span> (line <span class="line-number">1918</span>)
</span>
</div>
@ -112,13 +112,13 @@
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'pgsql:host=[[hostname]];port=[[port]];dbname=[[database]];user=[[username]];password=[[password]]'</span> (line <span class="line-number">37</span>)
= <span class="var-default"> 'pgsql:host=[[hostname]];port=[[port]];dbname=[[database]];user=[[username]];password=[[password]]'</span> (line <span class="line-number">1926</span>)
</span>
</div>
@ -140,13 +140,13 @@
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> 5432</span> (line <span class="line-number">45</span>)
= <span class="var-default"> 5432</span> (line <span class="line-number">1934</span>)
</span>
</div>
@ -178,6 +178,9 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$cache">Database_Common::$cache</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
@ -240,8 +243,10 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetCache">Database_Common::getCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetCache">Database_Common::setCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
@ -262,7 +267,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SQLite Database Abstraction Layer</p>
<p class="notes">
Located in <a class="field" href="_classes---Database---PDO---SQLite.php.html">/classes/Database/PDO/SQLite.php</a> (line <span class="field">21</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">1955</span>)
</p>
@ -86,7 +86,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
= <span class="var-default"> 'pdo_sqlite'</span> (line <span class="line-number">29</span>)
= <span class="var-default"> 'pdo_sqlite'</span> (line <span class="line-number">1963</span>)
</span>
</div>
@ -114,7 +114,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
= <span class="var-default"> 'sqlite:[[hostname]]'</span> (line <span class="line-number">37</span>)
= <span class="var-default"> 'sqlite:[[hostname]]'</span> (line <span class="line-number">1971</span>)
</span>
</div>
@ -146,6 +146,9 @@
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$cache">Database_Common::$cache</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
</span>
<span class="var-title">
@ -211,8 +214,10 @@
<blockquote>
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetCache">Database_Common::getCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetCache">Database_Common::setCache()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
@ -233,7 +238,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

111
docs/PICKLES/Date.html Normal file
View file

@ -0,0 +1,111 @@
<?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 Date</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 Date</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Date Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant date related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2145</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">integer</span>
<a href="#age" title="details" class="method-name">age</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodage" id="age"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method age</span> (line <span class="line-number">2158</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Age</p>
<p class="description"><p>Calculates age based on the passed date.</p></p>
<ul class="tags">
<li><span class="field">return:</span> number of years old</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">integer</span>
<span class="method-name">
age
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$date</span><span class="var-description">: birth / inception date</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -29,7 +29,7 @@
<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">24</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2201</span>)
</p>
@ -57,9 +57,9 @@
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_RSS.html">Display_RSS</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Display_JSON.html">Display_JSON</a></td>
<td>
RSS Display
JSON Display
</td>
</tr>
<tr>
@ -69,9 +69,9 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_JSON.html">Display_JSON</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Display_RSS.html">Display_RSS</a></td>
<td>
JSON Display
RSS Display
</td>
</tr>
<tr>
@ -193,13 +193,13 @@
</div>
<div class="info-box-body">
<a name="var$child_template" id="$child_template"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$child_template</span>
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
= <span class="var-default"> null</span> (line <span class="line-number">2225</span>)
</span>
</div>
@ -215,13 +215,13 @@
</div>
<a name="var$css_class" id="$css_class"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$css_class</span>
= <span class="var-default"> ''</span> (line <span class="line-number">56</span>)
= <span class="var-default"> ''</span> (line <span class="line-number">2233</span>)
</span>
</div>
@ -237,13 +237,13 @@
</div>
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$extension</span>
= <span class="var-default"> null</span> (line <span class="line-number">32</span>)
= <span class="var-default"> null</span> (line <span class="line-number">2209</span>)
</span>
</div>
@ -268,13 +268,13 @@
</div>
<a name="var$js_basename" id="$js_basename"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$js_basename</span>
= <span class="var-default"> ''</span> (line <span class="line-number">64</span>)
= <span class="var-default"> ''</span> (line <span class="line-number">2241</span>)
</span>
</div>
@ -290,13 +290,13 @@
</div>
<a name="var$meta_data" id="$meta_data"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$meta_data</span>
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
= <span class="var-default"> null</span> (line <span class="line-number">2249</span>)
</span>
</div>
@ -312,13 +312,13 @@
</div>
<a name="var$module_return" id="$module_return"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$module_return</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
= <span class="var-default"> null</span> (line <span class="line-number">2257</span>)
</span>
</div>
@ -334,13 +334,13 @@
</div>
<a name="var$parent_template" id="$parent_template"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$parent_template</span>
= <span class="var-default"> null</span> (line <span class="line-number">40</span>)
= <span class="var-default"> null</span> (line <span class="line-number">2217</span>)
</span>
</div>
@ -384,10 +384,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">87</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">2264</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -415,10 +415,10 @@
</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">194</span>)
<span class="method-title">render</span> (line <span class="line-number">2371</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -442,16 +442,16 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a>
: Renders the data in RSS format
<a href="../PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a>
: Renders the data in JSON format
</li>
<li>
<a href="../PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a>
: Renders the PHP templated pages
</li>
<li>
<a href="../PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a>
: Renders the data in JSON format
<a href="../PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a>
: Renders the data in RSS format
</li>
<li>
<a href="../PICKLES/Display_XML.html#methodrender">Display_XML::render()</a>
@ -460,10 +460,10 @@
</ul>
</div>
<a name="methodsetMetaData" id="setMetaData"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">setMetaData</span> (line <span class="line-number">159</span>)
<span class="method-title">setMetaData</span> (line <span class="line-number">2336</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -490,10 +490,10 @@
</div>
<a name="methodsetModuleReturn" id="setModuleReturn"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">setModuleReturn</span> (line <span class="line-number">171</span>)
<span class="method-title">setModuleReturn</span> (line <span class="line-number">2348</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -520,10 +520,10 @@
</div>
<a name="methodsetTemplateVariables" id="setTemplateVariables"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">143</span>)
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">2320</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -559,10 +559,10 @@
</div>
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">184</span>)
<span class="method-title">templateExists</span> (line <span class="line-number">2361</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -607,7 +607,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">JSON Display</p>
<p class="description"><p>Displays data in JavaScript Object Notation.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Display---JSON.php.html">/classes/Display/JSON.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2394</span>)
</p>
@ -131,7 +131,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">28</span>)
<span class="method-title">render</span> (line <span class="line-number">2399</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -182,7 +182,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">PHP Display</p>
<p class="description"><p>Displays the associated PHP templates for the Model.</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">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2425</span>)
</p>
@ -101,13 +101,13 @@
</div>
<div class="info-box-body">
<a name="var$extension" id="$extension"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$extension</span>
= <span class="var-default"> 'phtml'</span> (line <span class="line-number">36</span>)
= <span class="var-default"> 'phtml'</span> (line <span class="line-number">2438</span>)
</span>
</div>
@ -179,10 +179,10 @@
<A NAME='method_detail'></A>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">58</span>)
<span class="method-title">render</span> (line <span class="line-number">2460</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -209,10 +209,10 @@
</div>
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">templateExists</span> (line <span class="line-number">43</span>)
<span class="method-title">templateExists</span> (line <span class="line-number">2445</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -264,7 +264,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">RSS Display</p>
<p class="description"><p>Displays data as an RSS formatted XML string.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Display---RSS.php.html">/classes/Display/RSS.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2538</span>)
</p>
@ -131,7 +131,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">92</span>)
<span class="method-title">render</span> (line <span class="line-number">2607</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -182,7 +182,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">XML Display</p>
<p class="description"><p>Displays data in XML format.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Display---XML.php.html">/classes/Display/XML.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2681</span>)
</p>
@ -128,10 +128,10 @@
<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">28</span>)
<span class="method-title">render</span> (line <span class="line-number">2686</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -182,7 +182,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Dynamic Class</p>
<p class="description"><p>Handles generating links to static content that are a timestamp injected as to avoid hard caching. Also minifies content where applicable.</p><p>Note: you will want to add a mod_rewrite line to your .htaccess to support the routing to the filenames with the timestamp injected:</p><p>RewriteRule ^(.+)\.([\d]+)\.(css|js|gif|png|jpg|jpeg)$ /$1.$3 [NC,QSA]</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Dynamic.php.html">/classes/Dynamic.php</a> (line <span class="field">29</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2718</span>)
</p>
@ -112,10 +112,10 @@
<A NAME='method_detail'></A>
<a name="methodcss" id="css"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">css</span> (line <span class="line-number">119</span>)
<span class="method-title">css</span> (line <span class="line-number">2797</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -146,10 +146,10 @@
</div>
<a name="methodjs" id="js"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">js</span> (line <span class="line-number">190</span>)
<span class="method-title">js</span> (line <span class="line-number">2864</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -184,10 +184,10 @@
</div>
<a name="methodreference" id="reference"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">reference</span> (line <span class="line-number">41</span>)
<span class="method-title">reference</span> (line <span class="line-number">2730</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -232,7 +232,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<p class="short-description">Error Class</p>
<p class="description"><p>Standardized error reporting, mostly used to display fatal errors.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Error.php.html">/classes/Error.php</a> (line <span class="field">23</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">2972</span>)
</p>
@ -67,10 +67,10 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodfatal" id="fatal"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method fatal</span> (line <span class="line-number">33</span>)
<span class="method-title">static method fatal</span> (line <span class="line-number">2982</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -104,7 +104,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

111
docs/PICKLES/File.html Normal file
View file

@ -0,0 +1,111 @@
<?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 File</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 File</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant file related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">3072</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#removeDirectory" title="details" class="method-name">removeDirectory</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$directory</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodremoveDirectory" id="removeDirectory"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method removeDirectory</span> (line <span class="line-number">3085</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a Directory, Recursively</p>
<p class="description"><p>Removes a directory by emptying all of the contents recursively and then removing the directory, as PHP will not let you rmdir() on ain non-empty directory. Use with caution, seriously.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of the final rmdir();</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">
removeDirectory
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$directory</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$directory</span><span class="var-description">: directory to remove</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Form Class</p>
<p class="description"><p>This class contains methods for easily generating form elements. There is a heavy focus on select boxes as they have the most overhead for a developer.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Form.php.html">/classes/Form.php</a> (line <span class="field">24</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">3139</span>)
</p>
@ -51,14 +51,19 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<div class="method-definition">
static <span class="method-result">object instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Form'</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#checkbox" title="details" class="method-name">checkbox</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#dateSelect" title="details" class="method-name">dateSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'date'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$start_year</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$end_year</span> = <span class="var-default">null</span>])
</div>
@ -69,18 +74,28 @@
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#hidden" title="details" class="method-name">hidden</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#hiddenInput" title="details" class="method-name">hiddenInput</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#input" title="details" class="method-name">input</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#options" title="details" class="method-name">options</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#password" title="details" class="method-name">password</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
@ -96,6 +111,16 @@
<span class="method-result">void</span>
<a href="#polarSelect" title="details" class="method-name">polarSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'decision'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#radio" title="details" class="method-name">radio</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#security" title="details" class="method-name">security</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
@ -111,6 +136,16 @@
<span class="method-result">string</span>
<a href="#stateSelect" title="details" class="method-name">stateSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'state'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#submit" title="details" class="method-name">submit</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#submitInput" title="details" class="method-name">submitInput</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
@ -164,7 +199,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">35</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">3152</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -199,11 +234,54 @@
</div>
<a name="methoddateSelect" id="dateSelect"><!-- --></a>
<a name="methodcheckbox" id="checkbox"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">dateSelect</span> (line <span class="line-number">316</span>)
<span class="method-title">checkbox</span> (line <span class="line-number">3351</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checkbox</p>
<p class="description"><p>Generates a checkbox input with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
checkbox
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the checkbox is checked</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methoddateSelect" id="dateSelect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">dateSelect</span> (line <span class="line-number">3607</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -246,10 +324,10 @@
</div>
<a name="methoddobSelect" id="dobSelect"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">dobSelect</span> (line <span class="line-number">389</span>)
<span class="method-title">dobSelect</span> (line <span class="line-number">3683</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -284,12 +362,52 @@
</ul>
</div>
<a name="methodhidden" id="hidden"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">hidden</span> (line <span class="line-number">3202</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hidden</p>
<p class="description"><p>Shorthand method to generate a hidden input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
hidden
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodhiddenInput" id="hiddenInput"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">hiddenInput</span> (line <span class="line-number">73</span>)
<span class="method-title">hiddenInput</span> (line <span class="line-number">3220</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -297,6 +415,7 @@
<p class="description"><p>Shorthand method to generate a hidden input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use hidden() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -311,7 +430,7 @@
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
@ -329,7 +448,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">input</span> (line <span class="line-number">52</span>)
<span class="method-title">input</span> (line <span class="line-number">3173</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -345,13 +464,13 @@
<span class="method-name">
input
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
@ -364,6 +483,9 @@
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span><span class="var-description">: optional type of input</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the input is checked</span> </li>
</ul>
@ -372,7 +494,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">options</span> (line <span class="line-number">163</span>)
<span class="method-title">options</span> (line <span class="line-number">3448</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -402,11 +524,51 @@
</div>
<a name="methodpasswordInput" id="passwordInput"><!-- --></a>
<a name="methodpassword" id="password"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">passwordInput</span> (line <span class="line-number">89</span>)
<span class="method-title">password</span> (line <span class="line-number">3239</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Password</p>
<p class="description"><p>Shorthand method to generate a password input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
password
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodpasswordInput" id="passwordInput"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">passwordInput</span> (line <span class="line-number">3257</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -414,6 +576,7 @@
<p class="description"><p>Shorthand method to generate a password input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use password() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -428,7 +591,7 @@
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
@ -443,10 +606,10 @@
</div>
<a name="methodphoneInput" id="phoneInput"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">phoneInput</span> (line <span class="line-number">423</span>)
<span class="method-title">phoneInput</span> (line <span class="line-number">3723</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -482,10 +645,10 @@
</div>
<a name="methodpolarSelect" id="polarSelect"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">polarSelect</span> (line <span class="line-number">406</span>)
<span class="method-title">polarSelect</span> (line <span class="line-number">3703</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -520,11 +683,85 @@
</div>
<a name="methodsecurityInput" id="securityInput"><!-- --></a>
<a name="methodradio" id="radio"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">radio</span> (line <span class="line-number">3376</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Radio Button</p>
<p class="description"><p>Generates a radio input with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
radio
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the checkbox is checked</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodsecurity" id="security"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">securityInput</span> (line <span class="line-number">104</span>)
<span class="method-title">security</span> (line <span class="line-number">3312</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security</p>
<p class="description"><p>Generates a hidden input with an SHA1 hash as the value. The name of the field is cannot be changed as this method was only intended for use with forms that are submitted via AJAX to provide better security.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
security
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: value to hash</span> </li>
</ul>
</div>
<a name="methodsecurityInput" id="securityInput"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">securityInput</span> (line <span class="line-number">3330</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -532,6 +769,7 @@
<p class="description"><p>Generates a hidden input with an SHA1 hash as the value. The name of the field is cannot be changed as this method was only intended for use with forms that are submitted via AJAX to provide better security.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use security() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
@ -552,10 +790,10 @@
</div>
<a name="methodselect" id="select"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">select</span> (line <span class="line-number">144</span>)
<span class="method-title">select</span> (line <span class="line-number">3426</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -595,10 +833,10 @@
</div>
<a name="methodstateSelect" id="stateSelect"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">stateSelect</span> (line <span class="line-number">230</span>)
<span class="method-title">stateSelect</span> (line <span class="line-number">3518</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -634,15 +872,96 @@
</div>
<a name="methodtextarea" id="textarea"><!-- --></a>
<div class="oddrow">
<a name="methodsubmit" id="submit"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">textarea</span> (line <span class="line-number">122</span>)
<span class="method-title">submit</span> (line <span class="line-number">3276</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Text Area</p>
<p class="short-description">Submit</p>
<p class="description"><p>Shorthand method to generate a submit input (button).</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
submit
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the input element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodsubmitInput" id="submitInput"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">submitInput</span> (line <span class="line-number">3294</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Submit Input</p>
<p class="description"><p>Shorthand method to generate a submit input (button).</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use submit() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
submitInput
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the input element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodtextarea" id="textarea"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">textarea</span> (line <span class="line-number">3401</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Textarea</p>
<p class="description"><p>Generates a textarea with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
@ -692,7 +1011,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<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>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">3786</span>)
</p>
@ -100,7 +100,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method error</span> (line <span class="line-number">56</span>)
<span class="method-title">static method error</span> (line <span class="line-number">3819</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -131,7 +131,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method information</span> (line <span class="line-number">32</span>)
<span class="method-title">static method information</span> (line <span class="line-number">3795</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -162,7 +162,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method phpError</span> (line <span class="line-number">92</span>)
<span class="method-title">static method phpError</span> (line <span class="line-number">3855</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -196,7 +196,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method query</span> (line <span class="line-number">104</span>)
<span class="method-title">static method query</span> (line <span class="line-number">3867</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -227,7 +227,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method slowQuery</span> (line <span class="line-number">68</span>)
<span class="method-title">static method slowQuery</span> (line <span class="line-number">3831</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -258,7 +258,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method transaction</span> (line <span class="line-number">80</span>)
<span class="method-title">static method transaction</span> (line <span class="line-number">3843</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -289,7 +289,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method warning</span> (line <span class="line-number">44</span>)
<span class="method-title">static method warning</span> (line <span class="line-number">3807</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -323,7 +323,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Model Class</p>
<p class="description"><p>This is a parent class that all PICKLES data models should be extending. When using the class as designed, objects will function as active record pattern objects.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Model.php.html">/classes/Model.php</a> (line <span class="field">25</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">3937</span>)
</p>
@ -50,7 +50,11 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">object</span>
<a href="#$cache" title="details" class="var-name">$cache</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$collection" title="details" class="var-name">$collection</a>
</div>
@ -61,6 +65,10 @@
<div class="var-title">
<span class="var-type">string</span>
<a href="#$datasource" title="details" class="var-name">$datasource</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
@ -109,6 +117,10 @@
<div class="var-title">
<span class="var-type">array</span>
<a href="#$records" title="details" class="var-name">$records</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$replace" title="details" class="var-name">$replace</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
@ -117,6 +129,10 @@
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$table" title="details" class="var-name">$table</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$use_cache" title="details" class="var-name">$use_cache</a>
</div>
</div>
</div>
@ -134,7 +150,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Model</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@ -159,6 +175,11 @@
<span class="method-result">boolean</span>
<a href="#end" title="details" class="method-name">end</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#execute" title="details" class="method-name">execute</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
@ -222,14 +243,36 @@
</div>
<div class="info-box-body">
<a name="var$collection" id="$collection"><!-- --></A>
<a name="var$cache" id="$cache"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$cache</span>
= <span class="var-default"> null</span> (line <span class="line-number">3955</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cache Object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$collection" id="$collection"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$collection</span>
= <span class="var-default"> false</span> (line <span class="line-number">103</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4039</span>)
</span>
</div>
@ -246,13 +289,13 @@
</div>
<a name="var$conditions" id="$conditions"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$conditions</span>
= <span class="var-default"> false</span> (line <span class="line-number">127</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4063</span>)
</span>
</div>
@ -268,13 +311,13 @@
</div>
<a name="var$datasource" id="$datasource"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$datasource</span>
(line <span class="line-number">59</span>)
(line <span class="line-number">3987</span>)
</span>
</div>
@ -288,6 +331,28 @@
</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">3947</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database Object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$delayed" id="$delayed"><!-- --></A>
<div class="oddrow">
@ -296,7 +361,7 @@
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$delayed</span>
= <span class="var-default"> false</span> (line <span class="line-number">67</span>)
= <span class="var-default"> false</span> (line <span class="line-number">3995</span>)
</span>
</div>
@ -318,7 +383,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$fields</span>
= <span class="var-default"> '*'</span> (line <span class="line-number">75</span>)
= <span class="var-default"> '*'</span> (line <span class="line-number">4011</span>)
</span>
</div>
@ -340,7 +405,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$group</span>
= <span class="var-default"> false</span> (line <span class="line-number">135</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4071</span>)
</span>
</div>
@ -362,7 +427,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$having</span>
= <span class="var-default"> false</span> (line <span class="line-number">143</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4079</span>)
</span>
</div>
@ -384,7 +449,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$hints</span>
= <span class="var-default"> false</span> (line <span class="line-number">119</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4055</span>)
</span>
</div>
@ -406,7 +471,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$id</span>
= <span class="var-default"> 'id'</span> (line <span class="line-number">91</span>)
= <span class="var-default"> 'id'</span> (line <span class="line-number">4027</span>)
</span>
</div>
@ -428,7 +493,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$joins</span>
= <span class="var-default"> false</span> (line <span class="line-number">111</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4047</span>)
</span>
</div>
@ -450,7 +515,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$limit</span>
= <span class="var-default"> false</span> (line <span class="line-number">159</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4095</span>)
</span>
</div>
@ -472,7 +537,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$offset</span>
= <span class="var-default"> false</span> (line <span class="line-number">167</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4103</span>)
</span>
</div>
@ -495,7 +560,7 @@
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$order</span>
= <span class="var-default"> false</span> (line <span class="line-number">151</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4087</span>)
</span>
</div>
@ -517,7 +582,7 @@
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$record</span>
= <span class="var-default"> null</span> (line <span class="line-number">190</span>)
= <span class="var-default"> null</span> (line <span class="line-number">4126</span>)
</span>
</div>
@ -539,7 +604,7 @@
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$records</span>
= <span class="var-default"> null</span> (line <span class="line-number">197</span>)
= <span class="var-default"> null</span> (line <span class="line-number">4133</span>)
</span>
</div>
@ -554,14 +619,36 @@
</div>
<a name="var$results" id="$results"><!-- --></A>
<a name="var$replace" id="$replace"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$replace</span>
= <span class="var-default"> false</span> (line <span class="line-number">4003</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Replace instead of Insert/Update?</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">175</span>)
= <span class="var-default"> null</span> (line <span class="line-number">4111</span>)
</span>
</div>
@ -577,13 +664,13 @@
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$table</span>
= <span class="var-default"> false</span> (line <span class="line-number">83</span>)
= <span class="var-default"> false</span> (line <span class="line-number">4019</span>)
</span>
</div>
@ -597,6 +684,28 @@
</div>
<a name="var$use_cache" id="$use_cache"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$use_cache</span>
= <span class="var-default"> false</span> (line <span class="line-number">3963</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Whether or not to use cache</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
@ -629,12 +738,12 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">230</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">4174</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Creates a new (empty) object or creates the record set from the passed arguments. The record and records arrays are populated as well as the count variable.</p></p>
<p class="description"><p>Creates a new (empty) object or populates the record set.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
@ -668,7 +777,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">860</span>)
<span class="method-title">commit</span> (line <span class="line-number">4854</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -694,7 +803,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">count</span> (line <span class="line-number">688</span>)
<span class="method-title">count</span> (line <span class="line-number">4682</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -719,7 +828,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">915</span>)
<span class="method-title">delete</span> (line <span class="line-number">4921</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -745,7 +854,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">end</span> (line <span class="line-number">798</span>)
<span class="method-title">end</span> (line <span class="line-number">4792</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -767,11 +876,44 @@
</div>
<a name="methodfirst" id="first"><!-- --></a>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">786</span>)
<span class="method-title">execute</span> (line <span class="line-number">4212</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute</p>
<p class="description"><p>Potentially populates the record set from the passed arguments.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
execute
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$type_or_parameters</span><span class="var-description">: optional type of query or parameters</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$parameters</span><span class="var-description">: optional data to create a query from</span> </li>
</ul>
</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">4780</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -794,10 +936,10 @@
</div>
<a name="methodlast" id="last"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">last</span> (line <span class="line-number">818</span>)
<span class="method-title">last</span> (line <span class="line-number">4812</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -820,10 +962,10 @@
</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">728</span>)
<span class="method-title">next</span> (line <span class="line-number">4722</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -846,10 +988,10 @@
</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">747</span>)
<span class="method-title">prev</span> (line <span class="line-number">4741</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -872,10 +1014,10 @@
</div>
<a name="methodreset" id="reset"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">reset</span> (line <span class="line-number">766</span>)
<span class="method-title">reset</span> (line <span class="line-number">4760</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -898,10 +1040,10 @@
</div>
<a name="methodshuffle" id="shuffle"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">shuffle</span> (line <span class="line-number">716</span>)
<span class="method-title">shuffle</span> (line <span class="line-number">4710</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -925,10 +1067,10 @@
</div>
<a name="methodsort" id="sort"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">sort</span> (line <span class="line-number">703</span>)
<span class="method-title">sort</span> (line <span class="line-number">4697</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -960,10 +1102,10 @@
</div>
<a name="methodunescape" id="unescape"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">976</span>)
<span class="method-title">unescape</span> (line <span class="line-number">4982</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -991,10 +1133,10 @@
</div>
<a name="methodwalk" id="walk"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">walk</span> (line <span class="line-number">832</span>)
<span class="method-title">walk</span> (line <span class="line-number">4826</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -1032,7 +1174,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:20 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Module Class</p>
<p class="description"><p>This is a parent class that all PICKLES modules should be extending. Each module can specify it's own meta data and whether or not a user must be properly authenticated to view the page. Currently any pages without a template are treated as pages being requested via AJAX and the return will be JSON encoded. In the future this may need to be changed out for logic that allows the requested module to specify what display type(s) it can use.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Module.php.html">/classes/Module.php</a> (line <span class="field">28</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">5020</span>)
</p>
@ -50,7 +50,11 @@
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<div class="var-title">
<span class="var-type">object</span>
<a href="#$cache" title="details" class="var-name">$cache</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
@ -157,19 +161,41 @@
</div>
<div class="info-box-body">
<a name="var$db" id="$db"><!-- --></A>
<a name="var$cache" id="$cache"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$cache</span>
= <span class="var-default"> null</span> (line <span class="line-number">5028</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cache Object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$db" id="$db"><!-- --></A>
<div class="oddrow">
<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">36</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5036</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database object</p>
<p class="short-description">Database Object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
@ -186,12 +212,12 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$description</span>
= <span class="var-default"> null</span> (line <span class="line-number">52</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5052</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Meta description</p>
<p class="short-description">Meta Description</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -209,12 +235,12 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$engine</span>
= <span class="var-default"> DISPLAY_PHP</span> (line <span class="line-number">131</span>)
= <span class="var-default"> DISPLAY_PHP</span> (line <span class="line-number">5131</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default display engine</p>
<p class="short-description">Default Display Engine</p>
<p class="description"><p>Defaults to PHP but could be set to JSON, XML or RSS. Value is overwritten by the config value if not set by the module.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
@ -233,7 +259,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$hash</span>
= <span class="var-default"> null</span> (line <span class="line-number">120</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5120</span>)
</span>
</div>
@ -257,12 +283,12 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$keywords</span>
= <span class="var-default"> null</span> (line <span class="line-number">60</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5060</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Meta keywords (comma separated)</p>
<p class="short-description">Meta Keywords (comma separated)</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -280,7 +306,7 @@
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$method</span>
= <span class="var-default"> null</span> (line <span class="line-number">108</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5108</span>)
</span>
</div>
@ -304,7 +330,7 @@
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$private</span>
= <span class="var-default"> false</span> (line <span class="line-number">80</span>)
= <span class="var-default"> false</span> (line <span class="line-number">5080</span>)
</span>
</div>
@ -328,7 +354,7 @@
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$secure</span>
= <span class="var-default"> null</span> (line <span class="line-number">70</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5070</span>)
</span>
</div>
@ -352,12 +378,12 @@
<span class="var-title">
<span class="var-type">boolean,</span>
<span class="var-name">$security</span>
= <span class="var-default"> null</span> (line <span class="line-number">88</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5088</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security settings of the page</p>
<p class="short-description">Security Settings</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -375,7 +401,7 @@
<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">98</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5098</span>)
</span>
</div>
@ -399,12 +425,12 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$template</span>
= <span class="var-default"> 'index'</span> (line <span class="line-number">143</span>)
= <span class="var-default"> 'index'</span> (line <span class="line-number">5143</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default template</p>
<p class="short-description">Default Template</p>
<p class="description"><p>Defaults to null but could be set to any valid template basename. The value is overwritten by the config value if not set by the module. The display engine determines what the file extension should be.</p></p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
@ -423,12 +449,12 @@
<span class="var-title">
<span class="var-type">string,</span>
<span class="var-name">$title</span>
= <span class="var-default"> null</span> (line <span class="line-number">44</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5044</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Page title</p>
<p class="short-description">Page Title</p>
<ul class="tags">
<li><span class="field">var:</span> null by default</li>
<li><span class="field">access:</span> protected</li>
@ -470,7 +496,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">155</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">5155</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -506,7 +532,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">setRequest</span> (line <span class="line-number">226</span>)
<span class="method-title">setRequest</span> (line <span class="line-number">5227</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -536,7 +562,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__default</span> (line <span class="line-number">176</span>)
<span class="method-title">__default</span> (line <span class="line-number">5177</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -561,7 +587,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">203</span>)
<span class="method-title">__get</span> (line <span class="line-number">5204</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -592,7 +618,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">__set</span> (line <span class="line-number">189</span>)
<span class="method-title">__set</span> (line <span class="line-number">5190</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -636,7 +662,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -26,7 +26,7 @@
<p class="short-description">Object Class</p>
<p class="description"><p>Every instantiated class in PICKLES should be extending this class. By doing so the class is automatically hooked into the profiler, and the object will have access to some common components as well.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Object.php.html">/classes/Object.php</a> (line <span class="field">25</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">5265</span>)
</p>
@ -52,33 +52,15 @@
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_Common.html">Display_Common</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/API_Common.html">API_Common</a></td>
<td>
Common Display Class
Common API Interface
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_Common.html">Database_Common</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Cache.html">Cache</a></td>
<td>
Common Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Module.html">Module</a></td>
<td>
Module Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Controller.html">Controller</a></td>
<td>
Controller Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
<td>
Database Factory
Cache Class
</td>
</tr>
<tr>
@ -88,9 +70,33 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Session.html">Session</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Controller.html">Controller</a></td>
<td>
Session Class
Controller Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_Common.html">Database_Common</a></td>
<td>
Common Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
<td>
Database Factory
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Display_Common.html">Display_Common</a></td>
<td>
Common Display Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Dynamic.html">Dynamic</a></td>
<td>
Dynamic Class
</td>
</tr>
<tr>
@ -106,9 +112,15 @@
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Dynamic.html">Dynamic</a></td>
<td style="padding-right: 2em"><a href="../PICKLES/Module.html">Module</a></td>
<td>
Dynamic Class
Module Class
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Session.html">Session</a></td>
<td>
Session Class
</td>
</tr>
</table>
@ -189,13 +201,13 @@
</div>
<div class="info-box-body">
<a name="var$instances" id="$instances"><!-- --></A>
<div class="oddrow">
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$instances</span>
= <span class="var-default">array()</span> (line <span class="line-number">34</span>)
= <span class="var-default">array()</span> (line <span class="line-number">5274</span>)
</span>
</div>
@ -211,13 +223,13 @@
</div>
<a name="var$config" id="$config"><!-- --></A>
<div class="evenrow">
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$config</span>
= <span class="var-default"> null</span> (line <span class="line-number">42</span>)
= <span class="var-default"> null</span> (line <span class="line-number">5282</span>)
</span>
</div>
@ -249,10 +261,10 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">91</span>)
<span class="method-title">static method getInstance</span> (line <span class="line-number">5331</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -283,14 +295,18 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database.html#methodgetInstance">Database::getInstance()</a>
: Get instance
<a href="../PICKLES/Cache.html#methodgetInstance">Cache::getInstance()</a>
: Get Instance
</li>
<li>
<a href="../PICKLES/Config.html#methodgetInstance">Config::getInstance()</a>
: Get instance of the object
</li>
<li>
<a href="../PICKLES/Database.html#methodgetInstance">Database::getInstance()</a>
: Get instance
</li>
<li>
<a href="../PICKLES/Form.html#methodgetInstance">Form::getInstance()</a>
: Get Instance
</li>
@ -298,10 +314,10 @@
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">58</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">5298</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -325,7 +341,23 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a>
<a href="../PICKLES/API_Common.html#method__construct">API_Common::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/API_Tinychat.html#method__construct">API_Tinychat::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Cache.html#method__construct">Cache::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Config.html#method__construct">Config::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
: Constructor
</li>
<li>
@ -337,36 +369,32 @@
: Constructor
</li>
<li>
<a href="../PICKLES/Module.html#method__construct">Module::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Database.html#method__construct">Database::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Config.html#method__construct">Config::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Session.html#method__construct">Session::__construct()</a>
<a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Model.html#method__construct">Model::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Module.html#method__construct">Module::__construct()</a>
: Constructor
</li>
<li>
<a href="../PICKLES/Session.html#method__construct">Session::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">112</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">5352</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -389,6 +417,14 @@
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/API_Common.html#method__destruct">API_Common::__destruct()</a>
: Destructor
</li>
<li>
<a href="../PICKLES/Cache.html#method__destruct">Cache::__destruct()</a>
: Destructor
</li>
<li>
<a href="../PICKLES/Controller.html#method__destruct">Controller::__destruct()</a>
: Destructor
</li>
@ -404,7 +440,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -30,7 +30,7 @@
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Profiler.php.html">/classes/Profiler.php</a> (line <span class="field">34</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">5393</span>)
</p>
@ -96,7 +96,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method enabled</span> (line <span class="line-number">101</span>)
<span class="method-title">static method enabled</span> (line <span class="line-number">5460</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -128,7 +128,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method log</span> (line <span class="line-number">144</span>)
<span class="method-title">static method log</span> (line <span class="line-number">5503</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -165,7 +165,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method logQuery</span> (line <span class="line-number">201</span>)
<span class="method-title">static method logQuery</span> (line <span class="line-number">5560</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -205,7 +205,7 @@
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method report</span> (line <span class="line-number">279</span>)
<span class="method-title">static method report</span> (line <span class="line-number">5638</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -231,7 +231,7 @@
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method timer</span> (line <span class="line-number">248</span>)
<span class="method-title">static method timer</span> (line <span class="line-number">5607</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -266,7 +266,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -30,7 +30,7 @@
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Security.php.html">/classes/Security.php</a> (line <span class="field">27</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">5794</span>)
</p>
@ -74,7 +74,7 @@
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#login" title="details" class="method-name">login</a>
(<span class="var-type">$user_id</span>&nbsp;<span class="var-name">$user_id</span>)
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$user_id</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
@ -98,10 +98,10 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodbetweenLevel" id="betweenLevel"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method betweenLevel</span> (line <span class="line-number">366</span>)
<span class="method-title">static method betweenLevel</span> (line <span class="line-number">6142</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -133,10 +133,10 @@
</div>
<a name="methodgenerateHash" id="generateHash"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method generateHash</span> (line <span class="line-number">49</span>)
<span class="method-title">static method generateHash</span> (line <span class="line-number">5816</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -168,10 +168,10 @@
</div>
<a name="methodhasLevel" id="hasLevel"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method hasLevel</span> (line <span class="line-number">328</span>)
<span class="method-title">static method hasLevel</span> (line <span class="line-number">6104</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -200,10 +200,10 @@
</div>
<a name="methodisLevel" id="isLevel"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method isLevel</span> (line <span class="line-number">291</span>)
<span class="method-title">static method isLevel</span> (line <span class="line-number">6067</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -232,15 +232,15 @@
</div>
<a name="methodlogin" id="login"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method login</span> (line <span class="line-number">158</span>)
<span class="method-title">static method login</span> (line <span class="line-number">5928</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Login</p>
<p class="description"><p>Creates a session variable containing the user ID and generated token. The token is also assigned to a cookie to be used when validating the security level.</p></p>
<p class="description"><p>Creates a session variable containing the user ID and generated token. The token is also assigned to a cookie to be used when validating the security level. When the level value is present, the class will by pass the database look up and simply use that value when validating (the less paranoid scenario).</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the login could be completed</li>
<li><span class="field">access:</span> public</li>
@ -252,22 +252,25 @@
<span class="method-name">
login
</span>
(<span class="var-type">$user_id</span>&nbsp;<span class="var-name">$user_id</span>)
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$user_id</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">$user_id</span>
<span class="var-type">integer</span>
<span class="var-name">$user_id</span><span class="var-description">: ID of the user that's been logged in</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$level</span><span class="var-description">: optional level for the user being logged in</span> </li>
</ul>
</div>
<a name="methodlogout" id="logout"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method logout</span> (line <span class="line-number">187</span>)
<span class="method-title">static method logout</span> (line <span class="line-number">5958</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -297,7 +300,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -25,7 +25,7 @@
<p class="short-description">Session Class</p>
<p class="description"><p>Provides session handling via database instead of the file based session handling built into PHP. Using this class requires an array to be defined in place of the boolean true/false (on/off). If simply array(), the datasource will default to the value in $config['pickles']['datasource'] and if the table will default to &quot;sessions&quot;. The format is as follows:</p><p>$config = array( 'pickles' =&gt; array( 'session' =&gt; array( 'datasource' =&gt; 'mysql', 'table' =&gt; 'sessions', ) ) );</p><p>In addition to the configuration variables, a table in your database must be created. The [MySQL] table schema is as follows:</p><p>CREATE TABLE sessions ( id varchar(32) COLLATE utf8_unicode_ci NOT NULL, session text COLLATE utf8_unicode_ci NOT NULL, expires_at datetime NOT NULL, PRIMARY KEY (id) ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;</p><p>Note: The reason for not using a model class was to avoid a naming conflict between the Session model and the Session class itself. This will eventually be resolved when I abandon full 5.x support and migrate to 5.3+ (assuming that ever happens).</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Session.php.html">/classes/Session.php</a> (line <span class="field">51</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">6212</span>)
</p>
@ -142,10 +142,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">115</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">6286</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -173,10 +173,10 @@
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">147</span>)
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">6395</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -204,10 +204,10 @@
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">194</span>)
<span class="method-title">close</span> (line <span class="line-number">6445</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -229,10 +229,10 @@
</div>
<a name="methoddestroy" id="destroy"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">destroy</span> (line <span class="line-number">242</span>)
<span class="method-title">destroy</span> (line <span class="line-number">6493</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -260,10 +260,10 @@
</div>
<a name="methodgc" id="gc"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">gc</span> (line <span class="line-number">259</span>)
<span class="method-title">gc</span> (line <span class="line-number">6508</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -291,10 +291,10 @@
</div>
<a name="methodinitialize" id="initialize"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">initialize</span> (line <span class="line-number">160</span>)
<span class="method-title">initialize</span> (line <span class="line-number">6411</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -316,10 +316,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">182</span>)
<span class="method-title">open</span> (line <span class="line-number">6433</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -341,10 +341,10 @@
</div>
<a name="methodread" id="read"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">read</span> (line <span class="line-number">207</span>)
<span class="method-title">read</span> (line <span class="line-number">6458</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -372,10 +372,10 @@
</div>
<a name="methodwrite" id="write"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">write</span> (line <span class="line-number">225</span>)
<span class="method-title">write</span> (line <span class="line-number">6476</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -420,7 +420,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -24,7 +24,7 @@
<p class="short-description">String Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant string related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---String.php.html">/classes/String.php</a> (line <span class="field">24</span>)
Located in <a class="field" href="_jar.php.html">/jar.php</a> (line <span class="field">6539</span>)
</p>
@ -92,10 +92,10 @@
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodformatPhoneNumber" id="formatPhoneNumber"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method formatPhoneNumber</span> (line <span class="line-number">38</span>)
<span class="method-title">static method formatPhoneNumber</span> (line <span class="line-number">6553</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -127,10 +127,10 @@
</div>
<a name="methodgenerateGravatarHash" id="generateGravatarHash"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method generateGravatarHash</span> (line <span class="line-number">60</span>)
<span class="method-title">static method generateGravatarHash</span> (line <span class="line-number">6575</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -159,10 +159,10 @@
</div>
<a name="methodisEmpty" id="isEmpty"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method isEmpty</span> (line <span class="line-number">81</span>)
<span class="method-title">static method isEmpty</span> (line <span class="line-number">6596</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -191,10 +191,10 @@
</div>
<a name="methodrandom" id="random"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method random</span> (line <span class="line-number">111</span>)
<span class="method-title">static method random</span> (line <span class="line-number">6626</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -232,10 +232,10 @@
</div>
<a name="methodtruncate" id="truncate"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method truncate</span> (line <span class="line-number">170</span>)
<span class="method-title">static method truncate</span> (line <span class="line-number">6685</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -270,10 +270,10 @@
</div>
<a name="methodupperWords" id="upperWords"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method upperWords</span> (line <span class="line-number">200</span>)
<span class="method-title">static method upperWords</span> (line <span class="line-number">6715</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -308,7 +308,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</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 Mongo.php</title>
<title>Docs for page Common.php</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="file-name">/classes/Database/Mongo.php</h2>
<h2 class="file-name">/classes/API/Common.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">Mongo Class File for PICKLES</p>
<p class="short-description">Common API Class File for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
@ -47,10 +47,10 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_Mongo.html">Database_Mongo</a>
</td>
<td>
Mongo Database Abstraction Layer
Common API Interface
</td>
</tr>
</table>
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page Profanity.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/API/Google/Profanity.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Google Profanity Class File for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
</td>
<td>
Google Profanity API Interface
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page Tinychat.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/API/Tinychat.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Tinychat Class File for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
</td>
<td>
Tinychat API Interface
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page Cache.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/Cache.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Caching System for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
</td>
<td>
Cache Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Config.html">Config</a>
</td>
<td>
Config Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Controller.html">Controller</a>
</td>
<td>
Controller Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Convert.html">Convert</a>
</td>
<td>
Convert Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_Common.html">Database_Common</a>
</td>
<td>
Common Database Abstraction Layer
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a>
</td>
<td>
PDO Abstraction Layer
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a>
</td>
<td>
MySQL Database Abstraction Layer
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a>
</td>
<td>
PostgreSQL Database Abstraction Layer
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a>
</td>
<td>
SQLite Database Abstraction Layer
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database.html">Database</a>
</td>
<td>
Database Factory
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page Date.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/Date.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Date Utility Collection</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
</td>
<td>
Date Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_Common.html">Display_Common</a>
</td>
<td>
Common Display Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_JSON.html">Display_JSON</a>
</td>
<td>
JSON Display
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_PHP.html">Display_PHP</a>
</td>
<td>
PHP Display
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_RSS.html">Display_RSS</a>
</td>
<td>
RSS Display
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_XML.html">Display_XML</a>
</td>
<td>
XML Display
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Dynamic.html">Dynamic</a>
</td>
<td>
Dynamic Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Error.html">Error</a>
</td>
<td>
Error Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page File.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/File.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">File Utility Collection</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
</td>
<td>
File Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Form.html">Form</a>
</td>
<td>
Form Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Log.html">Log</a>
</td>
<td>
Log Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Model.html">Model</a>
</td>
<td>
Model Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Module.html">Module</a>
</td>
<td>
Module Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Object.html">Object</a>
</td>
<td>
Object Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Profiler.html">Profiler</a>
</td>
<td>
Profiler Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Security.html">Security</a>
</td>
<td>
Security Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Session.html">Session</a>
</td>
<td>
Session Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -47,7 +47,7 @@
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/String.html">String</a>
</td>
<td>
String Class
@ -62,7 +62,7 @@
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

308
docs/PICKLES/_jar.php.html Normal file
View file

@ -0,0 +1,308 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page jar.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">/jar.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Common API Class File for PICKLES</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2011, Josh Sherman</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/API_Common.html">API_Common</a>
</td>
<td>
Common API Interface
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/API_Google_Profanity.html">API_Google_Profanity</a>
</td>
<td>
Google Profanity API Interface
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/API_Tinychat.html">API_Tinychat</a>
</td>
<td>
Tinychat API Interface
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Cache.html">Cache</a>
</td>
<td>
Cache Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Config.html">Config</a>
</td>
<td>
Config Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Controller.html">Controller</a>
</td>
<td>
Controller Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Convert.html">Convert</a>
</td>
<td>
Convert Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_Common.html">Database_Common</a>
</td>
<td>
Common Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a>
</td>
<td>
PDO Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a>
</td>
<td>
MySQL Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a>
</td>
<td>
PostgreSQL Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a>
</td>
<td>
SQLite Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Database.html">Database</a>
</td>
<td>
Database Factory
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Date.html">Date</a>
</td>
<td>
Date Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_Common.html">Display_Common</a>
</td>
<td>
Common Display Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_JSON.html">Display_JSON</a>
</td>
<td>
JSON Display
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_PHP.html">Display_PHP</a>
</td>
<td>
PHP Display
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_RSS.html">Display_RSS</a>
</td>
<td>
RSS Display
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Display_XML.html">Display_XML</a>
</td>
<td>
XML Display
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Dynamic.html">Dynamic</a>
</td>
<td>
Dynamic Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Error.html">Error</a>
</td>
<td>
Error Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/File.html">File</a>
</td>
<td>
File Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Form.html">Form</a>
</td>
<td>
Form Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Log.html">Log</a>
</td>
<td>
Log Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Model.html">Model</a>
</td>
<td>
Model Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Module.html">Module</a>
</td>
<td>
Module Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Object.html">Object</a>
</td>
<td>
Object Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Profiler.html">Profiler</a>
</td>
<td>
Profiler Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Security.html">Security</a>
</td>
<td>
Security Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/Session.html">Session</a>
</td>
<td>
Session Class
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/String.html">String</a>
</td>
<td>
String Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -16,7 +16,8 @@
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-constants">Constants</a>
<a href="#sec-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
@ -36,18 +37,45 @@
</div>
<a name="sec-includes"></a>
<div class="info-box">
<div class="info-box-title">Includes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Includes</span>
| <a href="#sec-constants">Constants</a>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="_$jar_file"><!-- --></a>
<div class="oddrow">
<div>
<span class="include-title">
<span class="include-type">require</span>
(<span class="include-name">$jar_file</span>)
(line <span class="line-number">94</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
<a name="sec-constants"></a>
<div class="info-box">
<div class="info-box-title">Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span>
<a href="#sec-includes">Includes</a>
| <span class="disabled">Constants</span>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="defineDISPLAY_JSON"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -61,7 +89,7 @@
</div>
<a name="defineDISPLAY_PHP"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -75,7 +103,7 @@
</div>
<a name="defineDISPLAY_RSS"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -89,7 +117,7 @@
</div>
<a name="defineDISPLAY_XML"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -103,7 +131,7 @@
</div>
<a name="defineIS_CLI"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -117,7 +145,7 @@
</div>
<a name="defineJSON_AVAILABLE"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -131,7 +159,7 @@
</div>
<a name="defineLOG_PATH"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -145,7 +173,7 @@
</div>
<a name="definePICKLES_CLASS_PATH"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -159,7 +187,7 @@
</div>
<a name="definePICKLES_PATH"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -173,7 +201,7 @@
</div>
<a name="definePICKLES_START_TIME"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -187,7 +215,7 @@
</div>
<a name="definePRIVATE_PATH"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -201,7 +229,7 @@
</div>
<a name="defineSITE_CLASS_PATH"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -215,7 +243,7 @@
</div>
<a name="defineSITE_MODEL_PATH"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -229,7 +257,7 @@
</div>
<a name="defineSITE_MODULE_PATH"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -243,7 +271,7 @@
</div>
<a name="defineSITE_PATH"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div>
<span class="const-title">
@ -257,7 +285,7 @@
</div>
<a name="defineSITE_TEMPLATE_PATH"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div>
<span class="const-title">
@ -279,15 +307,41 @@
<div class="info-box-title">Functions</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-constants">Constants</a>
<a href="#sec-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
| <span class="disabled">Functions</span>
</div>
<div class="info-box-body">
<a name="function__autoload" id="function__autoload"><!-- --></a>
<a name="functionreadFileContents" id="functionreadFileContents"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">readFileContents</span> (line <span class="line-number">59</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
readFileContents
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$directory</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$directory</span> </li>
</ul>
</div>
<a name="function__autoload" id="function__autoload"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">__autoload</span> (line <span class="line-number">117</span>)
<span class="method-title">__autoload</span> (line <span class="line-number">151</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -317,7 +371,7 @@
<div class="evenrow">
<div>
<span class="method-title">__handleError</span> (line <span class="line-number">170</span>)
<span class="method-title">__handleError</span> (line <span class="line-number">204</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -359,7 +413,7 @@
<div class="oddrow">
<div>
<span class="method-title">__handleException</span> (line <span class="line-number">191</span>)
<span class="method-title">__handleException</span> (line <span class="line-number">225</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@ -386,7 +440,7 @@
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

View file

@ -17,10 +17,38 @@
<ul>
<li><a href="PICKLES/Convert.html">Convert</a></li></ul>
<h2>Root class Convert</h2>
<ul>
<li><a href="PICKLES/Convert.html">Convert</a></li></ul>
<h2>Root class Date</h2>
<ul>
<li><a href="PICKLES/Date.html">Date</a></li></ul>
<h2>Root class Date</h2>
<ul>
<li><a href="PICKLES/Date.html">Date</a></li></ul>
<h2>Root class Error</h2>
<ul>
<li><a href="PICKLES/Error.html">Error</a></li></ul>
<h2>Root class Error</h2>
<ul>
<li><a href="PICKLES/Error.html">Error</a></li></ul>
<h2>Root class File</h2>
<ul>
<li><a href="PICKLES/File.html">File</a></li></ul>
<h2>Root class File</h2>
<ul>
<li><a href="PICKLES/File.html">File</a></li></ul>
<h2>Root class Log</h2>
<ul>
<li><a href="PICKLES/Log.html">Log</a></li></ul>
<h2>Root class Log</h2>
<ul>
<li><a href="PICKLES/Log.html">Log</a></li></ul>
@ -28,8 +56,24 @@
<h2>Root class Object</h2>
<ul>
<li><a href="PICKLES/Object.html">Object</a><ul>
<li><a href="PICKLES/Config.html">Config</a></li><li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Database_Common.html">Database_Common</a><ul>
<li><a href="PICKLES/Database_Mongo.html">Database_Mongo</a></li><li><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a><ul>
<li><a href="PICKLES/API_Common.html">API_Common</a><ul>
<li><a href="PICKLES/API_Google_Profanity.html">API_Google_Profanity</a></li><li><a href="PICKLES/API_Tinychat.html">API_Tinychat</a></li></ul></li>
<li><a href="PICKLES/Cache.html">Cache</a></li><li><a href="PICKLES/Config.html">Config</a></li><li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Database_Common.html">Database_Common</a><ul>
<li><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a><ul>
<li><a href="PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a></li><li><a href="PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a></li><li><a href="PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></li></ul></li>
</ul></li>
<li><a href="PICKLES/Display_Common.html">Display_Common</a><ul>
<li><a href="PICKLES/Display_JSON.html">Display_JSON</a></li><li><a href="PICKLES/Display_PHP.html">Display_PHP</a></li><li><a href="PICKLES/Display_RSS.html">Display_RSS</a></li><li><a href="PICKLES/Display_XML.html">Display_XML</a></li></ul></li>
<li><a href="PICKLES/Dynamic.html">Dynamic</a></li><li><a href="PICKLES/Form.html">Form</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li><li><a href="PICKLES/Session.html">Session</a></li></ul></li>
</ul>
<h2>Root class Object</h2>
<ul>
<li><a href="PICKLES/Object.html">Object</a><ul>
<li><a href="PICKLES/API_Common.html">API_Common</a><ul>
<li><a href="PICKLES/API_Google_Profanity.html">API_Google_Profanity</a></li><li><a href="PICKLES/API_Tinychat.html">API_Tinychat</a></li></ul></li>
<li><a href="PICKLES/Cache.html">Cache</a></li><li><a href="PICKLES/Config.html">Config</a></li><li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Database_Common.html">Database_Common</a><ul>
<li><a href="PICKLES/Database_PDO_Common.html">Database_PDO_Common</a><ul>
<li><a href="PICKLES/Database_PDO_MySQL.html">Database_PDO_MySQL</a></li><li><a href="PICKLES/Database_PDO_PostgreSQL.html">Database_PDO_PostgreSQL</a></li><li><a href="PICKLES/Database_PDO_SQLite.html">Database_PDO_SQLite</a></li></ul></li>
</ul></li>
<li><a href="PICKLES/Display_Common.html">Display_Common</a><ul>
@ -41,16 +85,28 @@
<ul>
<li><a href="PICKLES/Profiler.html">Profiler</a></li></ul>
<h2>Root class Profiler</h2>
<ul>
<li><a href="PICKLES/Profiler.html">Profiler</a></li></ul>
<h2>Root class Security</h2>
<ul>
<li><a href="PICKLES/Security.html">Security</a></li></ul>
<h2>Root class Security</h2>
<ul>
<li><a href="PICKLES/Security.html">Security</a></li></ul>
<h2>Root class String</h2>
<ul>
<li><a href="PICKLES/String.html">String</a></li></ul>
<h2>Root class String</h2>
<ul>
<li><a href="PICKLES/String.html">String</a></li></ul>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -9,47 +9,186 @@
</head>
<body>
<a href="#Post-parsing">Post-parsing</a><br>
<a href="#Common.php">Common.php</a><br>
<a href="#Config.php">Config.php</a><br>
<a href="#config.php">config.php</a><br>
<a href="#Controller.php">Controller.php</a><br>
<a href="#Convert.php">Convert.php</a><br>
<a href="#Database.php">Database.php</a><br>
<a href="#Date.php">Date.php</a><br>
<a href="#Dynamic.php">Dynamic.php</a><br>
<a href="#Error.php">Error.php</a><br>
<a href="#File.php">File.php</a><br>
<a href="#Form.php">Form.php</a><br>
<a href="#home.php">home.php</a><br>
<a href="#home.phtml">home.phtml</a><br>
<a href="#index.php">index.php</a><br>
<a href="#index.phtml">index.phtml</a><br>
<a href="#jar.php">jar.php</a><br>
<a href="#JSON.php">JSON.php</a><br>
<a href="#Log.php">Log.php</a><br>
<a href="#Model.php">Model.php</a><br>
<a href="#Module.php">Module.php</a><br>
<a href="#Mongo.php">Mongo.php</a><br>
<a href="#MySQL.php">MySQL.php</a><br>
<a href="#Object.php">Object.php</a><br>
<a href="#PHP.php">PHP.php</a><br>
<a href="#pickles.php">pickles.php</a><br>
<a href="#PostgreSQL.php">PostgreSQL.php</a><br>
<a href="#Profanity.php">Profanity.php</a><br>
<a href="#Profiler.php">Profiler.php</a><br>
<a href="#RSS.php">RSS.php</a><br>
<a href="#SampleModel.php">SampleModel.php</a><br>
<a href="#scripts.php">scripts.php</a><br>
<a href="#Security.php">Security.php</a><br>
<a href="#Session.php">Session.php</a><br>
<a href="#SQLite.php">SQLite.php</a><br>
<a href="#String.php">String.php</a><br>
<a href="#Tinychat.php">Tinychat.php</a><br>
<a href="#XML.php">XML.php</a><br>
<a name="Post-parsing"></a>
<h1>Post-parsing</h1>
<h2>Warnings:</h2><br>
<b>Warning</b> - Class Database in file /home/josh/Source/pickles/classes/Database.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Config in file /home/josh/Source/pickles/classes/Config.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Controller in file /home/josh/Source/pickles/classes/Controller.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Module in file /home/josh/Source/pickles/classes/Module.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Database_Common in file /home/josh/Source/pickles/classes/Database/Common.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Session in file /home/josh/Source/pickles/classes/Session.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Form in file /home/josh/Source/pickles/classes/Form.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Dynamic in file /home/josh/Source/pickles/classes/Dynamic.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Model in file /home/josh/Source/pickles/classes/Model.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Cache in file /home/josh/Source/pickles/classes/Cache.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class API_Common in file /home/josh/Source/pickles/classes/API/Common.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Display_Common in file /home/josh/Source/pickles/classes/Display/Common.php has multiple possible parents named Object. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Display_XML in file /home/josh/Source/pickles/classes/Display/XML.php has multiple possible parents named Display_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class API_Google_Profanity in file /home/josh/Source/pickles/classes/API/Google/Profanity.php has multiple possible parents named API_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Database_PDO_MySQL in file /home/josh/Source/pickles/classes/Database/PDO/MySQL.php has multiple possible parents named Database_PDO_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class API_Tinychat in file /home/josh/Source/pickles/classes/API/Tinychat.php has multiple possible parents named API_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> -
duplicate class element "Module" in file /home/josh/Source/pickles/classes/Module.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Model" in file /home/josh/Source/pickles/classes/Model.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> - Class Database_PDO_SQLite in file /home/josh/Source/pickles/classes/Database/PDO/SQLite.php has multiple possible parents named Database_PDO_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Database_PDO_PostgreSQL in file /home/josh/Source/pickles/classes/Database/PDO/PostgreSQL.php has multiple possible parents named Database_PDO_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Display_JSON in file /home/josh/Source/pickles/classes/Display/JSON.php has multiple possible parents named Display_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Display_PHP in file /home/josh/Source/pickles/classes/Display/PHP.php has multiple possible parents named Display_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Display_RSS in file /home/josh/Source/pickles/classes/Display/RSS.php has multiple possible parents named Display_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> - Class Database_PDO_Common in file /home/josh/Source/pickles/classes/Database/PDO/Common.php has multiple possible parents named Database_Common. Cannot resolve name conflict,
try ignoring a file that contains the conflicting parent class<br>
<b>Warning</b> -
duplicate class element "Convert" in file /home/josh/Source/pickles/classes/Convert.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Date" in file /home/josh/Source/pickles/classes/Date.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database" in file /home/josh/Source/pickles/classes/Database.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Display_Common" in file /home/josh/Source/pickles/classes/Display/Common.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database_PDO_SQLite" in file /home/josh/Source/pickles/classes/Database/PDO/SQLite.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database_PDO_PostgreSQL" in file /home/josh/Source/pickles/classes/Database/PDO/PostgreSQL.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database_PDO_MySQL" in file /home/josh/Source/pickles/classes/Database/PDO/MySQL.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Display_JSON" in file /home/josh/Source/pickles/classes/Display/JSON.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Display_PHP" in file /home/josh/Source/pickles/classes/Display/PHP.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Form" in file /home/josh/Source/pickles/classes/Form.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Dynamic" in file /home/josh/Source/pickles/classes/Dynamic.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Display_XML" in file /home/josh/Source/pickles/classes/Display/XML.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Display_RSS" in file /home/josh/Source/pickles/classes/Display/RSS.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database_PDO_Common" in file /home/josh/Source/pickles/classes/Database/PDO/Common.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Database_Common" in file /home/josh/Source/pickles/classes/Database/Common.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Object" in file /home/josh/Source/pickles/classes/Object.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Log" in file /home/josh/Source/pickles/classes/Log.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "File" in file /home/josh/Source/pickles/classes/File.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Error" in file /home/josh/Source/pickles/classes/Error.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "API_Common" in file /home/josh/Source/pickles/classes/API/Common.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "API_Google_Profanity" in file /home/josh/Source/pickles/classes/API/Google/Profanity.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Controller" in file /home/josh/Source/pickles/classes/Controller.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Config" in file /home/josh/Source/pickles/classes/Config.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Cache" in file /home/josh/Source/pickles/classes/Cache.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "API_Tinychat" in file /home/josh/Source/pickles/classes/API/Tinychat.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Profiler" in file /home/josh/Source/pickles/classes/Profiler.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Session" in file /home/josh/Source/pickles/classes/Session.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "Security" in file /home/josh/Source/pickles/classes/Security.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<b>Warning</b> -
duplicate class element "String" in file /home/josh/Source/pickles/classes/String.php will be ignored.
Use an @ignore tag on the original if you want this case to be documented.<br>
<a name="Cache.php"></a>
<h1>Cache.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 35</b> - no @package tag was used in a DocBlock for class Cache<br>
<a name="Common.php"></a>
<h1>Common.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Database_PDO_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Database_Common<br>
<a name="config.php"></a>
<h1>config.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 80</b> - File "/home/josh/Source/pickles/boilerplate/config.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class API_Common<br>
<a name="Config.php"></a>
<h1>Config.php</h1>
<h2>Warnings:</h2><br>
@ -66,6 +205,10 @@
<h1>Database.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Database<br>
<a name="Date.php"></a>
<h1>Date.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Date<br>
<a name="Dynamic.php"></a>
<h1>Dynamic.php</h1>
<h2>Warnings:</h2><br>
@ -74,27 +217,51 @@
<h1>Error.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Error<br>
<a name="File.php"></a>
<h1>File.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class File<br>
<a name="Form.php"></a>
<h1>Form.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class Form<br>
<a name="home.php"></a>
<h1>home.php</h1>
<a name="jar.php"></a>
<h1>jar.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class home<br>
<b>Warning on line 18</b> - File "/home/josh/Source/pickles/boilerplate/modules/home.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="home.phtml"></a>
<h1>home.phtml</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 10</b> - File "/home/josh/Source/pickles/boilerplate/templates/home.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="index.php"></a>
<h1>index.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 7</b> - File "/home/josh/Source/pickles/boilerplate/public/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="index.phtml"></a>
<h1>index.phtml</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 15</b> - File "/home/josh/Source/pickles/boilerplate/templates/__shared/index.phtml" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class API_Common<br>
<b>Warning on line 61</b> - no @package tag was used in a DocBlock for class API_Google_Profanity<br>
<b>Warning on line 107</b> - no @package tag was used in a DocBlock for class API_Tinychat<br>
<b>Warning on line 301</b> - no @package tag was used in a DocBlock for class Cache<br>
<b>Warning on line 504</b> - no @package tag was used in a DocBlock for class Config<br>
<b>Warning on line 800</b> - no @package tag was used in a DocBlock for class Controller<br>
<b>Warning on line 1248</b> - no @package tag was used in a DocBlock for class Convert<br>
<b>Warning on line 1392</b> - no @package tag was used in a DocBlock for class Database_Common<br>
<b>Warning on line 1631</b> - no @package tag was used in a DocBlock for class Database_PDO_Common<br>
<b>Warning on line 1865</b> - no @package tag was used in a DocBlock for class Database_PDO_MySQL<br>
<b>Warning on line 1910</b> - no @package tag was used in a DocBlock for class Database_PDO_PostgreSQL<br>
<b>Warning on line 1955</b> - no @package tag was used in a DocBlock for class Database_PDO_SQLite<br>
<b>Warning on line 1996</b> - no @package tag was used in a DocBlock for class Database<br>
<b>Warning on line 2145</b> - no @package tag was used in a DocBlock for class Date<br>
<b>Warning on line 2201</b> - no @package tag was used in a DocBlock for class Display_Common<br>
<b>Warning on line 2394</b> - no @package tag was used in a DocBlock for class Display_JSON<br>
<b>Warning on line 2425</b> - no @package tag was used in a DocBlock for class Display_PHP<br>
<b>Warning on line 2538</b> - no @package tag was used in a DocBlock for class Display_RSS<br>
<b>Warning on line 2681</b> - no @package tag was used in a DocBlock for class Display_XML<br>
<b>Warning on line 2718</b> - no @package tag was used in a DocBlock for class Dynamic<br>
<b>Warning on line 2972</b> - no @package tag was used in a DocBlock for class Error<br>
<b>Warning on line 3072</b> - no @package tag was used in a DocBlock for class File<br>
<b>Warning on line 3139</b> - no @package tag was used in a DocBlock for class Form<br>
<b>Warning on line 3786</b> - no @package tag was used in a DocBlock for class Log<br>
<b>Warning on line 3937</b> - no @package tag was used in a DocBlock for class Model<br>
<b>Warning on line 5020</b> - no @package tag was used in a DocBlock for class Module<br>
<b>Warning on line 5265</b> - no @package tag was used in a DocBlock for class Object<br>
<b>Warning on line 5393</b> - no @package tag was used in a DocBlock for class Profiler<br>
<b>Warning on line 5794</b> - no @package tag was used in a DocBlock for class Security<br>
<b>Warning on line 6212</b> - no @package tag was used in a DocBlock for class Session<br>
<b>Warning on line 6539</b> - no @package tag was used in a DocBlock for class String<br>
<h2>Errors:</h2><br>
<b>Error on line 1888</b> - @access was passed neither "public" nor "private." Was passed: "proceted"<br>
<b>Error on line 1933</b> - @access was passed neither "public" nor "private." Was passed: "proceted"<br>
<a name="JSON.php"></a>
<h1>JSON.php</h1>
<h2>Warnings:</h2><br>
@ -111,10 +278,6 @@
<h1>Module.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Module<br>
<a name="Mongo.php"></a>
<h1>Mongo.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Database_Mongo<br>
<a name="MySQL.php"></a>
<h1>MySQL.php</h1>
<h2>Warnings:</h2><br>
@ -139,6 +302,10 @@
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for class Database_PDO_PostgreSQL<br>
<h2>Errors:</h2><br>
<b>Error on line 44</b> - @access was passed neither "public" nor "private." Was passed: "proceted"<br>
<a name="Profanity.php"></a>
<h1>Profanity.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for class API_Google_Profanity<br>
<a name="Profiler.php"></a>
<h1>Profiler.php</h1>
<h2>Warnings:</h2><br>
@ -147,15 +314,6 @@
<h1>RSS.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Display_RSS<br>
<a name="SampleModel.php"></a>
<h1>SampleModel.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 6</b> - no @package tag was used in a DocBlock for class SampleModel<br>
<b>Warning on line 12</b> - File "/home/josh/Source/pickles/boilerplate/models/SampleModel.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="scripts.php"></a>
<h1>scripts.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 10</b> - File "/home/josh/Source/pickles/boilerplate/scripts/scripts.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
<a name="Security.php"></a>
<h1>Security.php</h1>
<h2>Warnings:</h2><br>
@ -172,12 +330,16 @@
<h1>String.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 24</b> - no @package tag was used in a DocBlock for class String<br>
<a name="Tinychat.php"></a>
<h1>Tinychat.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class API_Tinychat<br>
<a name="XML.php"></a>
<h1>XML.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 23</b> - no @package tag was used in a DocBlock for class Display_XML<br>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -4,7 +4,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Generated by phpDocumentor on Mon, 09 May 2011 22:14:40 -0400 -->
<!-- Generated by phpDocumentor on Sun, 06 Nov 2011 20:54:19 -0500 -->
<title>PHP Interface Collection of Killer Libraries to Enhance Stuff</title>
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>

View file

@ -23,16 +23,20 @@
<dt class="folder-title">Classes</dt>
<dd><a href='PICKLES/Config.html' target='right'>Config</a></dd>
<dd><a href='PICKLES/API_Common.html' target='right'>API_Common</a></dd>
<dd><a href='PICKLES/API_Google_Profanity.html' target='right'>API_Google_Profanity</a></dd>
<dd><a href='PICKLES/API_Tinychat.html' target='right'>API_Tinychat</a></dd>
<dd><a href='PICKLES/Cache.html' target='right'>Cache</a></dd>
<dd><a href='PICKLES/Config.html' target='right'>Config</a></dd>
<dd><a href='PICKLES/Controller.html' target='right'>Controller</a></dd>
<dd><a href='PICKLES/Convert.html' target='right'>Convert</a></dd>
<dd><a href='PICKLES/Database.html' target='right'>Database</a></dd>
<dd><a href='PICKLES/Database_Common.html' target='right'>Database_Common</a></dd>
<dd><a href='PICKLES/Database_Mongo.html' target='right'>Database_Mongo</a></dd>
<dd><a href='PICKLES/Database_PDO_Common.html' target='right'>Database_PDO_Common</a></dd>
<dd><a href='PICKLES/Database_PDO_MySQL.html' target='right'>Database_PDO_MySQL</a></dd>
<dd><a href='PICKLES/Database_PDO_PostgreSQL.html' target='right'>Database_PDO_PostgreSQL</a></dd>
<dd><a href='PICKLES/Database_PDO_SQLite.html' target='right'>Database_PDO_SQLite</a></dd>
<dd><a href='PICKLES/Date.html' target='right'>Date</a></dd>
<dd><a href='PICKLES/Display_Common.html' target='right'>Display_Common</a></dd>
<dd><a href='PICKLES/Display_JSON.html' target='right'>Display_JSON</a></dd>
<dd><a href='PICKLES/Display_PHP.html' target='right'>Display_PHP</a></dd>
@ -40,6 +44,7 @@
<dd><a href='PICKLES/Display_XML.html' target='right'>Display_XML</a></dd>
<dd><a href='PICKLES/Dynamic.html' target='right'>Dynamic</a></dd>
<dd><a href='PICKLES/Error.html' target='right'>Error</a></dd>
<dd><a href='PICKLES/File.html' target='right'>File</a></dd>
<dd><a href='PICKLES/Form.html' target='right'>Form</a></dd>
<dd><a href='PICKLES/Log.html' target='right'>Log</a></dd>
<dd><a href='PICKLES/Model.html' target='right'>Model</a></dd>
@ -50,36 +55,43 @@
<dd><a href='PICKLES/Session.html' target='right'>Session</a></dd>
<dd><a href='PICKLES/String.html' target='right'>String</a></dd>
<dt class="folder-title">Functions</dt>
<dd><a href='PICKLES/_pickles.php.html#functionreadFileContents' target='right'>readFileContents</a></dd>
<dd><a href='PICKLES/_pickles.php.html#function__autoload' target='right'>__autoload</a></dd>
<dd><a href='PICKLES/_pickles.php.html#function__handleError' target='right'>__handleError</a></dd>
<dd><a href='PICKLES/_pickles.php.html#function__handleException' target='right'>__handleException</a></dd>
<dt class="folder-title">Files</dt>
<dd><a href='PICKLES/_classes---Database---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Cache.php.html' target='right'>Cache.php</a></dd>
<dd><a href='PICKLES/_classes---Display---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---API---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Database---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---Common.php.html' target='right'>Common.php</a></dd>
<dd><a href='PICKLES/_classes---Config.php.html' target='right'>Config.php</a></dd>
<dd><a href='PICKLES/_classes---Controller.php.html' target='right'>Controller.php</a></dd>
<dd><a href='PICKLES/_classes---Convert.php.html' target='right'>Convert.php</a></dd>
<dd><a href='PICKLES/_classes---Database.php.html' target='right'>Database.php</a></dd>
<dd><a href='PICKLES/_classes---Date.php.html' target='right'>Date.php</a></dd>
<dd><a href='PICKLES/_classes---Dynamic.php.html' target='right'>Dynamic.php</a></dd>
<dd><a href='PICKLES/_classes---Error.php.html' target='right'>Error.php</a></dd>
<dd><a href='PICKLES/_classes---File.php.html' target='right'>File.php</a></dd>
<dd><a href='PICKLES/_classes---Form.php.html' target='right'>Form.php</a></dd>
<dd><a href='PICKLES/_jar.php.html' target='right'>jar.php</a></dd>
<dd><a href='PICKLES/_classes---Display---JSON.php.html' target='right'>JSON.php</a></dd>
<dd><a href='PICKLES/_classes---Log.php.html' target='right'>Log.php</a></dd>
<dd><a href='PICKLES/_classes---Model.php.html' target='right'>Model.php</a></dd>
<dd><a href='PICKLES/_classes---Module.php.html' target='right'>Module.php</a></dd>
<dd><a href='PICKLES/_classes---Database---Mongo.php.html' target='right'>Mongo.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---MySQL.php.html' target='right'>MySQL.php</a></dd>
<dd><a href='PICKLES/_classes---Object.php.html' target='right'>Object.php</a></dd>
<dd><a href='PICKLES/_classes---Display---PHP.php.html' target='right'>PHP.php</a></dd>
<dd><a href='PICKLES/_pickles.php.html' target='right'>pickles.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---PostgreSQL.php.html' target='right'>PostgreSQL.php</a></dd>
<dd><a href='PICKLES/_classes---API---Google---Profanity.php.html' target='right'>Profanity.php</a></dd>
<dd><a href='PICKLES/_classes---Profiler.php.html' target='right'>Profiler.php</a></dd>
<dd><a href='PICKLES/_classes---Display---RSS.php.html' target='right'>RSS.php</a></dd>
<dd><a href='PICKLES/_classes---Security.php.html' target='right'>Security.php</a></dd>
<dd><a href='PICKLES/_classes---Session.php.html' target='right'>Session.php</a></dd>
<dd><a href='PICKLES/_classes---Database---PDO---SQLite.php.html' target='right'>SQLite.php</a></dd>
<dd><a href='PICKLES/_classes---String.php.html' target='right'>String.php</a></dd>
<dd><a href='PICKLES/_classes---API---Tinychat.php.html' target='right'>Tinychat.php</a></dd>
<dd><a href='PICKLES/_classes---Display---XML.php.html' target='right'>XML.php</a></dd>

View file

@ -34,7 +34,7 @@ THE SOFTWARE.
</pre>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -61,7 +61,7 @@ Installation is quite simple as there is no installer to run, and all server con
</pre>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:40 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

View file

@ -10,6 +10,14 @@
<body>
<div align="center"><h1>Todo List</h1></div>
<h2>PICKLES</h2>
<h3><a href="PICKLES/API_Tinychat.html#methodgenerateHTML">API_Tinychat::generateHTML()</a></h3>
<ul>
<li>List params...</li>
</ul>
<h3><a href="PICKLES/Cache.html#methodincrement">Cache::increment()</a></h3>
<ul>
<li>Wondering if I should check the key and set to 1 if it's new</li>
</ul>
<h3><a href="PICKLES/Model.html#methodshuffle">Model::shuffle()</a></h3>
<ul>
<li>Implement this method</li>
@ -23,7 +31,7 @@
<li>Does not currently support &quot;indexed&quot; or &quot;list&quot; return types</li>
</ul>
<p class="notes" id="credit">
Documentation generated on Mon, 09 May 2011 22:14:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 06 Nov 2011 20:54:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</body>
</html>

246
jar.php
View file

@ -1608,122 +1608,6 @@ abstract class Database_Common extends Object
abstract public function close();
}
/**
* Mongo Class File for PICKLES
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2011, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link http://p.ickl.es
*/
/**
* Mongo Database Abstraction Layer
*
* This database class is still considered incomplete and very experimental.
*/
class Database_Mongo extends Database_Common
{
/**
* Driver
*
* @access protected
* @var string
*/
protected $driver = 'mongo';
/**
* Opens database connection
*
* Establishes a connection to the database based on the set configuration
* options.
*
* @return boolean true on success, throws an exception overwise
*/
public function open()
{
if ($this->connection === null)
{
// Assembles the server string
$server = 'mongodb://';
if (isset($this->username))
{
$server .= $this->username;
if (isset($this->password))
{
$server .= ':' . $this->password;
}
$server .= '@';
}
$server .= $this->hostname . ':' . $this->port . '/' . $this->database;
// Attempts to connect
try
{
$this->connection = new Mongo($server, array('persist' => 'pickles'));
// If we have database and collection, attempt to assign them
if (isset($this->database))
{
$this->connection = $this->connection->selectDB($this->database);
}
}
catch (Exception $exception)
{
throw new Exception('Unable to connect to Mongo database');
}
}
return true;
}
/**
* Closes database connection
*
* Sets the connection to null regardless of state.
*
* @return boolean always true
*/
public function close()
{
try
{
$this->connection->close();
}
catch (Exception $exception)
{
// Trapping error
}
$this->connection = null;
return true;
}
/**
* Fetch records from the database
*/
public function fetch($collection, $query = array(), $fields = array())
{
$this->open();
// Pulls the results based on the type
$results = $this->connection->$collection->find($query, $fields);
return $results;
}
}
/**
* PDO Class File for PICKLES
*
@ -2172,7 +2056,6 @@ class Database extends Object
// Checks the driver is legit and scrubs the name
switch ($datasource['driver'])
{
case 'mongo': $class = 'Mongo'; break;
case 'pdo_mysql': $class = 'PDO_MySQL'; break;
case 'pdo_pgsql': $class = 'PDO_PostgreSQL'; break;
case 'pdo_sqlite': $class = 'PDO_SQLite'; break;
@ -4038,7 +3921,7 @@ class Log
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2011, Josh Sherman
* @copyright Copyright 2007-2011, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link http://p.ickl.es
@ -4267,15 +4150,23 @@ class Model extends Object
*/
private $iterate = false;
/**
* Snapshot
*
* Snapshot of the object properties
*
* @access private
* @var array
*/
private $snapshot = array();
// }}}
// {{{ Class Constructor
/**
* Constructor
*
* Creates a new (empty) object or creates the record set from the passed
* arguments. The record and records arrays are populated as well as the
* count variable.
* Creates a new (empty) object or populates the record set.
*
* @param mixed $type_or_parameters optional type of query or parameters
* @param array $parameters optional data to create a query from
@ -4289,12 +4180,43 @@ class Model extends Object
// @todo Datasource has no way of being set
$this->db = Database::getInstance($this->datasource != '' ? $this->datasource : null);
$this->caching = $this->db->getCache();
if ($this->caching)
{
$this->cache = Cache::getInstance();
}
// Takes a snapshot of the [non-object] object properties
foreach ($this as $variable => $value)
{
if (!in_array($variable, array('db', 'cache', 'config', 'snapshot')))
{
$this->snapshot[$variable] = $value;
}
}
return $this->execute($type_or_parameters, $parameters);
}
// }}}
// {{{ Database Execution Methods
/**
* Execute
*
* Potentially populates the record set from the passed arguments.
*
* @param mixed $type_or_parameters optional type of query or parameters
* @param array $parameters optional data to create a query from
*/
public function execute($type_or_parameters = null, $parameters = null)
{
// Resets internal properties
foreach ($this->snapshot as $variable => $value)
{
$this->$variable = $value;
}
// Builds out the query
if ($type_or_parameters != null)
{
@ -4328,56 +4250,48 @@ class Model extends Object
$this->table = $this->collection;
}
// If we're using an RDBMS (not Mongo) proceed with using SQL to pull the data
if ($this->db->getDriver() != 'mongo')
// Starts with a basic SELECT ... FROM
$this->sql = array(
'SELECT ' . (is_array($this->fields) ? implode(', ', $this->fields) : $this->fields),
'FROM ' . $this->table,
);
switch ($type_or_parameters)
{
// Starts with a basic SELECT ... FROM
$this->sql = array(
'SELECT ' . (is_array($this->fields) ? implode(', ', $this->fields) : $this->fields),
'FROM ' . $this->table,
);
// Updates query to use COUNT syntax
case 'count':
$this->sql[0] = 'SELECT COUNT(*) AS count';
$this->generateQuery();
break;
switch ($type_or_parameters)
{
// Updates query to use COUNT syntax
case 'count':
$this->sql[0] = 'SELECT COUNT(*) AS count';
$this->generateQuery();
break;
// Adds the rest of the query
case 'all':
case 'list':
case 'indexed':
default:
$this->generateQuery();
break;
}
// Adds the rest of the query
case 'all':
case 'list':
case 'indexed':
default:
$this->generateQuery();
break;
}
$query_database = true;
$query_database = true;
if (isset($cache_key))
{
//$cached = $this->cache->get($cache_key);
}
if (isset($cache_key))
{
//$cached = $this->cache->get($cache_key);
}
if (isset($cached) && $cached)
{
$this->records = $cached;
}
else
{
$this->records = $this->db->fetch(implode(' ', $this->sql), (count($this->input_parameters) == 0 ? null : $this->input_parameters));
if (isset($cache_key))
{
//$this->cache->set($cache_key, $this->records);
}
}
if (isset($cached) && $cached)
{
$this->records = $cached;
}
else
{
throw new Exception('Sorry, Mongo support in the PICKLES Model is not quite ready yet');
$this->records = $this->db->fetch(implode(' ', $this->sql), (count($this->input_parameters) == 0 ? null : $this->input_parameters));
if (isset($cache_key))
{
//$this->cache->set($cache_key, $this->records);
}
}
$index_records = in_array($type_or_parameters, array('list', 'indexed'));
@ -4915,7 +4829,7 @@ class Model extends Object
if ($this->iterate == false)
{
$this->iterate = true;
// Resets the records, saves calling reset() when walking multiple times
$this->reset();
}
@ -4982,7 +4896,7 @@ class Model extends Object
{
$sql .= ' WHERE ' . $this->id . ' = :' . $this->id . ' LIMIT 1;';
$input_parameters[':' . $this->id] = $this->record[$this->id];
if ($this->caching)
{
//$this->cache->delete('PICKLES-' . $this->datasource . '-' . $this->table . '-' . $this->record[$this->id]);