642 lines
No EOL
21 KiB
HTML
642 lines
No EOL
21 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 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">28</span>)
|
|
</p>
|
|
|
|
|
|
<pre>Object
|
|
|
|
|
--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">object</span>
|
|
<a href="#$cache" title="details" class="var-name">$cache</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">object</span>
|
|
<a href="#$db" title="details" class="var-name">$db</a>
|
|
</div>
|
|
<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="#$hash" title="details" class="var-name">$hash</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">string</span>
|
|
<a href="#$method" title="details" class="var-name">$method</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">boolean,</span>
|
|
<a href="#$private" title="details" class="var-name">$private</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">boolean,</span>
|
|
<a href="#$security" title="details" class="var-name">$security</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">boolean,</span>
|
|
<a href="#$session" title="details" class="var-name">$session</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string,</span>
|
|
<a href="#$template" title="details" class="var-name">$template</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string,</span>
|
|
<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">boolean</span>
|
|
<a href="#setRequest" title="details" class="method-name">setRequest</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$request</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#__default" title="details" class="method-name">__default</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">mixed</span>
|
|
<a href="#__get" title="details" class="method-name">__get</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</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">$name</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$cache" id="$cache"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$cache</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">36</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Cache Object</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$db" id="$db"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$db</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">44</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Database Object</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$description" id="$description"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string,</span>
|
|
<span class="var-name">$description</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">60</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Meta Description</p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$engine" id="$engine"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<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">139</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 JSON, XML or RSS. Value is overwritten by the config value if not set by the module.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$hash" id="$hash"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$hash</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">128</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Hash</p>
|
|
<p class="description"><p>Whether or not to validate the security hash. Boolean true will indicate using the name of the module as the hash, a string value will use the value instead.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> or boolean, null by default</li>
|
|
<li><span class="field">access:</span> protected</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>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">68</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Meta Keywords (comma separated)</p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$method" id="$method"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$method</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">116</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Method</p>
|
|
<p class="description"><p>Request methods that are allowed to access the module.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> or array, null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$private" id="$private"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean,</span>
|
|
<span class="var-name">$private</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">88</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Private</p>
|
|
<p class="description"><p>Whether or not the page can be accessed directly.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> false by default</li>
|
|
<li><span class="field">access:</span> protected</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"> null</span> (line <span class="line-number">78</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.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$security" id="$security"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean,</span>
|
|
<span class="var-name">$security</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">96</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Security Settings</p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$session" id="$session"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean,</span>
|
|
<span class="var-name">$session</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">106</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Session</p>
|
|
<p class="description"><p>Whether or not a session should be established.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</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">151</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Default Template</p>
|
|
<p class="description"><p>Defaults to null but could be set to any valid template basename. The value is overwritten by the config value if not set by the module. The display engine determines what the file extension should be.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</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>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">52</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Page Title</p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> null by default</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</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-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">163</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>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetRequest" id="setRequest"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setRequest</span> (line <span class="line-number">235</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets the Request</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the assignment was successful</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
setRequest
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$request</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$request</span><span class="var-description">: data to be loaded into the request variable</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method__default" id="__default"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">__default</span> (line <span class="line-number">185</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>
|
|
<a name="method__get" id="__get"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">__get</span> (line <span class="line-number">212</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Magic Getter Method</p>
|
|
<p class="description"><p>Attempts to load the module variable. If it's not set, will attempt to load from the config.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> value of the variable or boolean false</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">mixed</span>
|
|
<span class="method-name">
|
|
__get
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: name of the variable requested</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method__set" id="__set"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">__set</span> (line <span class="line-number">198</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Magic Setter Method</p>
|
|
<p class="description"><p>Prohibits the direct modification of module variables.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">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">$name</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">$name</span><span class="var-description">: name of the variable to be set</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$value</span><span class="var-description">: value of the variable to be set</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Wed, 03 Oct 2012 17:46:05 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |