1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:32 -0800' --> |
6 |
<TITLE>Docs For Class Container</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
<!-- Links --> |
11 |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
13 |
<TR> |
14 |
<TD class="font10"> |
15 |
Links: |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from Container">Child Classes</A> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
</TD> |
24 |
</TR> |
25 |
</TABLE> |
26 |
<BR> |
27 |
<!-- Start of Class Data --> |
28 |
<H2> |
29 |
Class Container |
30 |
</H2> (line <span class="linenumber">38</span>) |
31 |
<pre> |
32 |
</pre> |
33 |
<SPAN class="type">Classes extended from Container:</SPAN> |
34 |
<dl> |
35 |
<dt><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></dt> |
36 |
<dd>This class is used for building and rendering an XML tag.</dd> |
37 |
</dl> |
38 |
<dl> |
39 |
<dt><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></dt> |
40 |
<dd>this is the base widget class, that all widgets are based off of. It provides some basic members and methods</dd> |
41 |
</dl> |
42 |
<dl> |
43 |
<dt><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></dt> |
44 |
<dd>This is just to maintain compatibility with the 1.1.0 release of phphtmllib</dd> |
45 |
</dl> |
46 |
<dl> |
47 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></dt> |
48 |
<dd>This class lets you build a complete xml document and render it.</dd> |
49 |
</dl> |
50 |
<dl> |
51 |
<dt><a href="../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></dt> |
52 |
<dd>This is the main engine for the processing</dd> |
53 |
</dl> |
54 |
</p> |
55 |
<p> |
56 |
<b><i>Located in File: Program_Root/ContainerClass.inc</i></b><br> |
57 |
</p> |
58 |
<hr> |
59 |
This class is nothing more then a |
60 |
<br /> |
61 |
<p>container widget. It lets you push data into it, and it will render each item indented properly so it works with the rest of the libs.</p><p>This is helpfull when you have a function that wants to return multiple Tag Objects or widgets. Just wrap them in this container and they will all get rendered with the current indentation level.</p><p>Base Class for phpHtmlLib</p> |
62 |
<UL> |
63 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
64 |
<LI><b>link</b> - <CODE><a href="http://phphtmllib.sourceforge.net">http://phphtmllib.sourceforge.net</a></CODE></LI> |
65 |
</UL> |
66 |
<hr> |
67 |
<!-- =========== VAR SUMMARY =========== --> |
68 |
<A NAME='var_summary'><!-- --></A> |
69 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
70 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
71 |
<TD> |
72 |
<span CLASS="font12bold">Class Variable Summary</span> |
73 |
<A HREF="#top" CLASS="links">^TOP</A> |
74 |
</TD> |
75 |
</TR> |
76 |
|
77 |
<!-- =========== Summary =========== --> |
78 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
79 |
<TD> |
80 |
<CODE><B><A HREF="../phpHtmlLib/Container.html#var$_flags">$_flags</A></B></CODE> |
81 |
<BR> |
82 |
<blockquote> The flags that tell us </blockquote> |
83 |
<blockquote> Default Value: <CODE>-> _NEWLINEAFTERCONTENT<-</CODE> </blockquote> |
84 |
</TD> |
85 |
</TR> |
86 |
</TABLE> |
87 |
<hr> |
88 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
89 |
<A NAME='var_inherited_summary'><!-- --></A> |
90 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
91 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
92 |
<TD> |
93 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
94 |
<A HREF="#top" CLASS="links">^TOP</A> |
95 |
</TD> |
96 |
</TR> |
97 |
|
98 |
</TABLE> |
99 |
|
100 |
<hr> |
101 |
<!-- =========== METHOD SUMMARY =========== --> |
102 |
<A NAME='method_summary'><!-- --></A> |
103 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
104 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
105 |
<TD> |
106 |
<span class="font12bold">Method Summary</span> |
107 |
<A HREF="#top" CLASS="links">^TOP</A> |
108 |
</TD> |
109 |
</TR> |
110 |
|
111 |
<!-- =========== Summary =========== --> |
112 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
113 |
<TD> |
114 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodContainer'>void constructor Container ( )</A></B></CODE> |
115 |
<BR> |
116 |
<blockquote> The constructor. </blockquote> |
117 |
</TD> |
118 |
</TR> |
119 |
<!-- =========== Summary =========== --> |
120 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
121 |
<TD> |
122 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodadd'>void add ( )</A></B></CODE> |
123 |
<BR> |
124 |
<blockquote> add content onto content stack </blockquote> |
125 |
</TD> |
126 |
</TR> |
127 |
<!-- =========== Summary =========== --> |
128 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
129 |
<TD> |
130 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodadd_reference'>void add_reference ( &$content )</A></B></CODE> |
131 |
<BR> |
132 |
<blockquote> Add content onto content stack so you can change the item later. </blockquote> |
133 |
</TD> |
134 |
</TR> |
135 |
<!-- =========== Summary =========== --> |
136 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
137 |
<TD> |
138 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodcount_content'>int count_content ( )</A></B></CODE> |
139 |
<BR> |
140 |
<blockquote> counts the number of content objects </blockquote> |
141 |
</TD> |
142 |
</TR> |
143 |
<!-- =========== Summary =========== --> |
144 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
145 |
<TD> |
146 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodget_indent_flag'>boolean get_indent_flag ( )</A></B></CODE> |
147 |
<BR> |
148 |
<blockquote> This flag gets the current value of the indent flag </blockquote> |
149 |
</TD> |
150 |
</TR> |
151 |
<!-- =========== Summary =========== --> |
152 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
153 |
<TD> |
154 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodpush'>void push ( )</A></B></CODE> |
155 |
<BR> |
156 |
<blockquote> Same as add(). </blockquote> |
157 |
</TD> |
158 |
</TR> |
159 |
<!-- =========== Summary =========== --> |
160 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
161 |
<TD> |
162 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodpush_reference'>void push_reference ( &$content )</A></B></CODE> |
163 |
<BR> |
164 |
<blockquote> Same as add_reference NOTE : only exists for compatibility with 1.1.x </blockquote> |
165 |
</TD> |
166 |
</TR> |
167 |
<!-- =========== Summary =========== --> |
168 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
169 |
<TD> |
170 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodrender'>string render ( [$indent_level = 0], [$output_debug = 0] )</A></B></CODE> |
171 |
<BR> |
172 |
<blockquote> This function is compatible with the rest of the phpHtmllib API spec. </blockquote> |
173 |
</TD> |
174 |
</TR> |
175 |
<!-- =========== Summary =========== --> |
176 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
177 |
<TD> |
178 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodreset_content'>void reset_content ( )</A></B></CODE> |
179 |
<BR> |
180 |
<blockquote> destroy existing content and start with new content. </blockquote> |
181 |
</TD> |
182 |
</TR> |
183 |
<!-- =========== Summary =========== --> |
184 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
185 |
<TD> |
186 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodset_collapse'>void set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></B></CODE> |
187 |
<BR> |
188 |
<blockquote> This function turns on the collapse flag </blockquote> |
189 |
</TD> |
190 |
</TR> |
191 |
<!-- =========== Summary =========== --> |
192 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
193 |
<TD> |
194 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#methodset_indent_flag'>void set_indent_flag ( $flag )</A></B></CODE> |
195 |
<BR> |
196 |
<blockquote> function to set the indent flag </blockquote> |
197 |
</TD> |
198 |
</TR> |
199 |
<!-- =========== Summary =========== --> |
200 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
201 |
<TD> |
202 |
<CODE><B><A HREF='../phpHtmlLib/Container.html#method_set_flags'>void _set_flags ( )</A></B></CODE> |
203 |
<BR> |
204 |
<blockquote> This method is used to set the bitmask flags for this tag. It tells the class how to render the tag. </blockquote> |
205 |
</TD> |
206 |
</TR> |
207 |
</TABLE> |
208 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
209 |
<A NAME='functions_inherited'><!-- --></A> |
210 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
211 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
212 |
<TD> |
213 |
<span CLASS="font12bold">Inherited Method Summary</span> |
214 |
<A HREF="#top" CLASS="links">^TOP</A> |
215 |
</TD> |
216 |
</TR> |
217 |
|
218 |
</TABLE> |
219 |
<hr> |
220 |
<!-- ============ VARIABLE DETAIL =========== --> |
221 |
|
222 |
<A NAME='variable_detail'></A> |
223 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
224 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
225 |
<TD> |
226 |
<span CLASS="font12bold">Variable Detail</span> |
227 |
<A HREF="#top" CLASS="links">^TOP</A> |
228 |
</TD> |
229 |
</TR> |
230 |
</TABLE> |
231 |
|
232 |
<A NAME='var$_flags'><!-- --></A><H3>$_flags</H3> (line <span class="linenumber">64</span>)<br /> |
233 |
<b>Data type:</b> mixed<br>The flags that tell us |
234 |
<br /> |
235 |
<p>how to render the tag its contents, and the close</p> |
236 |
<UL> |
237 |
</UL> |
238 |
<HR> |
239 |
<hr> |
240 |
<!-- ============ METHOD DETAIL =========== --> |
241 |
|
242 |
<A NAME='method_detail'></A> |
243 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
244 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
245 |
<TD> |
246 |
<span class="font12bold">Method Detail</span> |
247 |
<A HREF="#top" CLASS="links">^TOP</A> |
248 |
</TD> |
249 |
</TR> |
250 |
</TABLE> |
251 |
<BR> |
252 |
<DIV CLASS="function"> |
253 |
<A NAME='methodContainer'><!-- --></A> |
254 |
<SPAN CLASS="font12bold">Constructor Container</SPAN> (line <span class="linenumber">76</span>) |
255 |
<BR> |
256 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
257 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
258 |
<span class="font10bold" style="color: #0000FF">Container( |
259 |
)</SPAN> |
260 |
<BR> |
261 |
|
262 |
<BR> |
263 |
<SPAN CLASS="font10bold">Description : </SPAN> |
264 |
The constructor. |
265 |
<br /> |
266 |
<p>This lets you pass in data that you want automatically added to the container. This works in the same manner as the push() method.</p> |
267 |
<DL> |
268 |
|
269 |
<DT class="font10bold">Function Info:</DT> |
270 |
</DL> |
271 |
</DIV> |
272 |
<BR> |
273 |
<DIV CLASS="function"> |
274 |
<A NAME='methodadd'><!-- --></A> |
275 |
<SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">172</span>) |
276 |
<BR> |
277 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
278 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
279 |
<span class="font10bold" style="color: #0000FF">add( |
280 |
mixed |
281 |
$content)</SPAN> |
282 |
<BR> |
283 |
<p>Overridden in child classes as:<br /> |
284 |
<dl> |
285 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodadd">XMLDocumentClass::add()</a></dt> |
286 |
<dd>we override this class to make sure we push all content inside the local _xml_obj tag</dd> |
287 |
</dl> |
288 |
</p> |
289 |
|
290 |
<BR> |
291 |
<SPAN CLASS="font10bold">Description : </SPAN> |
292 |
add content onto content stack |
293 |
<br /> |
294 |
<p>adds content to tag as a FIFO. You can have n number of parameters. each one will get added in succession to the content.</p> |
295 |
<DL> |
296 |
<DT class="font10bold">Function Parameters:</DT> |
297 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object.</DD> |
298 |
|
299 |
<DT class="font10bold">Function Info:</DT> |
300 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
301 |
</DL> |
302 |
</DIV> |
303 |
<BR> |
304 |
<DIV CLASS="function"> |
305 |
<A NAME='methodadd_reference'><!-- --></A> |
306 |
<SPAN CLASS="font12bold">add_reference</SPAN> (line <span class="linenumber">214</span>) |
307 |
<BR> |
308 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
309 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
310 |
<span class="font10bold" style="color: #0000FF">add_reference( |
311 |
mixed |
312 |
&$content, mixed |
313 |
$content)</SPAN> |
314 |
<BR> |
315 |
<p>Overridden in child classes as:<br /> |
316 |
<dl> |
317 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodadd_reference">XMLDocumentClass::add_reference()</a></dt> |
318 |
<dd>we override this class to make sure we push all content inside the local _xml_obj tag</dd> |
319 |
</dl> |
320 |
</p> |
321 |
|
322 |
<BR> |
323 |
<SPAN CLASS="font10bold">Description : </SPAN> |
324 |
Add content onto content stack so you can change the item later. |
325 |
<br /> |
326 |
<p>adds content to tag as a FIFO You can only add 1 element at a time, and it will be added as a reference. So you can't do push_reference("something");, since "something" is a static.</p> |
327 |
<DL> |
328 |
<DT class="font10bold">Function Parameters:</DT> |
329 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</DD> |
330 |
|
331 |
<DT class="font10bold">Function Info:</DT> |
332 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
333 |
</DL> |
334 |
</DIV> |
335 |
<BR> |
336 |
<DIV CLASS="function"> |
337 |
<A NAME='methodcount_content'><!-- --></A> |
338 |
<SPAN CLASS="font12bold">count_content</SPAN> (line <span class="linenumber">239</span>) |
339 |
<BR> |
340 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
341 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
342 |
<span class="font10bold" style="color: #0000FF">count_content( |
343 |
)</SPAN> |
344 |
<BR> |
345 |
|
346 |
<BR> |
347 |
<SPAN CLASS="font10bold">Description : </SPAN> |
348 |
counts the number of content objects |
349 |
<br /> |
350 |
|
351 |
<DL> |
352 |
|
353 |
<DT class="font10bold">Function Info:</DT> |
354 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
355 |
</DL> |
356 |
</DIV> |
357 |
<BR> |
358 |
<DIV CLASS="function"> |
359 |
<A NAME='methodget_indent_flag'><!-- --></A> |
360 |
<SPAN CLASS="font12bold">get_indent_flag</SPAN> (line <span class="linenumber">280</span>) |
361 |
<BR> |
362 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
363 |
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
364 |
<span class="font10bold" style="color: #0000FF">get_indent_flag( |
365 |
)</SPAN> |
366 |
<BR> |
367 |
|
368 |
<BR> |
369 |
<SPAN CLASS="font10bold">Description : </SPAN> |
370 |
This flag gets the current value of the indent flag |
371 |
<br /> |
372 |
|
373 |
<DL> |
374 |
|
375 |
<DT class="font10bold">Function Info:</DT> |
376 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
377 |
</DL> |
378 |
</DIV> |
379 |
<BR> |
380 |
<DIV CLASS="function"> |
381 |
<A NAME='methodpush'><!-- --></A> |
382 |
<SPAN CLASS="font12bold">push</SPAN> (line <span class="linenumber">158</span>) |
383 |
<BR> |
384 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
385 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
386 |
<span class="font10bold" style="color: #0000FF">push( |
387 |
mixed |
388 |
$content)</SPAN> |
389 |
<BR> |
390 |
<p>Overridden in child classes as:<br /> |
391 |
<dl> |
392 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodpush">XMLDocumentClass::push()</a></dt> |
393 |
<dd>Same as add().</dd> |
394 |
</dl> |
395 |
</p> |
396 |
|
397 |
<BR> |
398 |
<SPAN CLASS="font10bold">Description : </SPAN> |
399 |
Same as add(). |
400 |
<br /> |
401 |
<p>NOTE: only exists for 1.1.x compatibility</p> |
402 |
<DL> |
403 |
<DT class="font10bold">Function Parameters:</DT> |
404 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object.</DD> |
405 |
|
406 |
<DT class="font10bold">Function Info:</DT> |
407 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
408 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>deprecated</b> - </DD> |
409 |
</DL> |
410 |
</DIV> |
411 |
<BR> |
412 |
<DIV CLASS="function"> |
413 |
<A NAME='methodpush_reference'><!-- --></A> |
414 |
<SPAN CLASS="font12bold">push_reference</SPAN> (line <span class="linenumber">193</span>) |
415 |
<BR> |
416 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
417 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
418 |
<span class="font10bold" style="color: #0000FF">push_reference( |
419 |
mixed |
420 |
&$content)</SPAN> |
421 |
<BR> |
422 |
<p>Overridden in child classes as:<br /> |
423 |
<dl> |
424 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodpush_reference">XMLDocumentClass::push_reference()</a></dt> |
425 |
<dd>Same as add_reference NOTE : only exists for compatibility with 1.1.x</dd> |
426 |
</dl> |
427 |
</p> |
428 |
|
429 |
<BR> |
430 |
<SPAN CLASS="font10bold">Description : </SPAN> |
431 |
Same as add_reference NOTE : only exists for compatibility with 1.1.x |
432 |
<br /> |
433 |
|
434 |
<DL> |
435 |
<DT class="font10bold">Function Parameters:</DT> |
436 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">&$content</SPAN></SPAN> - a reference to some variable.</DD> |
437 |
|
438 |
<DT class="font10bold">Function Info:</DT> |
439 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
440 |
</DL> |
441 |
</DIV> |
442 |
<BR> |
443 |
<DIV CLASS="function"> |
444 |
<A NAME='methodrender'><!-- --></A> |
445 |
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">106</span>) |
446 |
<BR> |
447 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
448 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
449 |
<span class="font10bold" style="color: #0000FF">render( |
450 |
int |
451 |
$indent_level, int |
452 |
$output_debug)</SPAN> |
453 |
<BR> |
454 |
<p>Overridden in child classes as:<br /> |
455 |
<dl> |
456 |
<dt><a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a></dt> |
457 |
<dd>This function is responsible for rendering the tag and its contents</dd> |
458 |
</dl> |
459 |
<dl> |
460 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodrender">XMLDocumentClass::render()</a></dt> |
461 |
<dd>function that will render the XML Document.</dd> |
462 |
</dl> |
463 |
<dl> |
464 |
<dt><a href="../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a></dt> |
465 |
<dd>This method is called to render the form's html</dd> |
466 |
</dl> |
467 |
</p> |
468 |
|
469 |
<BR> |
470 |
<SPAN CLASS="font10bold">Description : </SPAN> |
471 |
This function is compatible with the rest of the phpHtmllib API spec. |
472 |
<br /> |
473 |
<p>It just walks through each of the class' data and renders it with the appropriate indentation.</p> |
474 |
<DL> |
475 |
<DT class="font10bold">Function Parameters:</DT> |
476 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for the container.</DD> |
477 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD> |
478 |
|
479 |
<DT class="font10bold">Function Info:</DT> |
480 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
481 |
</DL> |
482 |
</DIV> |
483 |
<BR> |
484 |
<DIV CLASS="function"> |
485 |
<A NAME='methodreset_content'><!-- --></A> |
486 |
<SPAN CLASS="font12bold">reset_content</SPAN> (line <span class="linenumber">226</span>) |
487 |
<BR> |
488 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
489 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
490 |
<span class="font10bold" style="color: #0000FF">reset_content( |
491 |
mixed |
492 |
$content)</SPAN> |
493 |
<BR> |
494 |
<p>Overridden in child classes as:<br /> |
495 |
<dl> |
496 |
<dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodreset_content">XMLDocumentClass::reset_content()</a></dt> |
497 |
<dd>we override this class to make sure we push all content inside the local _xml_obj tag</dd> |
498 |
</dl> |
499 |
</p> |
500 |
|
501 |
<BR> |
502 |
<SPAN CLASS="font10bold">Description : </SPAN> |
503 |
destroy existing content and start with new content. |
504 |
<br /> |
505 |
|
506 |
<DL> |
507 |
<DT class="font10bold">Function Parameters:</DT> |
508 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> can be tag object, or raw (string).</DD> |
509 |
|
510 |
<DT class="font10bold">Function Info:</DT> |
511 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
512 |
</DL> |
513 |
</DIV> |
514 |
<BR> |
515 |
<DIV CLASS="function"> |
516 |
<A NAME='methodset_collapse'><!-- --></A> |
517 |
<SPAN CLASS="font12bold">set_collapse</SPAN> (line <span class="linenumber">294</span>) |
518 |
<BR> |
519 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
520 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
521 |
<span class="font10bold" style="color: #0000FF">set_collapse( |
522 |
[boolean |
523 |
$collapse = TRUE], [boolean |
524 |
$indent = TRUE])</SPAN> |
525 |
<BR> |
526 |
<p>Overridden in child classes as:<br /> |
527 |
<dl> |
528 |
<dt><a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a></dt> |
529 |
<dd>This function turns on the collapse flag</dd> |
530 |
</dl> |
531 |
</p> |
532 |
|
533 |
<BR> |
534 |
<SPAN CLASS="font10bold">Description : </SPAN> |
535 |
This function turns on the collapse flag |
536 |
<br /> |
537 |
|
538 |
<DL> |
539 |
<DT class="font10bold">Function Parameters:</DT> |
540 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$collapse</SPAN></SPAN> - the collapse flag</DD> |
541 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$indent</SPAN></SPAN> - the indent flag DEFAULT: TRUE;</DD> |
542 |
|
543 |
<DT class="font10bold">Function Info:</DT> |
544 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
545 |
</DL> |
546 |
</DIV> |
547 |
<BR> |
548 |
<DIV CLASS="function"> |
549 |
<A NAME='methodset_indent_flag'><!-- --></A> |
550 |
<SPAN CLASS="font12bold">set_indent_flag</SPAN> (line <span class="linenumber">263</span>) |
551 |
<BR> |
552 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
553 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
554 |
<span class="font10bold" style="color: #0000FF">set_indent_flag( |
555 |
boolean |
556 |
$flag)</SPAN> |
557 |
<BR> |
558 |
|
559 |
<BR> |
560 |
<SPAN CLASS="font10bold">Description : </SPAN> |
561 |
function to set the indent flag |
562 |
<br /> |
563 |
|
564 |
<DL> |
565 |
<DT class="font10bold">Function Parameters:</DT> |
566 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> TRUE or FALSE</DD> |
567 |
|
568 |
<DT class="font10bold">Function Info:</DT> |
569 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD> |
570 |
</DL> |
571 |
</DIV> |
572 |
<BR> |
573 |
<DIV CLASS="function"> |
574 |
<A NAME='method_set_flags'><!-- --></A> |
575 |
<SPAN CLASS="font12bold">_set_flags</SPAN> (line <span class="linenumber">252</span>) |
576 |
<BR> |
577 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
578 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
579 |
<span class="font10bold" style="color: #0000FF">_set_flags( |
580 |
)</SPAN> |
581 |
<BR> |
582 |
<p>Overridden in child classes as:<br /> |
583 |
<dl> |
584 |
<dt><a href="../phpHtmlLib/XMLTagClass.html#method_set_flags">XMLTagClass::_set_flags()</a></dt> |
585 |
<dd>This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</dd> |
586 |
</dl> |
587 |
</p> |
588 |
|
589 |
<BR> |
590 |
<SPAN CLASS="font10bold">Description : </SPAN> |
591 |
This method is used to set the bitmask flags for this tag. It tells the class how to render the tag. |
592 |
<br /> |
593 |
<p>NOTE: the child class can override this to set the options</p> |
594 |
<DL> |
595 |
|
596 |
<DT class="font10bold">Function Info:</DT> |
597 |
</DL> |
598 |
</DIV> |
599 |
<BR> |
600 |
<div id="credit"> |
601 |
<hr> |
602 |
Documention generated on Thu, 20 Feb 2003 16:22:32 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
603 |
</div> |
604 |
</body> |
605 |
</html> |