224 lines
No EOL
7.7 KiB
HTML
224 lines
No EOL
7.7 KiB
HTML
<?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 class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#__destruct" title="details" class="method-name">__destruct</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#prepareVariables" title="details" class="method-name">prepareVariables</a>
|
|
(<span class="var-type"></span> <span class="var-name">$request</span>)
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<h4>Inherited Variables</h4>
|
|
<A NAME='inherited_vars'><!-- --></A>
|
|
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
|
|
</span>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-vars">Vars</a>
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
|
|
<a name="method__construct" id="__construct"><!-- --></a>
|
|
<div class="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>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>
|
|
<a name="method__destruct" id="__destruct"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">421</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">
|
|
__destruct
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></dt>
|
|
<dd>Destructor</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
<a name="methodprepareVariables" id="prepareVariables"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">prepareVariables</span> (line <span class="line-number">432</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">
|
|
prepareVariables
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$request</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$request</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sat, 27 Nov 2010 21:43:41 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |