1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <!-- Generated with PHPDoc, http://www.phpdoc.de -->
5 <title>{APPNAME} - {CLASS_PACKAGE} - Class: {CLASS_NAME}</title>
6 <link href="phpdoc.css" rel="stylesheet" type="text/css">
10 <table width="100%" border="0">
12 <td align="left" valign="top" bgcolor="#B0BAFF">
15 <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
16 <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
17 <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
18 <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
19 <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
20 <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
26 <td height="20" align="left" valign="top"><hr></td>
29 <td align="left" valign="top">
30 File: <a href="file://{CLASS_FILE}" target="_new">{CLASS_FILE}</a>
31 <h5>{APPNAME} - {CLASS_PACKAGE}</h5>
35 {CLASS_SHORTDESCRIPTION}{CLASS_UNDOC}
41 <td align="left" valign="top">
42 <h4>{CLASS_ACCESS} {CLASS_ABSTRACT} {CLASS_STATIC} {CLASS_FINAL} class {CLASS_NAME} {CLASS_EXTENDS}</h4>
43 {CLASS_SHORTDESCRIPTION}
48 <!-- BEGIN class_see --><tr><td align="left" valign="top">See Also</td><td align="left" valign="top">{SEE}</td></tr><!-- END class_see -->
49 <!-- BEGIN class_links --><tr><td align="left" valign="top">Links</td><td align="left" valign="top">{LINK}</td></tr><!-- END class_links -->
50 <!-- BEGIN class_authors --><tr><td align="left" valign="top">Authors</td><td align="left" valign="top">{AUTHOR}</td></tr><!-- END class_authors -->
51 <!-- BEGIN class_since --><tr><td align="left" valign="top">Since</td><td align="left" valign="top">{SINCE}</td></tr><!-- END class_since -->
52 <!-- BEGIN class_version --><tr><td align="left" valign="top">Version</td><td align="left" valign="top">{VERSION}</td></tr><!-- END class_version -->
53 <!-- BEGIN class_deprecated --><tr><td align="left" valign="top">Deprecated</td><td align="left" valign="top">{DEPRECATED}</td></tr><!-- END class_deprecated -->
54 <!-- BEGIN class_copyright --><tr><td align="left" valign="top">Copyright</td><td align="left" valign="top">{COPYRIGHT}</td></tr><!-- END class_copyright -->
55 <!-- BEGIN class_magic --><tr><td align="left" valign="top">Magic</td><td align="left" valign="top">{MAGIC}</td></tr><!-- END class_magic -->
60 <td height="10" align="left" valign="top"> </td>
62 <!-- BEGIN subclasses -->
64 <td align="left" valign="top">
65 <b>Direct known subclasses:</b> {ELEMENTS}
68 <!-- END subclasses -->
70 <td height="20" align="left" valign="top"><hr></td>
72 <!-- BEGIN inheritedfunctions -->
74 <td align="left" valign="top">
75 <table width="100%" border="0">
77 <td align="left" valign="top"><h3>Methods inherited from {SOURCE}</h3></td>
80 <td align="left" valign="top">{ELEMENTS}</td>
85 <!-- END inheritedfunctions -->
86 <!-- BEGIN functionsummary -->
88 <td align="left" valign="top">
89 <table width="100%" border="0">
91 <td colspan="2" align="left" valign="top"><h2>{ACCESS} Method Summary</h2></td>
93 <!-- BEGIN functionsummary_loop -->
95 <td align="right" valign="top">{RETURNTYPE}</td>
96 <td align="left" valign="top" width="100%"><a href="#function_{NAME}()"><h4>{NAME}({PARAMETER})</h4></a>{SHORTDESCRIPTION}{UNDOC}</td>
98 <!-- END functionsummary_loop -->
102 <!-- END functionsummary -->
103 <!-- BEGIN inheritedvariables -->
105 <td align="left" valign="top">
106 <table width="100%" border="0">
108 <td align="left" valign="top"><h3>Fields inherited from {SOURCE}</h3></td>
111 <td align="left" valign="top">{ELEMENTS}</td>
116 <!-- END inheritedvariables -->
117 <!-- BEGIN variablesummary -->
119 <td align="left" valign="top">
120 <table width="100%" border="0">
122 <td colspan="2" align="left" valign="top"><h2>{ACCESS} Field Summary</h2></td>
124 <!-- BEGIN variablesummary_loop -->
126 <td align="right" valign="top">{TYPE}</td>
127 <td align="left" valign="top" width="100%"><a href="#variable_{NAME}"><h4>{NAME}</h4></a>{SHORTDESCRIPTION}{UNDOC}</td>
129 <!-- END variablesummary_loop -->
133 <!-- END variablesummary -->
134 <!-- BEGIN inheritedconstants -->
136 <td align="left" valign="top">
137 <table width="100%" border="0">
139 <td align="left" valign="top"><h3>Constants inherited from {SOURCE}</h3></td>
142 <td align="left" valign="top">{ELEMENTS}</td>
147 <!-- END inheritedconstants -->
148 <!-- BEGIN constantssummary -->
150 <td align="left" valign="top">
151 <table width="100%" border="0">
153 <td align="left" valign="top" colspan=3><h3>{ACCESS} Constant Summary</h3></td>
155 <!-- BEGIN constantssummary_loop -->
157 <td align="left" valign="top"><a href="#constants_{NAME}">{NAME}</a></td>
158 <td align="left" valign="top">>><code>{VALUE}</code><<</td>
159 <td align="left" valign="top" width="100%">{SHORTDESCRIPTION}{UNDOC}</td>
161 <!-- END constantssummary_loop -->
165 <!-- END constantssummary -->
166 <!-- BEGIN inheriteduses -->
168 <td align="left" valign="top">
169 <table width="100%" border="0">
171 <td align="left" valign="top"><h3>Included files inherited from {SOURCE}</h3></td>
174 <td align="left" valign="top">{ELEMENTS}</td>
179 <!-- END inheriteduses -->
180 <!-- BEGIN usessummary -->
182 <td align="left" valign="top">
183 <table width="100%" border="0">
185 <td align="left" valign="top" colspan=2><h3>Included files Summary, Type: {TYPE}</h3></td>
187 <!-- BEGIN usessummary_loop -->
189 <td align="left" valign="top"><a href="#uses_{FILE}">{FILE}</a></td>
190 <td align="left" valign="top" width="100%"><a href="#uses_{FILE}">{SHORTDESCRIPTION}{UNDOC}</a></td>
192 <!-- END usessummary_loop -->
196 <!-- END usessummary -->
197 <!-- BEGIN functiondetails -->
199 <td align="left" valign="top">
200 <table width="100%" border="0">
202 <td colspan="2" align="left" valign="top"><h2>{ACCESS} Method Details</h2></td>
204 <!-- BEGIN functiondetails_loop -->
205 <tr><td colspan="2" align="left" valign="top"><a name="function_{NAME}()"><h4>{NAME}</h4></a></td></tr>
207 <td colspan="2" align="left" valign="top">
208 <b>{ACCESS} {ABSTRACT} {STATIC} {FINAL} {RETURNTYPE} {NAME}( {PARAMETER} )</b><p>
212 <td width="10" align="left" valign="top"> </td>
213 <td align="left" valign="top">
221 <!-- BEGIN functiondetails_parameter -->
223 <td colspan="2" align="left" valign="top">Parameter</td>
225 <!-- BEGIN functiondetails_parameter_loop -->
228 <td align="left" valign="top">
231 <td align="left" valign="top">{TYPE}</td>
232 <td align="left" valign="top">{NAME}</td>
233 <td align="left" valign="top"><code>{DEFAULT}</code></td>
237 <td colspan="2" align="left" valign="top">{DESCRIPTION}{UNDOC}</td>
242 <!-- END functiondetails_parameter_loop -->
243 <!-- END functiondetails_parameter -->
244 <!-- BEGIN functiondetails_return -->
246 <td align="left" valign="top">Returns</td>
247 <td>{TYPE} {NAME}<p>{DESCRIPTION}</td>
249 <!-- END functiondetails_return -->
250 <!-- BEGIN functiondetails_throws -->
252 <td align="left" valign="top">Throws</td>
253 <td align="left" valign="top">{EXCEPTIONS}</td>
255 <!-- END functiondetails_throws -->
256 <!-- BEGIN functiondetails_globals -->
258 <td colspan="2" align="left" valign="top">Required global variables</td>
260 <!-- BEGIN functiondetails_globals_loop -->
262 <td align="left" valign="top"></td>
263 <td align="left" valign="top">
266 <td align="left" valign="top">{TYPE} {NAME}</td>
267 <td align="left" valign="top">{DESCRIPTION}</td>
272 <!-- END functiondetails_globals_loop -->
273 <!-- END functiondetails_globals -->
274 <!-- BEGIN functiondetails_version -->
276 <td align="left" valign="top">Version</td>
277 <td align="left" valign="top">{VERSION}</td>
279 <!-- END functiondetails_version -->
280 <!-- BEGIN functiondetails_since -->
282 <td align="left" valign="top">Since</td>
283 <td align="left" valign="top">{SINCE}</td>
285 <!-- END functiondetails_since -->
286 <!-- BEGIN functiondetails_deprecated -->
288 <td align="left" valign="top">Deprecated</td>
289 <td align="left" valign="top">{DEPRECATED}</td>
291 <!-- END functiondetails_deprecated -->
292 <!-- BEGIN functiondetails_copyright -->
294 <td align="left" valign="top">Copyright</td>
295 <td align="left" valign="top">{COPYRIGHT}</td>
297 <!-- END functiondetails_copyright -->
298 <!-- BEGIN functiondetails_magic -->
300 <td align="left" valign="top">Magic</td>
301 <td align="left" valign="top">{MAGIC}</td>
303 <!-- END functiondetails_magic -->
304 <!-- BEGIN functiondetails_brother -->
306 <td align="left" valign="top">Brother</td>
307 <td align="left" valign="top">{BROTHER}</td>
309 <!-- END functiondetails_brother -->
310 <!-- BEGIN functiondetails_see -->
312 <td align="left" valign="top">See Also</td>
313 <td align="left" valign="top">{SEE}</td>
315 <!-- END functiondetails_see -->
316 <!-- BEGIN functiondetails_links -->
318 <td align="left" valign="top">Links</td>
319 <td align="left" valign="top">{LINK}</td>
321 <!-- END functiondetails_links -->
322 <!-- BEGIN functiondetails_authors -->
324 <td align="left" valign="top">Author(s)</td>
325 <td align="left" valign="top">{AUTHOR}</td>
327 <!-- END functiondetails_authors -->
329 <td colspan="2" align="left" valign="top"><hr></td>
331 <!-- END functiondetails_loop -->
334 <!-- END functiondetails -->
335 <!-- BEGIN variabledetails -->
337 <td align="left" valign="top">
338 <table width="100%" border="0">
340 <td colspan="2" align="left" valign="top"><h2>{ACCESS} Field Details</h2></td>
342 <!-- BEGIN variabledetails_loop -->
343 <tr><td colspan="2" align="left" valign="top"><a name="variable_{NAME}"><h4>{NAME}</h4></a></td></tr>
345 <td colspan="2" align="left" valign="top">
346 <b>{ACCESS} {STATIC} {FINAL} {TYPE} {NAME}</b>
348 >><code>{VALUE}</code><<
355 <!-- BEGIN variabledetails_version -->
357 <td align="left" valign="top">Version</td>
358 <td align="left" valign="top">{VERSION}</td>
360 <!-- END variabledetails_version -->
361 <!-- BEGIN variabledetails_since -->
363 <td align="left" valign="top">Since</td>
364 <td align="left" valign="top">{SINCE}</td>
366 <!-- END variabledetails_since -->
367 <!-- BEGIN variabledetails_deprecated -->
369 <td align="left" valign="top">Deprecated</td>
370 <td align="left" valign="top">{DEPRECATED}</td>
372 <!-- END variabledetails_deprecated -->
373 <!-- BEGIN variabledetails_copyright -->
375 <td align="left" valign="top">Copyright</td>
376 <td align="left" valign="top">{COPYRIGHT}</td>
378 <!-- END variabledetails_copyright -->
379 <!-- BEGIN variabledetails_magic -->
381 <td align="left" valign="top">Magic</td>
382 <td align="left" valign="top">{MAGIC}</td>
384 <!-- END variabledetails_magic -->
385 <!-- BEGIN variabledetails_brother -->
387 <td align="left" valign="top">Brother</td>
388 <td align="left" valign="top">{BROTHER}</td>
390 <!-- END variabledetails_brother -->
391 <!-- BEGIN variabledetails_see -->
393 <td align="left" valign="top">See Also</td>
394 <td align="left" valign="top">{SEE}</td>
396 <!-- END variabledetails_see -->
397 <!-- BEGIN variabledetails_links -->
399 <td align="left" valign="top">Links</td>
400 <td align="left" valign="top">{LINK}</td>
402 <!-- END variabledetails_links -->
403 <!-- BEGIN variabledetails_authors -->
405 <td align="left" valign="top">Author(s)</td>
406 <td align="left" valign="top">{AUTHOR}</td>
408 <!-- END variabledetails_authors -->
410 <td colspan="2" align="left" valign="top"><hr></td>
412 <!-- END variabledetails_loop -->
415 <!-- END variabledetails -->
416 <!-- BEGIN constantdetails -->
418 <td align="left" valign="top">
419 <table width="100%" border="0">
421 <td colspan="2" align="left" valign="top"><h2>{ACCESS} Constant Details</h2></td>
423 <!-- BEGIN constantdetails_loop -->
425 <td colspan="2" align="left" valign="top">
426 <a name="constant_{NAME}"><h4>{NAME}</h4></a>
427 <code>define( {NAME}, >>{VALUE}<< )</code><br>
435 <!-- BEGIN constantdetails_version -->
437 <td align="left" valign="top">Version</td>
438 <td align="left" valign="top">{VERSION}</td>
440 <!-- END constantdetails_version -->
441 <!-- BEGIN constantdetails_since -->
443 <td align="left" valign="top">Since</td>
444 <td align="left" valign="top">{SINCE}</td>
446 <!-- END constantdetails_since -->
447 <!-- BEGIN constantdetails_deprecated -->
449 <td align="left" valign="top">Deprecated</td>
450 <td align="left" valign="top">{DEPRECATED}</td>
452 <!-- END constantdetails_deprecated -->
453 <!-- BEGIN constantdetails_copyright -->
455 <td align="left" valign="top">Copyright</td>
456 <td align="left" valign="top">{COPYRIGHT}</td>
458 <!-- END constantdetails_copyright -->
459 <!-- BEGIN constantdetails_magic -->
461 <td align="left" valign="top">Magic</td>
462 <td align="left" valign="top">{MAGIC}</td>
464 <!-- END constantdetails_magic -->
465 <!-- BEGIN constantdetails_brother -->
467 <td align="left" valign="top">Brother</td>
468 <td align="left" valign="top">{BROTHER}</td>
470 <!-- END constantdetails_brother -->
471 <!-- BEGIN constantdetails_see -->
473 <td align="left" valign="top">See Also</td>
474 <td align="left" valign="top">{SEE}</td>
476 <!-- END constantdetails_see -->
477 <!-- BEGIN constantdetails_links -->
479 <td align="left" valign="top">Links</td>
480 <td align="left" valign="top">{LINK}</td>
482 <!-- END constantdetails_links -->
483 <!-- BEGIN constantdetails_authors -->
485 <td align="left" valign="top">Author(s)</td>
486 <td align="left" valign="top">{AUTHOR}</td>
488 <!-- END constantdetails_authors -->
490 <td colspan="2" align="left" valign="top"><hr></td>
492 <!-- END constantdetails_loop -->
495 <!-- END constantdetails -->
496 <!-- BEGIN usesdetails -->
498 <td align="left" valign="top">
499 <table width="100%" border="0">
501 <td colspan="2" align="left" valign="top"><h2>Included Files, Type: {TYPE}</h2></td>
503 <!-- BEGIN usesdetails_loop -->
504 <tr><td colspan="2" align="left" valign="top"><a name="uses_{FILE}"><h4>{FILE}</h4></a></td></tr>
506 <td colspan="2" align="left" valign="top">
507 <b>{TYPE}( {FILE} )</b>
514 <!-- BEGIN usesdetails_version -->
516 <td align="left" valign="top">Version</td>
517 <td align="left" valign="top">{VERSION}</td>
519 <!-- END usesdetails_version -->
520 <!-- BEGIN usesdetails_since -->
522 <td align="left" valign="top">Since</td>
523 <td align="left" valign="top">{SINCE}</td>
525 <!-- END usesdetails_since -->
526 <!-- BEGIN usesdetails_deprecated -->
528 <td align="left" valign="top">Deprecated</td>
529 <td align="left" valign="top">{DEPRECATED}</td>
531 <!-- END usesdetails_deprecated -->
532 <!-- BEGIN usesdetails_copyright -->
534 <td align="left" valign="top">Copyright</td>
535 <td align="left" valign="top">{COPYRIGHT}</td>
537 <!-- END usesdetails_copyright -->
538 <!-- BEGIN usesdetails_magic -->
540 <td align="left" valign="top">Magic</td>
541 <td align="left" valign="top">{MAGIC}</td>
543 <!-- END usesdetails_magic -->
544 <!-- BEGIN usesdetails_brother -->
546 <td align="left" valign="top">Brother</td>
547 <td align="left" valign="top">{BROTHER}</td>
549 <!-- END usesdetails_brother -->
550 <!-- BEGIN usesdetails_see -->
552 <td align="left" valign="top">See Also</td>
553 <td align="left" valign="top">{SEE}</td>
555 <!-- END usesdetails_see -->
556 <!-- BEGIN usesdetails_links -->
558 <td align="left" valign="top">Links</td>
559 <td align="left" valign="top">{LINK}</td>
561 <!-- END usesdetails_links -->
562 <!-- BEGIN usesdetails_authors -->
564 <td align="left" valign="top">Author(s)</td>
565 <td align="left" valign="top">{AUTHOR}</td>
567 <!-- END usesdetails_authors -->
569 <td colspan="2" align="left" valign="top"><hr></td>
571 <!-- END usesdetails_loop -->
574 <!-- END usesdetails -->
576 <td height="10" align="left" valign="top"><hr></td>
579 <td align="left" valign="top" bgcolor="#C0C0C0">
582 <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
583 <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
584 <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
585 <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
586 <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
587 <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
593 <td align="left" valign="top">PHPDoc 1.0beta</td>