1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!--NewPage--> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<HTML> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<HEAD> |
<head> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class Container</TITLE> |
<title>Docs For Class Container</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
</HEAD> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
</head> |
10 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
<!-- Links --> |
<h2 class="class-name">Class Container</h2> |
13 |
<a NAME="top"></A> |
|
14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
15 |
<TR> |
<div class="info-box"> |
16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
17 |
Links: |
<div class="nav-bar"> |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from Container">Child Classes</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-descendents">Descendents</a> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</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> |
</div> |
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
<div class="info-box-body"> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<!-- ========== Info from phpDoc block ========= --> |
25 |
</TD> |
<p class="short-description">This class is nothing more then a</p> |
26 |
</TR> |
<p class="description"><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></p> |
27 |
</TABLE> |
<ul class="tags"> |
28 |
<BR> |
<li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html">Container</a></li> |
29 |
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
30 |
<!-- Start of Class Data --> |
<li><span class="field">link:</span> <a href="http://phphtmllib.sourceforge.net">http://phphtmllib.sourceforge.net</a></li> |
31 |
<H2> |
</ul> |
32 |
Class Container |
<p class="notes"> |
33 |
</H2> |
Located in <a class="field" href="_ContainerClass_inc.html">/ContainerClass.inc</a> (line <span class="field">39</span>) |
34 |
|
</p> |
35 |
<pre> |
|
36 |
Container |
|
37 |
</pre> |
<pre></pre> |
38 |
|
|
39 |
<A NAME="children_summary"</A> |
</div> |
40 |
<H3> |
</div> |
41 |
Classes extended from Container: <A HREF="#top" CLASS="links">^TOP</A> |
|
42 |
</H3> |
<a name="sec-descendents"></a> |
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> |
<div class="info-box"> |
44 |
<p> |
<div class="info-box-title">Direct descendents</div> |
45 |
<b><i>Located in File: Program_Root/ContainerClass.inc</i></b><br> |
<div class="nav-bar"> |
46 |
</p> |
<a href="#sec-description">Description</a> | |
47 |
<hr> |
<span class="disabled">Descendents</span> |
48 |
<!-- ========== Info from phpDoc block ========= --> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
49 |
This class is nothing more then a |
|
50 |
<BR> |
</div> |
51 |
container widget. It lets you |
<div class="info-box-body"> |
52 |
push data into it, and it will |
<table cellpadding="2" cellspacing="0" class="class-table"> |
53 |
render each item indented properly |
<tr> |
54 |
so it works with the rest of the libs. |
<th class="class-table-header">Class</th> |
55 |
|
<th class="class-table-header">Description</th> |
56 |
This is helpfull when you have a function |
</tr> |
57 |
that wants to return multiple Tag Objects |
<tr> |
58 |
or widgets. Just wrap them in this container |
<td style="padding-right: 2em"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></td> |
59 |
and they will all get rendered with the |
<td> |
60 |
current indentation level. |
This class is used for building and rendering an XML tag. |
61 |
|
</td> |
62 |
Base Class for phpHtmlLib |
</tr> |
63 |
|
<tr> |
64 |
<UL> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></td> |
65 |
|
<td> |
66 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
This is the main engine for the processing |
67 |
|
</td> |
68 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
</tr> |
69 |
|
<tr> |
70 |
<LI><b>Link</b> - <CODE>http://phphtmllib.sourceforge.net</CODE></LI> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></td> |
71 |
|
<td> |
72 |
</UL> |
this is the base widget class, that all widgets are based off of. It provides some basic members and methods |
73 |
|
</td> |
74 |
<hr> |
</tr> |
75 |
<!-- =========== VAR SUMMARY =========== --> |
<tr> |
76 |
<A NAME='var_summary'><!-- --></A> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></td> |
77 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<td> |
78 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
This is just to maintain compatibility with the 1.1.0 release of phphtmllib |
79 |
<TD> |
</td> |
80 |
<span CLASS="font12bold">Class Variable Summary</span> |
</tr> |
81 |
<A HREF="#top" CLASS="links">^TOP</A> |
<tr> |
82 |
</TD> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></td> |
83 |
</TR> |
<td> |
84 |
|
This class lets you build a complete xml document and render it. |
85 |
|
</td> |
86 |
<!-- =========== Summary =========== --> |
</tr> |
87 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</table> |
88 |
<TD> |
</div> |
89 |
<CODE><B><A HREF='Container.html#$indent_flag'>$indent_flag</A></B></CODE> |
</div> |
90 |
<BR> |
|
91 |
<blockquote> Flag for pretty (indented) output </blockquote> |
|
92 |
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
|
93 |
</TD> |
<a name="sec-method-summary"></a> |
94 |
</TR> |
<div class="info-box"> |
95 |
|
<div class="info-box-title">Method Summary</span></div> |
96 |
<!-- =========== Summary =========== --> |
<div class="nav-bar"> |
97 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#sec-description">Description</a> | |
98 |
<TD> |
<a href="#sec-descendents">Descendents</a> | |
99 |
<CODE><B><A HREF='Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></B></CODE> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
100 |
<BR> |
</div> |
101 |
<blockquote> Do we render a newline after the |
<div class="info-box-body"> |
102 |
contents has been rendered? </blockquote> |
<div class="method-summary"> |
103 |
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
|
104 |
</TD> |
<div class="method-definition"> |
105 |
</TR> |
<span class="method-result">Container</span> |
106 |
|
<a href="#Container" title="details" class="method-name">Container</a> |
107 |
</TABLE> |
() |
108 |
|
</div> |
109 |
<hr> |
|
110 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
<div class="method-definition"> |
111 |
<A NAME='var_inherited_summary'><!-- --></A> |
<span class="method-result">void</span> |
112 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<a href="#add" title="details" class="method-name">add</a> |
113 |
<TR CLASS='TableHeadingColor'> |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
114 |
<TD> |
</div> |
115 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
|
116 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="method-definition"> |
117 |
</TD> |
<span class="method-result">void</span> |
118 |
</TR> |
<a href="#add_reference" title="details" class="method-name">add_reference</a> |
119 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
120 |
|
</div> |
121 |
</TABLE> |
|
122 |
|
<div class="method-definition"> |
123 |
<hr> |
<span class="method-result">int</span> |
124 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
<a href="#count_content" title="details" class="method-name">count_content</a> |
125 |
<A NAME='functions_inherited'><!-- --></A> |
() |
126 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</div> |
127 |
<TR CLASS='TableHeadingColor'> |
|
128 |
<TD> |
<div class="method-definition"> |
129 |
<span CLASS="font12bold">Inherited Method Summary</span> |
<span class="method-result">mixed</span> |
130 |
<A HREF="#top" CLASS="links">^TOP</A> |
<a href="#get_element" title="details" class="method-name">&get_element</a> |
131 |
</TD> |
(<span class="var-type">int</span> <span class="var-name">$cell</span>) |
132 |
</TR> |
</div> |
133 |
|
|
134 |
|
<div class="method-definition"> |
135 |
</TABLE> |
<span class="method-result">boolean</span> |
136 |
|
<a href="#get_indent_flag" title="details" class="method-name">get_indent_flag</a> |
137 |
<hr> |
() |
138 |
<!-- should have constructor at some point --> |
</div> |
139 |
<!-- =========== Method SUMMARY =========== --> |
|
140 |
<A NAME='Method_summary'><!-- --></A> |
<div class="method-definition"> |
141 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
<span class="method-result">void</span> |
142 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<a href="#push" title="details" class="method-name">push</a> |
143 |
<TD> |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
144 |
<span class="font12bold">Method Summary</span> |
</div> |
145 |
<A HREF="#top" CLASS="links">^TOP</A> |
|
146 |
</TD> |
<div class="method-definition"> |
147 |
</TR> |
<span class="method-result">void</span> |
148 |
|
<a href="#push_reference" title="details" class="method-name">push_reference</a> |
149 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
150 |
<!-- =========== Summary =========== --> |
</div> |
151 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
152 |
<TD> |
<div class="method-definition"> |
153 |
<CODE><B><A HREF='Container.html#constructor Container'>void constructor Container ( )</A></B></CODE> |
<span class="method-result">string</span> |
154 |
<BR> |
<a href="#render" title="details" class="method-name">render</a> |
155 |
<blockquote> The constructor. </blockquote> |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
156 |
</TD> |
</div> |
157 |
</TR> |
|
158 |
|
<div class="method-definition"> |
159 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
160 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#reset_content" title="details" class="method-name">reset_content</a> |
161 |
<TD> |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
162 |
<CODE><B><A HREF='Container.html#add'>void add ( )</A></B></CODE> |
</div> |
163 |
<BR> |
|
164 |
<blockquote> add content onto content stack </blockquote> |
<div class="method-definition"> |
165 |
</TD> |
<span class="method-result">void</span> |
166 |
</TR> |
<a href="#set_collapse" title="details" class="method-name">set_collapse</a> |
167 |
|
([<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>]) |
168 |
<!-- =========== Summary =========== --> |
</div> |
169 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
170 |
<TD> |
<div class="method-definition"> |
171 |
<CODE><B><A HREF='Container.html#add_reference'>void add_reference ( &$content )</A></B></CODE> |
<span class="method-result">void</span> |
172 |
<BR> |
<a href="#set_indent_flag" title="details" class="method-name">set_indent_flag</a> |
173 |
<blockquote> Add content onto content stack |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
174 |
so you can change the item later. </blockquote> |
</div> |
175 |
</TD> |
</div> |
176 |
</TR> |
</div> |
177 |
|
</div> |
178 |
<!-- =========== Summary =========== --> |
|
179 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
180 |
<TD> |
<a name="sec-methods"></a> |
181 |
<CODE><B><A HREF='Container.html#count_content'>int count_content ( )</A></B></CODE> |
<div class="info-box"> |
182 |
<BR> |
<div class="info-box-title">Methods</div> |
183 |
<blockquote> counts the number of content objects </blockquote> |
<div class="nav-bar"> |
184 |
</TD> |
<a href="#sec-description">Description</a> | |
185 |
</TR> |
<a href="#sec-descendents">Descendents</a> | |
186 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
187 |
<!-- =========== Summary =========== --> |
|
188 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
189 |
<TD> |
<div class="info-box-body"> |
190 |
<CODE><B><A HREF='Container.html#get_indent_flag'>boolean get_indent_flag ( )</A></B></CODE> |
<A NAME='method_detail'></A> |
191 |
<BR> |
<a name="methodContainer" id="Container"><!-- --></a> |
192 |
<blockquote> This flag gets the current value |
<div class="oddrow"> |
193 |
of the indent flag </blockquote> |
|
194 |
</TD> |
<div class="method-header"> |
195 |
</TR> |
<span class="method-title">Constructor Container</span> (line <span class="line-number">82</span>) |
196 |
|
</div> |
197 |
<!-- =========== Summary =========== --> |
|
198 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
199 |
<TD> |
<p class="short-description">The constructor.</p> |
200 |
<CODE><B><A HREF='Container.html#push'>void push ( )</A></B></CODE> |
<p class="description"><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><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodContainer">Container</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
201 |
<BR> |
<li> <span class="src-comm">//We do the adding to the content var</span></li> |
202 |
<blockquote> Same as add(). </blockquote> |
<li> <span class="src-comm">//here instead of calling $this->push()</span></li> |
203 |
</TD> |
<li> <span class="src-comm">//to save some cpu cycles.</span></li> |
204 |
</TR> |
<li> <span class="src-var">$num </span>= <a href="http://www.php.net/func_num_args">func_num_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
205 |
|
<li> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$i</span>=<span class="src-num">0</span><span class="src-sym">;</span><span class="src-var">$i</span><<span class="src-var">$num</span><span class="src-sym">;</span><span class="src-var">$i</span>++<span class="src-sym">) </span><span class="src-sym">{</span></li> |
206 |
<!-- =========== Summary =========== --> |
<li> <span class="src-var">$arg </span>= <a href="http://www.php.net/func_get_arg">func_get_arg</a><span class="src-sym">(</span><span class="src-var">$i</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
207 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<li> <a href="http://www.php.net/array_push">array_push</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_content</span><span class="src-sym">, </span><span class="src-var">$arg</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
208 |
<TD> |
<li> <span class="src-sym">}</span></li> |
209 |
<CODE><B><A HREF='Container.html#push_reference'>void push_reference ( &$content )</A></B></CODE> |
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_data_count </span>+= <span class="src-var">$num</span><span class="src-sym">;</span></li> |
210 |
<BR> |
<li> </li> |
211 |
<blockquote> Same as add_reference |
<li> <span class="src-comm">//set the flag bitmask</span></li> |
212 |
NOTE : only exists for compatibility with 1.1.x </blockquote> |
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_set_flags</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
213 |
</TD> |
<li> <span class="src-sym">}</span></li> |
214 |
</TR> |
</ol></pre></p></p> |
215 |
|
<ul class="tags"> |
216 |
<!-- =========== Summary =========== --> |
<li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#constructor">Constructor call</a></li> |
217 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</ul> |
218 |
<TD> |
|
219 |
<CODE><B><A HREF='Container.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
<div class="method-signature"> |
220 |
<BR> |
<span class="method-result">Container</span> |
221 |
<blockquote> This function is compatible with the |
<span class="method-name"> |
222 |
rest of the phpHtmllib API spec. </blockquote> |
Container |
223 |
</TD> |
</span> |
224 |
</TR> |
() |
225 |
|
</div> |
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> |
</div> |
230 |
<BR> |
<a name="methodadd" id="add"><!-- --></a> |
231 |
<blockquote> destroy existing content and start with new content. </blockquote> |
<div class="evenrow"> |
232 |
</TD> |
|
233 |
</TR> |
<div class="method-header"> |
234 |
|
<span class="method-title">add</span> (line <span class="line-number">187</span>) |
235 |
<!-- =========== Summary =========== --> |
</div> |
236 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
237 |
<TD> |
<!-- ========== Info from phpDoc block ========= --> |
238 |
<CODE><B><A HREF='Container.html#set_collapse'>void set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></B></CODE> |
<p class="short-description">add content onto content stack</p> |
239 |
<BR> |
<p class="description"><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><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodadd">add</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
240 |
<blockquote> This function turns on the collapse flag </blockquote> |
<li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
241 |
</TD> |
<li> <span class="src-var">$num </span>= <span class="src-num">0</span><span class="src-sym">;</span></li> |
242 |
</TR> |
<li> <span class="src-key">foreach</span><span class="src-sym">( </span><span class="src-var">$args </span><span class="src-key">as </span><span class="src-var">$arg </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
243 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$arg</span><span class="src-sym">;</span></li> |
244 |
<!-- =========== Summary =========== --> |
<li> <span class="src-var">$num</span>++<span class="src-sym">;</span></li> |
245 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<li> <span class="src-sym">}</span></li> |
246 |
<TD> |
<li> <span class="src-comm">//keep track of how much data we have added.</span></li> |
247 |
<CODE><B><A HREF='Container.html#set_indent_flag'>void set_indent_flag ( $flag )</A></B></CODE> |
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_data_count </span>+= <span class="src-var">$num</span><span class="src-sym">;</span></li> |
248 |
<BR> |
<li> <span class="src-sym">}</span></li> |
249 |
<blockquote> function to set the indent flag </blockquote> |
</ol></pre></p></p> |
250 |
</TD> |
<ul class="tags"> |
251 |
</TR> |
<li><span class="field">access:</span> public</li> |
252 |
|
<li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#add">add Method</a></li> |
253 |
</TABLE> |
</ul> |
254 |
|
|
255 |
<hr> |
<div class="method-signature"> |
256 |
<!-- ============ VARIABLE DETAIL =========== --> |
<span class="method-result">void</span> |
257 |
|
<span class="method-name"> |
258 |
<A NAME='variable_detail'></A> |
add |
259 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</span> |
260 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
261 |
<TD> |
</div> |
262 |
<span CLASS="font12bold">Variable Detail</span> |
|
263 |
<A HREF="#top" CLASS="links">^TOP</A> |
<ul class="parameters"> |
264 |
</TD> |
<li> |
265 |
</TR> |
<span class="var-type">mixed</span> |
266 |
</TABLE> |
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
267 |
|
</ul> |
268 |
|
|
269 |
<A NAME='$indent_flag'><!-- --></A><H3>$indent_flag</H3> |
|
270 |
<b>Data type:</b> boolean<br> |
<hr class="separator" /> |
271 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="notes">Redefined in descendants as:</div> |
272 |
Flag for pretty (indented) output |
<ul class="redefinitions"> |
273 |
<BR> |
<li> |
274 |
|
<a href="../phpHtmlLib/OLtag.html#methodadd">OLtag::add()</a> |
275 |
|
: add content onto content stack adds content to tag as a FIFO. |
276 |
<UL> |
</li> |
277 |
|
<li> |
278 |
<LI><b>Access</b> - <CODE>public</CODE></LI> |
<a href="../phpHtmlLib/TRtag.html#methodadd">TRtag::add()</a> |
279 |
|
: add content onto content stack adds content to tag as a FIFO. |
280 |
</UL> |
</li> |
281 |
|
<li> |
282 |
<HR> |
<a href="../phpHtmlLib/ButtonPanel.html#methodadd">ButtonPanel::add()</a> |
283 |
|
: Push content onto the data object |
284 |
<A NAME='$_newline_after_content_flag'><!-- --></A><H3>$_newline_after_content_flag</H3> |
</li> |
285 |
<b>Data type:</b> boolean<br> |
<li> |
286 |
<!-- ========== Info from phpDoc block ========= --> |
<a href="../phpHtmlLib/CSSContainer.html#methodadd">CSSContainer::add()</a> |
287 |
Do we render a newline after the |
: Only allow the adding of CSSBuilder |
288 |
contents has been rendered? |
</li> |
289 |
<BR> |
<li> |
290 |
|
<a href="../phpHtmlLib/DialogWidget.html#methodadd">DialogWidget::add()</a> |
291 |
|
: Pushes a content into the data object |
292 |
<UL> |
</li> |
293 |
|
<li> |
294 |
</UL> |
<a href="../phpHtmlLib/FooterNav.html#methodadd">FooterNav::add()</a> |
295 |
|
: add an entry to the footer nav |
296 |
<HR> |
</li> |
297 |
|
<li> |
298 |
|
<a href="../phpHtmlLib/NavTable.html#methodadd">NavTable::add()</a> |
299 |
<hr> |
: this function adds an entry to the navtable. |
300 |
<!-- ============ FUNCTION DETAIL =========== --> |
</li> |
301 |
|
<li> |
302 |
<A NAME='function_detail'></A> |
<a href="../phpHtmlLib/TabList.html#methodadd">TabList::add()</a> |
303 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
: This public method adds a new tab to the table |
304 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</li> |
305 |
<TD> |
<li> |
306 |
<span class="font12bold">Method Detail</span> |
<a href="../phpHtmlLib/TextCSSNav.html#methodadd">TextCSSNav::add()</a> |
307 |
<A HREF="#top" CLASS="links">^TOP</A> |
: this function adds a clickable link. |
308 |
</TD> |
</li> |
309 |
</TR> |
<li> |
310 |
</TABLE> |
<a href="../phpHtmlLib/TextNav.html#methodadd">TextNav::add()</a> |
311 |
<BR> |
: this function adds a clickable link. |
312 |
|
</li> |
313 |
<DIV CLASS="function"> |
<li> |
314 |
<A NAME='constructor Container'><!-- --></A> |
<a href="../phpHtmlLib/VerticalCSSNavTable.html#methodadd">VerticalCSSNavTable::add()</a> |
315 |
<SPAN CLASS="font12bold">constructor Container</SPAN> |
: this function adds a clickable link. |
316 |
<BR> |
</li> |
317 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> |
318 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<a href="../phpHtmlLib/XMLDocumentClass.html#methodadd">XMLDocumentClass::add()</a> |
319 |
<span class="font10bold" style="color: #0000FF">constructor Container ( )</SPAN> |
: we override this class to make sure we push all content inside the local _xml_obj tag |
320 |
<BR> |
</li> |
321 |
|
</ul> |
322 |
<BR> |
</div> |
323 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a name="methodadd_reference" id="add_reference"><!-- --></a> |
324 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="oddrow"> |
325 |
The constructor. |
|
326 |
<BR> |
<div class="method-header"> |
327 |
This lets you pass in data |
<span class="method-title">add_reference</span> (line <span class="line-number">230</span>) |
328 |
that you want automatically |
</div> |
329 |
added to the container. This |
|
330 |
works in the same manner as |
<!-- ========== Info from phpDoc block ========= --> |
331 |
the push() method. |
<p class="short-description">Add content onto content stack so you can change the item later.</p> |
332 |
<DL> |
<p class="description"><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></p> |
333 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="tags"> |
334 |
|
<li><span class="field">access:</span> public</li> |
335 |
|
</ul> |
336 |
<DT class="font10bold">Function Info:</DT> |
|
337 |
|
<div class="method-signature"> |
338 |
</DL> |
<span class="method-result">void</span> |
339 |
|
<span class="method-name"> |
340 |
</DIV> |
add_reference |
341 |
<BR> |
</span> |
342 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
343 |
<DIV CLASS="function"> |
</div> |
344 |
<A NAME='add'><!-- --></A> |
|
345 |
<SPAN CLASS="font12bold">add</SPAN> |
<ul class="parameters"> |
346 |
<BR> |
<li> |
347 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-type">mixed</span> |
348 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="var-name">$content</span><span class="var-description">: - 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.</span> </li> |
349 |
<span class="font10bold" style="color: #0000FF">add ( )</SPAN> |
</ul> |
350 |
<BR> |
|
351 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLDocumentClass.html#add">XMLDocumentClass::add()</a><br> |
|
352 |
<BR> |
<hr class="separator" /> |
353 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="notes">Redefined in descendants as:</div> |
354 |
<!-- ========== Info from phpDoc block ========= --> |
<ul class="redefinitions"> |
355 |
add content onto content stack |
<li> |
356 |
<BR> |
<a href="../phpHtmlLib/OLtag.html#methodadd_reference">OLtag::add_reference()</a> |
357 |
adds content to tag as a FIFO. |
: push content onto content stack |
358 |
You can have n number of parameters. |
</li> |
359 |
each one will get added in succession to the content. |
<li> |
360 |
<DL> |
<a href="../phpHtmlLib/TRtag.html#methodadd_reference">TRtag::add_reference()</a> |
361 |
<DT class="font10bold">Function Parameters:</DT> |
: add content onto content stack |
362 |
|
</li> |
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> |
<li> |
364 |
|
<a href="../phpHtmlLib/XMLDocumentClass.html#methodadd_reference">XMLDocumentClass::add_reference()</a> |
365 |
|
: we override this class to make sure we push all content inside the local _xml_obj tag |
366 |
<DT class="font10bold">Function Info:</DT> |
</li> |
367 |
|
</ul> |
368 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
</div> |
369 |
|
<a name="methodcount_content" id="count_content"><!-- --></a> |
370 |
</DL> |
<div class="evenrow"> |
371 |
|
|
372 |
</DIV> |
<div class="method-header"> |
373 |
<BR> |
<span class="method-title">count_content</span> (line <span class="line-number">258</span>) |
374 |
|
</div> |
375 |
<DIV CLASS="function"> |
|
376 |
<A NAME='add_reference'><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
377 |
<SPAN CLASS="font12bold">add_reference</SPAN> |
<p class="short-description">counts the number of content objects</p> |
378 |
<BR> |
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodcount_content">count_content</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
379 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_data_count</span><span class="src-sym">;</span></li> |
380 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li> <span class="src-sym">}</span></li> |
381 |
<span class="font10bold" style="color: #0000FF">add_reference ( &$content )</SPAN> |
</ol></pre></p></p> |
382 |
<BR> |
<ul class="tags"> |
383 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLDocumentClass.html#add_reference">XMLDocumentClass::add_reference()</a><br> |
<li><span class="field">access:</span> public</li> |
384 |
<BR> |
</ul> |
385 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
386 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
387 |
Add content onto content stack |
<span class="method-result">int</span> |
388 |
so you can change the item later. |
<span class="method-name"> |
389 |
<BR> |
count_content |
390 |
adds content to tag as a FIFO |
</span> |
391 |
You can only add 1 element at a time, and |
() |
392 |
it will be added as a reference. So you can't do |
</div> |
393 |
push_reference("something");, since "something" is a |
|
394 |
static. |
|
395 |
<DL> |
|
396 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
397 |
|
<a name="methodget_element" id="get_element"><!-- --></a> |
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. |
<div class="oddrow"> |
399 |
the tag object gets stored as a |
|
400 |
reference to the original, so you |
<div class="method-header"> |
401 |
can push it, then modify it later.</DD> |
<span class="method-title">get_element</span> (line <span class="line-number">271</span>) |
402 |
|
</div> |
403 |
|
|
404 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
405 |
|
<p class="short-description">get the nth element from content array</p> |
406 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<p class="description"><p><pre><ol><li><span class="src-key">function </span><span class="src-sym">&</span><a href="../phpHtmlLib/Container.html#methodget_element">get_element</a><span class="src-sym">( </span><span class="src-var">$cell </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
407 |
|
<li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-var">$cell</span><span class="src-sym">]</span><span class="src-sym">;</span></li> |
408 |
</DL> |
<li> <span class="src-sym">}</span></li> |
409 |
|
</ol></pre></p></p> |
410 |
</DIV> |
|
411 |
<BR> |
<div class="method-signature"> |
412 |
|
<span class="method-result">mixed</span> |
413 |
<DIV CLASS="function"> |
<span class="method-name"> |
414 |
<A NAME='count_content'><!-- --></A> |
&get_element |
415 |
<SPAN CLASS="font12bold">count_content</SPAN> |
</span> |
416 |
<BR> |
(<span class="var-type">int</span> <span class="var-name">$cell</span>) |
417 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
418 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
419 |
<span class="font10bold" style="color: #0000FF">count_content ( )</SPAN> |
<ul class="parameters"> |
420 |
<BR> |
<li> |
421 |
|
<span class="var-type">int</span> |
422 |
<BR> |
<span class="var-name">$cell</span><span class="var-description">: the cell to get</span> </li> |
423 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</ul> |
424 |
<!-- ========== Info from phpDoc block ========= --> |
|
425 |
counts the number of content objects |
|
426 |
<BR> |
</div> |
427 |
|
<a name="methodget_indent_flag" id="get_indent_flag"><!-- --></a> |
428 |
<DL> |
<div class="evenrow"> |
429 |
<DT class="font10bold">Function Parameters:</DT> |
|
430 |
|
<div class="method-header"> |
431 |
|
<span class="method-title">get_indent_flag</span> (line <span class="line-number">318</span>) |
432 |
<DT class="font10bold">Function Info:</DT> |
</div> |
433 |
|
|
434 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<!-- ========== Info from phpDoc block ========= --> |
435 |
|
<p class="short-description">This flag gets the current value of the indent flag</p> |
436 |
</DL> |
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodget_indent_flag">get_indent_flag</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
437 |
|
<li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li> |
438 |
</DIV> |
<li> <span class="src-sym">}</span></li> |
439 |
<BR> |
</ol></pre></p></p> |
440 |
|
|
441 |
<DIV CLASS="function"> |
<div class="method-signature"> |
442 |
<A NAME='get_indent_flag'><!-- --></A> |
<span class="method-result">boolean</span> |
443 |
<SPAN CLASS="font12bold">get_indent_flag</SPAN> |
<span class="method-name"> |
444 |
<BR> |
get_indent_flag |
445 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
446 |
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
() |
447 |
<span class="font10bold" style="color: #0000FF">get_indent_flag ( )</SPAN> |
</div> |
448 |
<BR> |
|
449 |
|
|
450 |
<BR> |
|
451 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
452 |
<!-- ========== Info from phpDoc block ========= --> |
<a name="methodpush" id="push"><!-- --></a> |
453 |
This flag gets the current value |
<div class="oddrow"> |
454 |
of the indent flag |
|
455 |
<BR> |
<div class="method-header"> |
456 |
|
<span class="method-title">push</span> (line <span class="line-number">168</span>) |
457 |
<DL> |
</div> |
458 |
<DT class="font10bold">Function Parameters:</DT> |
|
459 |
|
<!-- ========== Info from phpDoc block ========= --> |
460 |
|
<p class="short-description">Same as add().</p> |
461 |
<DT class="font10bold">Function Info:</DT> |
<p class="description"><p>NOTE: only exists for 1.1.x compatibility</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodpush">push</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
462 |
|
<li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
463 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<li> <a href="http://www.php.net/call_user_func_array">call_user_func_array</a><span class="src-sym">( </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$this</span><span class="src-sym">, </span><span class="src-str">"add"</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$args</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
464 |
|
<li> <span class="src-sym">}</span></li> |
465 |
</DL> |
</ol></pre></p></p> |
466 |
|
<ul class="tags"> |
467 |
</DIV> |
<li><span class="field">access:</span> public</li> |
468 |
<BR> |
<li><span class="field">deprecated:</span> </li> |
469 |
|
</ul> |
470 |
<DIV CLASS="function"> |
|
471 |
<A NAME='push'><!-- --></A> |
<div class="method-signature"> |
472 |
<SPAN CLASS="font12bold">push</SPAN> |
<span class="method-result">void</span> |
473 |
<BR> |
<span class="method-name"> |
474 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
push |
475 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</span> |
476 |
<span class="font10bold" style="color: #0000FF">push ( )</SPAN> |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
477 |
<BR> |
</div> |
478 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLDocumentClass.html#push">XMLDocumentClass::push()</a><br> |
|
479 |
<BR> |
<ul class="parameters"> |
480 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
481 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">mixed</span> |
482 |
Same as add(). |
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
483 |
<BR> |
</ul> |
484 |
NOTE: only exists for 1.1.x compatibility |
|
485 |
<DL> |
|
486 |
<DT class="font10bold">Function Parameters:</DT> |
<hr class="separator" /> |
487 |
|
<div class="notes">Redefined in descendants as:</div> |
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> |
<ul class="redefinitions"> |
489 |
|
<li> |
490 |
|
<a href="../phpHtmlLib/TRtag.html#methodpush">TRtag::push()</a> |
491 |
<DT class="font10bold">Function Info:</DT> |
: Same ass add() |
492 |
|
</li> |
493 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<li> |
494 |
|
<a href="../phpHtmlLib/FooterNav.html#methodpush">FooterNav::push()</a> |
495 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD> |
: add an entry to the footer nav. |
496 |
|
</li> |
497 |
</DL> |
<li> |
498 |
|
<a href="../phpHtmlLib/ImageThumbnailWidget.html#methodpush">ImageThumbnailWidget::push()</a> |
499 |
</DIV> |
</li> |
500 |
<BR> |
<li> |
501 |
|
<a href="../phpHtmlLib/NavTable.html#methodpush">NavTable::push()</a> |
502 |
<DIV CLASS="function"> |
: depricated version of add() |
503 |
<A NAME='push_reference'><!-- --></A> |
</li> |
504 |
<SPAN CLASS="font12bold">push_reference</SPAN> |
<li> |
505 |
<BR> |
<a href="../phpHtmlLib/TextCSSNav.html#methodpush">TextCSSNav::push()</a> |
506 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
: depricated version of add() |
507 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</li> |
508 |
<span class="font10bold" style="color: #0000FF">push_reference ( &$content )</SPAN> |
<li> |
509 |
<BR> |
<a href="../phpHtmlLib/TextNav.html#methodpush">TextNav::push()</a> |
510 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLDocumentClass.html#push_reference">XMLDocumentClass::push_reference()</a><br> |
: depricated version of add() |
511 |
<BR> |
</li> |
512 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
513 |
<!-- ========== Info from phpDoc block ========= --> |
<a href="../phpHtmlLib/TreeNav.html#methodpush">TreeNav::push()</a> |
514 |
Same as add_reference |
</li> |
515 |
NOTE : only exists for compatibility with 1.1.x |
<li> |
516 |
<BR> |
<a href="../phpHtmlLib/XMLDocumentClass.html#methodpush">XMLDocumentClass::push()</a> |
517 |
|
: Same as add(). |
518 |
<DL> |
</li> |
519 |
<DT class="font10bold">Function Parameters:</DT> |
</ul> |
520 |
|
</div> |
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> |
<a name="methodpush_reference" id="push_reference"><!-- --></a> |
522 |
|
<div class="evenrow"> |
523 |
|
|
524 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-header"> |
525 |
|
<span class="method-title">push_reference</span> (line <span class="line-number">209</span>) |
526 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
</div> |
527 |
|
|
528 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD> |
<!-- ========== Info from phpDoc block ========= --> |
529 |
|
<p class="short-description">Same as add_reference NOTE : only exists for compatibility with 1.1.x</p> |
530 |
</DL> |
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodpush_reference">push_reference</a><span class="src-sym">( </span><span class="src-sym">&</span><span class="src-var">$content </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
531 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../phpHtmlLib/Container.html#methodadd_reference">add_reference</a><span class="src-sym">( </span><span class="src-var">$content </span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
532 |
</DIV> |
<li> <span class="src-sym">}</span></li> |
533 |
<BR> |
</ol></pre></p></p> |
534 |
|
<ul class="tags"> |
535 |
<DIV CLASS="function"> |
<li><span class="field">access:</span> public</li> |
536 |
<A NAME='render'><!-- --></A> |
</ul> |
537 |
<SPAN CLASS="font12bold">render</SPAN> |
|
538 |
<BR> |
<div class="method-signature"> |
539 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-result">void</span> |
540 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="method-name"> |
541 |
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
push_reference |
542 |
<BR> |
</span> |
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> |
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
544 |
<BR> |
</div> |
545 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
546 |
<!-- ========== Info from phpDoc block ========= --> |
<ul class="parameters"> |
547 |
This function is compatible with the |
<li> |
548 |
rest of the phpHtmllib API spec. |
<span class="var-type">mixed</span> |
549 |
<BR> |
<span class="var-name">&$content</span><span class="var-description">: - a reference to some variable.</span> </li> |
550 |
It just walks through each of the |
</ul> |
551 |
class' data and renders it with the |
|
552 |
appropriate indentation. |
|
553 |
<DL> |
<hr class="separator" /> |
554 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="notes">Redefined in descendants as:</div> |
555 |
|
<ul class="redefinitions"> |
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 |
<li> |
557 |
the container.</DD> |
<a href="../phpHtmlLib/TRtag.html#methodpush_reference">TRtag::push_reference()</a> |
558 |
|
: Same ass add_reference() |
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 |
</li> |
560 |
maintain compatibility w/ the API.</DD> |
<li> |
561 |
|
<a href="../phpHtmlLib/XMLDocumentClass.html#methodpush_reference">XMLDocumentClass::push_reference()</a> |
562 |
|
: Same as add_reference NOTE : only exists for compatibility with 1.1.x |
563 |
<DT class="font10bold">Function Info:</DT> |
</li> |
564 |
|
</ul> |
565 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
</div> |
566 |
|
<a name="methodrender" id="render"><!-- --></a> |
567 |
</DL> |
<div class="oddrow"> |
568 |
|
|
569 |
</DIV> |
<div class="method-header"> |
570 |
<BR> |
<span class="method-title">render</span> (line <span class="line-number">114</span>) |
571 |
|
</div> |
572 |
<DIV CLASS="function"> |
|
573 |
<A NAME='reset_content'><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
574 |
<SPAN CLASS="font12bold">reset_content</SPAN> |
<p class="short-description">This function is compatible with the rest of the phpHtmllib API spec.</p> |
575 |
<BR> |
<p class="description"><p>It just walks through each of the class' data and renders it with the appropriate indentation.</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodrender">render</a><span class="src-sym">(</span><span class="src-var">$indent_level</span>=<span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$output_debug</span>=<span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
576 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> <span class="src-var">$html </span>= <span class="src-str">''</span><span class="src-sym">;</span></li> |
577 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li> </li> |
578 |
<span class="font10bold" style="color: #0000FF">reset_content ( )</SPAN> |
<li> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$x</span>=<span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$x</span><=<span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_data_count</span>-<span class="src-num">1</span><span class="src-sym">; </span><span class="src-var">$x</span>++<span class="src-sym">) </span><span class="src-sym">{</span></li> |
579 |
<BR> |
<li> <span class="src-var">$item </span>= <span class="src-sym">&</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-var">$x</span><span class="src-sym">]</span><span class="src-sym">;</span></li> |
580 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLDocumentClass.html#reset_content">XMLDocumentClass::reset_content()</a><br> |
<li> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/method_exists">method_exists</a><span class="src-sym">(</span><span class="src-var">$item</span><span class="src-sym">, </span><span class="src-str">"render"</span><span class="src-sym">) ) </span><span class="src-sym">{</span></li> |
581 |
<BR> |
<li> <span class="src-key">if </span><span class="src-sym">((</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span>&& <a href="http://www.php.net/method_exists">method_exists</a><span class="src-sym">(</span><span class="src-var">$item</span><span class="src-sym">, </span><span class="src-str">"set_collapse"</span><span class="src-sym">)) </span><span class="src-sym">{</span></li> |
582 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> <span class="src-var">$item</span><span class="src-sym">-></span><a href="../phpHtmlLib/Container.html#methodset_collapse">set_collapse</a><span class="src-sym">(</span><span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-id">FALSE</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
583 |
<!-- ========== Info from phpDoc block ========= --> |
<li> <span class="src-sym">}</span></li> |
584 |
destroy existing content and start with new content. |
<li> <span class="src-var">$html </span>.= <span class="src-var">$item</span><span class="src-sym">-></span><a href="../phpHtmlLib/Container.html#methodrender">render</a><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
585 |
<BR> |
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
586 |
|
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
587 |
<DL> |
<li> <span class="src-var">$html </span>.= <span class="src-var">$item</span><span class="src-sym">; </span></li> |
588 |
<DT class="font10bold">Function Parameters:</DT> |
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
589 |
|
<li> <span class="src-var">$indent </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_render_indent</span><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
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> |
<li> <span class="src-var">$html </span>.= <span class="src-var">$indent</span>.<span class="src-var">$item</span><span class="src-sym">;</span></li> |
591 |
|
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
592 |
|
<li> <span class="src-var">$html </span>.= <span class="src-str">"\n"</span><span class="src-sym">;</span></li> |
593 |
<DT class="font10bold">Function Info:</DT> |
<li> <span class="src-sym">}</span></li> |
594 |
|
<li> <span class="src-sym">} </span></li> |
595 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<li> <span class="src-sym">}</span></li> |
596 |
|
<li> <span class="src-sym">}</span></li> |
597 |
</DL> |
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
598 |
|
<li> <span class="src-var">$indent </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_render_indent</span><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
599 |
</DIV> |
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span><span class="src-sym">& </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
600 |
<BR> |
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$output_debug</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
601 |
|
<li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html </span>. <span class="src-str">"<br>\n"</span><span class="src-sym">; </span></li> |
602 |
<DIV CLASS="function"> |
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
603 |
<A NAME='set_collapse'><!-- --></A> |
<li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html </span>. <span class="src-str">"\n"</span><span class="src-sym">;</span></li> |
604 |
<SPAN CLASS="font12bold">set_collapse</SPAN> |
<li> <span class="src-sym">} </span></li> |
605 |
<BR> |
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
606 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html</span><span class="src-sym">;</span></li> |
607 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li> <span class="src-sym">}</span></li> |
608 |
<span class="font10bold" style="color: #0000FF">set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</SPAN> |
<li> </li> |
609 |
<BR> |
<li> <span class="src-sym">}</span></li> |
610 |
Overridden in child class(es) as: <a href="../phpHtmlLib/XMLTagClass.html#set_collapse">XMLTagClass::set_collapse()</a><br> |
<li> <span class="src-key">return </span><span class="src-var">$html</span><span class="src-sym">;</span></li> |
611 |
<BR> |
<li> <span class="src-sym">}</span></li> |
612 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</ol></pre></p></p> |
613 |
<!-- ========== Info from phpDoc block ========= --> |
<ul class="tags"> |
614 |
This function turns on the collapse flag |
<li><span class="field">return:</span> the raw html output.</li> |
615 |
<BR> |
</ul> |
616 |
|
|
617 |
<DL> |
<div class="method-signature"> |
618 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">string</span> |
619 |
|
<span class="method-name"> |
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> |
render |
621 |
|
</span> |
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 |
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
623 |
DEFAULT: TRUE;</DD> |
</div> |
624 |
|
|
625 |
|
<ul class="parameters"> |
626 |
<DT class="font10bold">Function Info:</DT> |
<li> |
627 |
|
<span class="var-type">int</span> |
628 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li> |
629 |
|
<li> |
630 |
</DL> |
<span class="var-type">int</span> |
631 |
|
<span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li> |
632 |
</DIV> |
</ul> |
633 |
<BR> |
|
634 |
|
|
635 |
<DIV CLASS="function"> |
<hr class="separator" /> |
636 |
<A NAME='set_indent_flag'><!-- --></A> |
<div class="notes">Redefined in descendants as:</div> |
637 |
<SPAN CLASS="font12bold">set_indent_flag</SPAN> |
<ul class="redefinitions"> |
638 |
<BR> |
<li> |
639 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a> |
640 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
: This function is responsible for rendering the tag and its contents |
641 |
<span class="font10bold" style="color: #0000FF">set_indent_flag ( $flag )</SPAN> |
</li> |
642 |
<BR> |
<li> |
643 |
|
<a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a> |
644 |
<BR> |
: Renders the tag, attributes, content and close tag. |
645 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</li> |
646 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
647 |
function to set the indent flag |
<a href="../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a> |
648 |
<BR> |
: This method is called to render the form's html |
649 |
|
</li> |
650 |
<DL> |
<li> |
651 |
<DT class="font10bold">Function Parameters:</DT> |
<a href="../phpHtmlLib/FormProcessing/FormWizard.html#methodrender">FormWizard::render()</a> |
652 |
|
: This function renders the |
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> |
</li> |
654 |
|
<li> |
655 |
|
<a href="../phpHtmlLib/SVG/SVGGraph.html#methodrender">SVGGraph::render()</a> |
656 |
<DT class="font10bold">Function Info:</DT> |
</li> |
657 |
|
<li> |
658 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
<a href="../phpHtmlLib/ActiveTab.html#methodrender">ActiveTab::render()</a> |
659 |
|
</li> |
660 |
</DL> |
<li> |
661 |
|
<a href="../phpHtmlLib/ButtonPanel.html#methodrender">ButtonPanel::render()</a> |
662 |
</DIV> |
: render the entire table. |
663 |
<BR> |
</li> |
664 |
|
<li> |
665 |
|
<a href="../phpHtmlLib/DialogWidget.html#methodrender">DialogWidget::render()</a> |
666 |
<hr> |
: Creates a container with title, |
667 |
</HTML> |
</li> |
668 |
|
<li> |
669 |
|
<a href="../phpHtmlLib/MessageBoxWidget.html#methodrender">MessageBoxWidget::render()</a> |
670 |
|
: We override the render function |
671 |
|
</li> |
672 |
|
<li> |
673 |
|
<a href="../phpHtmlLib/FooterNav.html#methodrender">FooterNav::render()</a> |
674 |
|
: render the code for this widget. |
675 |
|
</li> |
676 |
|
<li> |
677 |
|
<a href="../phpHtmlLib/ImageThumbnailWidget.html#methodrender">ImageThumbnailWidget::render()</a> |
678 |
|
: Render the entire widget. this includes the page offset links, as well as the thumbnails. |
679 |
|
</li> |
680 |
|
<li> |
681 |
|
<a href="../phpHtmlLib/InfoTable.html#methodrender">InfoTable::render()</a> |
682 |
|
: This function renders the object. |
683 |
|
</li> |
684 |
|
<li> |
685 |
|
<a href="../phpHtmlLib/NavTable.html#methodrender">NavTable::render()</a> |
686 |
|
: Render the Navtable and its content. |
687 |
|
</li> |
688 |
|
<li> |
689 |
|
<a href="../phpHtmlLib/RoundTitleTable.html#methodrender">RoundTitleTable::render()</a> |
690 |
|
: Render the Navtable and its content. |
691 |
|
</li> |
692 |
|
<li> |
693 |
|
<a href="../phpHtmlLib/TabList.html#methodrender">TabList::render()</a> |
694 |
|
: The render method |
695 |
|
</li> |
696 |
|
<li> |
697 |
|
<a href="../phpHtmlLib/TextCSSNav.html#methodrender">TextCSSNav::render()</a> |
698 |
|
: function that will render the widget. |
699 |
|
</li> |
700 |
|
<li> |
701 |
|
<a href="../phpHtmlLib/TextNav.html#methodrender">TextNav::render()</a> |
702 |
|
: function that will render the widget. |
703 |
|
</li> |
704 |
|
<li> |
705 |
|
<a href="../phpHtmlLib/TreeNav.html#methodrender">TreeNav::render()</a> |
706 |
|
: function that will render the widget. |
707 |
|
</li> |
708 |
|
<li> |
709 |
|
<a href="../phpHtmlLib/VerticalCSSNavTable.html#methodrender">VerticalCSSNavTable::render()</a> |
710 |
|
: function that will render the widget. |
711 |
|
</li> |
712 |
|
<li> |
713 |
|
<a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a> |
714 |
|
: This function renders the final |
715 |
|
</li> |
716 |
|
<li> |
717 |
|
<a href="../phpHtmlLib/XMLDocumentClass.html#methodrender">XMLDocumentClass::render()</a> |
718 |
|
: function that will render the XML Document. |
719 |
|
</li> |
720 |
|
</ul> |
721 |
|
</div> |
722 |
|
<a name="methodreset_content" id="reset_content"><!-- --></a> |
723 |
|
<div class="evenrow"> |
724 |
|
|
725 |
|
<div class="method-header"> |
726 |
|
<span class="method-title">reset_content</span> (line <span class="line-number">244</span>) |
727 |
|
</div> |
728 |
|
|
729 |
|
<!-- ========== Info from phpDoc block ========= --> |
730 |
|
<p class="short-description">destroy existing content and start with new content.</p> |
731 |
|
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodreset_content">reset_content</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
732 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_content </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
733 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_data_count </span>= <span class="src-num">0</span><span class="src-sym">;</span></li> |
734 |
|
<li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
735 |
|
<li> <a href="http://www.php.net/call_user_func_array">call_user_func_array</a><span class="src-sym">( </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$this</span><span class="src-sym">, </span><span class="src-str">"add"</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$args</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
736 |
|
<li> <span class="src-sym">}</span></li> |
737 |
|
</ol></pre></p></p> |
738 |
|
<ul class="tags"> |
739 |
|
<li><span class="field">access:</span> public</li> |
740 |
|
</ul> |
741 |
|
|
742 |
|
<div class="method-signature"> |
743 |
|
<span class="method-result">void</span> |
744 |
|
<span class="method-name"> |
745 |
|
reset_content |
746 |
|
</span> |
747 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
748 |
|
</div> |
749 |
|
|
750 |
|
<ul class="parameters"> |
751 |
|
<li> |
752 |
|
<span class="var-type">mixed</span> |
753 |
|
<span class="var-name">$content</span><span class="var-description">: can be tag object, or raw (string).</span> </li> |
754 |
|
</ul> |
755 |
|
|
756 |
|
|
757 |
|
<hr class="separator" /> |
758 |
|
<div class="notes">Redefined in descendants as:</div> |
759 |
|
<ul class="redefinitions"> |
760 |
|
<li> |
761 |
|
<a href="../phpHtmlLib/XMLDocumentClass.html#methodreset_content">XMLDocumentClass::reset_content()</a> |
762 |
|
: we override this class to make sure we push all content inside the local _xml_obj tag |
763 |
|
</li> |
764 |
|
</ul> |
765 |
|
</div> |
766 |
|
<a name="methodset_collapse" id="set_collapse"><!-- --></a> |
767 |
|
<div class="oddrow"> |
768 |
|
|
769 |
|
<div class="method-header"> |
770 |
|
<span class="method-title">set_collapse</span> (line <span class="line-number">334</span>) |
771 |
|
</div> |
772 |
|
|
773 |
|
<!-- ========== Info from phpDoc block ========= --> |
774 |
|
<p class="short-description">This function turns on the collapse flag</p> |
775 |
|
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodset_collapse">set_collapse</a><span class="src-sym">(</span><span class="src-var">$collapse</span>=<span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-var">$indent</span>=<span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
776 |
|
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$collapse</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
777 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span>|= <span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">;</span></li> |
778 |
|
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
779 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span>&= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">;</span></li> |
780 |
|
<li> <span class="src-sym">}</span></li> |
781 |
|
<li> </li> |
782 |
|
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$indent</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
783 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../phpHtmlLib/Container.html#methodset_indent_flag">set_indent_flag</a><span class="src-sym">(</span><span class="src-var">$indent</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
784 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span>&= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">;</span></li> |
785 |
|
<li> <span class="src-sym">} </span></li> |
786 |
|
<li> <span class="src-sym">}</span></li> |
787 |
|
</ol></pre></p></p> |
788 |
|
<ul class="tags"> |
789 |
|
<li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#collapse">Collapse</a></li> |
790 |
|
</ul> |
791 |
|
|
792 |
|
<div class="method-signature"> |
793 |
|
<span class="method-result">void</span> |
794 |
|
<span class="method-name"> |
795 |
|
set_collapse |
796 |
|
</span> |
797 |
|
([<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>]) |
798 |
|
</div> |
799 |
|
|
800 |
|
<ul class="parameters"> |
801 |
|
<li> |
802 |
|
<span class="var-type">boolean</span> |
803 |
|
<span class="var-name">$collapse</span><span class="var-description">: - the collapse flag</span> </li> |
804 |
|
<li> |
805 |
|
<span class="var-type">boolean</span> |
806 |
|
<span class="var-name">$indent</span><span class="var-description">: - the indent flag DEFAULT: TRUE;</span> </li> |
807 |
|
</ul> |
808 |
|
|
809 |
|
|
810 |
|
<hr class="separator" /> |
811 |
|
<div class="notes">Redefined in descendants as:</div> |
812 |
|
<ul class="redefinitions"> |
813 |
|
<li> |
814 |
|
<a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a> |
815 |
|
: This function turns on the collapse flag |
816 |
|
</li> |
817 |
|
</ul> |
818 |
|
</div> |
819 |
|
<a name="methodset_indent_flag" id="set_indent_flag"><!-- --></a> |
820 |
|
<div class="evenrow"> |
821 |
|
|
822 |
|
<div class="method-header"> |
823 |
|
<span class="method-title">set_indent_flag</span> (line <span class="line-number">301</span>) |
824 |
|
</div> |
825 |
|
|
826 |
|
<!-- ========== Info from phpDoc block ========= --> |
827 |
|
<p class="short-description">function to set the indent flag</p> |
828 |
|
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodset_indent_flag">set_indent_flag</a><span class="src-sym">( </span><span class="src-var">$flag </span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
829 |
|
<li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$flag</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
830 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span>|= <span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li> |
831 |
|
<li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> |
832 |
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">_flags </span>&= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li> |
833 |
|
<li> <span class="src-sym">}</span></li> |
834 |
|
<li> <span class="src-sym">}</span></li> |
835 |
|
</ol></pre></p></p> |
836 |
|
<ul class="tags"> |
837 |
|
<li><span class="field">access:</span> public</li> |
838 |
|
</ul> |
839 |
|
|
840 |
|
<div class="method-signature"> |
841 |
|
<span class="method-result">void</span> |
842 |
|
<span class="method-name"> |
843 |
|
set_indent_flag |
844 |
|
</span> |
845 |
|
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
846 |
|
</div> |
847 |
|
|
848 |
|
<ul class="parameters"> |
849 |
|
<li> |
850 |
|
<span class="var-type">boolean</span> |
851 |
|
<span class="var-name">$flag</span><span class="var-description">: TRUE or FALSE</span> </li> |
852 |
|
</ul> |
853 |
|
|
854 |
|
|
855 |
|
</div> |
856 |
|
|
857 |
|
</div> |
858 |
|
</div> |
859 |
|
|
860 |
|
|
861 |
|
<p class="notes" id="credit"> |
862 |
|
Documentation generated on Thu, 1 Apr 2004 09:38:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
863 |
|
</p> |
864 |
|
</div></body> |
865 |
|
</html> |