Added generated documentation.
* I suppressed the vendor packages to save space (<500K versus 10MB)
This commit is contained in:
Josh Sherman
parent
62efd59e5e
commit
0cdd8e080a
41 changed files with 8079 additions and 3 deletions
243
docs/PICKLES/Config.html
Normal file
243
docs/PICKLES/Config.html
Normal file
|
|
@ -0,0 +1,243 @@
|
|||
<?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 Config</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 Config</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">Config Class</p>
|
||||
<p class="description"><p>Handles loading a configuration file and parsing the data for any public nodes that need to be made available to the viewer.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$config </span>= <span class="src-key">new </span><span class="src-id"><a href="../PICKLES/Config.html">Config</a></span><span class="src-sym">(</span><span class="src-var">$filename</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// $filename is optional, default = ../config.xml</span></div></li>
|
||||
</ol></div></li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Config.php.html">/classes/Config.php</a> (line <span class="field">27</span>)
|
||||
</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">object self::$instance</span>
|
||||
<a href="#getInstance" title="details" class="method-name">getInstance</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">Config</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">'../config.xml'</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#disabled" title="details" class="method-name">disabled</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#load" title="details" class="method-name">load</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$file</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#module" title="details" class="method-name">module</a>
|
||||
()
|
||||
</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="methodgetInstance" id="getInstance"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method getInstance</span> (line <span class="line-number">109</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Get instance of the object</p>
|
||||
<p class="description"><p>Instantiates a new object if one isn't already available, then returns the instance.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> instance of the Config</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">object self::$instance</span>
|
||||
<span class="method-name">
|
||||
getInstance
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">45</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>Calls the parent constructor and loads the pass file</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Config</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">'../config.xml'</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$file</span><span class="var-description">: Filename of the config file (optional)</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddisabled" id="disabled"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">disabled</span> (line <span class="line-number">126</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Gets status of site</p>
|
||||
<p class="description"><p>Checks the site->disabled variable for truth.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> whether or not the site is disabled</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
disabled
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodload" id="load"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">load</span> (line <span class="line-number">60</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Loads a configuration file</p>
|
||||
<p class="description"><p>Handles the potential loading of the configuration file and sanitizing the boolean strings into actual boolean values.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Success of the load process</li>
|
||||
<li><span class="field">todo:</span> Add the ability to load in multiple configuration files.</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
load
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$file</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$file</span><span class="var-description">: Filename of the XML file to be loaded</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodmodule" id="module"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">module</span> (line <span class="line-number">136</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Gets default module</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> default module or null</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
module
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
152
docs/PICKLES/Controller.html
Normal file
152
docs/PICKLES/Controller.html
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<?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 Controller</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 Controller</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">Controller Class</p>
|
||||
<p class="description"><p>The heavy lifter of PICKLES, makes the calls to get the session and configuration loaded. Loads modules, serves up user authentication when the module asks for it, and loads the viewer that the module requested. Default values are present to make things easier on the user.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-key">new </span><span class="src-id"><a href="../PICKLES/Controller.html">Controller</a></span><span class="src-sym">(</span><span class="src-var">$config</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||||
</ol></div></li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Controller.php.html">/classes/Controller.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Controller</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">Controller</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">36</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>To make life a bit easier when using PICKLES, the Controller logic is executed automatically via use of a constructor.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Controller</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>
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
379
docs/PICKLES/Database.html
Normal file
379
docs/PICKLES/Database.html
Normal file
|
|
@ -0,0 +1,379 @@
|
|||
<?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</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</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">Database Abstraction Layer for MySQL</p>
|
||||
<p class="description"><p>All database usage inside PICKLES-based sites should be done via the database object that is a part of every model ($this->db). Because the database object can execute raw SQL, there should be no limitations.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Database.php.html">/classes/Database.php</a> (line <span class="field">26</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Database</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">Database</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#close" title="details" class="method-name">close</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#execute" title="details" class="method-name">execute</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$sql</span>, [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#fetch" title="details" class="method-name">fetch</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$return_type</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#fetchAll" title="details" class="method-name">fetchAll</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#fetchColumn" title="details" class="method-name">fetchColumn</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#open" title="details" class="method-name">open</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">86</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">Database</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$hostname</span><span class="var-description">: optional hostname to connect to</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: optional username to use</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$password</span><span class="var-description">: optional password to use</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$database</span><span class="var-description">: optional database to connect to</span> </li>
|
||||
</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="methodclose" id="close"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">close</span> (line <span class="line-number">163</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Closes database connection</p>
|
||||
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> always true</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
close
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodexecute" id="execute"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">execute</span> (line <span class="line-number">180</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Executes an SQL Statement</p>
|
||||
<p class="description"><p>Executes a standard or prepared query based on passed parameters. All queries are logged to a file as well as timed and logged in the execution time is over 1 second.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> ID of the last inserted row or sequence number</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
execute
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$sql</span>, [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql</span><span class="var-description">: statement to execute</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodfetch" id="fetch"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">fetch</span> (line <span class="line-number">234</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Fetch a single row from the database</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> based on return type</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
fetch
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$return_type</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$return_type</span><span class="var-description">: optional type of return set</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodfetchAll" id="fetchAll"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">fetchAll</span> (line <span class="line-number">283</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Fetches all rows as an array</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
fetchAll
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodfetchColumn" id="fetchColumn"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">fetchColumn</span> (line <span class="line-number">271</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Fetch a single column from the database</p>
|
||||
<p class="description"><p>This method assumes you want the first column in your select. If you need 2 or more columns you should simply use fetch()</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
fetchColumn
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodopen" id="open"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">open</span> (line <span class="line-number">125</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Opens database connection</p>
|
||||
<p class="description"><p>Establishes a connection to the MySQL database based on the configuration options that are available in the Config object.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
open
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
370
docs/PICKLES/Display_Common.html
Normal file
370
docs/PICKLES/Display_Common.html
Normal file
|
|
@ -0,0 +1,370 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Display_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 Display_Common</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-descendents">Descendents</a>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Common Display Class</p>
|
||||
<p class="description"><p>This is the class that each viewer class should be extending from.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">abstract:</span> </li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Display---Common.php.html">/classes/Display/Common.php</a> (line <span class="field">25</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Display_Common</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-descendents"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Direct descendents</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Descendents</span>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Display_JSON.html">Display_JSON</a></td>
|
||||
<td>
|
||||
JSON Display
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Display_RSS.html">Display_RSS</a></td>
|
||||
<td>
|
||||
RSS Display
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Display_PHP.html">Display_PHP</a></td>
|
||||
<td>
|
||||
PHP Display
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Display_Smarty.html">Display_Smarty</a></td>
|
||||
<td>
|
||||
Smarty Display
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<a href="#$module_return" title="details" class="var-name">$module_return</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$template" title="details" class="var-name">$template</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">Display_Common</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$template</span>, <span class="var-type"></span> <span class="var-name">$module_return</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#prepare" title="details" class="method-name">prepare</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="var$module_return" id="$module_return"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$module_return</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Module Return Data</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$template" id="$template"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$template</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Template</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">48</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>Runs the parent's constructor and adds the module to the object.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Display_Common</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$template</span>, <span class="var-type"></span> <span class="var-name">$module_return</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$template</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$module_return</span> </li>
|
||||
</ul>
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<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/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodprepare" id="prepare"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">prepare</span> (line <span class="line-number">83</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Preparation for display</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">
|
||||
prepare
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefined in descendants as:</div>
|
||||
<ul class="redefinitions">
|
||||
<li>
|
||||
<a href="../PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">render</span> (line <span class="line-number">78</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Abstract rendering function that is overloaded within the loaded viewer</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">abstract:</span> </li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefined in descendants as:</div>
|
||||
<ul class="redefinitions">
|
||||
<li>
|
||||
<a href="../PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a>
|
||||
: Renders the data in JSON format
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a>
|
||||
: Render the RSS feed data
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a>
|
||||
: Renders the PHP templated pages
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Display_Smarty.html#methodrender">Display_Smarty::render()</a>
|
||||
: Render the Smarty generated pages
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
170
docs/PICKLES/Display_JSON.html
Normal file
170
docs/PICKLES/Display_JSON.html
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Display_JSON</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name">Class Display_JSON</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">JSON Display</p>
|
||||
<p class="description"><p>Displays data in JavaScript Object Notation. Requires PHP 5 >= 5.2.0 or PECL json 1.2.0 or 1.2.1</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">link:</span> <a href="http://pecl.php.net/package/json">http://pecl.php.net/package/json</a></li>
|
||||
<li><span class="field">link:</span> <a href="http://us.php.net/json_encode">http://us.php.net/json_encode</a></li>
|
||||
<li><span class="field">link:</span> <a href="http://json.org/">http://json.org/</a></li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Display---JSON.php.html">/classes/Display/JSON.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
||||
|
|
||||
--Display_JSON</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
|
||||
</span>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">render</span> (line <span class="line-number">33</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Renders the data in JSON format</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">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
|
||||
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</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>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
199
docs/PICKLES/Display_PHP.html
Normal file
199
docs/PICKLES/Display_PHP.html
Normal file
|
|
@ -0,0 +1,199 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Display_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="class-name">Class Display_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-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">PHP Display</p>
|
||||
<p class="description"><p>Displays the associated PHP templates for the Model. This is very similar to the Smarty viewer, but less overhead since it's straight PHP. The PHP viewer also utilizes a different caching system than Smarty. The general rules around the caching will be the same though.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Display---PHP.php.html">/classes/Display/PHP.php</a> (line <span class="field">27</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
||||
|
|
||||
--Display_PHP</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#prepare" title="details" class="method-name">prepare</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
|
||||
</span>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-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="methodprepare" id="prepare"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">prepare</span> (line <span class="line-number">29</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
prepare
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></dt>
|
||||
<dd>Preparation for display</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">render</span> (line <span class="line-number">47</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Renders the PHP templated pages</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">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
|
||||
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</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>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
171
docs/PICKLES/Display_RSS.html
Normal file
171
docs/PICKLES/Display_RSS.html
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Display_RSS</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name">Class Display_RSS</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">RSS Display</p>
|
||||
<p class="description"><p>Displays data in RSS version 2.0 format.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">link:</span> <a href="http://cyber.law.harvard.edu/rss/rss.html">http://cyber.law.harvard.edu/rss/rss.html</a></li>
|
||||
<li><span class="field">todo:</span> Need to add support for RSS v1.0 as well as ATOM feeds. This may result in my abstracting out these classes a bit more (Probably a Feed viewer that would take a parameter to determine which type of of feed to use).</li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Display---RSS.php.html">/classes/Display/RSS.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
||||
|
|
||||
--Display_RSS</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
|
||||
</span>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">render</span> (line <span class="line-number">39</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the RSS feed data</p>
|
||||
<p class="description"><p>Uses a combination of configuration options and a properly formatted data array to create an RSS v2.0 feed.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">todo:</span> Error handling is non-existant.</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
|
||||
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</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>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
272
docs/PICKLES/Display_Smarty.html
Normal file
272
docs/PICKLES/Display_Smarty.html
Normal file
|
|
@ -0,0 +1,272 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Display_Smarty</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name">Class Display_Smarty</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">Smarty Display</p>
|
||||
<p class="description"><p>Displays the associated Smarty templates for the Module.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">link:</span> <a href="http://smarty.net/">http://smarty.net/</a></li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Display---Smarty.php.html">/classes/Display/Smarty.php</a> (line <span class="field">25</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
||||
|
|
||||
--Display_Smarty</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">Display_Smarty</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span> <span class="var-name">$config</span>, <span class="var-type"></span> <span class="var-name">$error</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#getSmartyObject" title="details" class="method-name">getSmartyObject</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#prepare" title="details" class="method-name">prepare</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a></span><br>
|
||||
</span>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Display_Common.html#var$template">Display_Common::$template</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-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">29</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Display_Smarty</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span> <span class="var-name">$config</span>, <span class="var-type"></span> <span class="var-name">$error</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../PICKLES/Config.html">Config</a></span>
|
||||
<span class="var-name">$config</span> </li>
|
||||
<li>
|
||||
<span class="var-type">Error</span>
|
||||
<span class="var-name">$error</span> </li>
|
||||
</ul>
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></dt>
|
||||
<dd>Constructor</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<a name="methodgetSmartyObject" id="getSmartyObject"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getSmartyObject</span> (line <span class="line-number">164</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
getSmartyObject
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodprepare" id="prepare"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">prepare</span> (line <span class="line-number">47</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
prepare
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></dt>
|
||||
<dd>Preparation for display</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">render</span> (line <span class="line-number">82</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the Smarty generated pages</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">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefinition of:</div>
|
||||
<dl>
|
||||
<dt><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</a></dt>
|
||||
<dd>Abstract rendering function that is overloaded within the loaded viewer</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Display_Common.html">Display_Common</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a></span><br>
|
||||
<span class="method-name"><a href="../PICKLES/Display_Common.html#methodrender">Display_Common::render()</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>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
151
docs/PICKLES/Logger.html
Normal file
151
docs/PICKLES/Logger.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Logger</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name">Class Logger</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logger Class</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Logger.php.html">/classes/Logger.php</a> (line <span class="field">21</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Logger</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
static <span class="method-result">void</span>
|
||||
<a href="#write" title="details" class="method-name">write</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$class</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-vars">Vars</a>
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodwrite" id="write"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method write</span> (line <span class="line-number">23</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
write
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$class</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$message</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$class</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
646
docs/PICKLES/Model.html
Normal file
646
docs/PICKLES/Model.html
Normal file
|
|
@ -0,0 +1,646 @@
|
|||
<?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 Model</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 Model</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">Model Class</p>
|
||||
<p class="description"><p>This is a parent class that all PICKLES data models should be extending. The only thing it does currently is establish a database object for the data models to use.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Model.php.html">/classes/Model.php</a> (line <span class="field">25</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Model</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">mixed</span>
|
||||
<a href="#$columns" title="details" class="var-name">$columns</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">integer</span>
|
||||
<a href="#$count" title="details" class="var-name">$count</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<a href="#$data" title="details" class="var-name">$data</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">mixed</span>
|
||||
<a href="#$order_by" title="details" class="var-name">$order_by</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<a href="#$record" title="details" class="var-name">$record</a>
|
||||
</div>
|
||||
<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">string</span>
|
||||
<a href="#$table" title="details" class="var-name">$table</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">Model</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
([<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">boolean</span> <span class="var-name">$return_data</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#commit" title="details" class="method-name">commit</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#commitRecord" title="details" class="method-name">commitRecord</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#delete" title="details" class="method-name">delete</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#next" title="details" class="method-name">next</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#prev" title="details" class="method-name">prev</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#unescape" title="details" class="method-name">unescape</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#__get" title="details" class="method-name">__get</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#__set" title="details" class="method-name">__set</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$variable</span>, <span class="var-type">mixed</span> <span class="var-name">$value</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">
|
||||
<a name="var$columns" id="$columns"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$columns</span>
|
||||
= <span class="var-default"> '*'</span> (line <span class="line-number">49</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Column List</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> string | array</li>
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$count" id="$count"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$count</span>
|
||||
= <span class="var-default"> 0</span> (line <span class="line-number">89</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Record Count</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$data" id="$data"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$data</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">65</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Data</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">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Database</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$order_by" id="$order_by"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$order_by</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">57</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Order By Clause</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> string | array</li>
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$record" id="$record"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$record</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">73</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Record Array</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$records" id="$records"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$records</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">81</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Records Array</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$table" id="$table"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$table</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Table Name</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</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="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>Creates a new (empty) object or creates the record set from the passed parameters. The record and records arrays are populated as well as the count variable.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Model</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
([<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">null</span>], <span class="var-type">boolean</span> <span class="var-name">$return_data</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$data</span><span class="var-description">: optional key/values for the WHERE cause</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$return_data</span><span class="var-description">: currently not in use</span> </li>
|
||||
</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="methodcommit" id="commit"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">commit</span> (line <span class="line-number">340</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Commit</p>
|
||||
<p class="description"><p>Commits the record to the database. Intelligently does an UPDATE or INSERT INTO.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> results of the query</li>
|
||||
<li><span class="field">deprecated:</span> Deprecated is commitRecord() is even implemented</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
commit
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodcommitRecord" id="commitRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">commitRecord</span> (line <span class="line-number">233</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Commit Record</p>
|
||||
<p class="description"><p>Commits a record to the database. Intelligently does an UPDATE or INSERT INTO.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> results of the query</li>
|
||||
<li><span class="field">todo:</span> This will replace commit() eventually will add commitAll();</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
commitRecord
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddelete" id="delete"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">delete</span> (line <span class="line-number">275</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Delete Record</p>
|
||||
<p class="description"><p>Deletes the current record from the database</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> status of the query</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>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnext" id="next"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">next</span> (line <span class="line-number">209</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Next Record</p>
|
||||
<p class="description"><p>Increment the record array to the next member of the record set.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
next
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodprev" id="prev"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">prev</span> (line <span class="line-number">219</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Previous Record</p>
|
||||
<p class="description"><p>Decrement the record array to the next member of the record set.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
prev
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodunescape" id="unescape"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">unescape</span> (line <span class="line-number">384</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Unescape String</p>
|
||||
<p class="description"><p>Assuming magic quotes is turned on, strips slashes from the string</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> unescaped string</li>
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
unescape
|
||||
</span>
|
||||
(<span class="var-type">string</span> <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">: string to be unescaped</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method__get" id="__get"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">__get</span> (line <span class="line-number">293</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Magic Getter</p>
|
||||
<p class="description"><p>Overrides the built in PHP getter and checks our data variable for the variable or returns false. The data array is loaded via the magic setter.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> requested variable, the entire data array or false</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
__get
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$variable</span><span class="var-description">: name of the variable</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method__set" id="__set"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">__set</span> (line <span class="line-number">318</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Magic Setter</p>
|
||||
<p class="description"><p>Overrides the built in PHP setter so that we can assign variables to our private data array (avoids conflicts with the object variables).</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
__set
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$variable</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$variable</span><span class="var-description">: name of the variable</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: value for the variable</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
411
docs/PICKLES/Module.html
Normal file
411
docs/PICKLES/Module.html
Normal file
|
|
@ -0,0 +1,411 @@
|
|||
<?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 Module</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 Module</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">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">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../PICKLES/Object.html">Object</a>
|
||||
|
|
||||
--Module</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">boolean</span>
|
||||
<a href="#$access" title="details" class="var-name">$access</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<a href="#$ajax" title="details" class="var-name">$ajax</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$description" title="details" class="var-name">$description</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$engine" title="details" class="var-name">$engine</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$keywords" title="details" class="var-name">$keywords</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">boolean</span>
|
||||
<a href="#$secure" title="details" class="var-name">$secure</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$template" title="details" class="var-name">$template</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$title" title="details" class="var-name">$title</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">Module</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
([<span class="var-type">boolean</span> <span class="var-name">$autorun</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#__default" title="details" class="method-name">__default</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$access" id="$access"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$access</span>
|
||||
= <span class="var-default"> false</span> (line <span class="line-number">59</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Access level of the page</p>
|
||||
<p class="description"><p>Defaults to false which is everybody, even anonymous</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$ajax" id="$ajax"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$ajax</span>
|
||||
= <span class="var-default"> false</span> (line <span class="line-number">79</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">AJAX</p>
|
||||
<p class="description"><p>Whether or not the page must be loaded via AJAX and if so, what pages are allowed to access it and the request method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$description" id="$description"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$description</span>
|
||||
(line <span class="line-number">43</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Meta description</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$engine" id="$engine"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<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">88</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Default display engine</p>
|
||||
<p class="description"><p>Defaults to PHP but could be set to Smarty, JSON, XML or RSS.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$keywords" id="$keywords"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$keywords</span>
|
||||
(line <span class="line-number">50</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Meta keywords (comma separated)</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$secure" id="$secure"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$secure</span>
|
||||
= <span class="var-default"> false</span> (line <span class="line-number">69</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Secure</p>
|
||||
<p class="description"><p>Whether or not the page should be loaded via SSL. Not currently being used. Defaults to false, non-SSL.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$template" id="$template"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$template</span>
|
||||
= <span class="var-default"> 'index'</span> (line <span class="line-number">98</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Default template</p>
|
||||
<p class="description"><p>Defaults to 'index' but could be set to any valid template basename. The display engine determines what the file extension should be.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$title" id="$title"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$title</span>
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Page title</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
||||
</span>
|
||||
</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="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">111</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>The constructor does nothing by default but can be passed a boolean variable to tell it to automatically run the __default() method. This is typically used when a module is called outside of the scope of the controller (the registration page calls the login page in this manner.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Module</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
([<span class="var-type">boolean</span> <span class="var-name">$autorun</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$autorun</span><span class="var-description">: optional flag to autorun __default()</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__default" id="__default"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">__default</span> (line <span class="line-number">130</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Default "Magic" Method</p>
|
||||
<p class="description"><p>This function is overloaded by the module. The __default() method is where you want to place any code that needs to be executed at runtime. The reason the code isn't in the constructor is because the module must be instantiated before the code is executed so that the controller script is aware of the authentication requirements.</p></p>
|
||||
<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">
|
||||
__default
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
256
docs/PICKLES/Object.html
Normal file
256
docs/PICKLES/Object.html
Normal file
|
|
@ -0,0 +1,256 @@
|
|||
<?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 Object</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 Object</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-descendents">Descendents</a>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Object Class</p>
|
||||
<p class="description"><p>Every non-Singleton-based class needs to extend this class. Any models will extend the Model class which entends the Object class already. This class handles getting an instance of the Config object so that it's available. Also provides a getter and setter for variables.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">todo:</span> Implement a profiler in every object</li>
|
||||
</ul>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_classes---Object.php.html">/classes/Object.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-descendents"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Direct descendents</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Descendents</span>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Display_Common.html">Display_Common</a></td>
|
||||
<td>
|
||||
Common Display Class
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Logger.html">Logger</a></td>
|
||||
<td>
|
||||
Logger 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/Module.html">Module</a></td>
|
||||
<td>
|
||||
Module Class
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Model.html">Model</a></td>
|
||||
<td>
|
||||
Model Class
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../PICKLES/Database.html">Database</a></td>
|
||||
<td>
|
||||
Database Abstraction Layer for MySQL
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<span class="var-type">object</span>
|
||||
<a href="#$config" title="details" class="var-name">$config</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">Object</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="var$config" id="$config"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<span class="var-title">
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$config</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Instance of the Config object</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">44</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<p class="description"><p>Establishes a Config instance for all children to enjoy</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">Object</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<hr class="separator" />
|
||||
<div class="notes">Redefined in descendants as:</div>
|
||||
<ul class="redefinitions">
|
||||
<li>
|
||||
<a href="../PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a>
|
||||
: Constructor
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Controller.html#method__construct">Controller::__construct()</a>
|
||||
: Constructor
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Module.html#method__construct">Module::__construct()</a>
|
||||
: Constructor
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Model.html#method__construct">Model::__construct()</a>
|
||||
: Constructor
|
||||
</li>
|
||||
<li>
|
||||
<a href="../PICKLES/Database.html#method__construct">Database::__construct()</a>
|
||||
: Constructor
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
69
docs/PICKLES/_classes---Config.php.html
Normal file
69
docs/PICKLES/_classes---Config.php.html
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
<?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 Config.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/Config.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">Configuration Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">todo:</span> Add support for .php and .ini config files (auto scan directory?)</li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</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/Config.html">Config</a>
|
||||
</td>
|
||||
<td>
|
||||
Config Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Controller.php.html
Normal file
68
docs/PICKLES/_classes---Controller.php.html
Normal 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 Controller.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/Controller.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">Single Entry Controller</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Controller.html">Controller</a>
|
||||
</td>
|
||||
<td>
|
||||
Controller Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Database.php.html
Normal file
68
docs/PICKLES/_classes---Database.php.html
Normal 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 Database.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.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">Database Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Database.html">Database</a>
|
||||
</td>
|
||||
<td>
|
||||
Database Abstraction Layer for MySQL
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Display---Common.php.html
Normal file
68
docs/PICKLES/_classes---Display---Common.php.html
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page Common.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Display/Common.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Common Display Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Display_Common.html">Display_Common</a>
|
||||
</td>
|
||||
<td>
|
||||
Common Display Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Display---JSON.php.html
Normal file
68
docs/PICKLES/_classes---Display---JSON.php.html
Normal 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 JSON.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Display/JSON.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">JSON Display Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Display_JSON.html">Display_JSON</a>
|
||||
</td>
|
||||
<td>
|
||||
JSON Display
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Display---PHP.php.html
Normal file
68
docs/PICKLES/_classes---Display---PHP.php.html
Normal 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 PHP.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Display/PHP.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">PHP Display Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Display_PHP.html">Display_PHP</a>
|
||||
</td>
|
||||
<td>
|
||||
PHP Display
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Display---RSS.php.html
Normal file
68
docs/PICKLES/_classes---Display---RSS.php.html
Normal 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 RSS.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Display/RSS.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">RSS Display Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Display_RSS.html">Display_RSS</a>
|
||||
</td>
|
||||
<td>
|
||||
RSS Display
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Display---Smarty.php.html
Normal file
68
docs/PICKLES/_classes---Display---Smarty.php.html
Normal 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 Smarty.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Display/Smarty.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">Smarty Display Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Display_Smarty.html">Display_Smarty</a>
|
||||
</td>
|
||||
<td>
|
||||
Smarty Display
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Logger.php.html
Normal file
68
docs/PICKLES/_classes---Logger.php.html
Normal 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 Logger.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name">/classes/Logger.php</h2>
|
||||
|
||||
<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">Logger Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Logger.html">Logger</a>
|
||||
</td>
|
||||
<td>
|
||||
Logger Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Model.php.html
Normal file
68
docs/PICKLES/_classes---Model.php.html
Normal 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 Model.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/Model.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">Model Parent Class for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Model.html">Model</a>
|
||||
</td>
|
||||
<td>
|
||||
Model Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Module.php.html
Normal file
68
docs/PICKLES/_classes---Module.php.html
Normal 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 Module.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/Module.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">Module Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Module.html">Module</a>
|
||||
</td>
|
||||
<td>
|
||||
Module Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/PICKLES/_classes---Object.php.html
Normal file
68
docs/PICKLES/_classes---Object.php.html
Normal 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 Object.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/Object.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">Object Class File for PICKLES</p>
|
||||
<p class="description"><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../PICKLES/Object.html">Object</a>
|
||||
</td>
|
||||
<td>
|
||||
Object Class
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
239
docs/PICKLES/_pickles.php.html
Normal file
239
docs/PICKLES/_pickles.php.html
Normal file
|
|
@ -0,0 +1,239 @@
|
|||
<?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 pickles.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">/pickles.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-constants">Constants</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Core PICKLES Include File</p>
|
||||
<p class="description"><p>This is the file that you include on the page you're instantiating the controller from (typically index.php). The path to the PICKLES code base is established as well as the path that Smarty will use to store the compiled pages.</p><p>PHP version 5</p><p>Licensed under the GNU General Public License Version 3 Redistribution of these files must retain the above copyright notice.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once </span><span class="src-str">'pickles.php'</span><span class="src-sym">;</span></div></li>
|
||||
</ol></div></li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">GPL v3</a></li>
|
||||
</ul>
|
||||
|
||||
</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-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineDISPLAY_JSON"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineDISPLAY_PHP"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
|
||||
(line <span class="line-number">40</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineDISPLAY_RSS"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
|
||||
(line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineDISPLAY_SMARTY"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">DISPLAY_SMARTY</span> = 'Smarty'
|
||||
(line <span class="line-number">42</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineDISPLAY_XML"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">DISPLAY_XML</span> = 'XML'
|
||||
(line <span class="line-number">43</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineLOG_PATH"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">LOG_PATH</span> = VAR_PATH.'logs/'
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="definePICKLES_PATH"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">PICKLES_PATH</span> = dirname(__FILE__).'/'
|
||||
(line <span class="line-number">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineSITE_PATH"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">SITE_PATH</span> = getcwd().'/'
|
||||
(line <span class="line-number">32</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineSMARTY_PATH"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">SMARTY_PATH</span> = VAR_PATH.'smarty/'
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineVAR_PATH"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">VAR_PATH</span> = PICKLES_PATH.'var/'.$_SERVER['SERVER_NAME'].'/'
|
||||
(line <span class="line-number">34</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</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>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="method-title">__autoload</span> (line <span class="line-number">54</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Magic function to automatically load classes</p>
|
||||
<p class="description"><p>Determines if the system needs to load a PICKLES core class or a PICKLES shared module (not to be confused with site level modules).</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Return value of require_once() or false (default)</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
__autoload
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$class</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 be loaded</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
43
docs/PICKLES/_scripts---pickle.php.html
Normal file
43
docs/PICKLES/_scripts---pickle.php.html
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
<?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 pickle.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">/scripts/pickle.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">PICKLES Scaffolding Generator (verb: to pickle)</p>
|
||||
<p class="description"><p>This is the file that you include on the page you're instantiating the controller from (typically index.php). The path to the PICKLES code base is established as well as the path that Smarty will use to store the compiled pages.</p><p>PICKLES is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>PICKLES is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p><p>You should have received a copy of the GNU Lesser General Public License along with PICKLES. If not, see <http://www.gnu.org/licenses/>.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Joshua John Sherman <<a href="mailto:josh@phpwithpickles.org">josh@phpwithpickles.org</a>></li>
|
||||
<li><span class="field">copyright:</span> Copyright 2007, 2008, 2009 Joshua John Sherman</li>
|
||||
<li><span class="field">link:</span> <a href="http://phpwithpickles.org">http://phpwithpickles.org</a></li>
|
||||
<li><span class="field">usage:</span> ./pickle /path/to/new/site</li>
|
||||
<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">http://www.gnu.org/copyleft/lesser.html</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
To keep the download small, documentation is not included.
|
||||
|
||||
You can use scripts/docs/generate.sh to generate the appropriate documentation.
|
||||
13
docs/blank.html
Normal file
13
docs/blank.html
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>PHP Interface Collection of Killer Libraries to Enhance Stuff</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div align="center"><h1>PHP Interface Collection of Killer Libraries to Enhance Stuff</h1></div>
|
||||
<b>Welcome to PICKLES!</b><br />
|
||||
<br />
|
||||
This documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor v1.4.2</a><br />
|
||||
</body>
|
||||
</html>
|
||||
32
docs/classtrees_PICKLES.html
Normal file
32
docs/classtrees_PICKLES.html
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<!-- Start of Class Data -->
|
||||
<H2>
|
||||
|
||||
</H2>
|
||||
<h2>Root class Config</h2>
|
||||
<ul>
|
||||
<li><a href="PICKLES/Config.html">Config</a></li></ul>
|
||||
|
||||
<h2>Root class Object</h2>
|
||||
<ul>
|
||||
<li><a href="PICKLES/Object.html">Object</a><ul>
|
||||
<li><a href="PICKLES/Controller.html">Controller</a></li><li><a href="PICKLES/Database.html">Database</a></li><li><a href="PICKLES/Display_Common.html">Display_Common</a><ul>
|
||||
<li><a href="PICKLES/Display_JSON.html">Display_JSON</a></li><li><a href="PICKLES/Display_PHP.html">Display_PHP</a></li><li><a href="PICKLES/Display_RSS.html">Display_RSS</a></li><li><a href="PICKLES/Display_Smarty.html">Display_Smarty</a></li></ul></li>
|
||||
<li><a href="PICKLES/Logger.html">Logger</a></li><li><a href="PICKLES/Model.html">Model</a></li><li><a href="PICKLES/Module.html">Module</a></li></ul></li>
|
||||
</ul>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
846
docs/elementindex.html
Normal file
846
docs/elementindex.html
Normal file
|
|
@ -0,0 +1,846 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a name="top"></a>
|
||||
<h2>Full index</h2>
|
||||
<h3>Package indexes</h3>
|
||||
<ul>
|
||||
<li><a href="elementindex_PICKLES.html">PICKLES</a></li>
|
||||
</ul>
|
||||
<br />
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex.html#e">e</a>
|
||||
<a class="index-letter" href="elementindex.html#f">f</a>
|
||||
<a class="index-letter" href="elementindex.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex.html#j">j</a>
|
||||
<a class="index-letter" href="elementindex.html#k">k</a>
|
||||
<a class="index-letter" href="elementindex.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex.html#p">p</a>
|
||||
<a class="index-letter" href="elementindex.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex.html#u">u</a>
|
||||
<a class="index-letter" href="elementindex.html#v">v</a>
|
||||
<a class="index-letter" href="elementindex.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex.html#_">_</a>
|
||||
</div>
|
||||
|
||||
<a name="a"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">a</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$access</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$access">Module::$access</a> in Module.php</div>
|
||||
<div class="index-item-description">Access level of the page</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$ajax</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$ajax">Module::$ajax</a> in Module.php</div>
|
||||
<div class="index-item-description">AJAX</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="c"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">c</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$columns</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$columns">Model::$columns</a> in Model.php</div>
|
||||
<div class="index-item-description">Column List</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$config</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html#var$config">Object::$config</a> in Object.php</div>
|
||||
<div class="index-item-description">Instance of the Config object</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$count</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$count">Model::$count</a> in Model.php</div>
|
||||
<div class="index-item-description">Record Count</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Config.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Config.php.html">Config.php</a> in Config.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Controller.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Controller.php.html">Controller.php</a> in Controller.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Common.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">close</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodclose">Database::close()</a> in Database.php</div>
|
||||
<div class="index-item-description">Closes database connection</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">commit</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommit">Model::commit()</a> in Model.php</div>
|
||||
<div class="index-item-description">Commit</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">commitRecord</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a> in Model.php</div>
|
||||
<div class="index-item-description">Commit Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Config
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html">Config</a> in Config.php</div>
|
||||
<div class="index-item-description">Config Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Controller
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Controller.html">Controller</a> in Controller.php</div>
|
||||
<div class="index-item-description">Controller Class</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="d"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">d</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$data</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$data">Model::$data</a> in Model.php</div>
|
||||
<div class="index-item-description">Data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$db</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$db">Model::$db</a> in Model.php</div>
|
||||
<div class="index-item-description">Database</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$description</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$description">Module::$description</a> in Module.php</div>
|
||||
<div class="index-item-description">Meta description</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Database.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Database.php.html">Database.php</a> in Database.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Database
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html">Database</a> in Database.php</div>
|
||||
<div class="index-item-description">Database Abstraction Layer for MySQL</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">delete</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methoddelete">Model::delete()</a> in Model.php</div>
|
||||
<div class="index-item-description">Delete Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">disabled</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methoddisabled">Config::disabled()</a> in Config.php</div>
|
||||
<div class="index-item-description">Gets status of site</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_Common
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html">Display_Common</a> in Common.php</div>
|
||||
<div class="index-item-description">Common Display Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_JSON</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_JSON
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
|
||||
<div class="index-item-description">JSON Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_PHP</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_PHP">DISPLAY_PHP</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_PHP
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
|
||||
<div class="index-item-description">PHP Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_RSS
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_RSS.html">Display_RSS</a> in RSS.php</div>
|
||||
<div class="index-item-description">RSS Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_RSS</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_SMARTY</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_SMARTY">DISPLAY_SMARTY</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_Smarty
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
|
||||
<div class="index-item-description">Smarty Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_XML</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="e"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">e</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$engine</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$engine">Module::$engine</a> in Module.php</div>
|
||||
<div class="index-item-description">Default display engine</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">execute</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodexecute">Database::execute()</a> in Database.php</div>
|
||||
<div class="index-item-description">Executes an SQL Statement</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="f"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">f</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetch</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetch">Database::fetch()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetch a single row from the database</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetchAll</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchAll">Database::fetchAll()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetches all rows as an array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetchColumn</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetch a single column from the database</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="g"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">g</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">getInstance</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
|
||||
<div class="index-item-description">Get instance of the object</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getSmartyObject</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodgetSmartyObject">Display_Smarty::getSmartyObject()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="j"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">j</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">JSON.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---JSON.php.html">JSON.php</a> in JSON.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="k"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">k</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$keywords</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$keywords">Module::$keywords</a> in Module.php</div>
|
||||
<div class="index-item-description">Meta keywords (comma separated)</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="l"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">l</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">Logger.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Logger.php.html">Logger.php</a> in Logger.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">load</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodload">Config::load()</a> in Config.php</div>
|
||||
<div class="index-item-description">Loads a configuration file</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Logger
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Logger.html">Logger</a> in Logger.php</div>
|
||||
<div class="index-item-description">Logger Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">LOG_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineLOG_PATH">LOG_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="m"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">m</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$module_return</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a> in Common.php</div>
|
||||
<div class="index-item-description">Module Return Data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Model.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Model.php.html">Model.php</a> in Model.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Module.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Module.php.html">Module.php</a> in Module.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Model
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
|
||||
<div class="index-item-description">Model Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Module
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html">Module</a> in Module.php</div>
|
||||
<div class="index-item-description">Module Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">module</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodmodule">Config::module()</a> in Config.php</div>
|
||||
<div class="index-item-description">Gets default module</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="n"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">n</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">next</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodnext">Model::next()</a> in Model.php</div>
|
||||
<div class="index-item-description">Next Record</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="o"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">o</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$order_by</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$order_by">Model::$order_by</a> in Model.php</div>
|
||||
<div class="index-item-description">Order By Clause</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Object.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Object.php.html">Object.php</a> in Object.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Object
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html">Object</a> in Object.php</div>
|
||||
<div class="index-item-description">Object Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">open</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodopen">Database::open()</a> in Database.php</div>
|
||||
<div class="index-item-description">Opens database connection</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="p"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">p</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">PHP.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---PHP.php.html">PHP.php</a> in PHP.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">pickles.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html">pickles.php</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">PICKLES_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#definePICKLES_PATH">PICKLES_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a> in PHP.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a> in Common.php</div>
|
||||
<div class="index-item-description">Preparation for display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prev</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodprev">Model::prev()</a> in Model.php</div>
|
||||
<div class="index-item-description">Previous Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">pickle.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_scripts---pickle.php.html">pickle.php</a> in pickle.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="r"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">r</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$record</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$record">Model::$record</a> in Model.php</div>
|
||||
<div class="index-item-description">Record Array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$records</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$records">Model::$records</a> in Model.php</div>
|
||||
<div class="index-item-description">Records Array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">RSS.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---RSS.php.html">RSS.php</a> in RSS.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a> in RSS.php</div>
|
||||
<div class="index-item-description">Render the RSS feed data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodrender">Display_Smarty::render()</a> in Smarty.php</div>
|
||||
<div class="index-item-description">Render the Smarty generated pages</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
|
||||
<div class="index-item-description">Renders the PHP templated pages</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
|
||||
<div class="index-item-description">Abstract rendering function that is overloaded within the loaded viewer</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
|
||||
<div class="index-item-description">Renders the data in JSON format</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="s"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">s</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$secure</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$secure">Module::$secure</a> in Module.php</div>
|
||||
<div class="index-item-description">Secure</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Smarty.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---Smarty.php.html">Smarty.php</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">SITE_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">SMARTY_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSMARTY_PATH">SMARTY_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="t"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">t</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$table</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$table">Model::$table</a> in Model.php</div>
|
||||
<div class="index-item-description">Table Name</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$template</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$template">Display_Common::$template</a> in Common.php</div>
|
||||
<div class="index-item-description">Template</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$template</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$template">Module::$template</a> in Module.php</div>
|
||||
<div class="index-item-description">Default template</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$title</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$title">Module::$title</a> in Module.php</div>
|
||||
<div class="index-item-description">Page title</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="u"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">u</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">unescape</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodunescape">Model::unescape()</a> in Model.php</div>
|
||||
<div class="index-item-description">Unescape String</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="v"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">v</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="const-title">VAR_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineVAR_PATH">VAR_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="w"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">w</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">write</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Logger.html#methodwrite">Logger::write()</a> in Logger.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="_"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">_</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">__autoload</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#function__autoload">__autoload()</a> in pickles.php</div>
|
||||
<div class="index-item-description">Magic function to automatically load classes</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#method__construct">Config::__construct()</a> in Config.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__default</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#method__default">Module::__default()</a> in Module.php</div>
|
||||
<div class="index-item-description">Default "Magic" Method</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__get</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__get">Model::__get()</a> in Model.php</div>
|
||||
<div class="index-item-description">Magic Getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__set</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__set">Model::__set()</a> in Model.php</div>
|
||||
<div class="index-item-description">Magic Setter</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex.html#e">e</a>
|
||||
<a class="index-letter" href="elementindex.html#f">f</a>
|
||||
<a class="index-letter" href="elementindex.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex.html#j">j</a>
|
||||
<a class="index-letter" href="elementindex.html#k">k</a>
|
||||
<a class="index-letter" href="elementindex.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex.html#p">p</a>
|
||||
<a class="index-letter" href="elementindex.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex.html#u">u</a>
|
||||
<a class="index-letter" href="elementindex.html#v">v</a>
|
||||
<a class="index-letter" href="elementindex.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex.html#_">_</a>
|
||||
</div> </body>
|
||||
</html>
|
||||
843
docs/elementindex_PICKLES.html
Normal file
843
docs/elementindex_PICKLES.html
Normal file
|
|
@ -0,0 +1,843 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a name="top"></a>
|
||||
<h2>[PICKLES] element index</h2>
|
||||
<a href="elementindex.html">All elements</a>
|
||||
<br />
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#f">f</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#j">j</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#k">k</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#p">p</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#u">u</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#v">v</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#_">_</a>
|
||||
</div>
|
||||
|
||||
<a name="_"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">_</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">__autoload</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#function__autoload">__autoload()</a> in pickles.php</div>
|
||||
<div class="index-item-description">Magic function to automatically load classes</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#method__construct">Display_Smarty::__construct()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#method__construct">Module::__construct()</a> in Module.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html#method__construct">Object::__construct()</a> in Object.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#method__construct">Display_Common::__construct()</a> in Common.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__construct">Model::__construct()</a> in Model.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#method__construct">Config::__construct()</a> in Config.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Controller.html#method__construct">Controller::__construct()</a> in Controller.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__construct</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#method__construct">Database::__construct()</a> in Database.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__default</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#method__default">Module::__default()</a> in Module.php</div>
|
||||
<div class="index-item-description">Default "Magic" Method</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__get</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__get">Model::__get()</a> in Model.php</div>
|
||||
<div class="index-item-description">Magic Getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">__set</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#method__set">Model::__set()</a> in Model.php</div>
|
||||
<div class="index-item-description">Magic Setter</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="a"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">a</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$access</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$access">Module::$access</a> in Module.php</div>
|
||||
<div class="index-item-description">Access level of the page</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$ajax</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$ajax">Module::$ajax</a> in Module.php</div>
|
||||
<div class="index-item-description">AJAX</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="c"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">c</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$columns</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$columns">Model::$columns</a> in Model.php</div>
|
||||
<div class="index-item-description">Column List</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$config</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html#var$config">Object::$config</a> in Object.php</div>
|
||||
<div class="index-item-description">Instance of the Config object</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$count</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$count">Model::$count</a> in Model.php</div>
|
||||
<div class="index-item-description">Record Count</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Config.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Config.php.html">Config.php</a> in Config.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Controller.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Controller.php.html">Controller.php</a> in Controller.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Common.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---Common.php.html">Common.php</a> in Common.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">close</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodclose">Database::close()</a> in Database.php</div>
|
||||
<div class="index-item-description">Closes database connection</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">commit</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommit">Model::commit()</a> in Model.php</div>
|
||||
<div class="index-item-description">Commit</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">commitRecord</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a> in Model.php</div>
|
||||
<div class="index-item-description">Commit Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Config
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html">Config</a> in Config.php</div>
|
||||
<div class="index-item-description">Config Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Controller
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Controller.html">Controller</a> in Controller.php</div>
|
||||
<div class="index-item-description">Controller Class</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="d"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">d</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$data</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$data">Model::$data</a> in Model.php</div>
|
||||
<div class="index-item-description">Data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$db</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$db">Model::$db</a> in Model.php</div>
|
||||
<div class="index-item-description">Database</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$description</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$description">Module::$description</a> in Module.php</div>
|
||||
<div class="index-item-description">Meta description</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Database.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Database.php.html">Database.php</a> in Database.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Database
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html">Database</a> in Database.php</div>
|
||||
<div class="index-item-description">Database Abstraction Layer for MySQL</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">delete</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methoddelete">Model::delete()</a> in Model.php</div>
|
||||
<div class="index-item-description">Delete Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">disabled</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methoddisabled">Config::disabled()</a> in Config.php</div>
|
||||
<div class="index-item-description">Gets status of site</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_Common
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html">Display_Common</a> in Common.php</div>
|
||||
<div class="index-item-description">Common Display Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_JSON</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_JSON">DISPLAY_JSON</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_JSON
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_JSON.html">Display_JSON</a> in JSON.php</div>
|
||||
<div class="index-item-description">JSON Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_PHP</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_PHP">DISPLAY_PHP</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_PHP
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html">Display_PHP</a> in PHP.php</div>
|
||||
<div class="index-item-description">PHP Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_RSS
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_RSS.html">Display_RSS</a> in RSS.php</div>
|
||||
<div class="index-item-description">RSS Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_RSS</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_RSS">DISPLAY_RSS</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_SMARTY</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_SMARTY">DISPLAY_SMARTY</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Display_Smarty
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html">Display_Smarty</a> in Smarty.php</div>
|
||||
<div class="index-item-description">Smarty Display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">DISPLAY_XML</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineDISPLAY_XML">DISPLAY_XML</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="e"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">e</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$engine</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$engine">Module::$engine</a> in Module.php</div>
|
||||
<div class="index-item-description">Default display engine</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">execute</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodexecute">Database::execute()</a> in Database.php</div>
|
||||
<div class="index-item-description">Executes an SQL Statement</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="f"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">f</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetch</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetch">Database::fetch()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetch a single row from the database</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetchAll</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchAll">Database::fetchAll()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetches all rows as an array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">fetchColumn</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodfetchColumn">Database::fetchColumn()</a> in Database.php</div>
|
||||
<div class="index-item-description">Fetch a single column from the database</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="g"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">g</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">getInstance</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodgetInstance">Config::getInstance()</a> in Config.php</div>
|
||||
<div class="index-item-description">Get instance of the object</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getSmartyObject</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodgetSmartyObject">Display_Smarty::getSmartyObject()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="j"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">j</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">JSON.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---JSON.php.html">JSON.php</a> in JSON.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="k"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">k</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$keywords</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$keywords">Module::$keywords</a> in Module.php</div>
|
||||
<div class="index-item-description">Meta keywords (comma separated)</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="l"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">l</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">Logger.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Logger.php.html">Logger.php</a> in Logger.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">load</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodload">Config::load()</a> in Config.php</div>
|
||||
<div class="index-item-description">Loads a configuration file</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Logger
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Logger.html">Logger</a> in Logger.php</div>
|
||||
<div class="index-item-description">Logger Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">LOG_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineLOG_PATH">LOG_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="m"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">m</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$module_return</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$module_return">Display_Common::$module_return</a> in Common.php</div>
|
||||
<div class="index-item-description">Module Return Data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Model.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Model.php.html">Model.php</a> in Model.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Module.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Module.php.html">Module.php</a> in Module.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Model
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html">Model</a> in Model.php</div>
|
||||
<div class="index-item-description">Model Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Module
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html">Module</a> in Module.php</div>
|
||||
<div class="index-item-description">Module Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">module</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Config.html#methodmodule">Config::module()</a> in Config.php</div>
|
||||
<div class="index-item-description">Gets default module</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="n"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">n</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">next</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodnext">Model::next()</a> in Model.php</div>
|
||||
<div class="index-item-description">Next Record</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="o"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">o</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$order_by</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$order_by">Model::$order_by</a> in Model.php</div>
|
||||
<div class="index-item-description">Order By Clause</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Object.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Object.php.html">Object.php</a> in Object.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Object
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Object.html">Object</a> in Object.php</div>
|
||||
<div class="index-item-description">Object Class</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">open</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Database.html#methodopen">Database::open()</a> in Database.php</div>
|
||||
<div class="index-item-description">Opens database connection</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="p"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">p</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">PHP.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---PHP.php.html">PHP.php</a> in PHP.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">pickles.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html">pickles.php</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">PICKLES_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#definePICKLES_PATH">PICKLES_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodprepare">Display_Smarty::prepare()</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodprepare">Display_PHP::prepare()</a> in PHP.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prepare</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodprepare">Display_Common::prepare()</a> in Common.php</div>
|
||||
<div class="index-item-description">Preparation for display</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">prev</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodprev">Model::prev()</a> in Model.php</div>
|
||||
<div class="index-item-description">Previous Record</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">pickle.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_scripts---pickle.php.html">pickle.php</a> in pickle.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="r"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">r</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$record</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$record">Model::$record</a> in Model.php</div>
|
||||
<div class="index-item-description">Record Array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$records</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$records">Model::$records</a> in Model.php</div>
|
||||
<div class="index-item-description">Records Array</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">RSS.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---RSS.php.html">RSS.php</a> in RSS.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a> in RSS.php</div>
|
||||
<div class="index-item-description">Render the RSS feed data</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Smarty.html#methodrender">Display_Smarty::render()</a> in Smarty.php</div>
|
||||
<div class="index-item-description">Render the Smarty generated pages</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_PHP.html#methodrender">Display_PHP::render()</a> in PHP.php</div>
|
||||
<div class="index-item-description">Renders the PHP templated pages</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#methodrender">Display_Common::render()</a> in Common.php</div>
|
||||
<div class="index-item-description">Abstract rendering function that is overloaded within the loaded viewer</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">render</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_JSON.html#methodrender">Display_JSON::render()</a> in JSON.php</div>
|
||||
<div class="index-item-description">Renders the data in JSON format</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="s"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">s</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$secure</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$secure">Module::$secure</a> in Module.php</div>
|
||||
<div class="index-item-description">Secure</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Smarty.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_classes---Display---Smarty.php.html">Smarty.php</a> in Smarty.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">SITE_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSITE_PATH">SITE_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">SMARTY_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineSMARTY_PATH">SMARTY_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="t"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">t</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="var-title">$table</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#var$table">Model::$table</a> in Model.php</div>
|
||||
<div class="index-item-description">Table Name</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$template</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Display_Common.html#var$template">Display_Common::$template</a> in Common.php</div>
|
||||
<div class="index-item-description">Template</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$template</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$template">Module::$template</a> in Module.php</div>
|
||||
<div class="index-item-description">Default template</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="var-title">$title</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Module.html#var$title">Module::$title</a> in Module.php</div>
|
||||
<div class="index-item-description">Page title</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="u"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">u</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">unescape</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Model.html#methodunescape">Model::unescape()</a> in Model.php</div>
|
||||
<div class="index-item-description">Unescape String</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="v"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">v</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="const-title">VAR_PATH</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/_pickles.php.html#defineVAR_PATH">VAR_PATH</a> in pickles.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="w"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">w</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">write</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="PICKLES/Logger.html#methodwrite">Logger::write()</a> in Logger.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#e">e</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#f">f</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#j">j</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#k">k</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#p">p</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#u">u</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#v">v</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex_PICKLES.html#_">_</a>
|
||||
</div> </body>
|
||||
</html>
|
||||
654
docs/errors.html
Normal file
654
docs/errors.html
Normal file
|
|
@ -0,0 +1,654 @@
|
|||
<?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>phpDocumentor Parser Errors and Warnings</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a href="#Post-parsing">Post-parsing</a><br>
|
||||
<a href="#adapter_test.php">adapter_test.php</a><br>
|
||||
<a href="#advanced.php">advanced.php</a><br>
|
||||
<a href="#all_tests.php">all_tests.php</a><br>
|
||||
<a href="#authentication_test.php">authentication_test.php</a><br>
|
||||
<a href="#autorun.php">autorun.php</a><br>
|
||||
<a href="#autorun_test.php">autorun_test.php</a><br>
|
||||
<a href="#bad_test_suite.php">bad_test_suite.php</a><br>
|
||||
<a href="#browser_test.php">browser_test.php</a><br>
|
||||
<a href="#ckeditor.php">ckeditor.php</a><br>
|
||||
<a href="#ckeditor_php4.php">ckeditor_php4.php</a><br>
|
||||
<a href="#ckeditor_php5.php">ckeditor_php5.php</a><br>
|
||||
<a href="#collector_test.php">collector_test.php</a><br>
|
||||
<a href="#command_line_test.php">command_line_test.php</a><br>
|
||||
<a href="#Common.php">Common.php</a><br>
|
||||
<a href="#compatibility_test.php">compatibility_test.php</a><br>
|
||||
<a href="#Config.php">Config.php</a><br>
|
||||
<a href="#Controller.php">Controller.php</a><br>
|
||||
<a href="#cookies_test.php">cookies_test.php</a><br>
|
||||
<a href="#Database.php">Database.php</a><br>
|
||||
<a href="#detached_test.php">detached_test.php</a><br>
|
||||
<a href="#dumper_test.php">dumper_test.php</a><br>
|
||||
<a href="#eclipse_test.php">eclipse_test.php</a><br>
|
||||
<a href="#empty_test_file.php">empty_test_file.php</a><br>
|
||||
<a href="#encoding_test.php">encoding_test.php</a><br>
|
||||
<a href="#errors_test.php">errors_test.php</a><br>
|
||||
<a href="#events.php">events.php</a><br>
|
||||
<a href="#exceptions_test.php">exceptions_test.php</a><br>
|
||||
<a href="#expectation_test.php">expectation_test.php</a><br>
|
||||
<a href="#form_test.php">form_test.php</a><br>
|
||||
<a href="#frames_test.php">frames_test.php</a><br>
|
||||
<a href="#function.html_select_time.php">function.html_select_time.php</a><br>
|
||||
<a href="#http_test.php">http_test.php</a><br>
|
||||
<a href="#index.php">index.php</a><br>
|
||||
<a href="#interfaces_test.php">interfaces_test.php</a><br>
|
||||
<a href="#JSON.php">JSON.php</a><br>
|
||||
<a href="#live_test.php">live_test.php</a><br>
|
||||
<a href="#Logger.php">Logger.php</a><br>
|
||||
<a href="#mock_objects.php">mock_objects.php</a><br>
|
||||
<a href="#mock_objects_test.php">mock_objects_test.php</a><br>
|
||||
<a href="#Model.php">Model.php</a><br>
|
||||
<a href="#Module.php">Module.php</a><br>
|
||||
<a href="#Object.php">Object.php</a><br>
|
||||
<a href="#page_test.php">page_test.php</a><br>
|
||||
<a href="#parser_test.php">parser_test.php</a><br>
|
||||
<a href="#parse_error_test.php">parse_error_test.php</a><br>
|
||||
<a href="#PHP.php">PHP.php</a><br>
|
||||
<a href="#pickles.php">pickles.php</a><br>
|
||||
<a href="#reflection_php4_test.php">reflection_php4_test.php</a><br>
|
||||
<a href="#reflection_php5_test.php">reflection_php5_test.php</a><br>
|
||||
<a href="#remote_test.php">remote_test.php</a><br>
|
||||
<a href="#replace.php">replace.php</a><br>
|
||||
<a href="#replaceall.php">replaceall.php</a><br>
|
||||
<a href="#RSS.php">RSS.php</a><br>
|
||||
<a href="#sample_posteddata.php">sample_posteddata.php</a><br>
|
||||
<a href="#shell_test.php">shell_test.php</a><br>
|
||||
<a href="#shell_tester_test.php">shell_tester_test.php</a><br>
|
||||
<a href="#simpletest_test.php">simpletest_test.php</a><br>
|
||||
<a href="#Smarty.php">Smarty.php</a><br>
|
||||
<a href="#socket_test.php">socket_test.php</a><br>
|
||||
<a href="#spl_examples.php">spl_examples.php</a><br>
|
||||
<a href="#standalone.php">standalone.php</a><br>
|
||||
<a href="#tag_test.php">tag_test.php</a><br>
|
||||
<a href="#test.php">test.php</a><br>
|
||||
<a href="#test1.php">test1.php</a><br>
|
||||
<a href="#testdox.php">testdox.php</a><br>
|
||||
<a href="#test_case.php">test_case.php</a><br>
|
||||
<a href="#test_with_parse_error.php">test_with_parse_error.php</a><br>
|
||||
<a href="#unit_tester_test.php">unit_tester_test.php</a><br>
|
||||
<a href="#unit_tests.php">unit_tests.php</a><br>
|
||||
<a href="#url_test.php">url_test.php</a><br>
|
||||
<a href="#user_agent_test.php">user_agent_test.php</a><br>
|
||||
<a href="#visual_test.php">visual_test.php</a><br>
|
||||
<a href="#web_tester_test.php">web_tester_test.php</a><br>
|
||||
<a href="#xml_test.php">xml_test.php</a><br>
|
||||
<a name="acceptance_test.php"></a>
|
||||
<h1>acceptance_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 8</b> - no @package tag was used in a DocBlock for class SimpleTestAcceptanceTest<br>
|
||||
<b>Warning on line 14</b> - no @package tag was used in a DocBlock for class TestOfLiveBrowser<br>
|
||||
<b>Warning on line 105</b> - no @package tag was used in a DocBlock for class TestRadioFields<br>
|
||||
<b>Warning on line 121</b> - no @package tag was used in a DocBlock for class TestOfLiveFetching<br>
|
||||
<b>Warning on line 218</b> - no @package tag was used in a DocBlock for class TestOfLinkFollowing<br>
|
||||
<b>Warning on line 262</b> - no @package tag was used in a DocBlock for class TestOfLivePageLinkingWithMinimalLinks<br>
|
||||
<b>Warning on line 317</b> - no @package tag was used in a DocBlock for class TestOfLiveFrontControllerEmulation<br>
|
||||
<b>Warning on line 433</b> - no @package tag was used in a DocBlock for class TestOfLiveHeaders<br>
|
||||
<b>Warning on line 447</b> - no @package tag was used in a DocBlock for class TestOfLiveRedirects<br>
|
||||
<b>Warning on line 493</b> - no @package tag was used in a DocBlock for class TestOfLiveCookies<br>
|
||||
<b>Warning on line 594</b> - no @package tag was used in a DocBlock for class LiveTestOfForms<br>
|
||||
<b>Warning on line 993</b> - no @package tag was used in a DocBlock for class TestOfLiveMultiValueWidgets<br>
|
||||
<b>Warning on line 1084</b> - no @package tag was used in a DocBlock for class TestOfFileUploads<br>
|
||||
<b>Warning on line 1121</b> - no @package tag was used in a DocBlock for class TestOfLiveHistoryNavigation<br>
|
||||
<b>Warning on line 1189</b> - no @package tag was used in a DocBlock for class TestOfLiveAuthentication<br>
|
||||
<b>Warning on line 1263</b> - no @package tag was used in a DocBlock for class TestOfLoadingFrames<br>
|
||||
<b>Warning on line 1510</b> - no @package tag was used in a DocBlock for class TestOfFrameAuthentication<br>
|
||||
<b>Warning on line 1554</b> - no @package tag was used in a DocBlock for class TestOfNestedFrames<br>
|
||||
<b>Warning on line 1632</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/acceptance_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="adapter_test.php"></a>
|
||||
<h1>adapter_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 6</b> - no @package tag was used in a DocBlock for class SameTestClass<br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class TestOfPearAdapter<br>
|
||||
<b>Warning on line 51</b> - no @package tag was used in a DocBlock for class TestOfPhpUnitAdapter<br>
|
||||
<b>Warning on line 76</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/adapter_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="advanced.php"></a>
|
||||
<h1>advanced.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 92</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/php/advanced.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="all_tests.php"></a>
|
||||
<h1>all_tests.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class AllTests<br>
|
||||
<b>Warning on line 12</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/all_tests.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="authentication_test.php"></a>
|
||||
<h1>authentication_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class TestOfRealm<br>
|
||||
<b>Warning on line 88</b> - no @package tag was used in a DocBlock for class TestOfAuthenticator<br>
|
||||
<b>Warning on line 144</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/authentication_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="autorun.php"></a>
|
||||
<h1>autorun.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - Page-level DocBlock precedes "require_once dirname(__FILE__).'/unit_tester.php'", use another DocBlock to document the source element<br>
|
||||
<a name="autorun_test.php"></a>
|
||||
<h1>autorun_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 4</b> - no @package tag was used in a DocBlock for class LoadIfIncludedTestCase<br>
|
||||
<b>Warning on line 12</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/autorun_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="bad_test_suite.php"></a>
|
||||
<h1>bad_test_suite.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class BadTestCases<br>
|
||||
<b>Warning on line 9</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/bad_test_suite.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="browser_test.php"></a>
|
||||
<h1>browser_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 22</b> - no @package tag was used in a DocBlock for class TestOfHistory<br>
|
||||
<b>Warning on line 148</b> - no @package tag was used in a DocBlock for class TestOfParsedPageAccess<br>
|
||||
<b>Warning on line 227</b> - no @package tag was used in a DocBlock for class TestOfBrowserNavigation<br>
|
||||
<b>Warning on line 523</b> - no @package tag was used in a DocBlock for class TestOfBrowserFrames<br>
|
||||
<b>Warning on line 778</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/browser_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="ckeditor.php"></a>
|
||||
<h1>ckeditor.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 28</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/ckeditor.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="ckeditor_php4.php"></a>
|
||||
<h1>ckeditor_php4.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 17</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 18</b> - no @package tag was used in a DocBlock for class CKEditor<br>
|
||||
<b>Warning on line 39</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 39</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 51</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 51</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 70</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 70</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 134</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 134</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 134</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 176</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 176</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 219</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 219</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 219</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 219</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 274</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 274</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 314</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 314</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 592</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/ckeditor_php4.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="ckeditor_php5.php"></a>
|
||||
<h1>ckeditor_php5.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 17</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 17</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 18</b> - no @package tag was used in a DocBlock for class CKEditor<br>
|
||||
<b>Warning on line 37</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 37</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 49</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 49</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 68</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 68</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 130</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 130</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 130</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 130</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 172</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 172</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 215</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 215</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 215</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 215</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 270</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 270</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 310</b> - Unknown tag "@code" used<br>
|
||||
<b>Warning on line 310</b> - Unknown tag "@endcode" used<br>
|
||||
<b>Warning on line 582</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/ckeditor_php5.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="collector_test.php"></a>
|
||||
<h1>collector_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class PathEqualExpectation<br>
|
||||
<b>Warning on line 17</b> - no @package tag was used in a DocBlock for class TestOfCollector<br>
|
||||
<b>Warning on line 30</b> - no @package tag was used in a DocBlock for class TestOfPatternCollector<br>
|
||||
<b>Warning on line 50</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/collector_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="command_line_test.php"></a>
|
||||
<h1>command_line_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 4</b> - no @package tag was used in a DocBlock for class TestOfCommandLineParsing<br>
|
||||
<b>Warning on line 39</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/command_line_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Common.php"></a>
|
||||
<h1>Common.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Display_Common<br>
|
||||
<a name="compatibility_test.php"></a>
|
||||
<h1>compatibility_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class ComparisonClass<br>
|
||||
<b>Warning on line 8</b> - no @package tag was used in a DocBlock for class ComparisonSubclass<br>
|
||||
<b>Warning on line 16</b> - no @package tag was used in a DocBlock for class TestOfCompatibility<br>
|
||||
<b>Warning on line 96</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/compatibility_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Config.php"></a>
|
||||
<h1>Config.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Config<br>
|
||||
<a name="Controller.php"></a>
|
||||
<h1>Controller.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Controller<br>
|
||||
<a name="cookies_test.php"></a>
|
||||
<h1>cookies_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class TestOfCookie<br>
|
||||
<b>Warning on line 104</b> - no @package tag was used in a DocBlock for class TestOfCookieJar<br>
|
||||
<b>Warning on line 226</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/cookies_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Database.php"></a>
|
||||
<h1>Database.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 26</b> - no @package tag was used in a DocBlock for class Database<br>
|
||||
<a name="detached_test.php"></a>
|
||||
<h1>detached_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 14</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/detached_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="dumper_test.php"></a>
|
||||
<h1>dumper_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 4</b> - no @package tag was used in a DocBlock for class DumperDummy<br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class TestOfTextFormatting<br>
|
||||
<b>Warning on line 87</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/dumper_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="eclipse_test.php"></a>
|
||||
<h1>eclipse_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class TestOfEclipse<br>
|
||||
<b>Warning on line 31</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/eclipse_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="empty_test_file.php"></a>
|
||||
<h1>empty_test_file.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 2</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/support/empty_test_file.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="encoding_test.php"></a>
|
||||
<h1>encoding_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 8</b> - no @package tag was used in a DocBlock for class TestOfEncodedParts<br>
|
||||
<b>Warning on line 31</b> - no @package tag was used in a DocBlock for class TestOfEncoding<br>
|
||||
<b>Warning on line 194</b> - no @package tag was used in a DocBlock for class TestOfFormHeaders<br>
|
||||
<b>Warning on line 212</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/encoding_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="errors_test.php"></a>
|
||||
<h1>errors_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class TestOfErrorQueue<br>
|
||||
<b>Warning on line 99</b> - no @package tag was used in a DocBlock for class TestOfErrorTrap<br>
|
||||
<b>Warning on line 156</b> - no @package tag was used in a DocBlock for class TestOfErrors<br>
|
||||
<b>Warning on line 217</b> - no @package tag was used in a DocBlock for class TestOfPHP52RecoverableErrors<br>
|
||||
<b>Warning on line 238</b> - no @package tag was used in a DocBlock for class TestOfErrorsExcludingPHP52AndAbove<br>
|
||||
<b>Warning on line 263</b> - no @package tag was used in a DocBlock for class TestOfNotEnoughErrors<br>
|
||||
<b>Warning on line 278</b> - no @package tag was used in a DocBlock for class TestOfLeftOverErrors<br>
|
||||
<b>Warning on line 286</b> - no @package tag was used in a DocBlock for class TestRunnerForLeftOverAndNotEnoughErrors<br>
|
||||
<b>Warning on line 299</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/errors_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="events.php"></a>
|
||||
<h1>events.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 129</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/php/events.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="exceptions_test.php"></a>
|
||||
<h1>exceptions_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class MyTestException<br>
|
||||
<b>Warning on line 10</b> - no @package tag was used in a DocBlock for class HigherTestException<br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class OtherTestException<br>
|
||||
<b>Warning on line 13</b> - no @package tag was used in a DocBlock for class TestOfExceptionExpectation<br>
|
||||
<b>Warning on line 38</b> - no @package tag was used in a DocBlock for class TestOfExceptionTrap<br>
|
||||
<b>Warning on line 69</b> - no @package tag was used in a DocBlock for class TestOfCatchingExceptions<br>
|
||||
<b>Warning on line 93</b> - no @package tag was used in a DocBlock for class TestOfCallingTearDownAfterExceptions<br>
|
||||
<b>Warning on line 111</b> - no @package tag was used in a DocBlock for class TestOfExceptionThrownInSetUpDoesNotRunTestBody<br>
|
||||
<b>Warning on line 127</b> - no @package tag was used in a DocBlock for class TestOfExpectExceptionWithSetUp<br>
|
||||
<b>Warning on line 142</b> - no @package tag was used in a DocBlock for class TestOfThrowingExceptionsInTearDown<br>
|
||||
<b>Warning on line 152</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/exceptions_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="expectation_test.php"></a>
|
||||
<h1>expectation_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class TestOfEquality<br>
|
||||
<b>Warning on line 49</b> - no @package tag was used in a DocBlock for class TestOfWithin<br>
|
||||
<b>Warning on line 70</b> - no @package tag was used in a DocBlock for class TestOfInequality<br>
|
||||
<b>Warning on line 79</b> - no @package tag was used in a DocBlock for class RecursiveNasty<br>
|
||||
<b>Warning on line 87</b> - no @package tag was used in a DocBlock for class TestOfIdentity<br>
|
||||
<b>Warning on line 106</b> - no @package tag was used in a DocBlock for class DummyReferencedObject<br>
|
||||
<b>Warning on line 108</b> - no @package tag was used in a DocBlock for class TestOfReference<br>
|
||||
<b>Warning on line 145</b> - no @package tag was used in a DocBlock for class TestOfNonIdentity<br>
|
||||
<b>Warning on line 155</b> - no @package tag was used in a DocBlock for class TestOfPatterns<br>
|
||||
<b>Warning on line 170</b> - no @package tag was used in a DocBlock for class ExpectedMethodTarget<br>
|
||||
<b>Warning on line 174</b> - no @package tag was used in a DocBlock for class TestOfMethodExistence<br>
|
||||
<b>Warning on line 185</b> - no @package tag was used in a DocBlock for class TestOfIsA<br>
|
||||
<b>Warning on line 236</b> - no @package tag was used in a DocBlock for class TestOfNotA<br>
|
||||
<b>Warning on line 244</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/expectation_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="form_test.php"></a>
|
||||
<h1>form_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class TestOfForm<br>
|
||||
<b>Warning on line 322</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/form_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="frames_test.php"></a>
|
||||
<h1>frames_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class TestOfFrameset<br>
|
||||
<b>Warning on line 153</b> - no @package tag was used in a DocBlock for class TestOfFrameNavigation<br>
|
||||
<b>Warning on line 240</b> - no @package tag was used in a DocBlock for class TestOfFramesetPageInterface<br>
|
||||
<b>Warning on line 548</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/frames_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="function.html_select_time.php"></a>
|
||||
<h1>function.html_select_time.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 23</b> - Unknown tag "@credits" used<br>
|
||||
<a name="http_test.php"></a>
|
||||
<h1>http_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 16</b> - no @package tag was used in a DocBlock for class TestOfDirectRoute<br>
|
||||
<b>Warning on line 75</b> - no @package tag was used in a DocBlock for class TestOfProxyRoute<br>
|
||||
<b>Warning on line 158</b> - no @package tag was used in a DocBlock for class TestOfHttpRequest<br>
|
||||
<b>Warning on line 231</b> - no @package tag was used in a DocBlock for class TestOfHttpPostRequest<br>
|
||||
<b>Warning on line 277</b> - no @package tag was used in a DocBlock for class TestOfHttpHeaders<br>
|
||||
<b>Warning on line 336</b> - no @package tag was used in a DocBlock for class TestOfHttpResponse<br>
|
||||
<b>Warning on line 426</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/http_test.php" 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 24</b> - File "/home/josh/Source/pickles/vendors/Smarty-2.6.26/demo/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="interfaces_test.php"></a>
|
||||
<h1>interfaces_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for interface DummyInterface<br>
|
||||
<b>Warning on line 16</b> - no @package tag was used in a DocBlock for class TestOfMockInterfaces<br>
|
||||
<b>Warning on line 38</b> - no @package tag was used in a DocBlock for class TestOfSpl<br>
|
||||
<b>Warning on line 70</b> - no @package tag was used in a DocBlock for class WithHint<br>
|
||||
<b>Warning on line 74</b> - no @package tag was used in a DocBlock for class ImplementsDummy<br>
|
||||
<b>Warning on line 82</b> - no @package tag was used in a DocBlock for class TestOfImplementations<br>
|
||||
<b>Warning on line 102</b> - no @package tag was used in a DocBlock for interface SampleClassWithConstruct<br>
|
||||
<b>Warning on line 106</b> - no @package tag was used in a DocBlock for class TestOfInterfaceMocksWithConstruct<br>
|
||||
<b>Warning on line 113</b> - no @package tag was used in a DocBlock for interface SampleInterfaceWithHintInSignature<br>
|
||||
<b>Warning on line 117</b> - no @package tag was used in a DocBlock for class TestOfInterfaceMocksWithHintInSignature<br>
|
||||
<b>Warning on line 126</b> - no @package tag was used in a DocBlock for interface SampleInterfaceWithClone<br>
|
||||
<b>Warning on line 130</b> - no @package tag was used in a DocBlock for class TestOfSampleInterfaceWithClone<br>
|
||||
<b>Warning on line 136</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/interfaces_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="JSON.php"></a>
|
||||
<h1>JSON.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class Display_JSON<br>
|
||||
<a name="live_test.php"></a>
|
||||
<h1>live_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class LiveHttpTestCase<br>
|
||||
<b>Warning on line 46</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/live_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Logger.php"></a>
|
||||
<h1>Logger.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 20</b> - no @package tag was used in a DocBlock for class Logger<br>
|
||||
<a name="mock_objects_test.php"></a>
|
||||
<h1>mock_objects_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 6</b> - no @package tag was used in a DocBlock for class TestOfAnythingExpectation<br>
|
||||
<b>Warning on line 16</b> - no @package tag was used in a DocBlock for class TestOfParametersExpectation<br>
|
||||
<b>Warning on line 77</b> - no @package tag was used in a DocBlock for class TestOfSimpleSignatureMap<br>
|
||||
<b>Warning on line 141</b> - no @package tag was used in a DocBlock for class TestOfCallSchedule<br>
|
||||
<b>Warning on line 207</b> - no @package tag was used in a DocBlock for class Dummy<br>
|
||||
<b>Warning on line 223</b> - no @package tag was used in a DocBlock for class TestOfMockGeneration<br>
|
||||
<b>Warning on line 242</b> - no @package tag was used in a DocBlock for class TestOfMockReturns<br>
|
||||
<b>Warning on line 352</b> - no @package tag was used in a DocBlock for class TestOfMockExpectationsThatPass<br>
|
||||
<b>Warning on line 433</b> - no @package tag was used in a DocBlock for class MockWithInjectedTestCase<br>
|
||||
<b>Warning on line 445</b> - no @package tag was used in a DocBlock for class LikeExpectation<br>
|
||||
<b>Warning on line 462</b> - no @package tag was used in a DocBlock for class TestOfMockExpectations<br>
|
||||
<b>Warning on line 645</b> - no @package tag was used in a DocBlock for class TestOfMockComparisons<br>
|
||||
<b>Warning on line 658</b> - no @package tag was used in a DocBlock for class ClassWithSpecialMethods<br>
|
||||
<b>Warning on line 668</b> - no @package tag was used in a DocBlock for class TestOfSpecialMethods<br>
|
||||
<b>Warning on line 730</b> - no @package tag was used in a DocBlock for class TestOfMockingClassesWithStaticMethods<br>
|
||||
<b>Warning on line 744</b> - no @package tag was used in a DocBlock for class MockTestException<br>
|
||||
<b>Warning on line 747</b> - no @package tag was used in a DocBlock for class TestOfThrowingExceptionsFromMocks<br>
|
||||
<b>Warning on line 785</b> - no @package tag was used in a DocBlock for class TestOfThrowingErrorsFromMocks<br>
|
||||
<b>Warning on line 815</b> - no @package tag was used in a DocBlock for class TestOfPartialMocks<br>
|
||||
<b>Warning on line 856</b> - no @package tag was used in a DocBlock for class ConstructorSuperClass<br>
|
||||
<b>Warning on line 860</b> - no @package tag was used in a DocBlock for class ConstructorSubClass<br>
|
||||
<b>Warning on line 863</b> - no @package tag was used in a DocBlock for class TestOfPHP4StyleSuperClassConstruct<br>
|
||||
<b>Warning on line 876</b> - no @package tag was used in a DocBlock for class TestOfPHP5StaticMethodMocking<br>
|
||||
<b>Warning on line 893</b> - no @package tag was used in a DocBlock for class TestOfPHP5AbstractMethodMocking<br>
|
||||
<b>Warning on line 993</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/mock_objects_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Model.php"></a>
|
||||
<h1>Model.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Model<br>
|
||||
<a name="Module.php"></a>
|
||||
<h1>Module.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 29</b> - no @package tag was used in a DocBlock for class Module<br>
|
||||
<a name="Object.php"></a>
|
||||
<h1>Object.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 29</b> - no @package tag was used in a DocBlock for class Object<br>
|
||||
<a name="page_test.php"></a>
|
||||
<h1>page_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 17</b> - no @package tag was used in a DocBlock for class TestOfPageBuilder<br>
|
||||
<b>Warning on line 148</b> - no @package tag was used in a DocBlock for class TestOfPageParsing<br>
|
||||
<b>Warning on line 168</b> - no @package tag was used in a DocBlock for class TestOfPageInterface<br>
|
||||
<b>Warning on line 185</b> - no @package tag was used in a DocBlock for class TestOfPageHeaders<br>
|
||||
<b>Warning on line 257</b> - no @package tag was used in a DocBlock for class TestOfHtmlPage<br>
|
||||
<b>Warning on line 468</b> - no @package tag was used in a DocBlock for class TestOfFormsCreatedFromEventStream<br>
|
||||
<b>Warning on line 512</b> - no @package tag was used in a DocBlock for class TestOfPageScraping<br>
|
||||
<b>Warning on line 902</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/page_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="parser_test.php"></a>
|
||||
<h1>parser_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class TestOfParallelRegex<br>
|
||||
<b>Warning on line 69</b> - no @package tag was used in a DocBlock for class TestOfStateStack<br>
|
||||
<b>Warning on line 97</b> - no @package tag was used in a DocBlock for class TestParser<br>
|
||||
<b>Warning on line 110</b> - no @package tag was used in a DocBlock for class TestOfLexer<br>
|
||||
<b>Warning on line 155</b> - no @package tag was used in a DocBlock for class TestOfLexerModes<br>
|
||||
<b>Warning on line 257</b> - no @package tag was used in a DocBlock for class TestOfLexerHandlers<br>
|
||||
<b>Warning on line 281</b> - no @package tag was used in a DocBlock for class TestOfSimpleHtmlLexer<br>
|
||||
<b>Warning on line 364</b> - no @package tag was used in a DocBlock for class TestOfHtmlSaxParser<br>
|
||||
<b>Warning on line 481</b> - no @package tag was used in a DocBlock for class TestOfTextExtraction<br>
|
||||
<b>Warning on line 550</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/parser_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="parse_error_test.php"></a>
|
||||
<h1>parse_error_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 8</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/parse_error_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="PHP.php"></a>
|
||||
<h1>PHP.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class Display_PHP<br>
|
||||
<a name="pickles.php"></a>
|
||||
<h1>pickles.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 31</b> - Page-level DocBlock precedes "define SITE_PATH", use another DocBlock to document the source element<br>
|
||||
<a name="reflection_php4_test.php"></a>
|
||||
<h1>reflection_php4_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 4</b> - no @package tag was used in a DocBlock for class AnyOldThing<br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class AnyOldChildThing<br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class TestOfReflection<br>
|
||||
<b>Warning on line 60</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/reflection_php4_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="reflection_php5_test.php"></a>
|
||||
<h1>reflection_php5_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class AnyOldLeafClass<br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class AnyOldClass<br>
|
||||
<b>Warning on line 13</b> - no @package tag was used in a DocBlock for class AnyOldLeafClassWithAFinal<br>
|
||||
<b>Warning on line 17</b> - no @package tag was used in a DocBlock for interface AnyOldInterface<br>
|
||||
<b>Warning on line 21</b> - no @package tag was used in a DocBlock for interface AnyOldArgumentInterface<br>
|
||||
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for interface AnyDescendentInterface<br>
|
||||
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class AnyOldImplementation<br>
|
||||
<b>Warning on line 33</b> - no @package tag was used in a DocBlock for class AnyAbstractImplementation<br>
|
||||
<b>Warning on line 36</b> - no @package tag was used in a DocBlock for class AnotherOldAbstractClass<br>
|
||||
<b>Warning on line 40</b> - no @package tag was used in a DocBlock for class AnyOldSubclass<br>
|
||||
<b>Warning on line 42</b> - no @package tag was used in a DocBlock for class AnyOldArgumentClass<br>
|
||||
<b>Warning on line 46</b> - no @package tag was used in a DocBlock for class AnyOldArgumentImplementation<br>
|
||||
<b>Warning on line 50</b> - no @package tag was used in a DocBlock for class AnyOldTypeHintedClass<br>
|
||||
<b>Warning on line 54</b> - no @package tag was used in a DocBlock for class AnyDescendentImplementation<br>
|
||||
<b>Warning on line 58</b> - no @package tag was used in a DocBlock for class AnyOldOverloadedClass<br>
|
||||
<b>Warning on line 63</b> - no @package tag was used in a DocBlock for class AnyOldClassWithStaticMethods<br>
|
||||
<b>Warning on line 68</b> - no @package tag was used in a DocBlock for class AnyOldAbstractClassWithAbstractMethods<br>
|
||||
<b>Warning on line 74</b> - no @package tag was used in a DocBlock for class TestOfReflection<br>
|
||||
<b>Warning on line 234</b> - no @package tag was used in a DocBlock for class TestOfReflectionWithTypeHints<br>
|
||||
<b>Warning on line 252</b> - no @package tag was used in a DocBlock for class TestOfAbstractsWithAbstractMethods<br>
|
||||
<b>Warning on line 270</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/reflection_php5_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="remote_test.php"></a>
|
||||
<h1>remote_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 19</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/remote_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="replace.php"></a>
|
||||
<h1>replace.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 62</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/php/replace.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="replaceall.php"></a>
|
||||
<h1>replaceall.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 67</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/php/replaceall.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="RSS.php"></a>
|
||||
<h1>RSS.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 29</b> - no @package tag was used in a DocBlock for class Display_RSS<br>
|
||||
<a name="sample_posteddata.php"></a>
|
||||
<h1>sample_posteddata.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 58</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/sample_posteddata.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="shell_test.php"></a>
|
||||
<h1>shell_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class TestOfShell<br>
|
||||
<b>Warning on line 19</b> - no @package tag was used in a DocBlock for class TestOfShellTesterAndShell<br>
|
||||
<b>Warning on line 37</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/shell_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="shell_tester_test.php"></a>
|
||||
<h1>shell_tester_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 6</b> - no @package tag was used in a DocBlock for class TestOfShellTestCase<br>
|
||||
<b>Warning on line 41</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/shell_tester_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="simpletest_test.php"></a>
|
||||
<h1>simpletest_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class ShouldNeverBeRun<br>
|
||||
<b>Warning on line 13</b> - no @package tag was used in a DocBlock for class ShouldNeverBeRunEither<br>
|
||||
<b>Warning on line 15</b> - no @package tag was used in a DocBlock for class TestOfStackTrace<br>
|
||||
<b>Warning on line 28</b> - no @package tag was used in a DocBlock for class DummyResource<br>
|
||||
<b>Warning on line 30</b> - no @package tag was used in a DocBlock for class TestOfContext<br>
|
||||
<b>Warning on line 57</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/simpletest_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="Smarty.php"></a>
|
||||
<h1>Smarty.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 25</b> - no @package tag was used in a DocBlock for class Display_Smarty<br>
|
||||
<a name="socket_test.php"></a>
|
||||
<h1>socket_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 6</b> - no @package tag was used in a DocBlock for class TestOfSimpleStickyError<br>
|
||||
<b>Warning on line 24</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/socket_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="spl_examples.php"></a>
|
||||
<h1>spl_examples.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class IteratorImplementation<br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class IteratorAggregateImplementation<br>
|
||||
<b>Warning on line 14</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/support/spl_examples.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="standalone.php"></a>
|
||||
<h1>standalone.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 63</b> - File "/home/josh/Source/pickles/vendors/ckeditor-3.2/_samples/php/standalone.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="tag_test.php"></a>
|
||||
<h1>tag_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class TestOfTag<br>
|
||||
<b>Warning on line 59</b> - no @package tag was used in a DocBlock for class TestOfWidget<br>
|
||||
<b>Warning on line 150</b> - no @package tag was used in a DocBlock for class TestOfTextArea<br>
|
||||
<b>Warning on line 186</b> - no @package tag was used in a DocBlock for class TestOfCheckbox<br>
|
||||
<b>Warning on line 196</b> - no @package tag was used in a DocBlock for class TestOfSelection<br>
|
||||
<b>Warning on line 386</b> - no @package tag was used in a DocBlock for class TestOfRadioGroup<br>
|
||||
<b>Warning on line 455</b> - no @package tag was used in a DocBlock for class TestOfTagGroup<br>
|
||||
<b>Warning on line 520</b> - no @package tag was used in a DocBlock for class TestOfUploadWidget<br>
|
||||
<b>Warning on line 540</b> - no @package tag was used in a DocBlock for class TestOfLabelTag<br>
|
||||
<b>Warning on line 553</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/tag_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="test.php"></a>
|
||||
<h1>test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 9</b> - no @package tag was used in a DocBlock for class TestOfTestDoxReporter<br>
|
||||
<b>Warning on line 106</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/extensions/testdox/test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="test1.php"></a>
|
||||
<h1>test1.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 1</b> - no @package tag was used in a DocBlock for class test1<br>
|
||||
<b>Warning on line 6</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/support/test1.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="testdox.php"></a>
|
||||
<h1>testdox.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class TestDoxReporter<br>
|
||||
<b>Warning on line 41</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/extensions/testdox.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="test_case.php"></a>
|
||||
<h1>test_case.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 377</b> - no @package tag was used in a DocBlock for class SimpleFileLoader<br>
|
||||
<a name="test_with_parse_error.php"></a>
|
||||
<h1>test_with_parse_error.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 3</b> - no @package tag was used in a DocBlock for class TestCaseWithParseError<br>
|
||||
<b>Warning on line 7</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/test_with_parse_error.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="unit_tester_test.php"></a>
|
||||
<h1>unit_tester_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 4</b> - no @package tag was used in a DocBlock for class ReferenceForTesting<br>
|
||||
<b>Warning on line 7</b> - no @package tag was used in a DocBlock for class TestOfUnitTester<br>
|
||||
<b>Warning on line 54</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/unit_tester_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="unit_tests.php"></a>
|
||||
<h1>unit_tests.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 10</b> - no @package tag was used in a DocBlock for class UnitTests<br>
|
||||
<b>Warning on line 54</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/unit_tests.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="url_test.php"></a>
|
||||
<h1>url_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class TestOfUrl<br>
|
||||
<b>Warning on line 299</b> - no @package tag was used in a DocBlock for class TestOfAbsoluteUrls<br>
|
||||
<b>Warning on line 433</b> - no @package tag was used in a DocBlock for class TestOfFrameUrl<br>
|
||||
<b>Warning on line 442</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/url_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="user_agent_test.php"></a>
|
||||
<h1>user_agent_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 12</b> - no @package tag was used in a DocBlock for class TestOfFetchingUrlParameters<br>
|
||||
<b>Warning on line 40</b> - no @package tag was used in a DocBlock for class TestOfAdditionalHeaders<br>
|
||||
<b>Warning on line 60</b> - no @package tag was used in a DocBlock for class TestOfBrowserCookies<br>
|
||||
<b>Warning on line 200</b> - no @package tag was used in a DocBlock for class TestOfHttpRedirects<br>
|
||||
<b>Warning on line 310</b> - no @package tag was used in a DocBlock for class TestOfBadHosts<br>
|
||||
<b>Warning on line 337</b> - no @package tag was used in a DocBlock for class TestOfAuthorisation<br>
|
||||
<b>Warning on line 357</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/user_agent_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="visual_test.php"></a>
|
||||
<h1>visual_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 19</b> - no @package tag was used in a DocBlock for class TestDisplayClass<br>
|
||||
<b>Warning on line 27</b> - no @package tag was used in a DocBlock for class PassingUnitTestCaseOutput<br>
|
||||
<b>Warning on line 144</b> - no @package tag was used in a DocBlock for class FailingUnitTestCaseOutput<br>
|
||||
<b>Warning on line 262</b> - no @package tag was used in a DocBlock for class Dummy<br>
|
||||
<b>Warning on line 271</b> - no @package tag was used in a DocBlock for class TestOfMockObjectsOutput<br>
|
||||
<b>Warning on line 372</b> - no @package tag was used in a DocBlock for class TestOfPastBugs<br>
|
||||
<b>Warning on line 387</b> - no @package tag was used in a DocBlock for class TestOfVisualShell<br>
|
||||
<b>Warning on line 402</b> - no @package tag was used in a DocBlock for class PassesAsWellReporter<br>
|
||||
<b>Warning on line 426</b> - no @package tag was used in a DocBlock for class TestOfSkippingNoMatterWhat<br>
|
||||
<b>Warning on line 436</b> - no @package tag was used in a DocBlock for class TestOfSkippingOrElse<br>
|
||||
<b>Warning on line 446</b> - no @package tag was used in a DocBlock for class TestOfSkippingTwiceOver<br>
|
||||
<b>Warning on line 457</b> - no @package tag was used in a DocBlock for class TestThatShouldNotBeSkipped<br>
|
||||
<b>Warning on line 494</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/visual_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="web_tester_test.php"></a>
|
||||
<h1>web_tester_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 5</b> - no @package tag was used in a DocBlock for class TestOfFieldExpectation<br>
|
||||
<b>Warning on line 47</b> - no @package tag was used in a DocBlock for class TestOfHeaderExpectations<br>
|
||||
<b>Warning on line 129</b> - no @package tag was used in a DocBlock for class TestOfTextExpectations<br>
|
||||
<b>Warning on line 148</b> - no @package tag was used in a DocBlock for class TestOfGenericAssertionsInWebTester<br>
|
||||
<b>Warning on line 155</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/web_tester_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="xml_test.php"></a>
|
||||
<h1>xml_test.php</h1>
|
||||
<h2>Warnings:</h2><br>
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for class TestOfNestingTags<br>
|
||||
<b>Warning on line 18</b> - no @package tag was used in a DocBlock for class TestOfXmlStructureParsing<br>
|
||||
<b>Warning on line 98</b> - no @package tag was used in a DocBlock for class AnyOldSignal<br>
|
||||
<b>Warning on line 102</b> - no @package tag was used in a DocBlock for class TestOfXmlResultsParsing<br>
|
||||
<b>Warning on line 186</b> - File "/home/josh/Source/pickles/vendors/SimpleTest-1.0.1/test/xml_test.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br>
|
||||
<a name="mock_objects.php"></a>
|
||||
<h1>mock_objects.php</h1>
|
||||
<h2>Errors:</h2><br>
|
||||
<b>Error on line 467</b> - @access was passed neither "public" nor "private." Was passed: "public."<br>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
24
docs/index.html
Normal file
24
docs/index.html
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html
|
||||
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//FR"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- Generated by phpDocumentor on Sat, 13 Mar 2010 14:42:52 -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>
|
||||
|
||||
<FRAMESET rows='120,*'>
|
||||
<FRAME src='packages.html' name='left_top' frameborder="1" bordercolor="#999999">
|
||||
<FRAMESET cols='25%,*'>
|
||||
<FRAME src='li_PICKLES.html' name='left_bottom' frameborder="1" bordercolor="#999999">
|
||||
<FRAME src='blank.html' name='right' frameborder="1" bordercolor="#999999">
|
||||
</FRAMESET>
|
||||
<NOFRAMES>
|
||||
<H2>Frame Alert</H2>
|
||||
<P>This document is designed to be viewed using the frames feature.
|
||||
If you see this message, you are using a non-frame-capable web client.</P>
|
||||
</NOFRAMES>
|
||||
</FRAMESET>
|
||||
</HTML>
|
||||
61
docs/li_PICKLES.html
Normal file
61
docs/li_PICKLES.html
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="package-title">PICKLES</div>
|
||||
<div class="package-details">
|
||||
|
||||
<dl class="tree">
|
||||
|
||||
<dt class="folder-title">Description</dt>
|
||||
<dd>
|
||||
<a href='classtrees_PICKLES.html' target='right'>Class trees</a><br />
|
||||
<a href='elementindex_PICKLES.html' target='right'>Index of elements</a><br />
|
||||
<a href="todolist.html" target="right">Todo List</a><br />
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt class="folder-title">Classes</dt>
|
||||
<dd><a href='PICKLES/Config.html' target='right'>Config</a></dd>
|
||||
<dd><a href='PICKLES/Controller.html' target='right'>Controller</a></dd>
|
||||
<dd><a href='PICKLES/Database.html' target='right'>Database</a></dd>
|
||||
<dd><a href='PICKLES/Display_Common.html' target='right'>Display_Common</a></dd>
|
||||
<dd><a href='PICKLES/Display_JSON.html' target='right'>Display_JSON</a></dd>
|
||||
<dd><a href='PICKLES/Display_PHP.html' target='right'>Display_PHP</a></dd>
|
||||
<dd><a href='PICKLES/Display_RSS.html' target='right'>Display_RSS</a></dd>
|
||||
<dd><a href='PICKLES/Display_Smarty.html' target='right'>Display_Smarty</a></dd>
|
||||
<dd><a href='PICKLES/Logger.html' target='right'>Logger</a></dd>
|
||||
<dd><a href='PICKLES/Model.html' target='right'>Model</a></dd>
|
||||
<dd><a href='PICKLES/Module.html' target='right'>Module</a></dd>
|
||||
<dd><a href='PICKLES/Object.html' target='right'>Object</a></dd>
|
||||
<dt class="folder-title">Functions</dt>
|
||||
<dd><a href='PICKLES/_pickles.php.html#function__autoload' target='right'>__autoload</a></dd>
|
||||
<dt class="folder-title">Files</dt>
|
||||
<dd><a href='PICKLES/_classes---Display---Common.php.html' target='right'>Common.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Config.php.html' target='right'>Config.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Controller.php.html' target='right'>Controller.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Database.php.html' target='right'>Database.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Display---JSON.php.html' target='right'>JSON.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Logger.php.html' target='right'>Logger.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Model.php.html' target='right'>Model.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Module.php.html' target='right'>Module.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Object.php.html' target='right'>Object.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Display---PHP.php.html' target='right'>PHP.php</a></dd>
|
||||
<dd><a href='PICKLES/_scripts---pickle.php.html' target='right'>pickle.php</a></dd>
|
||||
<dd><a href='PICKLES/_pickles.php.html' target='right'>pickles.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Display---RSS.php.html' target='right'>RSS.php</a></dd>
|
||||
<dd><a href='PICKLES/_classes---Display---Smarty.php.html' target='right'>Smarty.php</a></dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.4.2</span></a></p>
|
||||
</BODY>
|
||||
</HTML>
|
||||
32
docs/media/banner.css
Normal file
32
docs/media/banner.css
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
body
|
||||
{
|
||||
background-color: #CCCCFF;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
/* Banner (top bar) classes */
|
||||
|
||||
.banner { }
|
||||
|
||||
.banner-menu
|
||||
{
|
||||
clear: both;
|
||||
padding: .5em;
|
||||
border-top: 2px solid #6666AA;
|
||||
}
|
||||
|
||||
.banner-title
|
||||
{
|
||||
text-align: right;
|
||||
font-size: 20pt;
|
||||
font-weight: bold;
|
||||
margin: .2em;
|
||||
}
|
||||
|
||||
.package-selector
|
||||
{
|
||||
background-color: #AAAADD;
|
||||
border: 1px solid black;
|
||||
color: yellow;
|
||||
}
|
||||
144
docs/media/stylesheet.css
Normal file
144
docs/media/stylesheet.css
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
a { color: #336699; text-decoration: none; }
|
||||
a:hover { color: #6699CC; text-decoration: underline; }
|
||||
a:active { color: #6699CC; text-decoration: underline; }
|
||||
|
||||
body { background : #FFFFFF; }
|
||||
body, table { font-family: Georgia, Times New Roman, Times, serif; font-size: 10pt }
|
||||
p, li { line-height: 140% }
|
||||
a img { border: 0px; }
|
||||
dd { margin-left: 0px; padding-left: 1em; }
|
||||
|
||||
/* Page layout/boxes */
|
||||
|
||||
.info-box {}
|
||||
.info-box-title { margin: 1em 0em 0em 0em; padding: .25em; font-weight: normal; font-size: 14pt; border: 2px solid #999999; background-color: #CCCCFF }
|
||||
.info-box-body { border: 1px solid #999999; padding: .5em; }
|
||||
.nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }
|
||||
|
||||
.oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
|
||||
.evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
|
||||
|
||||
.page-body { max-width: 800px; margin: auto; }
|
||||
.tree dl { margin: 0px }
|
||||
|
||||
/* Index formatting classes */
|
||||
|
||||
.index-item-body { margin-top: .5em; margin-bottom: .5em}
|
||||
.index-item-description { margin-top: .25em }
|
||||
.index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
|
||||
.index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
|
||||
.index-letter-title { font-size: 12pt; font-weight: bold }
|
||||
.index-letter-menu { text-align: center; margin: 1em }
|
||||
.index-letter { font-size: 12pt }
|
||||
|
||||
/* Docbook classes */
|
||||
|
||||
.description {}
|
||||
.short-description { font-weight: bold; color: #666666; }
|
||||
.tags { padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
|
||||
.parameters { padding-left: 0em; margin-left: 3em; font-style: italic; list-style-type: square; }
|
||||
.redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
|
||||
.package { }
|
||||
.package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
|
||||
.package-details { font-size: 85%; }
|
||||
.sub-package { font-weight: bold; font-size: 120% }
|
||||
.tutorial { border-width: thin; border-color: #0066ff }
|
||||
.tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
|
||||
.nav-button-disabled { color: #999999; }
|
||||
.nav-button:active,
|
||||
.nav-button:focus,
|
||||
.nav-button:hover { background-color: #DDDDDD; outline: 1px solid #999999; text-decoration: none }
|
||||
.folder-title { font-style: italic }
|
||||
|
||||
/* Generic formatting */
|
||||
|
||||
.field { font-weight: bold; }
|
||||
.detail { font-size: 8pt; }
|
||||
.notes { font-style: italic; font-size: 8pt; }
|
||||
.separator { background-color: #999999; height: 2px; }
|
||||
.warning { color: #FF6600; }
|
||||
.disabled { font-style: italic; color: #999999; }
|
||||
|
||||
/* Code elements */
|
||||
|
||||
.line-number { }
|
||||
|
||||
.class-table { width: 100%; }
|
||||
.class-table-header { border-bottom: 1px dotted #666666; text-align: left}
|
||||
.class-name { color: #000000; font-weight: bold; }
|
||||
|
||||
.method-summary { padding-left: 1em; font-size: 8pt }
|
||||
.method-header { }
|
||||
.method-definition { margin-bottom: .3em }
|
||||
.method-title { font-weight: bold; }
|
||||
.method-name { font-weight: bold; }
|
||||
.method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
|
||||
.method-result { font-style: italic; }
|
||||
|
||||
.var-summary { padding-left: 1em; font-size: 8pt; }
|
||||
.var-header { }
|
||||
.var-title { margin-bottom: .3em }
|
||||
.var-type { font-style: italic; }
|
||||
.var-name { font-weight: bold; }
|
||||
.var-default {}
|
||||
.var-description { font-weight: normal; color: #000000; }
|
||||
|
||||
.include-title { }
|
||||
.include-type { font-style: italic; }
|
||||
.include-name { font-weight: bold; }
|
||||
|
||||
.const-title { }
|
||||
.const-name { font-weight: bold; }
|
||||
|
||||
/* Syntax highlighting */
|
||||
|
||||
.src-code { border: 1px solid #336699; padding: 1em; background-color: #EEEEEE; }
|
||||
.src-line { font-family: 'Courier New', Courier, monospace; font-weight: normal; }
|
||||
|
||||
.src-comm { color: green; }
|
||||
.src-id { }
|
||||
.src-inc { color: #0000FF; }
|
||||
.src-key { color: #0000FF; }
|
||||
.src-num { color: #CC0000; }
|
||||
.src-str { color: #66cccc; }
|
||||
.src-sym { font-weight: bold; }
|
||||
.src-var { }
|
||||
|
||||
.src-php { font-weight: bold; }
|
||||
|
||||
.src-doc { color: #009999 }
|
||||
.src-doc-close-template { color: #0000FF }
|
||||
.src-doc-coretag { color: #0099FF; font-weight: bold }
|
||||
.src-doc-inlinetag { color: #0099FF }
|
||||
.src-doc-internal { color: #6699cc }
|
||||
.src-doc-tag { color: #0080CC }
|
||||
.src-doc-template { color: #0000FF }
|
||||
.src-doc-type { font-style: italic }
|
||||
.src-doc-var { font-style: italic }
|
||||
|
||||
.tute-tag { color: #009999 }
|
||||
.tute-attribute-name { color: #0000FF }
|
||||
.tute-attribute-value { color: #0099FF }
|
||||
.tute-entity { font-weight: bold; }
|
||||
.tute-comment { font-style: italic }
|
||||
.tute-inline-tag { color: #636311; font-weight: bold }
|
||||
|
||||
/* tutorial */
|
||||
|
||||
.authors { }
|
||||
.author { font-style: italic; font-weight: bold }
|
||||
.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
|
||||
.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; }
|
||||
*[class="example"] { line-height : 0.5em }
|
||||
.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; }
|
||||
*[class="listing"] { line-height : 0.5em }
|
||||
.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
|
||||
.ref-title-box { }
|
||||
.ref-title { }
|
||||
.ref-purpose { font-style: italic; color: #666666 }
|
||||
.ref-synopsis { }
|
||||
.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #CCCCFF }
|
||||
.cmd-synopsis { margin: 1em 0em }
|
||||
.cmd-title { font-weight: bold }
|
||||
.toc { margin-left: 2em; padding-left: 0em }
|
||||
|
||||
34
docs/packages.html
Normal file
34
docs/packages.html
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<link rel="stylesheet" href="media/banner.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="banner">
|
||||
<div class="banner-title">PICKLES</div>
|
||||
<div class="banner-menu">
|
||||
<table cellpadding="0" cellspacing="0" style="width: 100%">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
<a href="ric_README.html" target="right">README</a>
|
||||
|
||||
| <a href="ric_INSTALL.html" target="right">INSTALL</a>
|
||||
|
||||
| <a href="ric_COPYING.html" target="right">COPYING</a>
|
||||
|
||||
</td>
|
||||
<td style="width: 2em"> </td>
|
||||
<td style="text-align: right">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
693
docs/ric_COPYING.html
Normal file
693
docs/ric_COPYING.html
Normal file
|
|
@ -0,0 +1,693 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<h1 align="center">COPYING</h1>
|
||||
<pre>
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
||||
</pre>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
42
docs/ric_INSTALL.html
Normal file
42
docs/ric_INSTALL.html
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<h1 align="center">INSTALL</h1>
|
||||
<pre>
|
||||
______ _____ _____ _ __ _ _____ _____
|
||||
| ___ \_ _/ __ \| | / /| | | ___/ ___|
|
||||
| |_/ / | | | / \/| |/ / | | | |__ \ `--.
|
||||
| __/ | | | | | \ | | | __| `--. \
|
||||
| | _| |_| \__/\| |\ \| |____| |___/\__/ /
|
||||
\_| \___/ \____/\_| \_/\_____/\____/\____/
|
||||
|
||||
PHP Interface Collection of Killer Libraries to Enhance Stuff
|
||||
===========================================================================
|
||||
|
||||
Installation Guide
|
||||
------------------
|
||||
|
||||
1. Extract PICKLES source code to the location of your choice. I usually
|
||||
put it in /usr/share/pickles
|
||||
|
||||
2. Add PICKLES to your include path. This can be accomplished a number of
|
||||
ways, my preference being adding it to the VirtualHost entry of my
|
||||
Apache config and restart Apache:
|
||||
|
||||
php_value include_path .:/usr/share/pickles
|
||||
|
||||
3. Run the PICKLE site generation script (oh wait, there isn't one).
|
||||
|
||||
</pre>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
101
docs/ric_README.html
Normal file
101
docs/ric_README.html
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<h1 align="center">README</h1>
|
||||
<pre>
|
||||
______ _____ _____ _ __ _ _____ _____
|
||||
| ___ \_ _/ __ \| | / /| | | ___/ ___|
|
||||
| |_/ / | | | / \/| |/ / | | | |__ \ `--.
|
||||
| __/ | | | | | \ | | | __| `--. \
|
||||
| | _| |_| \__/\| |\ \| |____| |___/\__/ /
|
||||
\_| \___/ \____/\_| \_/\_____/\____/\____/
|
||||
|
||||
PHP Interface Collection of Killer Libraries to Enhance Stuff
|
||||
===========================================================================
|
||||
|
||||
What is PICKLES?
|
||||
----------------
|
||||
|
||||
The whole point behind PHP with PICKLES was for me (Josh Sherman) to take
|
||||
a decade of PHP experience and a dozen or so of my own websites (all
|
||||
running on different but similar custom systems of my own design) and build
|
||||
a new framework rapid development system that would be flexible enough to
|
||||
run all of my sites off of a single shared codebase. PICKLES runs in such a
|
||||
way that the core files are completely separate from the site code it's
|
||||
serving. So much so, that the core files should never really need to be
|
||||
accessed after installation (unless you want to void your warranty and/or
|
||||
make a global change to all of your sites), and each site you have running
|
||||
will be nicely packaged in a directory all it's own. This keeps your sites
|
||||
simple and tidy with no duplicated code for each site! In a site's
|
||||
directory modules (pages) are kept seperate from templates and everything
|
||||
is ran through a single entry point controller.
|
||||
|
||||
Okay, but why?
|
||||
--------------
|
||||
|
||||
Now I know you're wondering, "why didn't you just use one of the
|
||||
pre-existing and already established PHP frameworks that are out there?" I
|
||||
do have a handful of reasons for that, but those are personal gripes based
|
||||
on a limited number of experiences and I won't being going into detail
|
||||
about them. The main reason for developing my own framework is that I am,
|
||||
and also have been, a very do it yourself type when it comes to coding, and
|
||||
typically very proud of my coding accomplishments. Also, because all of the
|
||||
sites I had previously written shared a lot of the same concepts and in
|
||||
some cases, the same bits of code, it made a heck of a lot more sense for
|
||||
me to develop a new system based around some of the better concepts from
|
||||
previous outings than to rebuild my sites inside of another framework.
|
||||
|
||||
Get the facts!
|
||||
--------------
|
||||
|
||||
Please note that some of these may not be entirely accurate yet.
|
||||
|
||||
* PICKLES will only run on PHP 5.0.0 or greater. There are no plans to
|
||||
ever support PHP 4.x.y (or below) as those versions have reached end of
|
||||
life, so please don't ask.
|
||||
|
||||
* PICKLES is not Model-View-Controller (MVC). It was developed around
|
||||
concepts (as well as some naming conventions) of the MVC design pattern
|
||||
but does not entirely conform to my own understanding of MVC. I'm from
|
||||
the school of thought that there's not a single hammer for every nail,
|
||||
so there's no point in forcing PICKLES into the MVC box for the sake of
|
||||
it. PICKLES strives to provide a modular system for developing websites
|
||||
while keeping the display elements separated from any database calls and
|
||||
other logic. That isn't necessarily a bad thing, it just meants that
|
||||
PICKLES isn't all that trendy because it lacks a silly buzzword that's a
|
||||
bit overused at this point.
|
||||
|
||||
* PICKLES supports rendering Smarty template pages, returning JSON data
|
||||
and RSS feeds (currently only supports version 2.0) and is fully capable
|
||||
of running from the command line modes.
|
||||
|
||||
* PICKLES is coded fairly closely to the PEAR coding standards (sorry, I
|
||||
like my fancy braces inline for class and function definitions) and is
|
||||
fully documented in DocBlock notation.
|
||||
|
||||
* Included with PICKLES are shared CSS files (foundation classes and one to
|
||||
do a full CSS reset) and shared JavaScript files with includes a very
|
||||
trim AJAX library that handles a PICKLES-centric JSON object
|
||||
automatically. If your dataset does not fit into that format, custom
|
||||
handlers can be used instead.
|
||||
|
||||
* Writing error free code is very important to me, so any PHP development I
|
||||
do is made to be E_STRICT compatible. This means that not only is PICKLES
|
||||
code free of any errors, it is free of warnings as well.
|
||||
|
||||
* Depending on your server, any number of sites can be ran off of a single
|
||||
PICKLES install!
|
||||
|
||||
</pre>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
41
docs/todolist.html
Normal file
41
docs/todolist.html
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
<?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>Todo List</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div align="center"><h1>Todo List</h1></div>
|
||||
<h2>PICKLES</h2>
|
||||
<h3><a href="PICKLES/Model.html#methodcommitRecord">Model::commitRecord()</a></h3>
|
||||
<ul>
|
||||
<li>This will replace commit() eventually will add commitAll();</li>
|
||||
</ul>
|
||||
<h3><a href="PICKLES/_classes---Config.php.html">Config.php</a></h3>
|
||||
<ul>
|
||||
<li>Add support for .php and .ini config files (auto scan directory?)</li>
|
||||
</ul>
|
||||
<h3><a href="PICKLES/Display_RSS.html">Display_RSS</a></h3>
|
||||
<ul>
|
||||
<li>Need to add support for RSS v1.0 as well as ATOM feeds. This may result in my abstracting out these classes a bit more (Probably a Feed viewer that would take a parameter to determine which type of of feed to use).</li>
|
||||
</ul>
|
||||
<h3><a href="PICKLES/Config.html#methodload">Config::load()</a></h3>
|
||||
<ul>
|
||||
<li>Add the ability to load in multiple configuration files.</li>
|
||||
</ul>
|
||||
<h3><a href="PICKLES/Object.html">Object</a></h3>
|
||||
<ul>
|
||||
<li>Implement a profiler in every object</li>
|
||||
</ul>
|
||||
<h3><a href="PICKLES/Display_RSS.html#methodrender">Display_RSS::render()</a></h3>
|
||||
<ul>
|
||||
<li>Error handling is non-existant.</li>
|
||||
</ul>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 13 Mar 2010 14:42:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue