503 lines
No EOL
16 KiB
HTML
503 lines
No EOL
16 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 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-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 parent class class that each display class should be extending and executing parent::render()</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">abstract:</span> </li>
|
|
</ul>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Display---Common.php.html">/classes/Display/Common.php</a> (line <span class="field">24</span>)
|
|
</p>
|
|
|
|
|
|
<pre>Object
|
|
|
|
|
--Display_Common</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variable Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="var-summary">
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$child_template" title="details" class="var-name">$child_template</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$css_class" title="details" class="var-name">$css_class</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$extension" title="details" class="var-name">$extension</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$js_basename" title="details" class="var-name">$js_basename</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$meta_data" title="details" class="var-name">$meta_data</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$module_return" title="details" class="var-name">$module_return</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$parent_template" title="details" class="var-name">$parent_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-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>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#render" title="details" class="method-name">render</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setMetaData" title="details" class="method-name">setMetaData</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$meta_data</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setModuleReturn" title="details" class="method-name">setModuleReturn</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$module_return</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setTemplateVariables" title="details" class="method-name">setTemplateVariables</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$parent_template</span>, <span class="var-type">string</span> <span class="var-name">$child_template</span>, <span class="var-type">string</span> <span class="var-name">$css_class</span>, <span class="var-type">string</span> <span class="var-name">$js_basename</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#templateExists" title="details" class="method-name">templateExists</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$child_template" id="$child_template"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$child_template</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Child (sub) Template</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$css_class" id="$css_class"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$css_class</span>
|
|
= <span class="var-default"> ''</span> (line <span class="line-number">56</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">CSS Class Name</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$extension" id="$extension"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$extension</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">32</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Template Extension</p>
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> file extension for the template files</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$js_basename" id="$js_basename"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$js_basename</span>
|
|
= <span class="var-default"> ''</span> (line <span class="line-number">64</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Javascript [Path and] Basename</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$meta_data" id="$meta_data"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$meta_data</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Meta Data</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$module_return" id="$module_return"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$module_return</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">80</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$parent_template" id="$parent_template"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$parent_template</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">40</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Parent Template</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-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">87</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<p class="description"><p>Gets those headers working</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>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</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">194</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Rendering Method</p>
|
|
<ul class="tags">
|
|
<li><span class="field">abstract:</span> </li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
render
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodsetMetaData" id="setMetaData"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setMetaData</span> (line <span class="line-number">159</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set Meta Data</p>
|
|
<p class="description"><p>Sets the meta data from the module so the display class can use it</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">
|
|
setMetaData
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$meta_data</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$meta_data</span><span class="var-description">: key/value array of data</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetModuleReturn" id="setModuleReturn"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setModuleReturn</span> (line <span class="line-number">171</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set Module Return</p>
|
|
<p class="description"><p>Sets the return data from the module so the display class can display it</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">
|
|
setModuleReturn
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$module_return</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$module_return</span><span class="var-description">: key / value pairs for the data</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetTemplateVariables" id="setTemplateVariables"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setTemplateVariables</span> (line <span class="line-number">143</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set Template Variables</p>
|
|
<p class="description"><p>Sets the variables used by the templates</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">
|
|
setTemplateVariables
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$parent_template</span>, <span class="var-type">string</span> <span class="var-name">$child_template</span>, <span class="var-type">string</span> <span class="var-name">$css_class</span>, <span class="var-type">string</span> <span class="var-name">$js_basename</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$parent_template</span><span class="var-description">: parent template</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$child_template</span><span class="var-description">: child (sub) template</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$css_class</span><span class="var-description">: name of the CSS class for the module</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$js_basename</span><span class="var-description">: basename for the javascript file for the module</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodtemplateExists" id="templateExists"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">templateExists</span> (line <span class="line-number">184</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Template Exists</p>
|
|
<p class="description"><p>Checks the templates for validity, not required by every display type so the return defaults to true.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the template exists</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
templateExists
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |