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