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"> |
4 |
<head> |
5 |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<title>Docs For Class XMLTagClass</title> |
7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
</head> |
10 |
<body> |
11 |
<div class="page-body"> |
12 |
<h2 class="class-name">Class XMLTagClass</h2> |
13 |
|
14 |
<a name="sec-description"></a> |
15 |
<div class="info-box"> |
16 |
<div class="info-box-title">Description</div> |
17 |
<div class="nav-bar"> |
18 |
<span class="disabled">Description</span> | |
19 |
<a href="#sec-descendents">Descendents</a> |
20 |
| <a href="#sec-vars">Vars</a> |
21 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
22 |
|
23 |
</div> |
24 |
<div class="info-box-body"> |
25 |
<!-- ========== Info from phpDoc block ========= --> |
26 |
<p class="short-description">This class is used for building and rendering an XML tag.</p> |
27 |
<p class="description"><p>This class is the base class for the HTMLTagClass.</p><p>This is part of the phphtmllib libraries released under the LGPL license.</p></p> |
28 |
<ul class="tags"> |
29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
30 |
</ul> |
31 |
<p class="notes"> |
32 |
Located in <a class="field" href="_XMLTagClass_inc.html">Program_Root/XMLTagClass.inc</a> (line <span class="field">35</span>) |
33 |
</p> |
34 |
|
35 |
|
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
38 |
--XMLTagClass</pre> |
39 |
|
40 |
</div> |
41 |
</div> |
42 |
|
43 |
<a name="sec-descendents"></a> |
44 |
<div class="info-box"> |
45 |
<div class="info-box-title">Direct descendents</div> |
46 |
<div class="nav-bar"> |
47 |
<a href="#sec-description">Description</a> | |
48 |
<span class="disabled">Descendents</span> |
49 |
| <a href="#sec-vars">Vars</a> |
50 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
51 |
|
52 |
</div> |
53 |
<div class="info-box-body"> |
54 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
55 |
<tr> |
56 |
<th class="class-table-header">Class</th> |
57 |
<th class="class-table-header">Description</th> |
58 |
</tr> |
59 |
<tr> |
60 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></td> |
61 |
<td> |
62 |
Base class for all HTML Tag classes. |
63 |
</td> |
64 |
</tr> |
65 |
<tr> |
66 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/SVGTagClass.html">SVGTagClass</a></td> |
67 |
<td> |
68 |
This overrides the WMLTagClass to define some methods that set some commonly used SVG tag attributes. |
69 |
</td> |
70 |
</tr> |
71 |
<tr> |
72 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/WMLTagClass.html">WMLTagClass</a></td> |
73 |
<td> |
74 |
Base class for all WML Tag classes. |
75 |
</td> |
76 |
</tr> |
77 |
<tr> |
78 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></td> |
79 |
<td> |
80 |
xml tag class |
81 |
</td> |
82 |
</tr> |
83 |
</table> |
84 |
</div> |
85 |
</div> |
86 |
|
87 |
|
88 |
<a name="sec-method-summary"></a> |
89 |
<div class="info-box"> |
90 |
<div class="info-box-title">Method Summary</span></div> |
91 |
<div class="nav-bar"> |
92 |
<a href="#sec-description">Description</a> | |
93 |
<a href="#sec-descendents">Descendents</a> | |
94 |
<a href="#sec-vars">Vars</a> |
95 |
|
96 |
| |
97 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
98 |
</div> |
99 |
<div class="info-box-body"> |
100 |
<div class="method-summary"> |
101 |
|
102 |
<div class="method-definition"> |
103 |
<span class="method-result">void</span> |
104 |
<a href="#XMLTagClass" title="details" class="method-name">XMLTagClass</a> |
105 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
106 |
</div> |
107 |
|
108 |
<div class="method-definition"> |
109 |
<span class="method-result">string</span> |
110 |
<a href="#get_tag" title="details" class="method-name">get_tag</a> |
111 |
() |
112 |
</div> |
113 |
|
114 |
<div class="method-definition"> |
115 |
<span class="method-result">string</span> |
116 |
<a href="#get_tag_name" title="details" class="method-name">get_tag_name</a> |
117 |
() |
118 |
</div> |
119 |
|
120 |
<div class="method-definition"> |
121 |
<span class="method-result">void</span> |
122 |
<a href="#render" title="details" class="method-name">render</a> |
123 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>) |
124 |
</div> |
125 |
|
126 |
<div class="method-definition"> |
127 |
<span class="method-result">void</span> |
128 |
<a href="#reset_attributes" title="details" class="method-name">reset_attributes</a> |
129 |
([<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>]) |
130 |
</div> |
131 |
|
132 |
<div class="method-definition"> |
133 |
<span class="method-result">void</span> |
134 |
<a href="#set_cdata_flag" title="details" class="method-name">set_cdata_flag</a> |
135 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
136 |
</div> |
137 |
|
138 |
<div class="method-definition"> |
139 |
<span class="method-result">void</span> |
140 |
<a href="#set_collapse" title="details" class="method-name">set_collapse</a> |
141 |
([<span class="var-type">boolean</span> <span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span> <span class="var-name">$indent</span> = <span class="var-default">TRUE</span>]) |
142 |
</div> |
143 |
|
144 |
<div class="method-definition"> |
145 |
<span class="method-result">void</span> |
146 |
<a href="#set_newline_after_closetag" title="details" class="method-name">set_newline_after_closetag</a> |
147 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
148 |
</div> |
149 |
|
150 |
<div class="method-definition"> |
151 |
<span class="method-result">void</span> |
152 |
<a href="#set_newline_after_opentag" title="details" class="method-name">set_newline_after_opentag</a> |
153 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
154 |
</div> |
155 |
|
156 |
<div class="method-definition"> |
157 |
<span class="method-result">void</span> |
158 |
<a href="#set_tag_attribute" title="details" class="method-name">set_tag_attribute</a> |
159 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>]) |
160 |
</div> |
161 |
|
162 |
<div class="method-definition"> |
163 |
<span class="method-result">void</span> |
164 |
<a href="#set_tag_attributes" title="details" class="method-name">set_tag_attributes</a> |
165 |
([<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>]) |
166 |
</div> |
167 |
|
168 |
<div class="method-definition"> |
169 |
<span class="method-result">void</span> |
170 |
<a href="#set_tag_name" title="details" class="method-name">set_tag_name</a> |
171 |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
172 |
</div> |
173 |
|
174 |
<div class="method-definition"> |
175 |
<span class="method-result">the</span> |
176 |
<a href="#_build_attribute_string" title="details" class="method-name">_build_attribute_string</a> |
177 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
178 |
</div> |
179 |
|
180 |
<div class="method-definition"> |
181 |
<span class="method-result">mixed</span> |
182 |
<a href="#_get_element" title="details" class="method-name">_get_element</a> |
183 |
(<span class="var-type">int</span> <span class="var-name">$cell</span>) |
184 |
</div> |
185 |
|
186 |
<div class="method-definition"> |
187 |
<span class="method-result">void</span> |
188 |
<a href="#_prepare_flags" title="details" class="method-name">_prepare_flags</a> |
189 |
() |
190 |
</div> |
191 |
|
192 |
<div class="method-definition"> |
193 |
<span class="method-result">void</span> |
194 |
<a href="#_render_close_tag" title="details" class="method-name">_render_close_tag</a> |
195 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>) |
196 |
</div> |
197 |
|
198 |
<div class="method-definition"> |
199 |
<span class="method-result">void</span> |
200 |
<a href="#_render_content" title="details" class="method-name">_render_content</a> |
201 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
202 |
</div> |
203 |
|
204 |
<div class="method-definition"> |
205 |
<span class="method-result">void</span> |
206 |
<a href="#_render_open_tag" title="details" class="method-name">_render_open_tag</a> |
207 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, [<span class="var-type">boolean</span> <span class="var-name">$finish_slash</span> = <span class="var-default">TRUE</span>]) |
208 |
</div> |
209 |
|
210 |
<div class="method-definition"> |
211 |
<span class="method-result">void</span> |
212 |
<a href="#_set_flags" title="details" class="method-name">_set_flags</a> |
213 |
() |
214 |
</div> |
215 |
</div> |
216 |
</div> |
217 |
</div> |
218 |
|
219 |
<a name="sec-vars"></a> |
220 |
<div class="info-box"> |
221 |
<div class="info-box-title">Variables</div> |
222 |
<div class="nav-bar"> |
223 |
<a href="#sec-description">Description</a> | |
224 |
<a href="#sec-descendents">Descendents</a> | |
225 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
226 |
|
227 |
|
228 |
| |
229 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
230 |
|
231 |
</div> |
232 |
<div class="info-box-body"> |
233 |
<h4>Inherited Variables</h4> |
234 |
<A NAME='inherited_vars'><!-- --></A> |
235 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
236 |
<blockquote> |
237 |
<span class="var-title"> |
238 |
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
239 |
</span> |
240 |
</blockquote> |
241 |
|
242 |
</div> |
243 |
</div> |
244 |
|
245 |
<a name="sec-methods"></a> |
246 |
<div class="info-box"> |
247 |
<div class="info-box-title">Methods</div> |
248 |
<div class="nav-bar"> |
249 |
<a href="#sec-description">Description</a> | |
250 |
<a href="#sec-descendents">Descendents</a> | |
251 |
<a href="#sec-vars">Vars</a> |
252 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
253 |
|
254 |
</div> |
255 |
<div class="info-box-body"> |
256 |
<A NAME='method_detail'></A> |
257 |
<a name="methodXMLTagClass" id="XMLTagClass"><!-- --></a> |
258 |
<div class="oddrow"> |
259 |
|
260 |
<div class="method-header"> |
261 |
<span class="method-title">Constructor XMLTagClass</span> (line <span class="line-number">68</span>) |
262 |
</div> |
263 |
|
264 |
<!-- ========== Info from phpDoc block ========= --> |
265 |
<p class="short-description">The constructor</p> |
266 |
|
267 |
<div class="method-signature"> |
268 |
<span class="method-result">void</span> |
269 |
<span class="method-name"> |
270 |
XMLTagClass |
271 |
</span> |
272 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
273 |
</div> |
274 |
|
275 |
<ul class="parameters"> |
276 |
<li> |
277 |
<span class="var-type">mixed</span> |
278 |
<span class="var-name">2</span><span class="var-description">: <p>- n items of content to add</p></span> </li> |
279 |
<li> |
280 |
<span class="var-type">string</span> |
281 |
<span class="var-name">$name</span><span class="var-description">: <p>- the tag name</p></span> </li> |
282 |
<li> |
283 |
<span class="var-type">array</span> |
284 |
<span class="var-name">$attributes</span><span class="var-description">: <p>- the attributes array can be in name => value or just value</p></span> </li> |
285 |
</ul> |
286 |
|
287 |
|
288 |
</div> |
289 |
<a name="methodget_tag" id="get_tag"><!-- --></a> |
290 |
<div class="evenrow"> |
291 |
|
292 |
<div class="method-header"> |
293 |
<span class="method-title">get_tag</span> (line <span class="line-number">147</span>) |
294 |
</div> |
295 |
|
296 |
<!-- ========== Info from phpDoc block ========= --> |
297 |
<p class="short-description">This returns the tag declared for this class.</p> |
298 |
<p class="description"><p>This should be used in favor of accessing the $this->_tag directly.</p></p> |
299 |
<ul class="tags"> |
300 |
<li><span class="field">return:</span> <p>- the _tag var for this class.</p></li> |
301 |
</ul> |
302 |
|
303 |
<div class="method-signature"> |
304 |
<span class="method-result">string</span> |
305 |
<span class="method-name"> |
306 |
get_tag |
307 |
</span> |
308 |
() |
309 |
</div> |
310 |
|
311 |
|
312 |
|
313 |
</div> |
314 |
<a name="methodget_tag_name" id="get_tag_name"><!-- --></a> |
315 |
<div class="oddrow"> |
316 |
|
317 |
<div class="method-header"> |
318 |
<span class="method-title">get_tag_name</span> (line <span class="line-number">136</span>) |
319 |
</div> |
320 |
|
321 |
<!-- ========== Info from phpDoc block ========= --> |
322 |
<p class="short-description">This method gets the name of the tag</p> |
323 |
<ul class="tags"> |
324 |
<li><span class="field">return:</span> <p>- the tag name</p></li> |
325 |
</ul> |
326 |
|
327 |
<div class="method-signature"> |
328 |
<span class="method-result">string</span> |
329 |
<span class="method-name"> |
330 |
get_tag_name |
331 |
</span> |
332 |
() |
333 |
</div> |
334 |
|
335 |
|
336 |
|
337 |
</div> |
338 |
<a name="methodrender" id="render"><!-- --></a> |
339 |
<div class="evenrow"> |
340 |
|
341 |
<div class="method-header"> |
342 |
<span class="method-title">render</span> (line <span class="line-number">89</span>) |
343 |
</div> |
344 |
|
345 |
<!-- ========== Info from phpDoc block ========= --> |
346 |
<p class="short-description">This function is responsible for rendering the tag and its contents</p> |
347 |
|
348 |
<div class="method-signature"> |
349 |
<span class="method-result">void</span> |
350 |
<span class="method-name"> |
351 |
render |
352 |
</span> |
353 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>) |
354 |
</div> |
355 |
|
356 |
<ul class="parameters"> |
357 |
<li> |
358 |
<span class="var-type">int</span> |
359 |
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the current indentation level for the tag</p></span> </li> |
360 |
</ul> |
361 |
|
362 |
<hr class="separator" /> |
363 |
<div class="notes">Redefinition of:</div> |
364 |
<dl> |
365 |
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
366 |
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
367 |
</dl> |
368 |
|
369 |
<hr class="separator" /> |
370 |
<div class="notes">Redefined in descendants as:</div> |
371 |
<ul class="redefinitions"> |
372 |
<li> |
373 |
<a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a> |
374 |
: Renders the tag, attributes, content and close tag. |
375 |
</li> |
376 |
</ul> |
377 |
</div> |
378 |
<a name="methodreset_attributes" id="reset_attributes"><!-- --></a> |
379 |
<div class="oddrow"> |
380 |
|
381 |
<div class="method-header"> |
382 |
<span class="method-title">reset_attributes</span> (line <span class="line-number">180</span>) |
383 |
</div> |
384 |
|
385 |
<!-- ========== Info from phpDoc block ========= --> |
386 |
<p class="short-description">clear all attributes and start with new attributes</p> |
387 |
<ul class="tags"> |
388 |
<li><span class="field">access:</span> public</li> |
389 |
</ul> |
390 |
|
391 |
<div class="method-signature"> |
392 |
<span class="method-result">void</span> |
393 |
<span class="method-name"> |
394 |
reset_attributes |
395 |
</span> |
396 |
([<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>]) |
397 |
</div> |
398 |
|
399 |
<ul class="parameters"> |
400 |
<li> |
401 |
<span class="var-type">array</span> |
402 |
<span class="var-name">$attributes</span><span class="var-description">: <p>Associative array of name="value" pairs of tag atributes. ie array("border"=>"0", "class"=>"hover");</p></span> </li> |
403 |
</ul> |
404 |
|
405 |
|
406 |
</div> |
407 |
<a name="methodset_cdata_flag" id="set_cdata_flag"><!-- --></a> |
408 |
<div class="evenrow"> |
409 |
|
410 |
<div class="method-header"> |
411 |
<span class="method-title">set_cdata_flag</span> (line <span class="line-number">231</span>) |
412 |
</div> |
413 |
|
414 |
<!-- ========== Info from phpDoc block ========= --> |
415 |
<p class="short-description">This method turns on the automatic wrapping of the tag's content inside the CDATA wrapper for XML</p> |
416 |
|
417 |
<div class="method-signature"> |
418 |
<span class="method-result">void</span> |
419 |
<span class="method-name"> |
420 |
set_cdata_flag |
421 |
</span> |
422 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
423 |
</div> |
424 |
|
425 |
<ul class="parameters"> |
426 |
<li> |
427 |
<span class="var-type">boolean</span> |
428 |
<span class="var-name">$flag</span><span class="var-description">: <p>TRUE or FALSE</p></span> </li> |
429 |
</ul> |
430 |
|
431 |
|
432 |
</div> |
433 |
<a name="methodset_collapse" id="set_collapse"><!-- --></a> |
434 |
<div class="oddrow"> |
435 |
|
436 |
<div class="method-header"> |
437 |
<span class="method-title">set_collapse</span> (line <span class="line-number">247</span>) |
438 |
</div> |
439 |
|
440 |
<!-- ========== Info from phpDoc block ========= --> |
441 |
<p class="short-description">This function turns on the collapse flag</p> |
442 |
|
443 |
<div class="method-signature"> |
444 |
<span class="method-result">void</span> |
445 |
<span class="method-name"> |
446 |
set_collapse |
447 |
</span> |
448 |
([<span class="var-type">boolean</span> <span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span> <span class="var-name">$indent</span> = <span class="var-default">TRUE</span>]) |
449 |
</div> |
450 |
|
451 |
<ul class="parameters"> |
452 |
<li> |
453 |
<span class="var-type">boolean</span> |
454 |
<span class="var-name">$collapse</span><span class="var-description">: <p>- the collapse flag</p></span> </li> |
455 |
<li> |
456 |
<span class="var-type">boolean</span> |
457 |
<span class="var-name">$indent</span><span class="var-description">: <p>- the indent flag DEFAULT: TRUE;</p></span> </li> |
458 |
</ul> |
459 |
|
460 |
<hr class="separator" /> |
461 |
<div class="notes">Redefinition of:</div> |
462 |
<dl> |
463 |
<dt><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></dt> |
464 |
<dd>This function turns on the collapse flag</dd> |
465 |
</dl> |
466 |
|
467 |
</div> |
468 |
<a name="methodset_newline_after_closetag" id="set_newline_after_closetag"><!-- --></a> |
469 |
<div class="evenrow"> |
470 |
|
471 |
<div class="method-header"> |
472 |
<span class="method-title">set_newline_after_closetag</span> (line <span class="line-number">216</span>) |
473 |
</div> |
474 |
|
475 |
<!-- ========== Info from phpDoc block ========= --> |
476 |
<p class="short-description">set the newline_after_content flag</p> |
477 |
|
478 |
<div class="method-signature"> |
479 |
<span class="method-result">void</span> |
480 |
<span class="method-name"> |
481 |
set_newline_after_closetag |
482 |
</span> |
483 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
484 |
</div> |
485 |
|
486 |
<ul class="parameters"> |
487 |
<li> |
488 |
<span class="var-type">boolean</span> |
489 |
<span class="var-name">$flag</span><span class="var-description">: <p>TRUE or FALSE</p></span> </li> |
490 |
</ul> |
491 |
|
492 |
|
493 |
</div> |
494 |
<a name="methodset_newline_after_opentag" id="set_newline_after_opentag"><!-- --></a> |
495 |
<div class="oddrow"> |
496 |
|
497 |
<div class="method-header"> |
498 |
<span class="method-title">set_newline_after_opentag</span> (line <span class="line-number">204</span>) |
499 |
</div> |
500 |
|
501 |
<!-- ========== Info from phpDoc block ========= --> |
502 |
<p class="short-description">set the newline_after_opentag flag</p> |
503 |
|
504 |
<div class="method-signature"> |
505 |
<span class="method-result">void</span> |
506 |
<span class="method-name"> |
507 |
set_newline_after_opentag |
508 |
</span> |
509 |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
510 |
</div> |
511 |
|
512 |
<ul class="parameters"> |
513 |
<li> |
514 |
<span class="var-type">boolean</span> |
515 |
<span class="var-name">$flag</span><span class="var-description">: <p>TRUE or FALSE</p></span> </li> |
516 |
</ul> |
517 |
|
518 |
|
519 |
</div> |
520 |
<a name="methodset_tag_attribute" id="set_tag_attribute"><!-- --></a> |
521 |
<div class="evenrow"> |
522 |
|
523 |
<div class="method-header"> |
524 |
<span class="method-title">set_tag_attribute</span> (line <span class="line-number">158</span>) |
525 |
</div> |
526 |
|
527 |
<!-- ========== Info from phpDoc block ========= --> |
528 |
<p class="short-description">add a single attribute (name="value")</p> |
529 |
<ul class="tags"> |
530 |
<li><span class="field">access:</span> public</li> |
531 |
</ul> |
532 |
|
533 |
<div class="method-signature"> |
534 |
<span class="method-result">void</span> |
535 |
<span class="method-name"> |
536 |
set_tag_attribute |
537 |
</span> |
538 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>]) |
539 |
</div> |
540 |
|
541 |
<ul class="parameters"> |
542 |
<li> |
543 |
<span class="var-type">string</span> |
544 |
<span class="var-name">$name</span><span class="var-description">: <p>attribute name</p></span> </li> |
545 |
<li> |
546 |
<span class="var-type">mixed</span> |
547 |
<span class="var-name">$value</span><span class="var-description">: <p>the value.</p></span> </li> |
548 |
</ul> |
549 |
|
550 |
|
551 |
</div> |
552 |
<a name="methodset_tag_attributes" id="set_tag_attributes"><!-- --></a> |
553 |
<div class="oddrow"> |
554 |
|
555 |
<div class="method-header"> |
556 |
<span class="method-title">set_tag_attributes</span> (line <span class="line-number">169</span>) |
557 |
</div> |
558 |
|
559 |
<!-- ========== Info from phpDoc block ========= --> |
560 |
<p class="short-description">add multiple attributes (name="value")</p> |
561 |
<ul class="tags"> |
562 |
<li><span class="field">access:</span> public</li> |
563 |
</ul> |
564 |
|
565 |
<div class="method-signature"> |
566 |
<span class="method-result">void</span> |
567 |
<span class="method-name"> |
568 |
set_tag_attributes |
569 |
</span> |
570 |
([<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>]) |
571 |
</div> |
572 |
|
573 |
<ul class="parameters"> |
574 |
<li> |
575 |
<span class="var-type">array</span> |
576 |
<span class="var-name">$attributes</span><span class="var-description">: <p>Associative array of name="value" pairs of tag atributes. ie array("border"=>"0", "class"=>"hover");</p></span> </li> |
577 |
</ul> |
578 |
|
579 |
|
580 |
</div> |
581 |
<a name="methodset_tag_name" id="set_tag_name"><!-- --></a> |
582 |
<div class="evenrow"> |
583 |
|
584 |
<div class="method-header"> |
585 |
<span class="method-title">set_tag_name</span> (line <span class="line-number">127</span>) |
586 |
</div> |
587 |
|
588 |
<!-- ========== Info from phpDoc block ========= --> |
589 |
<p class="short-description">This method sets the name of the tag</p> |
590 |
|
591 |
<div class="method-signature"> |
592 |
<span class="method-result">void</span> |
593 |
<span class="method-name"> |
594 |
set_tag_name |
595 |
</span> |
596 |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
597 |
</div> |
598 |
|
599 |
<ul class="parameters"> |
600 |
<li> |
601 |
<span class="var-type">string</span> |
602 |
<span class="var-name">$name</span><span class="var-description">: <p>- the tag name</p></span> </li> |
603 |
</ul> |
604 |
|
605 |
|
606 |
</div> |
607 |
<a name="method_build_attribute_string" id="_build_attribute_string"><!-- --></a> |
608 |
<div class="oddrow"> |
609 |
|
610 |
<div class="method-header"> |
611 |
<span class="method-title">_build_attribute_string</span> (line <span class="line-number">424</span>) |
612 |
</div> |
613 |
|
614 |
<!-- ========== Info from phpDoc block ========= --> |
615 |
<p class="short-description">this builds an attribute for an XML tag.</p> |
616 |
<p class="description"><p>XML attributes MUST have a name AND a value.</p></p> |
617 |
<ul class="tags"> |
618 |
<li><span class="field">return:</span> <p>tag attribute name=value pair. to be added to the tag.</p></li> |
619 |
</ul> |
620 |
|
621 |
<div class="method-signature"> |
622 |
<span class="method-result">the</span> |
623 |
<span class="method-name"> |
624 |
_build_attribute_string |
625 |
</span> |
626 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
627 |
</div> |
628 |
|
629 |
<ul class="parameters"> |
630 |
<li> |
631 |
<span class="var-type">string</span> |
632 |
<span class="var-name">$name</span><span class="var-description">: <p>- $name attribute name</p></span> </li> |
633 |
<li> |
634 |
<span class="var-type">mixed</span> |
635 |
<span class="var-name">$value</span><span class="var-description">: <p>- $value attribute value</p></span> </li> |
636 |
</ul> |
637 |
|
638 |
|
639 |
<hr class="separator" /> |
640 |
<div class="notes">Redefined in descendants as:</div> |
641 |
<ul class="redefinitions"> |
642 |
<li> |
643 |
<a href="../phpHtmlLib/HTMLTagClass.html#method_build_attribute_string">HTMLTagClass::_build_attribute_string()</a> |
644 |
: this builds an attribute for a tag. |
645 |
</li> |
646 |
</ul> |
647 |
</div> |
648 |
<a name="method_get_element" id="_get_element"><!-- --></a> |
649 |
<div class="evenrow"> |
650 |
|
651 |
<div class="method-header"> |
652 |
<span class="method-title">_get_element</span> (line <span class="line-number">190</span>) |
653 |
</div> |
654 |
|
655 |
<!-- ========== Info from phpDoc block ========= --> |
656 |
<p class="short-description">get the nth element from content array</p> |
657 |
|
658 |
<div class="method-signature"> |
659 |
<span class="method-result">mixed</span> |
660 |
<span class="method-name"> |
661 |
_get_element |
662 |
</span> |
663 |
(<span class="var-type">int</span> <span class="var-name">$cell</span>) |
664 |
</div> |
665 |
|
666 |
<ul class="parameters"> |
667 |
<li> |
668 |
<span class="var-type">int</span> |
669 |
<span class="var-name">$cell</span><span class="var-description">: <p>the cell to get</p></span> </li> |
670 |
</ul> |
671 |
|
672 |
|
673 |
</div> |
674 |
<a name="method_prepare_flags" id="_prepare_flags"><!-- --></a> |
675 |
<div class="oddrow"> |
676 |
|
677 |
<div class="method-header"> |
678 |
<span class="method-title">_prepare_flags</span> (line <span class="line-number">270</span>) |
679 |
</div> |
680 |
|
681 |
<!-- ========== Info from phpDoc block ========= --> |
682 |
<p class="short-description">This function checks to see if</p> |
683 |
<p class="description"><p>there is only 1 content data, and its not an object, then it auto sets some of the indentation flags</p></p> |
684 |
|
685 |
<div class="method-signature"> |
686 |
<span class="method-result">void</span> |
687 |
<span class="method-name"> |
688 |
_prepare_flags |
689 |
</span> |
690 |
() |
691 |
</div> |
692 |
|
693 |
|
694 |
|
695 |
<hr class="separator" /> |
696 |
<div class="notes">Redefined in descendants as:</div> |
697 |
<ul class="redefinitions"> |
698 |
<li> |
699 |
<a href="../phpHtmlLib/HTMLTagClass.html#method_prepare_flags">HTMLTagClass::_prepare_flags()</a> |
700 |
: This function checks to see if |
701 |
</li> |
702 |
<li> |
703 |
<a href="../phpHtmlLib/SVGTagClass.html#method_prepare_flags">SVGTagClass::_prepare_flags()</a> |
704 |
: we override this method to automatically check to see if the tag has content. |
705 |
</li> |
706 |
<li> |
707 |
<a href="../phpHtmlLib/GOtag.html#method_prepare_flags">GOtag::_prepare_flags()</a> |
708 |
: we override this method to automatically check to see if the tag has content. |
709 |
</li> |
710 |
</ul> |
711 |
</div> |
712 |
<a name="method_render_close_tag" id="_render_close_tag"><!-- --></a> |
713 |
<div class="evenrow"> |
714 |
|
715 |
<div class="method-header"> |
716 |
<span class="method-title">_render_close_tag</span> (line <span class="line-number">396</span>) |
717 |
</div> |
718 |
|
719 |
<!-- ========== Info from phpDoc block ========= --> |
720 |
<p class="short-description">this function is reposnsible for rendering the closing tag (if any)</p> |
721 |
|
722 |
<div class="method-signature"> |
723 |
<span class="method-result">void</span> |
724 |
<span class="method-name"> |
725 |
_render_close_tag |
726 |
</span> |
727 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>) |
728 |
</div> |
729 |
|
730 |
<ul class="parameters"> |
731 |
<li> |
732 |
<span class="var-type">int</span> |
733 |
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indent level</p></span> </li> |
734 |
</ul> |
735 |
|
736 |
|
737 |
<hr class="separator" /> |
738 |
<div class="notes">Redefined in descendants as:</div> |
739 |
<ul class="redefinitions"> |
740 |
<li> |
741 |
<a href="../phpHtmlLib/CDATAtag.html#method_render_close_tag">CDATAtag::_render_close_tag()</a> |
742 |
</li> |
743 |
</ul> |
744 |
</div> |
745 |
<a name="method_render_content" id="_render_content"><!-- --></a> |
746 |
<div class="oddrow"> |
747 |
|
748 |
<div class="method-header"> |
749 |
<span class="method-title">_render_content</span> (line <span class="line-number">339</span>) |
750 |
</div> |
751 |
|
752 |
<!-- ========== Info from phpDoc block ========= --> |
753 |
<p class="short-description">this function is reponsible for rendering the pcdata, or content of the tag (if any)</p> |
754 |
|
755 |
<div class="method-signature"> |
756 |
<span class="method-result">void</span> |
757 |
<span class="method-name"> |
758 |
_render_content |
759 |
</span> |
760 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
761 |
</div> |
762 |
|
763 |
<ul class="parameters"> |
764 |
<li> |
765 |
<span class="var-type">int</span> |
766 |
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indent level</p></span> </li> |
767 |
</ul> |
768 |
|
769 |
|
770 |
</div> |
771 |
<a name="method_render_open_tag" id="_render_open_tag"><!-- --></a> |
772 |
<div class="evenrow"> |
773 |
|
774 |
<div class="method-header"> |
775 |
<span class="method-title">_render_open_tag</span> (line <span class="line-number">300</span>) |
776 |
</div> |
777 |
|
778 |
<!-- ========== Info from phpDoc block ========= --> |
779 |
<p class="short-description">this function is responsible for rendering the open tag.</p> |
780 |
|
781 |
<div class="method-signature"> |
782 |
<span class="method-result">void</span> |
783 |
<span class="method-name"> |
784 |
_render_open_tag |
785 |
</span> |
786 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, [<span class="var-type">boolean</span> <span class="var-name">$finish_slash</span> = <span class="var-default">TRUE</span>]) |
787 |
</div> |
788 |
|
789 |
<ul class="parameters"> |
790 |
<li> |
791 |
<span class="var-type">int</span> |
792 |
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indent level</p></span> </li> |
793 |
<li> |
794 |
<span class="var-type">boolean</span> |
795 |
<span class="var-name">$finish_slash</span><span class="var-description">: <p>- do we add the finish / if we have no close tag and no content?</p></span> </li> |
796 |
</ul> |
797 |
|
798 |
|
799 |
<hr class="separator" /> |
800 |
<div class="notes">Redefined in descendants as:</div> |
801 |
<ul class="redefinitions"> |
802 |
<li> |
803 |
<a href="../phpHtmlLib/CDATAtag.html#method_render_open_tag">CDATAtag::_render_open_tag()</a> |
804 |
</li> |
805 |
</ul> |
806 |
</div> |
807 |
<a name="method_set_flags" id="_set_flags"><!-- --></a> |
808 |
<div class="oddrow"> |
809 |
|
810 |
<div class="method-header"> |
811 |
<span class="method-title">_set_flags</span> (line <span class="line-number">116</span>) |
812 |
</div> |
813 |
|
814 |
<!-- ========== Info from phpDoc block ========= --> |
815 |
<p class="short-description">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</p> |
816 |
<p class="description"><p>NOTE: the child class can override this to set the options</p></p> |
817 |
|
818 |
<div class="method-signature"> |
819 |
<span class="method-result">void</span> |
820 |
<span class="method-name"> |
821 |
_set_flags |
822 |
</span> |
823 |
() |
824 |
</div> |
825 |
|
826 |
|
827 |
<hr class="separator" /> |
828 |
<div class="notes">Redefinition of:</div> |
829 |
<dl> |
830 |
<dt><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></dt> |
831 |
<dd>This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</dd> |
832 |
</dl> |
833 |
|
834 |
<hr class="separator" /> |
835 |
<div class="notes">Redefined in descendants as:</div> |
836 |
<ul class="redefinitions"> |
837 |
<li> |
838 |
<a href="../phpHtmlLib/Atag.html#method_set_flags">Atag::_set_flags()</a> |
839 |
</li> |
840 |
<li> |
841 |
<a href="../phpHtmlLib/APPLETtag.html#method_set_flags">APPLETtag::_set_flags()</a> |
842 |
</li> |
843 |
<li> |
844 |
<a href="../phpHtmlLib/AREAtag.html#method_set_flags">AREAtag::_set_flags()</a> |
845 |
</li> |
846 |
<li> |
847 |
<a href="../phpHtmlLib/Btag.html#method_set_flags">Btag::_set_flags()</a> |
848 |
</li> |
849 |
<li> |
850 |
<a href="../phpHtmlLib/BASEtag.html#method_set_flags">BASEtag::_set_flags()</a> |
851 |
</li> |
852 |
<li> |
853 |
<a href="../phpHtmlLib/BRtag.html#method_set_flags">BRtag::_set_flags()</a> |
854 |
</li> |
855 |
<li> |
856 |
<a href="../phpHtmlLib/CENTERtag.html#method_set_flags">CENTERtag::_set_flags()</a> |
857 |
</li> |
858 |
<li> |
859 |
<a href="../phpHtmlLib/DOCTYPEtag.html#method_set_flags">DOCTYPEtag::_set_flags()</a> |
860 |
</li> |
861 |
<li> |
862 |
<a href="../phpHtmlLib/FONTtag.html#method_set_flags">FONTtag::_set_flags()</a> |
863 |
</li> |
864 |
<li> |
865 |
<a href="../phpHtmlLib/FRAMEtag.html#method_set_flags">FRAMEtag::_set_flags()</a> |
866 |
</li> |
867 |
<li> |
868 |
<a href="../phpHtmlLib/H1tag.html#method_set_flags">H1tag::_set_flags()</a> |
869 |
</li> |
870 |
<li> |
871 |
<a href="../phpHtmlLib/H2tag.html#method_set_flags">H2tag::_set_flags()</a> |
872 |
</li> |
873 |
<li> |
874 |
<a href="../phpHtmlLib/H3tag.html#method_set_flags">H3tag::_set_flags()</a> |
875 |
</li> |
876 |
<li> |
877 |
<a href="../phpHtmlLib/H4tag.html#method_set_flags">H4tag::_set_flags()</a> |
878 |
</li> |
879 |
<li> |
880 |
<a href="../phpHtmlLib/H5tag.html#method_set_flags">H5tag::_set_flags()</a> |
881 |
</li> |
882 |
<li> |
883 |
<a href="../phpHtmlLib/H6tag.html#method_set_flags">H6tag::_set_flags()</a> |
884 |
</li> |
885 |
<li> |
886 |
<a href="../phpHtmlLib/HRtag.html#method_set_flags">HRtag::_set_flags()</a> |
887 |
</li> |
888 |
<li> |
889 |
<a href="../phpHtmlLib/IMGtag.html#method_set_flags">IMGtag::_set_flags()</a> |
890 |
</li> |
891 |
<li> |
892 |
<a href="../phpHtmlLib/INPUTtag.html#method_set_flags">INPUTtag::_set_flags()</a> |
893 |
</li> |
894 |
<li> |
895 |
<a href="../phpHtmlLib/LINKtag.html#method_set_flags">LINKtag::_set_flags()</a> |
896 |
</li> |
897 |
<li> |
898 |
<a href="../phpHtmlLib/METAtag.html#method_set_flags">METAtag::_set_flags()</a> |
899 |
</li> |
900 |
<li> |
901 |
<a href="../phpHtmlLib/NOBRtag.html#method_set_flags">NOBRtag::_set_flags()</a> |
902 |
</li> |
903 |
<li> |
904 |
<a href="../phpHtmlLib/OPTIONtag.html#method_set_flags">OPTIONtag::_set_flags()</a> |
905 |
</li> |
906 |
<li> |
907 |
<a href="../phpHtmlLib/PREtag.html#method_set_flags">PREtag::_set_flags()</a> |
908 |
</li> |
909 |
<li> |
910 |
<a href="../phpHtmlLib/Stag.html#method_set_flags">Stag::_set_flags()</a> |
911 |
</li> |
912 |
<li> |
913 |
<a href="../phpHtmlLib/TEXTAREAtag.html#method_set_flags">TEXTAREAtag::_set_flags()</a> |
914 |
</li> |
915 |
<li> |
916 |
<a href="../phpHtmlLib/DEFINITIONSRCsvgtag.html#method_set_flags">DEFINITIONSRCsvgtag::_set_flags()</a> |
917 |
</li> |
918 |
<li> |
919 |
<a href="../phpHtmlLib/ELLIPSEsvgtag.html#method_set_flags">ELLIPSEsvgtag::_set_flags()</a> |
920 |
</li> |
921 |
<li> |
922 |
<a href="../phpHtmlLib/FONTFACEFORMATsvgtag.html#method_set_flags">FONTFACEFORMATsvgtag::_set_flags()</a> |
923 |
</li> |
924 |
<li> |
925 |
<a href="../phpHtmlLib/FONTFACENAMEsvgtag.html#method_set_flags">FONTFACENAMEsvgtag::_set_flags()</a> |
926 |
</li> |
927 |
<li> |
928 |
<a href="../phpHtmlLib/HKERNsvgtag.html#method_set_flags">HKERNsvgtag::_set_flags()</a> |
929 |
</li> |
930 |
<li> |
931 |
<a href="../phpHtmlLib/SCRIPTsvgtag.html#method_set_flags">SCRIPTsvgtag::_set_flags()</a> |
932 |
</li> |
933 |
<li> |
934 |
<a href="../phpHtmlLib/STYLEsvgtag.html#method_set_flags">STYLEsvgtag::_set_flags()</a> |
935 |
</li> |
936 |
<li> |
937 |
<a href="../phpHtmlLib/VKERNsvgtag.html#method_set_flags">VKERNsvgtag::_set_flags()</a> |
938 |
</li> |
939 |
<li> |
940 |
<a href="../phpHtmlLib/ACCESStag.html#method_set_flags">ACCESStag::_set_flags()</a> |
941 |
</li> |
942 |
<li> |
943 |
<a href="../phpHtmlLib/NOOPtag.html#method_set_flags">NOOPtag::_set_flags()</a> |
944 |
</li> |
945 |
<li> |
946 |
<a href="../phpHtmlLib/TIMERtag.html#method_set_flags">TIMERtag::_set_flags()</a> |
947 |
</li> |
948 |
<li> |
949 |
<a href="../phpHtmlLib/XMLtag.html#method_set_flags">XMLtag::_set_flags()</a> |
950 |
</li> |
951 |
<li> |
952 |
<a href="../phpHtmlLib/CDATAtag.html#method_set_flags">CDATAtag::_set_flags()</a> |
953 |
</li> |
954 |
</ul> |
955 |
</div> |
956 |
<h4>Inherited Methods</h4> |
957 |
<a name='inherited_methods'><!-- --></a> |
958 |
<!-- =========== Summary =========== --> |
959 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
960 |
<blockquote> |
961 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
962 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
963 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
964 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
965 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
966 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
967 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
968 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
969 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
970 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
971 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
972 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
973 |
</blockquote> |
974 |
|
975 |
</div> |
976 |
</div> |
977 |
|
978 |
<p class="notes" id="credit"> |
979 |
Documention generated on Thu, 31 Jul 2003 18:34:05 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
980 |
</p> |
981 |
</div></body> |
982 |
</html> |