1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
5
<!-- template designed by Marco Von Ballmoos -->
6
<title>Docs For Class PHPDS_template</title>
7
<link rel="stylesheet" href="../media/stylesheet.css" />
8
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
11
<div class="page-body">
12
<h2 class="class-name">Class PHPDS_template</h2>
14
<a name="sec-description"></a>
15
<div class="info-box">
16
<div class="info-box-title">Description</div>
18
<span class="disabled">Description</span> |
19
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
<div class="info-box-body">
24
<!-- ========== Info from phpDoc block ========= -->
25
<p class="short-description">PHPDevShell is a RAD Framework aimed at developing administrative applications.</p>
27
<li><span class="field">author:</span> Jason Schoeman</li>
28
<li><span class="field">version:</span> 1.0.2 (greg)</li>
29
<li><span class="field">copyright:</span> Copyright (C) 2007 Jason Schoeman, All rights reserved.</li>
30
<li><span class="field">link:</span> <a href="http://www.phpdevshell.org">http://www.phpdevshell.org</a></li>
31
<li><span class="field">license:</span> GNU/LGPL,</li>
34
Located in <a class="field" href="_PHPDS_template.class.php.html">/PHPDS_template.class.php</a> (line <span class="field">14</span>)
38
<pre><a href="../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a>
40
--<a href="../PHPDevShell/template.html">template</a>
42
--PHPDS_template</pre>
49
<a name="sec-var-summary"></a>
50
<div class="info-box">
51
<div class="info-box-title">Variable Summary</span></div>
53
<a href="#sec-description">Description</a> |
54
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
56
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
59
<div class="info-box-body">
60
<div class="var-summary">
61
<div class="var-title">
62
<span class="var-type">string</span>
63
<a href="#$CDN" title="details" class="var-name">$CDN</a>
65
<div class="var-title">
66
<span class="var-type">string</span>
67
<a href="#$controller" title="details" class="var-name">$controller</a>
69
<div class="var-title">
70
<span class="var-type">string</span>
71
<a href="#$debugStr" title="details" class="var-name">$debugStr</a>
73
<div class="var-title">
74
<span class="var-type">array</span>
75
<a href="#$global" title="details" class="var-name">$global</a>
77
<div class="var-title">
78
<span class="var-type">string</span>
79
<a href="#$loginMessage" title="details" class="var-name">$loginMessage</a>
81
<div class="var-title">
82
<span class="var-type">string</span>
83
<a href="#$modifyHead" title="details" class="var-name">$modifyHead</a>
85
<div class="var-title">
86
<span class="var-type">mixed</span>
87
<a href="#$modifyOutputBreadcrumbs" title="details" class="var-name">$modifyOutputBreadcrumbs</a>
89
<div class="var-title">
90
<span class="var-type">mixed</span>
91
<a href="#$modifyOutputController" title="details" class="var-name">$modifyOutputController</a>
93
<div class="var-title">
94
<span class="var-type">mixed</span>
95
<a href="#$modifyOutputFooter" title="details" class="var-name">$modifyOutputFooter</a>
97
<div class="var-title">
98
<span class="var-type">mixed</span>
99
<a href="#$modifyOutputGroup" title="details" class="var-name">$modifyOutputGroup</a>
101
<div class="var-title">
102
<span class="var-type">mixed</span>
103
<a href="#$modifyOutputLoginLink" title="details" class="var-name">$modifyOutputLoginLink</a>
105
<div class="var-title">
106
<span class="var-type">mixed</span>
107
<a href="#$modifyOutputLogo" title="details" class="var-name">$modifyOutputLogo</a>
109
<div class="var-title">
110
<span class="var-type">mixed</span>
111
<a href="#$modifyOutputMenu" title="details" class="var-name">$modifyOutputMenu</a>
113
<div class="var-title">
114
<span class="var-type">mixed</span>
115
<a href="#$modifyOutputRole" title="details" class="var-name">$modifyOutputRole</a>
117
<div class="var-title">
118
<span class="var-type">mixed</span>
119
<a href="#$modifyOutputTextLogo" title="details" class="var-name">$modifyOutputTextLogo</a>
121
<div class="var-title">
122
<span class="var-type">mixed</span>
123
<a href="#$modifyOutputTime" title="details" class="var-name">$modifyOutputTime</a>
125
<div class="var-title">
126
<span class="var-type">mixed</span>
127
<a href="#$modifyOutputTitle" title="details" class="var-name">$modifyOutputTitle</a>
129
<div class="var-title">
130
<span class="var-type">mixed</span>
131
<a href="#$modifyOutputUser" title="details" class="var-name">$modifyOutputUser</a>
133
<div class="var-title">
134
<span class="var-type">array</span>
135
<a href="#$module" title="details" class="var-name">$module</a>
137
<div class="var-title">
138
<span class="var-type">array</span>
139
<a href="#$pieces" title="details" class="var-name">$pieces</a>
141
<div class="var-title">
142
<span class="var-type">array</span>
143
<a href="#$skipLogin" title="details" class="var-name">$skipLogin</a>
145
<div class="var-title">
146
<span class="var-type">array</span>
147
<a href="#$stopScript" title="details" class="var-name">$stopScript</a>
149
<div class="var-title">
150
<span class="var-type">string</span>
151
<a href="#$templateName" title="details" class="var-name">$templateName</a>
157
<a name="sec-method-summary"></a>
158
<div class="info-box">
159
<div class="info-box-title">Method Summary</span></div>
160
<div class="nav-bar">
161
<a href="#sec-description">Description</a> |
162
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
165
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
167
<div class="info-box-body">
168
<div class="method-summary">
170
<div class="method-definition">
171
<span class="method-result">void</span>
172
<a href="#addCssFileToHead" title="details" class="method-name">addCssFileToHead</a>
173
([<span class="var-type">string</span> <span class="var-name">$cssRelativePath</span> = <span class="var-default">''</span>], [<span class="var-type"></span> <span class="var-name">$media</span> = <span class="var-default">'screen, projection'</span>])
175
<div class="method-definition">
176
<span class="method-result">void</span>
177
<a href="#addCSSToHead" title="details" class="method-name">addCSSToHead</a>
178
([<span class="var-type">string</span> <span class="var-name">$css</span> = <span class="var-default">''</span>])
180
<div class="method-definition">
181
<span class="method-result">void</span>
182
<a href="#addJsFileToHead" title="details" class="method-name">addJsFileToHead</a>
183
([<span class="var-type">string</span> <span class="var-name">$jsRelativePath</span> = <span class="var-default">''</span>])
185
<div class="method-definition">
186
<span class="method-result">void</span>
187
<a href="#addJsToHead" title="details" class="method-name">addJsToHead</a>
188
([<span class="var-type">string</span> <span class="var-name">$js</span> = <span class="var-default">''</span>])
190
<div class="method-definition">
191
<span class="method-result">void</span>
192
<a href="#addToHead" title="details" class="method-name">addToHead</a>
193
([<span class="var-type">string</span> <span class="var-name">$extraHead</span> = <span class="var-default">''</span>])
195
<div class="method-definition">
196
<span class="method-result">string</span>
197
<a href="#busy" title="details" class="method-name">busy</a>
198
(<span class="var-type">string</span> <span class="var-name">$busy</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
200
<div class="method-definition">
201
<span class="method-result">string</span>
202
<a href="#critical" title="details" class="method-name">critical</a>
203
(<span class="var-type">string</span> <span class="var-name">$critical</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>], [<span class="var-type"></span> <span class="var-name">$mail</span> = <span class="var-default">'mailadmin'</span>])
205
<div class="method-definition">
206
<span class="method-result">void</span>
207
<a href="#debugInfo" title="details" class="method-name">debugInfo</a>
208
(<span class="var-type">string</span> <span class="var-name">$count_queries</span>)
210
<div class="method-definition">
211
<span class="method-result">string</span>
212
<a href="#error" title="details" class="method-name">error</a>
213
(<span class="var-type">string</span> <span class="var-name">$error</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
215
<div class="method-definition">
216
<span class="method-result">void</span>
217
<a href="#executeController" title="details" class="method-name">executeController</a>
220
<div class="method-definition">
221
<span class="method-result">integer</span>
222
<a href="#extendMenuLoop" title="details" class="method-name">extendMenuLoop</a>
223
(<span class="var-type">integer</span> <span class="var-name">$extended_menu_id</span>)
225
<div class="method-definition">
226
<span class="method-result">void</span>
227
<a href="#getPiece" title="details" class="method-name">getPiece</a>
228
(<span class="var-type">$name</span> <span class="var-name">$name</span>, [<span class="var-type">$module</span> <span class="var-name">$module</span> = <span class="var-default">false</span>])
230
<div class="method-definition">
231
<span class="method-result">string</span>
232
<a href="#getTemplate" title="details" class="method-name">getTemplate</a>
235
<div class="method-definition">
236
<span class="method-result">void</span>
237
<a href="#getTpl" title="details" class="method-name">getTpl</a>
238
([<span class="var-type">string</span> <span class="var-name">$load_view</span> = <span class="var-default">false</span>], [<span class="var-type">string</span> <span class="var-name">$plugin_override</span> = <span class="var-default">false</span>])
240
<div class="method-definition">
241
<span class="method-result">nothing</span>
242
<a href="#heading" title="details" class="method-name">heading</a>
243
(<span class="var-type">string</span> <span class="var-name">$heading</span>, [<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
245
<div class="method-definition">
246
<span class="method-result">string</span>
247
<a href="#htmlEntityDecode" title="details" class="method-name">htmlEntityDecode</a>
248
(<span class="var-type">string</span> <span class="var-name">$string_to_decode</span>)
250
<div class="method-definition">
251
<span class="method-result">void</span>
252
<a href="#icon" title="details" class="method-name">icon</a>
253
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">Title</span> <span class="var-name">$title</span> = <span class="var-default">false</span>], [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">16</span>], [<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'icon'</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">'.png'</span>], [<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">true</span>])
255
<div class="method-definition">
256
<span class="method-result">nothing</span>
257
<a href="#info" title="details" class="method-name">info</a>
258
(<span class="var-type">string</span> <span class="var-name">$information</span>, [<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
260
<div class="method-definition">
261
<span class="method-result">void</span>
262
<a href="#loadControllerFile" title="details" class="method-name">loadControllerFile</a>
263
(<span class="var-type">int</span> <span class="var-name">$menu_id</span>, [<span class="var-type"></span> <span class="var-name">$include_model</span> = <span class="var-default">false</span>])
265
<div class="method-definition">
266
<span class="method-result">void</span>
267
<a href="#loginForm" title="details" class="method-name">loginForm</a>
268
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
270
<div class="method-definition">
271
<span class="method-result">void</span>
272
<a href="#loginFormHeading" title="details" class="method-name">loginFormHeading</a>
273
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
275
<div class="method-definition">
276
<span class="method-result">string</span>
277
<a href="#message" title="details" class="method-name">message</a>
278
(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
280
<div class="method-definition">
281
<span class="method-result">void</span>
282
<a href="#modPrint" title="details" class="method-name">modPrint</a>
283
(<span class="var-type">string</span> <span class="var-name">$moduleName</span>, <span class="var-type">string</span> <span class="var-name">$string</span>)
285
<div class="method-definition">
286
<span class="method-result">string</span>
287
<a href="#note" title="details" class="method-name">note</a>
288
(<span class="var-type">string</span> <span class="var-name">$note</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
290
<div class="method-definition">
291
<span class="method-result">string</span>
292
<a href="#notice" title="details" class="method-name">notice</a>
293
(<span class="var-type">string</span> <span class="var-name">$notice</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
295
<div class="method-definition">
296
<span class="method-result">string</span>
297
<a href="#ok" title="details" class="method-name">ok</a>
298
(<span class="var-type">string</span> <span class="var-name">$ok</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
300
<div class="method-definition">
301
<span class="method-result">string</span>
302
<a href="#outputAbsoluteURL" title="details" class="method-name">outputAbsoluteURL</a>
303
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
305
<div class="method-definition">
306
<span class="method-result">void</span>
307
<a href="#outputBreadcrumbs" title="details" class="method-name">outputBreadcrumbs</a>
310
<div class="method-definition">
311
<span class="method-result">void</span>
312
<a href="#outputCharset" title="details" class="method-name">outputCharset</a>
313
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
315
<div class="method-definition">
316
<span class="method-result">void</span>
317
<a href="#outputController" title="details" class="method-name">outputController</a>
320
<div class="method-definition">
321
<span class="method-result">void</span>
322
<a href="#outputFooter" title="details" class="method-name">outputFooter</a>
325
<div class="method-definition">
326
<span class="method-result">void</span>
327
<a href="#outputGroup" title="details" class="method-name">outputGroup</a>
330
<div class="method-definition">
331
<span class="method-result">string</span>
332
<a href="#outputHead" title="details" class="method-name">outputHead</a>
333
([<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
335
<div class="method-definition">
336
<span class="method-result">void</span>
337
<a href="#outputLanguage" title="details" class="method-name">outputLanguage</a>
338
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
340
<div class="method-definition">
341
<span class="method-result">void</span>
342
<a href="#outputLoginLink" title="details" class="method-name">outputLoginLink</a>
345
<div class="method-definition">
346
<span class="method-result">void</span>
347
<a href="#outputLogo" title="details" class="method-name">outputLogo</a>
350
<div class="method-definition">
351
<span class="method-result">void</span>
352
<a href="#outputMenu" title="details" class="method-name">outputMenu</a>
355
<div class="method-definition">
356
<span class="method-result">string</span>
357
<a href="#outputMetaDescription" title="details" class="method-name">outputMetaDescription</a>
358
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
360
<div class="method-definition">
361
<span class="method-result">string</span>
362
<a href="#outputMetaKeywords" title="details" class="method-name">outputMetaKeywords</a>
363
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
365
<div class="method-definition">
366
<span class="method-result">void</span>
367
<a href="#outputNotifications" title="details" class="method-name">outputNotifications</a>
370
<div class="method-definition">
371
<span class="method-result">void</span>
372
<a href="#outputRole" title="details" class="method-name">outputRole</a>
375
<div class="method-definition">
376
<span class="method-result">void</span>
377
<a href="#outputScript" title="details" class="method-name">outputScript</a>
380
<div class="method-definition">
381
<span class="method-result">string</span>
382
<a href="#outputScriptIcon" title="details" class="method-name">outputScriptIcon</a>
383
([<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
385
<div class="method-definition">
386
<span class="method-result">string</span>
387
<a href="#outputSkin" title="details" class="method-name">outputSkin</a>
388
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
390
<div class="method-definition">
391
<span class="method-result">void</span>
392
<a href="#outputTextLogo" title="details" class="method-name">outputTextLogo</a>
395
<div class="method-definition">
396
<span class="method-result">void</span>
397
<a href="#outputTime" title="details" class="method-name">outputTime</a>
400
<div class="method-definition">
401
<span class="method-result">void</span>
402
<a href="#outputTitle" title="details" class="method-name">outputTitle</a>
405
<div class="method-definition">
406
<span class="method-result">void</span>
407
<a href="#runTemplate" title="details" class="method-name">runTemplate</a>
410
<div class="method-definition">
411
<span class="method-result">string</span>
412
<a href="#scripthead" title="details" class="method-name">scripthead</a>
413
(<span class="var-type">string</span> <span class="var-name">$scripthead</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
415
<div class="method-definition">
416
<span class="method-result">void</span>
417
<a href="#scriptLogo" title="details" class="method-name">scriptLogo</a>
418
(<span class="var-type">string</span> <span class="var-name">$menu_link</span>, <span class="var-type">string</span> <span class="var-name">$active_plugin</span>, [<span class="var-type"></span> <span class="var-name">$alias</span> = <span class="var-default">null</span>])
420
<div class="method-definition">
421
<span class="method-result">void</span>
422
<a href="#setPiece" title="details" class="method-name">setPiece</a>
423
(<span class="var-type">$name</span> <span class="var-name">$name</span>, [<span class="var-type">$data</span> <span class="var-name">$data</span> = <span class="var-default">null</span>])
425
<div class="method-definition">
426
<span class="method-result">void</span>
427
<a href="#startBuffering" title="details" class="method-name">startBuffering</a>
430
<div class="method-definition">
431
<span class="method-result">void</span>
432
<a href="#tip" title="details" class="method-name">tip</a>
433
(<span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">boolean</span> <span class="var-name">$print</span> = <span class="var-default">false</span>])
435
<div class="method-definition">
436
<span class="method-result">string</span>
437
<a href="#warning" title="details" class="method-name">warning</a>
438
(<span class="var-type">string</span> <span class="var-name">$warning</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
444
<a name="sec-vars"></a>
445
<div class="info-box">
446
<div class="info-box-title">Variables</div>
447
<div class="nav-bar">
448
<a href="#sec-description">Description</a> |
449
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
453
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
456
<div class="info-box-body">
457
<a name="var$CDN" id="$CDN"><!-- --></A>
458
<div class="evenrow">
460
<div class="var-header">
461
<span class="var-title">
462
<span class="var-type">string</span>
463
<span class="var-name">$CDN</span>
464
(line <span class="line-number">151</span>)
468
<!-- ========== Info from phpDoc block ========= -->
469
<p class="short-description">Content Distribution Network.</p>
470
<p class="description"><p>If you are running a very large site, you might want to consider running a dedicated light http server (httpdlight, nginx) that only serves static content like images and static files, call it a CDN if you like. By adding a host here 'http://192.34.22.33/project/cdn', all images etc, of PHPDevShell will be loaded from this address.</p></p>
472
<li><span class="field">access:</span> protected</li>
480
<a name="var$controller" id="$controller"><!-- --></A>
483
<div class="var-header">
484
<span class="var-title">
485
<span class="var-type">string</span>
486
<span class="var-name">$controller</span>
487
(line <span class="line-number">85</span>)
491
<!-- ========== Info from phpDoc block ========= -->
492
<p class="short-description">Modify Output Controller content.</p>
494
<li><span class="field">access:</span> public</li>
502
<a name="var$debugStr" id="$debugStr"><!-- --></A>
503
<div class="evenrow">
505
<div class="var-header">
506
<span class="var-title">
507
<span class="var-type">string</span>
508
<span class="var-name">$debugStr</span>
509
= <span class="var-default"> false</span> (line <span class="line-number">104</span>)
513
<!-- ========== Info from phpDoc block ========= -->
514
<p class="short-description">Assign this variable if you would like to debug your script, it will show on critical errors as well.</p>
515
<p class="description"><p>It will parse anything that is assigned to it.</p></p>
517
<li><span class="field">access:</span> public</li>
525
<a name="var$global" id="$global"><!-- --></A>
528
<div class="var-header">
529
<span class="var-title">
530
<span class="var-type">array</span>
531
<span class="var-name">$global</span>
532
(line <span class="line-number">110</span>)
536
<!-- ========== Info from phpDoc block ========= -->
537
<p class="short-description">Use this to have global available variables throughout scripts. For instance in hooks.</p>
539
<li><span class="field">access:</span> public</li>
547
<a name="var$loginMessage" id="$loginMessage"><!-- --></A>
548
<div class="evenrow">
550
<div class="var-header">
551
<span class="var-title">
552
<span class="var-type">string</span>
553
<span class="var-name">$loginMessage</span>
554
(line <span class="line-number">135</span>)
558
<!-- ========== Info from phpDoc block ========= -->
559
<p class="short-description">Sends a message to login form.</p>
561
<li><span class="field">access:</span> public</li>
569
<a name="var$modifyHead" id="$modifyHead"><!-- --></A>
572
<div class="var-header">
573
<span class="var-title">
574
<span class="var-type">string</span>
575
<span class="var-name">$modifyHead</span>
576
= <span class="var-default"> ''</span> (line <span class="line-number">20</span>)
580
<!-- ========== Info from phpDoc block ========= -->
581
<p class="short-description">Adds content to head of page.</p>
583
<li><span class="field">access:</span> public</li>
591
<a name="var$modifyOutputBreadcrumbs" id="$modifyOutputBreadcrumbs"><!-- --></A>
592
<div class="evenrow">
594
<div class="var-header">
595
<span class="var-title">
596
<span class="var-type">mixed</span>
597
<span class="var-name">$modifyOutputBreadcrumbs</span>
598
= <span class="var-default"> false</span> (line <span class="line-number">70</span>)
602
<!-- ========== Info from phpDoc block ========= -->
603
<p class="short-description">Modify Output Breadcrumbs.</p>
605
<li><span class="field">access:</span> public</li>
613
<a name="var$modifyOutputController" id="$modifyOutputController"><!-- --></A>
616
<div class="var-header">
617
<span class="var-title">
618
<span class="var-type">mixed</span>
619
<span class="var-name">$modifyOutputController</span>
620
= <span class="var-default"> false</span> (line <span class="line-number">80</span>)
624
<!-- ========== Info from phpDoc block ========= -->
625
<p class="short-description">Modify Output Controller.</p>
627
<li><span class="field">access:</span> public</li>
635
<a name="var$modifyOutputFooter" id="$modifyOutputFooter"><!-- --></A>
636
<div class="evenrow">
638
<div class="var-header">
639
<span class="var-title">
640
<span class="var-type">mixed</span>
641
<span class="var-name">$modifyOutputFooter</span>
642
= <span class="var-default"> false</span> (line <span class="line-number">75</span>)
646
<!-- ========== Info from phpDoc block ========= -->
647
<p class="short-description">Modify Output Footer.</p>
649
<li><span class="field">access:</span> public</li>
657
<a name="var$modifyOutputGroup" id="$modifyOutputGroup"><!-- --></A>
660
<div class="var-header">
661
<span class="var-title">
662
<span class="var-type">mixed</span>
663
<span class="var-name">$modifyOutputGroup</span>
664
= <span class="var-default"> false</span> (line <span class="line-number">55</span>)
668
<!-- ========== Info from phpDoc block ========= -->
669
<p class="short-description">Modify Output Group.</p>
671
<li><span class="field">access:</span> public</li>
679
<a name="var$modifyOutputLoginLink" id="$modifyOutputLoginLink"><!-- --></A>
680
<div class="evenrow">
682
<div class="var-header">
683
<span class="var-title">
684
<span class="var-type">mixed</span>
685
<span class="var-name">$modifyOutputLoginLink</span>
686
= <span class="var-default"> false</span> (line <span class="line-number">40</span>)
690
<!-- ========== Info from phpDoc block ========= -->
691
<p class="short-description">Modify Output Login Link.</p>
693
<li><span class="field">access:</span> public</li>
701
<a name="var$modifyOutputLogo" id="$modifyOutputLogo"><!-- --></A>
704
<div class="var-header">
705
<span class="var-title">
706
<span class="var-type">mixed</span>
707
<span class="var-name">$modifyOutputLogo</span>
708
= <span class="var-default"> false</span> (line <span class="line-number">30</span>)
712
<!-- ========== Info from phpDoc block ========= -->
713
<p class="short-description">Modify Output Logo</p>
715
<li><span class="field">access:</span> public</li>
723
<a name="var$modifyOutputMenu" id="$modifyOutputMenu"><!-- --></A>
724
<div class="evenrow">
726
<div class="var-header">
727
<span class="var-title">
728
<span class="var-type">mixed</span>
729
<span class="var-name">$modifyOutputMenu</span>
730
= <span class="var-default"> false</span> (line <span class="line-number">65</span>)
734
<!-- ========== Info from phpDoc block ========= -->
735
<p class="short-description">Modify Output Menu.</p>
737
<li><span class="field">access:</span> public</li>
745
<a name="var$modifyOutputRole" id="$modifyOutputRole"><!-- --></A>
748
<div class="var-header">
749
<span class="var-title">
750
<span class="var-type">mixed</span>
751
<span class="var-name">$modifyOutputRole</span>
752
= <span class="var-default"> false</span> (line <span class="line-number">50</span>)
756
<!-- ========== Info from phpDoc block ========= -->
757
<p class="short-description">Modify Output Role.</p>
759
<li><span class="field">access:</span> public</li>
767
<a name="var$modifyOutputTextLogo" id="$modifyOutputTextLogo"><!-- --></A>
768
<div class="evenrow">
770
<div class="var-header">
771
<span class="var-title">
772
<span class="var-type">mixed</span>
773
<span class="var-name">$modifyOutputTextLogo</span>
774
= <span class="var-default"> false</span> (line <span class="line-number">25</span>)
778
<!-- ========== Info from phpDoc block ========= -->
779
<p class="short-description">Modify Output Text Logo</p>
781
<li><span class="field">access:</span> public</li>
789
<a name="var$modifyOutputTime" id="$modifyOutputTime"><!-- --></A>
792
<div class="var-header">
793
<span class="var-title">
794
<span class="var-type">mixed</span>
795
<span class="var-name">$modifyOutputTime</span>
796
= <span class="var-default"> false</span> (line <span class="line-number">35</span>)
800
<!-- ========== Info from phpDoc block ========= -->
801
<p class="short-description">Modify Output Time</p>
803
<li><span class="field">access:</span> public</li>
811
<a name="var$modifyOutputTitle" id="$modifyOutputTitle"><!-- --></A>
812
<div class="evenrow">
814
<div class="var-header">
815
<span class="var-title">
816
<span class="var-type">mixed</span>
817
<span class="var-name">$modifyOutputTitle</span>
818
= <span class="var-default"> false</span> (line <span class="line-number">60</span>)
822
<!-- ========== Info from phpDoc block ========= -->
823
<p class="short-description">Modify Output Title.</p>
825
<li><span class="field">access:</span> public</li>
833
<a name="var$modifyOutputUser" id="$modifyOutputUser"><!-- --></A>
836
<div class="var-header">
837
<span class="var-title">
838
<span class="var-type">mixed</span>
839
<span class="var-name">$modifyOutputUser</span>
840
= <span class="var-default"> false</span> (line <span class="line-number">45</span>)
844
<!-- ========== Info from phpDoc block ========= -->
845
<p class="short-description">Modify Output User.</p>
847
<li><span class="field">access:</span> public</li>
855
<a name="var$module" id="$module"><!-- --></A>
856
<div class="evenrow">
858
<div class="var-header">
859
<span class="var-title">
860
<span class="var-type">array</span>
861
<span class="var-name">$module</span>
862
= <span class="var-default">array()</span> (line <span class="line-number">122</span>)
866
<!-- ========== Info from phpDoc block ========= -->
867
<p class="short-description">Contains module html sniplets.</p>
869
<li><span class="field">access:</span> public</li>
877
<a name="var$pieces" id="$pieces"><!-- --></A>
880
<div class="var-header">
881
<span class="var-title">
882
<span class="var-type">array</span>
883
<span class="var-name">$pieces</span>
884
(line <span class="line-number">142</span>)
888
<!-- ========== Info from phpDoc block ========= -->
889
<p class="short-description">Repository of data pieces to be used by the actual Theme code</p>
891
<li><span class="field">since:</span> v3.1.0</li>
892
<li><span class="field">access:</span> protected</li>
900
<a name="var$skipLogin" id="$skipLogin"><!-- --></A>
901
<div class="evenrow">
903
<div class="var-header">
904
<span class="var-title">
905
<span class="var-type">array</span>
906
<span class="var-name">$skipLogin</span>
907
= <span class="var-default"> false</span> (line <span class="line-number">116</span>)
911
<!-- ========== Info from phpDoc block ========= -->
912
<p class="short-description">Use this to have global available variables throughout scripts. For instance in hooks.</p>
914
<li><span class="field">access:</span> public</li>
922
<a name="var$stopScript" id="$stopScript"><!-- --></A>
925
<div class="var-header">
926
<span class="var-title">
927
<span class="var-type">array</span>
928
<span class="var-name">$stopScript</span>
929
(line <span class="line-number">97</span>)
933
<!-- ========== Info from phpDoc block ========= -->
934
<p class="short-description">This variable is used to activate a stop script command, it will be used to end a script immediately while still finishing compiling the template.</p>
935
<p class="description"><p>Usage Example : <div class="src-code"><ol><li><div class="src-line"> <span class="src-comm">// This wil make the script stop (not PHPDevShell) while still finishing the template to the end.</span></div></li>
936
<li><div class="src-line"> <span class="src-var">$template</span><span class="src-sym">-></span><span class="src-id"><a href="../PHPDevShell/PHPDS_template.html#var$stopScript">stopScript</a> </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'type'</span>=><span class="src-str">'auth'</span><span class="src-sym">,</span><span class="src-str">'message'</span>=><span class="src-str">'The script stopped cause I wanted it to.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
939
<li><span class="field">access:</span> public</li>
947
<a name="var$templateName" id="$templateName"><!-- --></A>
948
<div class="evenrow">
950
<div class="var-header">
951
<span class="var-title">
952
<span class="var-type">string</span>
953
<span class="var-name">$templateName</span>
954
(line <span class="line-number">129</span>)
958
<!-- ========== Info from phpDoc block ========= -->
959
<p class="short-description">Name of the Theme to use (previously known as template)</p>
961
<li><span class="field">since:</span> v3.1.0</li>
962
<li><span class="field">access:</span> public</li>
970
<h4>Inherited Variables</h4>
971
<A NAME='inherited_vars'><!-- --></A>
972
<p>Inherited from <span class="classname"><a href="../PHPDevShell/template.html">template</a></span></p>
974
<span class="var-title">
975
<span class="var-name"><a href="../PHPDevShell/template.html#var$active_language">template::$active_language</a></span><br>
977
<span class="var-title">
978
<span class="var-name"><a href="../PHPDevShell/template.html#var$cron_output">template::$cron_output</a></span><br>
980
<span class="var-title">
981
<span class="var-name"><a href="../PHPDevShell/template.html#var$HOOK">template::$HOOK</a></span><br>
983
<span class="var-title">
984
<span class="var-name"><a href="../PHPDevShell/template.html#var$hook_array">template::$hook_array</a></span><br>
986
<span class="var-title">
987
<span class="var-name"><a href="../PHPDevShell/template.html#var$hook_request">template::$hook_request</a></span><br>
989
<span class="var-title">
990
<span class="var-name"><a href="../PHPDevShell/template.html#var$HTML">template::$HTML</a></span><br>
992
<span class="var-title">
993
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_active_info">template::$modify_output_active_info</a></span><br>
995
<span class="var-title">
996
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_breadcrumbs">template::$modify_output_breadcrumbs</a></span><br>
998
<span class="var-title">
999
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_footer">template::$modify_output_footer</a></span><br>
1001
<span class="var-title">
1002
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_menu">template::$modify_output_menu</a></span><br>
1004
<span class="var-title">
1005
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_script">template::$modify_output_script</a></span><br>
1007
<span class="var-title">
1008
<span class="var-name"><a href="../PHPDevShell/template.html#var$modify_output_title">template::$modify_output_title</a></span><br>
1010
<span class="var-title">
1011
<span class="var-name"><a href="../PHPDevShell/template.html#var$view">template::$view</a></span><br>
1014
<p>Inherited from <span class="classname"><a href="../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a></span></p>
1016
<span class="var-title">
1017
<span class="var-name"><a href="../PHPDevShell/PHPDS_dependant.html#var$dependance">PHPDS_dependant::$dependance</a></span><br>
1019
<span class="var-title">
1020
<span class="var-name"><a href="../PHPDevShell/PHPDS_dependant.html#var$parent">PHPDS_dependant::$parent</a></span><br>
1027
<a name="sec-methods"></a>
1028
<div class="info-box">
1029
<div class="info-box-title">Methods</div>
1030
<div class="nav-bar">
1031
<a href="#sec-description">Description</a> |
1032
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
1033
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
1036
<div class="info-box-body">
1037
<A NAME='method_detail'></A>
1039
<a name="methodaddCssFileToHead" id="addCssFileToHead"><!-- --></a>
1040
<div class="oddrow">
1042
<div class="method-header">
1043
<span class="method-title">addCssFileToHead</span> (line <span class="line-number">260</span>)
1046
<!-- ========== Info from phpDoc block ========= -->
1047
<p class="short-description">Will add any css path to the <head></head> tags of your document.</p>
1049
<li><span class="field">access:</span> public</li>
1052
<div class="method-signature">
1053
<span class="method-result">void</span>
1054
<span class="method-name">
1057
([<span class="var-type">string</span> <span class="var-name">$cssRelativePath</span> = <span class="var-default">''</span>], [<span class="var-type"></span> <span class="var-name">$media</span> = <span class="var-default">'screen, projection'</span>])
1060
<ul class="parameters">
1062
<span class="var-type">string</span>
1063
<span class="var-name">$cssRelativePath</span> </li>
1065
<span class="var-type"></span>
1066
<span class="var-name">$media</span> </li>
1071
<a name="methodaddCSSToHead" id="addCSSToHead"><!-- --></a>
1072
<div class="evenrow">
1074
<div class="method-header">
1075
<span class="method-title">addCSSToHead</span> (line <span class="line-number">296</span>)
1078
<!-- ========== Info from phpDoc block ========= -->
1079
<p class="short-description">Will add any css to the <head></head> tags of your document adding script tags.</p>
1081
<li><span class="field">access:</span> public</li>
1084
<div class="method-signature">
1085
<span class="method-result">void</span>
1086
<span class="method-name">
1089
([<span class="var-type">string</span> <span class="var-name">$css</span> = <span class="var-default">''</span>])
1092
<ul class="parameters">
1094
<span class="var-type">string</span>
1095
<span class="var-name">$css</span> </li>
1100
<a name="methodaddJsFileToHead" id="addJsFileToHead"><!-- --></a>
1101
<div class="oddrow">
1103
<div class="method-header">
1104
<span class="method-title">addJsFileToHead</span> (line <span class="line-number">269</span>)
1107
<!-- ========== Info from phpDoc block ========= -->
1108
<p class="short-description">Will add any js path to the <head></head> tags of your document.</p>
1110
<li><span class="field">access:</span> public</li>
1113
<div class="method-signature">
1114
<span class="method-result">void</span>
1115
<span class="method-name">
1118
([<span class="var-type">string</span> <span class="var-name">$jsRelativePath</span> = <span class="var-default">''</span>])
1121
<ul class="parameters">
1123
<span class="var-type">string</span>
1124
<span class="var-name">$jsRelativePath</span> </li>
1129
<a name="methodaddJsToHead" id="addJsToHead"><!-- --></a>
1130
<div class="evenrow">
1132
<div class="method-header">
1133
<span class="method-title">addJsToHead</span> (line <span class="line-number">287</span>)
1136
<!-- ========== Info from phpDoc block ========= -->
1137
<p class="short-description">Will add any js to the <head></head> tags of your document adding script tags.</p>
1139
<li><span class="field">access:</span> public</li>
1142
<div class="method-signature">
1143
<span class="method-result">void</span>
1144
<span class="method-name">
1147
([<span class="var-type">string</span> <span class="var-name">$js</span> = <span class="var-default">''</span>])
1150
<ul class="parameters">
1152
<span class="var-type">string</span>
1153
<span class="var-name">$js</span> </li>
1158
<a name="methodaddToHead" id="addToHead"><!-- --></a>
1159
<div class="oddrow">
1161
<div class="method-header">
1162
<span class="method-title">addToHead</span> (line <span class="line-number">278</span>)
1165
<!-- ========== Info from phpDoc block ========= -->
1166
<p class="short-description">Will add any content to the <head></head> tags of your document.</p>
1168
<li><span class="field">access:</span> public</li>
1171
<div class="method-signature">
1172
<span class="method-result">void</span>
1173
<span class="method-name">
1176
([<span class="var-type">string</span> <span class="var-name">$extraHead</span> = <span class="var-default">''</span>])
1179
<ul class="parameters">
1181
<span class="var-type">string</span>
1182
<span class="var-name">$extraHead</span> </li>
1187
<a name="methodbusy" id="busy"><!-- --></a>
1188
<div class="evenrow">
1190
<div class="method-header">
1191
<span class="method-title">busy</span> (line <span class="line-number">971</span>)
1194
<!-- ========== Info from phpDoc block ========= -->
1195
<p class="short-description">This returns/prints a busy of the script being executed. Intended to be used by the developer.</p>
1197
<li><span class="field">return:</span> Busy string.</li>
1198
<li><span class="field">author:</span> Jason Schoeman</li>
1199
<li><span class="field">access:</span> public</li>
1202
<div class="method-signature">
1203
<span class="method-result">string</span>
1204
<span class="method-name">
1207
(<span class="var-type">string</span> <span class="var-name">$busy</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1210
<ul class="parameters">
1212
<span class="var-type">string</span>
1213
<span class="var-name">$busy</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1215
<span class="var-type">mixed</span>
1216
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1221
<a name="methodcritical" id="critical"><!-- --></a>
1222
<div class="oddrow">
1224
<div class="method-header">
1225
<span class="method-title">critical</span> (line <span class="line-number">901</span>)
1228
<!-- ========== Info from phpDoc block ========= -->
1229
<p class="short-description">This returns/prints a critical message regarding the active script. Intended to be used by the developer.</p>
1231
<li><span class="field">return:</span> Critical string.</li>
1232
<li><span class="field">author:</span> Jason Schoeman</li>
1233
<li><span class="field">access:</span> public</li>
1236
<div class="method-signature">
1237
<span class="method-result">string</span>
1238
<span class="method-name">
1241
(<span class="var-type">string</span> <span class="var-name">$critical</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>], [<span class="var-type"></span> <span class="var-name">$mail</span> = <span class="var-default">'mailadmin'</span>])
1244
<ul class="parameters">
1246
<span class="var-type">string</span>
1247
<span class="var-name">$critical</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1249
<span class="var-type">mixed</span>
1250
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1252
<span class="var-type">mixed</span>
1253
<span class="var-name">$log</span><span class="var-description">: default is log, can be set true, print, return.</span> </li>
1255
<span class="var-type"></span>
1256
<span class="var-name">$mail</span> </li>
1261
<a name="methoddebugInfo" id="debugInfo"><!-- --></a>
1262
<div class="evenrow">
1264
<div class="method-header">
1265
<span class="method-title">debugInfo</span> (line <span class="line-number">1503</span>)
1268
<!-- ========== Info from phpDoc block ========= -->
1269
<p class="short-description">Prints the number of queries used to the gui.</p>
1271
<li><span class="field">access:</span> public</li>
1274
<div class="method-signature">
1275
<span class="method-result">void</span>
1276
<span class="method-name">
1279
(<span class="var-type">string</span> <span class="var-name">$count_queries</span>)
1282
<ul class="parameters">
1284
<span class="var-type">string</span>
1285
<span class="var-name">$count_queries</span> </li>
1290
<a name="methoderror" id="error"><!-- --></a>
1291
<div class="oddrow">
1293
<div class="method-header">
1294
<span class="method-title">error</span> (line <span class="line-number">867</span>)
1297
<!-- ========== Info from phpDoc block ========= -->
1298
<p class="short-description">This returns/prints a error message regarding the active script. Intended to be used by the developer where exceptions are caught.</p>
1300
<li><span class="field">return:</span> Error string.</li>
1301
<li><span class="field">author:</span> Jason Schoeman</li>
1302
<li><span class="field">access:</span> public</li>
1305
<div class="method-signature">
1306
<span class="method-result">string</span>
1307
<span class="method-name">
1310
(<span class="var-type">string</span> <span class="var-name">$error</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
1313
<ul class="parameters">
1315
<span class="var-type">string</span>
1316
<span class="var-name">$error</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1318
<span class="var-type">mixed</span>
1319
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1321
<span class="var-type">mixed</span>
1322
<span class="var-name">$log</span><span class="var-description">: default is log, can be set true, print, return.</span> </li>
1327
<a name="methodexecuteController" id="executeController"><!-- --></a>
1328
<div class="evenrow">
1330
<div class="method-header">
1331
<span class="method-title">executeController</span> (line <span class="line-number">1100</span>)
1334
<!-- ========== Info from phpDoc block ========= -->
1335
<p class="short-description">Executes the controller.</p>
1337
<li><span class="field">author:</span> Jason Schoeman</li>
1338
<li><span class="field">access:</span> public</li>
1341
<div class="method-signature">
1342
<span class="method-result">void</span>
1343
<span class="method-name">
1352
<a name="methodextendMenuLoop" id="extendMenuLoop"><!-- --></a>
1353
<div class="oddrow">
1355
<div class="method-header">
1356
<span class="method-title">extendMenuLoop</span> (line <span class="line-number">1072</span>)
1359
<!-- ========== Info from phpDoc block ========= -->
1360
<p class="short-description">This function support output_script by looking deeper into menu structure to find last linked menu item that is not linked to another.</p>
1362
<li><span class="field">access:</span> public</li>
1365
<div class="method-signature">
1366
<span class="method-result">integer</span>
1367
<span class="method-name">
1370
(<span class="var-type">integer</span> <span class="var-name">$extended_menu_id</span>)
1373
<ul class="parameters">
1375
<span class="var-type">integer</span>
1376
<span class="var-name">$extended_menu_id</span> </li>
1381
<a name="methodgetPiece" id="getPiece"><!-- --></a>
1382
<div class="evenrow">
1384
<div class="method-header">
1385
<span class="method-title">getPiece</span> (line <span class="line-number">1542</span>)
1388
<!-- ========== Info from phpDoc block ========= -->
1389
<p class="short-description">returns a piece from the repository, optionnaly throught a module</p>
1391
<li><span class="field">author:</span> greg <<a href="mailto:greg@phpdevshell.org">greg@phpdevshell.org</a>></li>
1392
<li><span class="field">version:</span> 1.0</li>
1393
<li><span class="field">since:</span> v3.1.0</li>
1394
<li><span class="field">date:</span> 20110309 (v1.0) (greg) added</li>
1395
<li><span class="field">access:</span> public</li>
1398
<div class="method-signature">
1399
<span class="method-result">void</span>
1400
<span class="method-name">
1403
(<span class="var-type">$name</span> <span class="var-name">$name</span>, [<span class="var-type">$module</span> <span class="var-name">$module</span> = <span class="var-default">false</span>])
1406
<ul class="parameters">
1408
<span class="var-type">$name</span>
1409
<span class="var-name">$name</span><span class="var-description">: string, the name of the piece to fetch</span> </li>
1411
<span class="var-type">$module</span>
1412
<span class="var-name">$module</span><span class="var-description">: string or boolean, (optionnal) the name of the module to use, true to use a module with the piece name, false not to use a module</span> </li>
1417
<a name="methodgetTemplate" id="getTemplate"><!-- --></a>
1418
<div class="oddrow">
1420
<div class="method-header">
1421
<span class="method-title">getTemplate</span> (line <span class="line-number">1425</span>)
1424
<!-- ========== Info from phpDoc block ========= -->
1425
<p class="short-description">Get and return the supposed to run template.</p>
1427
<li><span class="field">return:</span> if not found, return default.</li>
1428
<li><span class="field">author:</span> Jason Schoeman</li>
1429
<li><span class="field">access:</span> public</li>
1432
<div class="method-signature">
1433
<span class="method-result">string</span>
1434
<span class="method-name">
1443
<a name="methodgetTpl" id="getTpl"><!-- --></a>
1444
<div class="evenrow">
1446
<div class="method-header">
1447
<span class="method-title">getTpl</span> (line <span class="line-number">1445</span>)
1450
<!-- ========== Info from phpDoc block ========= -->
1451
<p class="short-description">Gets the correct location of a tpl file, will return full path, can be a view.tpl or view.tpl.php files.</p>
1453
<li><span class="field">access:</span> public</li>
1456
<div class="method-signature">
1457
<span class="method-result">void</span>
1458
<span class="method-name">
1461
([<span class="var-type">string</span> <span class="var-name">$load_view</span> = <span class="var-default">false</span>], [<span class="var-type">string</span> <span class="var-name">$plugin_override</span> = <span class="var-default">false</span>])
1464
<ul class="parameters">
1466
<span class="var-type">string</span>
1467
<span class="var-name">$load_view</span> </li>
1469
<span class="var-type">string</span>
1470
<span class="var-name">$plugin_override</span><span class="var-description">: If another plugin is to be used in the directory.</span> </li>
1475
<a name="methodheading" id="heading"><!-- --></a>
1476
<div class="oddrow">
1478
<div class="method-header">
1479
<span class="method-title">heading</span> (line <span class="line-number">729</span>)
1482
<!-- ========== Info from phpDoc block ========= -->
1483
<p class="short-description">This returns/prints a heading discription of the script being executed. Intended to be used by the developer.</p>
1485
<li><span class="field">author:</span> Jason Schoeman</li>
1486
<li><span class="field">version:</span> 1.1</li>
1487
<li><span class="field">date:</span> 20110309 (v1.1) (greg) changed to use the pieces repository</li>
1488
<li><span class="field">date:</span> 20110309 (v1.2) (jason) good idea but it wont work as heading is not mandatory in controllers.</li>
1489
<li><span class="field">access:</span> public</li>
1492
<div class="method-signature">
1493
<span class="method-result">nothing</span>
1494
<span class="method-name">
1497
(<span class="var-type">string</span> <span class="var-name">$heading</span>, [<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1500
<ul class="parameters">
1502
<span class="var-type">string</span>
1503
<span class="var-name">$heading</span><span class="var-description">: This is the message that will be displayed as the heading.</span> </li>
1505
<span class="var-type"></span>
1506
<span class="var-name">$return</span> </li>
1511
<a name="methodhtmlEntityDecode" id="htmlEntityDecode"><!-- --></a>
1512
<div class="evenrow">
1514
<div class="method-header">
1515
<span class="method-title">htmlEntityDecode</span> (line <span class="line-number">1525</span>)
1518
<!-- ========== Info from phpDoc block ========= -->
1519
<p class="short-description">Convert all HTML entities to their applicable characters.</p>
1521
<li><span class="field">access:</span> public</li>
1524
<div class="method-signature">
1525
<span class="method-result">string</span>
1526
<span class="method-name">
1529
(<span class="var-type">string</span> <span class="var-name">$string_to_decode</span>)
1532
<ul class="parameters">
1534
<span class="var-type">string</span>
1535
<span class="var-name">$string_to_decode</span> </li>
1540
<a name="methodicon" id="icon"><!-- --></a>
1541
<div class="oddrow">
1543
<div class="method-header">
1544
<span class="method-title">icon</span> (line <span class="line-number">774</span>)
1547
<!-- ========== Info from phpDoc block ========= -->
1548
<p class="short-description">This method will load given png icon from icon database,</p>
1550
<li><span class="field">access:</span> public</li>
1553
<div class="method-signature">
1554
<span class="method-result">void</span>
1555
<span class="method-name">
1558
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">Title</span> <span class="var-name">$title</span> = <span class="var-default">false</span>], [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">16</span>], [<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'icon'</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">'.png'</span>], [<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">true</span>])
1561
<ul class="parameters">
1563
<span class="var-type">string</span>
1564
<span class="var-name">$name</span><span class="var-description">: Icon name without extention.</span> </li>
1566
<span class="var-type">Title</span>
1567
<span class="var-name">$title</span><span class="var-description">: of given image.</span> </li>
1569
<span class="var-type">int</span>
1570
<span class="var-name">$size</span><span class="var-description">: The size folder to look within.</span> </li>
1572
<span class="var-type">string</span>
1573
<span class="var-name">$class</span><span class="var-description">: If an alternative class must be added to image.</span> </li>
1575
<span class="var-type">string</span>
1576
<span class="var-name">$type</span><span class="var-description">: File type.</span> </li>
1578
<span class="var-type">boolean</span>
1579
<span class="var-name">$return</span><span class="var-description">: Default is false, if set true, the heading will return instead of print.</span> </li>
1584
<a name="methodinfo" id="info"><!-- --></a>
1585
<div class="evenrow">
1587
<div class="method-header">
1588
<span class="method-title">info</span> (line <span class="line-number">752</span>)
1591
<!-- ========== Info from phpDoc block ========= -->
1592
<p class="short-description">This returns/prints info of the script being executed. Intended to be used by the developer.</p>
1594
<li><span class="field">author:</span> Jason Schoeman</li>
1595
<li><span class="field">version:</span> 1.1</li>
1596
<li><span class="field">date:</span> 20110309 (v1.1) (greg) changed to use the pieces repository</li>
1597
<li><span class="field">date:</span> 20110309 (v1.2) (jason) good idea but it wont work as info is not mandatory in controllers.</li>
1598
<li><span class="field">access:</span> public</li>
1601
<div class="method-signature">
1602
<span class="method-result">nothing</span>
1603
<span class="method-name">
1606
(<span class="var-type">string</span> <span class="var-name">$information</span>, [<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1609
<ul class="parameters">
1611
<span class="var-type">string</span>
1612
<span class="var-name">$information</span><span class="var-description">: This is the message that will be displayed as the info.</span> </li>
1614
<span class="var-type"></span>
1615
<span class="var-name">$return</span> </li>
1618
<hr class="separator" />
1619
<div class="notes">Redefinition of:</div>
1621
<dt><a href="../PHPDevShell/PHPDS_dependant.html#methodinfo">PHPDS_dependant::info()</a></dt>
1622
<dd>DEPRECATED: alias for _log()</dd>
1626
<a name="methodloadControllerFile" id="loadControllerFile"><!-- --></a>
1627
<div class="oddrow">
1629
<div class="method-header">
1630
<span class="method-title">loadControllerFile</span> (line <span class="line-number">1339</span>)
1633
<!-- ========== Info from phpDoc block ========= -->
1634
<p class="short-description">Will attempt to load controller file from various locations.</p>
1636
<li><span class="field">author:</span> Jason Schoeman</li>
1637
<li><span class="field">version:</span> 1.0.1</li>
1638
<li><span class="field">date:</span> 20100917 (v1.0) (Jason)</li>
1639
<li><span class="field">date:</span> 20110308 (v1.0.1) (greg) loadFile returns an exact false when the file is not found</li>
1640
<li><span class="field">access:</span> public</li>
1643
<div class="method-signature">
1644
<span class="method-result">void</span>
1645
<span class="method-name">
1648
(<span class="var-type">int</span> <span class="var-name">$menu_id</span>, [<span class="var-type"></span> <span class="var-name">$include_model</span> = <span class="var-default">false</span>])
1651
<ul class="parameters">
1653
<span class="var-type">int</span>
1654
<span class="var-name">$menu_id</span> </li>
1656
<span class="var-type"></span>
1657
<span class="var-name">$include_model</span> </li>
1662
<a name="methodloginForm" id="loginForm"><!-- --></a>
1663
<div class="evenrow">
1665
<div class="method-header">
1666
<span class="method-title">loginForm</span> (line <span class="line-number">1408</span>)
1669
<!-- ========== Info from phpDoc block ========= -->
1670
<p class="short-description">Executes the login.</p>
1672
<li><span class="field">author:</span> Jason Schoeman</li>
1673
<li><span class="field">access:</span> public</li>
1676
<div class="method-signature">
1677
<span class="method-result">void</span>
1678
<span class="method-name">
1681
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
1684
<ul class="parameters">
1686
<span class="var-type"></span>
1687
<span class="var-name">$return</span> </li>
1692
<a name="methodloginFormHeading" id="loginFormHeading"><!-- --></a>
1693
<div class="oddrow">
1695
<div class="method-header">
1696
<span class="method-title">loginFormHeading</span> (line <span class="line-number">1369</span>)
1699
<!-- ========== Info from phpDoc block ========= -->
1700
<p class="short-description">Login heading messages.</p>
1702
<li><span class="field">author:</span> Jason Schoeman</li>
1703
<li><span class="field">access:</span> public</li>
1706
<div class="method-signature">
1707
<span class="method-result">void</span>
1708
<span class="method-name">
1711
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
1714
<ul class="parameters">
1716
<span class="var-type"></span>
1717
<span class="var-name">$return</span> </li>
1722
<a name="methodmessage" id="message"><!-- --></a>
1723
<div class="evenrow">
1725
<div class="method-header">
1726
<span class="method-title">message</span> (line <span class="line-number">992</span>)
1729
<!-- ========== Info from phpDoc block ========= -->
1730
<p class="short-description">This returns/prints a message of the script being executed. Intended to be used by the developer.</p>
1732
<li><span class="field">return:</span> Message string.</li>
1733
<li><span class="field">author:</span> Jason Schoeman</li>
1734
<li><span class="field">access:</span> public</li>
1737
<div class="method-signature">
1738
<span class="method-result">string</span>
1739
<span class="method-name">
1742
(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1745
<ul class="parameters">
1747
<span class="var-type">string</span>
1748
<span class="var-name">$message</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1750
<span class="var-type">mixed</span>
1751
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1756
<a name="methodmodPrint" id="modPrint"><!-- --></a>
1757
<div class="oddrow">
1759
<div class="method-header">
1760
<span class="method-title">modPrint</span> (line <span class="line-number">454</span>)
1763
<!-- ========== Info from phpDoc block ========= -->
1764
<p class="short-description">Print a string via a module and returns the result</p>
1766
<li><span class="field">author:</span> greg</li>
1767
<li><span class="field">version:</span> 1.0</li>
1768
<li><span class="field">date:</span> 20100920 (v1.0) (greg) created</li>
1769
<li><span class="field">access:</span> public</li>
1772
<div class="method-signature">
1773
<span class="method-result">void</span>
1774
<span class="method-name">
1777
(<span class="var-type">string</span> <span class="var-name">$moduleName</span>, <span class="var-type">string</span> <span class="var-name">$string</span>)
1780
<ul class="parameters">
1782
<span class="var-type">string</span>
1783
<span class="var-name">$moduleName</span><span class="var-description">: the module to use</span> </li>
1785
<span class="var-type">string</span>
1786
<span class="var-name">$string</span><span class="var-description">: the string to print (several strings can be provided)</span> </li>
1791
<a name="methodnote" id="note"><!-- --></a>
1792
<div class="evenrow">
1794
<div class="method-header">
1795
<span class="method-title">note</span> (line <span class="line-number">1013</span>)
1798
<!-- ========== Info from phpDoc block ========= -->
1799
<p class="short-description">This returns/prints a note of the script being executed. Intended to be used by the developer.</p>
1801
<li><span class="field">return:</span> Note string.</li>
1802
<li><span class="field">author:</span> Jason Schoeman</li>
1803
<li><span class="field">access:</span> public</li>
1806
<div class="method-signature">
1807
<span class="method-result">string</span>
1808
<span class="method-name">
1811
(<span class="var-type">string</span> <span class="var-name">$note</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1814
<ul class="parameters">
1816
<span class="var-type">string</span>
1817
<span class="var-name">$note</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1819
<span class="var-type">mixed</span>
1820
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1825
<a name="methodnotice" id="notice"><!-- --></a>
1826
<div class="oddrow">
1828
<div class="method-header">
1829
<span class="method-title">notice</span> (line <span class="line-number">950</span>)
1832
<!-- ========== Info from phpDoc block ========= -->
1833
<p class="short-description">This returns/prints a notice of the script being executed. Intended to be used by the developer.</p>
1835
<li><span class="field">return:</span> Notice string.</li>
1836
<li><span class="field">author:</span> Jason Schoeman</li>
1837
<li><span class="field">access:</span> public</li>
1840
<div class="method-signature">
1841
<span class="method-result">string</span>
1842
<span class="method-name">
1845
(<span class="var-type">string</span> <span class="var-name">$notice</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1848
<ul class="parameters">
1850
<span class="var-type">string</span>
1851
<span class="var-name">$notice</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1853
<span class="var-type">mixed</span>
1854
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1859
<a name="methodok" id="ok"><!-- --></a>
1860
<div class="evenrow">
1862
<div class="method-header">
1863
<span class="method-title">ok</span> (line <span class="line-number">834</span>)
1866
<!-- ========== Info from phpDoc block ========= -->
1867
<p class="short-description">This returns/prints a ok message regarding the active script. Intended to be used by the developer.</p>
1869
<li><span class="field">return:</span> Ok string.</li>
1870
<li><span class="field">author:</span> Jason Schoeman</li>
1871
<li><span class="field">access:</span> public</li>
1874
<div class="method-signature">
1875
<span class="method-result">string</span>
1876
<span class="method-name">
1879
(<span class="var-type">string</span> <span class="var-name">$ok</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
1882
<ul class="parameters">
1884
<span class="var-type">string</span>
1885
<span class="var-name">$ok</span><span class="var-description">: This is the message that will be displayed.</span> </li>
1887
<span class="var-type">mixed</span>
1888
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1890
<span class="var-type">mixed</span>
1891
<span class="var-name">$log</span><span class="var-description">: default is log, can be set true, print, return.</span> </li>
1896
<a name="methodoutputAbsoluteURL" id="outputAbsoluteURL"><!-- --></a>
1897
<div class="oddrow">
1899
<div class="method-header">
1900
<span class="method-title">outputAbsoluteURL</span> (line <span class="line-number">394</span>)
1903
<!-- ========== Info from phpDoc block ========= -->
1904
<p class="short-description">This returns/prints the absolute url for inside theme usage.</p>
1906
<li><span class="field">return:</span> Absolute url.</li>
1907
<li><span class="field">author:</span> Jason Schoeman</li>
1908
<li><span class="field">access:</span> public</li>
1911
<div class="method-signature">
1912
<span class="method-result">string</span>
1913
<span class="method-name">
1916
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
1919
<ul class="parameters">
1921
<span class="var-type">mixed</span>
1922
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
1927
<a name="methodoutputBreadcrumbs" id="outputBreadcrumbs"><!-- --></a>
1928
<div class="evenrow">
1930
<div class="method-header">
1931
<span class="method-title">outputBreadcrumbs</span> (line <span class="line-number">637</span>)
1934
<!-- ========== Info from phpDoc block ========= -->
1935
<p class="short-description">Returns "breadcrumbs" to the template system. Intended to be used by the engine.</p>
1937
<li><span class="field">author:</span> Jason Schoeman</li>
1938
<li><span class="field">access:</span> public</li>
1941
<div class="method-signature">
1942
<span class="method-result">void</span>
1943
<span class="method-name">
1952
<a name="methodoutputCharset" id="outputCharset"><!-- --></a>
1953
<div class="oddrow">
1955
<div class="method-header">
1956
<span class="method-title">outputCharset</span> (line <span class="line-number">336</span>)
1959
<!-- ========== Info from phpDoc block ========= -->
1960
<p class="short-description">Outputs charset.</p>
1962
<li><span class="field">author:</span> Jason Schoeman</li>
1963
<li><span class="field">access:</span> public</li>
1966
<div class="method-signature">
1967
<span class="method-result">void</span>
1968
<span class="method-name">
1971
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
1974
<ul class="parameters">
1976
<span class="var-type"></span>
1977
<span class="var-name">$return</span> </li>
1982
<a name="methodoutputController" id="outputController"><!-- --></a>
1983
<div class="evenrow">
1985
<div class="method-header">
1986
<span class="method-title">outputController</span> (line <span class="line-number">677</span>)
1989
<!-- ========== Info from phpDoc block ========= -->
1990
<p class="short-description">Returns "output script" to the template system. Intended to be used by the engine.</p>
1992
<li><span class="field">author:</span> Jason Schoeman</li>
1993
<li><span class="field">access:</span> public</li>
1996
<div class="method-signature">
1997
<span class="method-result">void</span>
1998
<span class="method-name">
2007
<a name="methodoutputFooter" id="outputFooter"><!-- --></a>
2008
<div class="oddrow">
2010
<div class="method-header">
2011
<span class="method-title">outputFooter</span> (line <span class="line-number">707</span>)
2014
<!-- ========== Info from phpDoc block ========= -->
2015
<p class="short-description">Returns the last footer string to the template system. Intended to be used by the engine.</p>
2017
<li><span class="field">author:</span> Jason Schoeman</li>
2018
<li><span class="field">access:</span> public</li>
2021
<div class="method-signature">
2022
<span class="method-result">void</span>
2023
<span class="method-name">
2032
<a name="methodoutputGroup" id="outputGroup"><!-- --></a>
2033
<div class="evenrow">
2035
<div class="method-header">
2036
<span class="method-title">outputGroup</span> (line <span class="line-number">589</span>)
2039
<!-- ========== Info from phpDoc block ========= -->
2040
<p class="short-description">Sets template group.</p>
2042
<li><span class="field">author:</span> Jason Schoeman</li>
2043
<li><span class="field">access:</span> public</li>
2046
<div class="method-signature">
2047
<span class="method-result">void</span>
2048
<span class="method-name">
2057
<a name="methodoutputHead" id="outputHead"><!-- --></a>
2058
<div class="oddrow">
2060
<div class="method-header">
2061
<span class="method-title">outputHead</span> (line <span class="line-number">305</span>)
2064
<!-- ========== Info from phpDoc block ========= -->
2065
<p class="short-description">Changes head output.</p>
2067
<li><span class="field">access:</span> public</li>
2070
<div class="method-signature">
2071
<span class="method-result">string</span>
2072
<span class="method-name">
2075
([<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
2078
<ul class="parameters">
2080
<span class="var-type">boolean</span>
2081
<span class="var-name">$return</span> </li>
2086
<a name="methodoutputLanguage" id="outputLanguage"><!-- --></a>
2087
<div class="evenrow">
2089
<div class="method-header">
2090
<span class="method-title">outputLanguage</span> (line <span class="line-number">320</span>)
2093
<!-- ========== Info from phpDoc block ========= -->
2094
<p class="short-description">Outputs current language identifier being used.</p>
2096
<li><span class="field">author:</span> Jason Schoeman</li>
2097
<li><span class="field">access:</span> public</li>
2100
<div class="method-signature">
2101
<span class="method-result">void</span>
2102
<span class="method-name">
2105
([<span class="var-type"></span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
2108
<ul class="parameters">
2110
<span class="var-type"></span>
2111
<span class="var-name">$return</span> </li>
2116
<a name="methodoutputLoginLink" id="outputLoginLink"><!-- --></a>
2117
<div class="oddrow">
2119
<div class="method-header">
2120
<span class="method-title">outputLoginLink</span> (line <span class="line-number">543</span>)
2123
<!-- ========== Info from phpDoc block ========= -->
2124
<p class="short-description">Sets template login link.</p>
2126
<li><span class="field">author:</span> Jason Schoeman</li>
2127
<li><span class="field">access:</span> public</li>
2130
<div class="method-signature">
2131
<span class="method-result">void</span>
2132
<span class="method-name">
2141
<a name="methodoutputLogo" id="outputLogo"><!-- --></a>
2142
<div class="evenrow">
2144
<div class="method-header">
2145
<span class="method-title">outputLogo</span> (line <span class="line-number">467</span>)
2148
<!-- ========== Info from phpDoc block ========= -->
2149
<p class="short-description">Gets the desired logo and displays it. This method will try its best to deliver a logo, whatever the case.</p>
2151
<li><span class="field">author:</span> Jason Schoeman</li>
2152
<li><span class="field">access:</span> public</li>
2155
<div class="method-signature">
2156
<span class="method-result">void</span>
2157
<span class="method-name">
2166
<a name="methodoutputMenu" id="outputMenu"><!-- --></a>
2167
<div class="oddrow">
2169
<div class="method-header">
2170
<span class="method-title">outputMenu</span> (line <span class="line-number">652</span>)
2173
<!-- ========== Info from phpDoc block ========= -->
2174
<p class="short-description">Returns "menus" to the template system. Intended to be used by the engine.</p>
2176
<li><span class="field">author:</span> Jason Schoeman</li>
2177
<li><span class="field">access:</span> public</li>
2180
<div class="method-signature">
2181
<span class="method-result">void</span>
2182
<span class="method-name">
2191
<a name="methodoutputMetaDescription" id="outputMetaDescription"><!-- --></a>
2192
<div class="evenrow">
2194
<div class="method-header">
2195
<span class="method-title">outputMetaDescription</span> (line <span class="line-number">431</span>)
2198
<!-- ========== Info from phpDoc block ========= -->
2199
<p class="short-description">This returns/prints the meta description for inside theme usage.</p>
2201
<li><span class="field">return:</span> Meta Description.</li>
2202
<li><span class="field">author:</span> Jason Schoeman</li>
2203
<li><span class="field">access:</span> public</li>
2206
<div class="method-signature">
2207
<span class="method-result">string</span>
2208
<span class="method-name">
2209
outputMetaDescription
2211
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
2214
<ul class="parameters">
2216
<span class="var-type">mixed</span>
2217
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
2222
<a name="methodoutputMetaKeywords" id="outputMetaKeywords"><!-- --></a>
2223
<div class="oddrow">
2225
<div class="method-header">
2226
<span class="method-title">outputMetaKeywords</span> (line <span class="line-number">411</span>)
2229
<!-- ========== Info from phpDoc block ========= -->
2230
<p class="short-description">This returns/prints the meta keywords for inside theme usage.</p>
2232
<li><span class="field">return:</span> Meta Keywords.</li>
2233
<li><span class="field">author:</span> Jason Schoeman</li>
2234
<li><span class="field">access:</span> public</li>
2237
<div class="method-signature">
2238
<span class="method-result">string</span>
2239
<span class="method-name">
2242
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
2245
<ul class="parameters">
2247
<span class="var-type">mixed</span>
2248
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
2253
<a name="methodoutputNotifications" id="outputNotifications"><!-- --></a>
2254
<div class="evenrow">
2256
<div class="method-header">
2257
<span class="method-title">outputNotifications</span> (line <span class="line-number">1579</span>)
2260
<!-- ========== Info from phpDoc block ========= -->
2261
<p class="short-description">Ability to call and display notifications pushed to the notification system.</p>
2263
<li><span class="field">version:</span> 1.0</li>
2264
<li><span class="field">date:</span> 20110706 (v1.0) (greg) added</li>
2265
<li><span class="field">since:</span> v3.0.5</li>
2266
<li><span class="field">access:</span> public</li>
2269
<div class="method-signature">
2270
<span class="method-result">void</span>
2271
<span class="method-name">
2280
<a name="methodoutputRole" id="outputRole"><!-- --></a>
2281
<div class="oddrow">
2283
<div class="method-header">
2284
<span class="method-title">outputRole</span> (line <span class="line-number">569</span>)
2287
<!-- ========== Info from phpDoc block ========= -->
2288
<p class="short-description">Sets template role.</p>
2290
<li><span class="field">author:</span> Jason Schoeman</li>
2291
<li><span class="field">access:</span> public</li>
2294
<div class="method-signature">
2295
<span class="method-result">void</span>
2296
<span class="method-name">
2305
<a name="methodoutputScript" id="outputScript"><!-- --></a>
2306
<div class="evenrow">
2308
<div class="method-header">
2309
<span class="method-title">outputScript</span> (line <span class="line-number">667</span>)
2312
<!-- ========== Info from phpDoc block ========= -->
2313
<p class="short-description">Returns "output script" to the template system. Intended to be used by the engine.</p>
2315
<li><span class="field">author:</span> Jason Schoeman</li>
2316
<li><span class="field">access:</span> public</li>
2319
<div class="method-signature">
2320
<span class="method-result">void</span>
2321
<span class="method-name">
2330
<a name="methodoutputScriptIcon" id="outputScriptIcon"><!-- --></a>
2331
<div class="oddrow">
2333
<div class="method-header">
2334
<span class="method-title">outputScriptIcon</span> (line <span class="line-number">611</span>)
2337
<!-- ========== Info from phpDoc block ========= -->
2338
<p class="short-description">This returns/prints an image of the current script running.</p>
2340
<li><span class="field">return:</span> Returns image tag with image url.</li>
2341
<li><span class="field">author:</span> Jason Schoeman</li>
2342
<li><span class="field">access:</span> public</li>
2345
<div class="method-signature">
2346
<span class="method-result">string</span>
2347
<span class="method-name">
2350
([<span class="var-type">boolean</span> <span class="var-name">$return</span> = <span class="var-default">false</span>])
2353
<ul class="parameters">
2355
<span class="var-type">boolean</span>
2356
<span class="var-name">$return</span><span class="var-description">: Default is false, if set true, the heading will return instead of print.</span> </li>
2361
<a name="methodoutputSkin" id="outputSkin"><!-- --></a>
2362
<div class="evenrow">
2364
<div class="method-header">
2365
<span class="method-title">outputSkin</span> (line <span class="line-number">374</span>)
2368
<!-- ========== Info from phpDoc block ========= -->
2369
<p class="short-description">This returns/prints the skin for inside theme usage.</p>
2371
<li><span class="field">return:</span> Skin.</li>
2372
<li><span class="field">author:</span> Jason Schoeman</li>
2373
<li><span class="field">access:</span> public</li>
2376
<div class="method-signature">
2377
<span class="method-result">string</span>
2378
<span class="method-name">
2381
([<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
2384
<ul class="parameters">
2386
<span class="var-type">mixed</span>
2387
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
2392
<a name="methodoutputTextLogo" id="outputTextLogo"><!-- --></a>
2393
<div class="oddrow">
2395
<div class="method-header">
2396
<span class="method-title">outputTextLogo</span> (line <span class="line-number">691</span>)
2399
<!-- ========== Info from phpDoc block ========= -->
2400
<p class="short-description">Sets template system logo or name.</p>
2402
<li><span class="field">author:</span> Jason Schoeman</li>
2403
<li><span class="field">access:</span> public</li>
2406
<div class="method-signature">
2407
<span class="method-result">void</span>
2408
<span class="method-name">
2417
<a name="methodoutputTime" id="outputTime"><!-- --></a>
2418
<div class="evenrow">
2420
<div class="method-header">
2421
<span class="method-title">outputTime</span> (line <span class="line-number">527</span>)
2424
<!-- ========== Info from phpDoc block ========= -->
2425
<p class="short-description">Sets template time.</p>
2427
<li><span class="field">author:</span> Jason Schoeman</li>
2428
<li><span class="field">access:</span> public</li>
2431
<div class="method-signature">
2432
<span class="method-result">void</span>
2433
<span class="method-name">
2442
<a name="methodoutputTitle" id="outputTitle"><!-- --></a>
2443
<div class="oddrow">
2445
<div class="method-header">
2446
<span class="method-title">outputTitle</span> (line <span class="line-number">352</span>)
2449
<!-- ========== Info from phpDoc block ========= -->
2450
<p class="short-description">Outputs the active scripts title.</p>
2452
<li><span class="field">author:</span> Jason Schoeman</li>
2453
<li><span class="field">access:</span> public</li>
2456
<div class="method-signature">
2457
<span class="method-result">void</span>
2458
<span class="method-name">
2467
<a name="methodrunTemplate" id="runTemplate"><!-- --></a>
2468
<div class="evenrow">
2470
<div class="method-header">
2471
<span class="method-title">runTemplate</span> (line <span class="line-number">161</span>)
2474
<!-- ========== Info from phpDoc block ========= -->
2475
<p class="short-description">Run default, custom or no template.</p>
2477
<li><span class="field">author:</span> Jason Schoeman</li>
2478
<li><span class="field">version:</span> 1.2</li>
2479
<li><span class="field">date:</span> 20100520 (v1.1) (greg) added merging with modules from the configuration array</li>
2480
<li><span class="field">date:</span> 20110308 (v1.2) greg) allows the new style controller to alter the current template to be used</li>
2481
<li><span class="field">access:</span> public</li>
2484
<div class="method-signature">
2485
<span class="method-result">void</span>
2486
<span class="method-name">
2495
<a name="methodscripthead" id="scripthead"><!-- --></a>
2496
<div class="oddrow">
2498
<div class="method-header">
2499
<span class="method-title">scripthead</span> (line <span class="line-number">1034</span>)
2502
<!-- ========== Info from phpDoc block ========= -->
2503
<p class="short-description">This returns/prints a heading of the script being executed. Intended to be used by the developer.</p>
2505
<li><span class="field">return:</span> Heading string.</li>
2506
<li><span class="field">author:</span> Jason Schoeman</li>
2507
<li><span class="field">access:</span> public</li>
2510
<div class="method-signature">
2511
<span class="method-result">string</span>
2512
<span class="method-name">
2515
(<span class="var-type">string</span> <span class="var-name">$scripthead</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>])
2518
<ul class="parameters">
2520
<span class="var-type">string</span>
2521
<span class="var-name">$scripthead</span><span class="var-description">: This is the message that will be displayed.</span> </li>
2523
<span class="var-type">mixed</span>
2524
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
2529
<a name="methodscriptLogo" id="scriptLogo"><!-- --></a>
2530
<div class="evenrow">
2532
<div class="method-header">
2533
<span class="method-title">scriptLogo</span> (line <span class="line-number">499</span>)
2536
<!-- ========== Info from phpDoc block ========= -->
2537
<p class="short-description">Acquire script identification image or logo.</p>
2539
<li><span class="field">access:</span> public</li>
2542
<div class="method-signature">
2543
<span class="method-result">void</span>
2544
<span class="method-name">
2547
(<span class="var-type">string</span> <span class="var-name">$menu_link</span>, <span class="var-type">string</span> <span class="var-name">$active_plugin</span>, [<span class="var-type"></span> <span class="var-name">$alias</span> = <span class="var-default">null</span>])
2550
<ul class="parameters">
2552
<span class="var-type">string</span>
2553
<span class="var-name">$menu_link</span> </li>
2555
<span class="var-type">string</span>
2556
<span class="var-name">$active_plugin</span> </li>
2558
<span class="var-type"></span>
2559
<span class="var-name">$alias</span> </li>
2564
<a name="methodsetPiece" id="setPiece"><!-- --></a>
2565
<div class="oddrow">
2567
<div class="method-header">
2568
<span class="method-title">setPiece</span> (line <span class="line-number">1566</span>)
2571
<!-- ========== Info from phpDoc block ========= -->
2572
<p class="short-description">insert a piece into the repository</p>
2574
<li><span class="field">author:</span> greg <<a href="mailto:greg@phpdevshell.org">greg@phpdevshell.org</a>></li>
2575
<li><span class="field">version:</span> 1.0</li>
2576
<li><span class="field">since:</span> v3.1.0</li>
2577
<li><span class="field">date:</span> 20110309 (v1.0) (greg) added</li>
2578
<li><span class="field">access:</span> public</li>
2581
<div class="method-signature">
2582
<span class="method-result">void</span>
2583
<span class="method-name">
2586
(<span class="var-type">$name</span> <span class="var-name">$name</span>, [<span class="var-type">$data</span> <span class="var-name">$data</span> = <span class="var-default">null</span>])
2589
<ul class="parameters">
2591
<span class="var-type">$name</span>
2592
<span class="var-name">$name</span><span class="var-description">: string, the name of the piece to add</span> </li>
2594
<span class="var-type">$data</span>
2595
<span class="var-name">$data</span><span class="var-description">: string, the raw content of the piece</span> </li>
2600
<a name="methodstartBuffering" id="startBuffering"><!-- --></a>
2601
<div class="evenrow">
2603
<div class="method-header">
2604
<span class="method-title">startBuffering</span> (line <span class="line-number">246</span>)
2607
<!-- ========== Info from phpDoc block ========= -->
2609
<li><span class="field">access:</span> protected</li>
2612
<div class="method-signature">
2613
<span class="method-result">void</span>
2614
<span class="method-name">
2623
<a name="methodtip" id="tip"><!-- --></a>
2624
<div class="oddrow">
2626
<div class="method-header">
2627
<span class="method-title">tip</span> (line <span class="line-number">1054</span>)
2630
<!-- ========== Info from phpDoc block ========= -->
2631
<p class="short-description">This creates an the [i] when over with mouse a popup with a message appears, this can be placed anywhere. Intended to be used by the developer.</p>
2633
<li><span class="field">author:</span> Jason Schoeman</li>
2634
<li><span class="field">access:</span> public</li>
2637
<div class="method-signature">
2638
<span class="method-result">void</span>
2639
<span class="method-name">
2642
(<span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">boolean</span> <span class="var-name">$print</span> = <span class="var-default">false</span>])
2645
<ul class="parameters">
2647
<span class="var-type">string</span>
2648
<span class="var-name">$text</span><span class="var-description">: The message to diplay when mouse goes over the [i].</span> </li>
2650
<span class="var-type">boolean</span>
2651
<span class="var-name">$print</span><span class="var-description">: Sets to print out confirm link instead of return.</span> </li>
2656
<a name="methodwarning" id="warning"><!-- --></a>
2657
<div class="evenrow">
2659
<div class="method-header">
2660
<span class="method-title">warning</span> (line <span class="line-number">801</span>)
2663
<!-- ========== Info from phpDoc block ========= -->
2664
<p class="short-description">This returns/prints a warning message regarding the active script. Intended to be used by the developer.</p>
2666
<li><span class="field">return:</span> Warning string.</li>
2667
<li><span class="field">author:</span> Jason Schoeman</li>
2668
<li><span class="field">access:</span> public</li>
2671
<div class="method-signature">
2672
<span class="method-result">string</span>
2673
<span class="method-name">
2676
(<span class="var-type">string</span> <span class="var-name">$warning</span>, [<span class="var-type">mixed</span> <span class="var-name">$return</span> = <span class="var-default">'print'</span>], [<span class="var-type">mixed</span> <span class="var-name">$log</span> = <span class="var-default">'log'</span>])
2679
<ul class="parameters">
2681
<span class="var-type">string</span>
2682
<span class="var-name">$warning</span><span class="var-description">: This is the message that will be displayed.</span> </li>
2684
<span class="var-type">mixed</span>
2685
<span class="var-name">$return</span><span class="var-description">: default is print, can be set true, print, return.</span> </li>
2687
<span class="var-type">mixed</span>
2688
<span class="var-name">$log</span><span class="var-description">: default is log, can be set true, print, return.</span> </li>
2693
<h4>Inherited Methods</h4>
2694
<a name='inherited_methods'><!-- --></a>
2695
<!-- =========== Summary =========== -->
2696
<p>Inherited From <span class="classname"><a href="../PHPDevShell/template.html">template</a></span></p>
2698
<span class="method-name"><a href="../PHPDevShell/template.html#methodalt_color">template::alt_color()</a></span><br>
2699
<span class="method-name"><a href="../PHPDevShell/template.html#methodassign">template::assign()</a></span><br>
2700
<span class="method-name"><a href="../PHPDevShell/template.html#methoddisplay">template::display()</a></span><br>
2701
<span class="method-name"><a href="../PHPDevShell/template.html#methoddofetch">template::dofetch()</a></span><br>
2702
<span class="method-name"><a href="../PHPDevShell/template.html#methodextend_menu_loop">template::extend_menu_loop()</a></span><br>
2703
<span class="method-name"><a href="../PHPDevShell/template.html#methodfetch">template::fetch()</a></span><br>
2704
<span class="method-name"><a href="../PHPDevShell/template.html#methodget_template">template::get_template()</a></span><br>
2705
<span class="method-name"><a href="../PHPDevShell/template.html#methodhook">template::hook()</a></span><br>
2706
<span class="method-name"><a href="../PHPDevShell/template.html#methodhtml_entity_decode">template::html_entity_decode()</a></span><br>
2707
<span class="method-name"><a href="../PHPDevShell/template.html#methodiconize">template::iconize()</a></span><br>
2708
<span class="method-name"><a href="../PHPDevShell/template.html#methodinfo_mark">template::info_mark()</a></span><br>
2709
<span class="method-name"><a href="../PHPDevShell/template.html#methodload_icons">template::load_icons()</a></span><br>
2710
<span class="method-name"><a href="../PHPDevShell/template.html#methodlogin_emplate">template::login_emplate()</a></span><br>
2711
<span class="method-name"><a href="../PHPDevShell/template.html#methodout">template::out()</a></span><br>
2712
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_active_info">template::output_active_info()</a></span><br>
2713
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_breadcrumbs">template::output_breadcrumbs()</a></span><br>
2714
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_charset">template::output_charset()</a></span><br>
2715
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_footer">template::output_footer()</a></span><br>
2716
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_language">template::output_language()</a></span><br>
2717
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_logo">template::output_logo()</a></span><br>
2718
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_menu">template::output_menu()</a></span><br>
2719
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_script">template::output_script()</a></span><br>
2720
<span class="method-name"><a href="../PHPDevShell/template.html#methodoutput_title">template::output_title()</a></span><br>
2721
<span class="method-name"><a href="../PHPDevShell/template.html#methodrandom_color">template::random_color()</a></span><br>
2722
<span class="method-name"><a href="../PHPDevShell/template.html#methodresult">template::result()</a></span><br>
2723
<span class="method-name"><a href="../PHPDevShell/template.html#methodscript_logo">template::script_logo()</a></span><br>
2724
<span class="method-name"><a href="../PHPDevShell/template.html#methodset">template::set()</a></span><br>
2725
<span class="method-name"><a href="../PHPDevShell/template.html#methodshow">template::show()</a></span><br>
2726
<span class="method-name"><a href="../PHPDevShell/template.html#methodtemplate_cron_output">template::template_cron_output()</a></span><br>
2728
<!-- =========== Summary =========== -->
2729
<p>Inherited From <span class="classname"><a href="../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a></span></p>
2731
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#method__construct">PHPDS_dependant::__construct()</a></span><br>
2732
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodconstruct">PHPDS_dependant::construct()</a></span><br>
2733
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methoddebugInstance">PHPDS_dependant::debugInstance()</a></span><br>
2734
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodfactory">PHPDS_dependant::factory()</a></span><br>
2735
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodfactoryWith">PHPDS_dependant::factoryWith()</a></span><br>
2736
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodinfo">PHPDS_dependant::info()</a></span><br>
2737
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodlog">PHPDS_dependant::log()</a></span><br>
2738
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#methodPHPDS_dependance">PHPDS_dependant::PHPDS_dependance()</a></span><br>
2739
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#method_log">PHPDS_dependant::_log()</a></span><br>
2740
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#method__call">PHPDS_dependant::__call()</a></span><br>
2741
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#method__get">PHPDS_dependant::__get()</a></span><br>
2742
<span class="method-name"><a href="../PHPDevShell/PHPDS_dependant.html#method__set">PHPDS_dependant::__set()</a></span><br>
2749
<p class="notes" id="credit">
2750
Documentation generated on Tue, 09 Aug 2011 09:05:23 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
b'\\ No newline at end of file'
added
removed
other/phpdoc/PHPDevShell/PHPDS_template.html
