/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ListAction.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ListAction.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Sat Feb 22 20:56:30 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:03 -0800' -->
6 <TITLE>Docs For Class ListAction</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10 <!-- Links -->
11 <a NAME="top"></A>
12 <table WIDTH="100%" class="links">
13 <TR>
14 <TD class="font10">
15 Links:
16 <A HREF="#children_summary" class="links" title="Classes extended from ListAction">Child Classes</A>
17 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20 <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 </TD>
24 </TR>
25 </TABLE>
26 <BR>
27 <!-- Start of Class Data -->
28 <H2>
29 Class ListAction
30 </H2> (line <span class="linenumber">18</span>)
31 <pre>
32 <a href="../phpHtmlLib/Container.html">Container</a>
33 |
34 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
35 |
36 --<a href="../phpHtmlLib/DataList.html">DataList</a>
37 |
38 --ListAction</pre>
39 <p>
40 <b><i>Located in File: Program_Root/widgets/data_list/ListAction.inc</i></b><br>
41 </p>
42 <hr>
43 A class for showing a list of items to preform an action on
44 <br />
45
46 <UL>
47 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
48 </UL>
49 <hr>
50 <!-- =========== VAR SUMMARY =========== -->
51 <A NAME='var_summary'><!-- --></A>
52 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
53 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
54 <TD>
55 <span CLASS="font12bold">Class Variable Summary</span>
56 <A HREF="#top" CLASS="links">^TOP</A>
57 </TD>
58 </TR>
59
60 <!-- =========== Summary =========== -->
61 <TR BGCOLOR='white' CLASS='TableRowColor'>
62 <TD>
63 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_action_name">$_action_name</A></B></CODE>
64 <BR>
65 <blockquote> The string that describes </blockquote>
66 <blockquote> Default Value: <CODE>->&nbsp;'delete'<-</CODE> </blockquote>
67 </TD>
68 </TR>
69 <!-- =========== Summary =========== -->
70 <TR BGCOLOR='white' CLASS='TableRowColor'>
71 <TD>
72 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_align">$_align</A></B></CODE>
73 <BR>
74 <blockquote> The overall alignment </blockquote>
75 <blockquote> Default Value: <CODE>->&nbsp;"center"<-</CODE> </blockquote>
76 </TD>
77 </TR>
78 <!-- =========== Summary =========== -->
79 <TR BGCOLOR='white' CLASS='TableRowColor'>
80 <TD>
81 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_cancel_url">$_cancel_url</A></B></CODE>
82 <BR>
83 <blockquote> This sets the url for the </blockquote>
84 <blockquote> Default Value: <CODE>->&nbsp;"index.php"<-</CODE> </blockquote>
85 </TD>
86 </TR>
87 <!-- =========== Summary =========== -->
88 <TR BGCOLOR='white' CLASS='TableRowColor'>
89 <TD>
90 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_data_post_name">$_data_post_name</A></B></CODE>
91 <BR>
92 <blockquote> The name of the array variable </blockquote>
93 <blockquote> Default Value: <CODE>->&nbsp;"checkbox"<-</CODE> </blockquote>
94 </TD>
95 </TR>
96 <!-- =========== Summary =========== -->
97 <TR BGCOLOR='white' CLASS='TableRowColor'>
98 <TD>
99 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_item_name">$_item_name</A></B></CODE>
100 <BR>
101 <blockquote> name/description of the type of </blockquote>
102 <blockquote> Default Value: <CODE>->&nbsp;''<-</CODE> </blockquote>
103 </TD>
104 </TR>
105 <!-- =========== Summary =========== -->
106 <TR BGCOLOR='white' CLASS='TableRowColor'>
107 <TD>
108 <CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_save_all_vars">$_save_all_vars</A></B></CODE>
109 <BR>
110 <blockquote> A flag to tell us to save all </blockquote>
111 <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>
112 </TD>
113 </TR>
114 </TABLE>
115 <hr>
116 <!-- =========== VAR INHERITED SUMMARY =========== -->
117 <A NAME='var_inherited_summary'><!-- --></A>
118 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
119 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
120 <TD>
121 <span CLASS="font12bold">Inherited Class Variable Summary</span>
122 <A HREF="#top" CLASS="links">^TOP</A>
123 </TD>
124 </TR>
125
126 <!-- =========== Summary =========== -->
127 <TR BGCOLOR='white'>
128 <TD>
129 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
130 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
131 <tr CLASS="tableheadingcolor">
132 <th>Variable</th>
133 <th>Default Value</th>
134 <th>Description</th>
135 </tr>
136 <tr>
137 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></td>
138 <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
139 <td CLASS="font10">Do we want to alternate the row colors? This helps to see each row easier.</td>
140 </tr>
141 <tr>
142 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></td>
143 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
144 <td CLASS="font10">Flag to let us know that</td>
145 </tr>
146 <tr>
147 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></td>
148 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
149 <td CLASS="font10">The column descriptions for the data we are working on</td>
150 </tr>
151 <tr>
152 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></td>
153 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
154 <td CLASS="font10">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</td>
155 </tr>
156 <tr>
157 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></td>
158 <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
159 <td CLASS="font10">Holds the db column name that we want to order by default.</td>
160 </tr>
161 <tr>
162 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></td>
163 <td CLASS="font10" STYLE="white-space: nowrap">-> "false"<-</td>
164 <td CLASS="font10">Holds a flag to let us know to</td>
165 </tr>
166 <tr>
167 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></td>
168 <td CLASS="font10" STYLE="white-space: nowrap">-> 10<-</td>
169 <td CLASS="font10">The number of rows of data to show per "page".</td>
170 </tr>
171 <tr>
172 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></td>
173 <td CLASS="font10" STYLE="white-space: nowrap">->array("method" =&gt; "GET",
174 "target" =&gt; "",
175 "action" =&gt; "",
176 "name" =&gt; "")<-</td>
177 <td CLASS="font10">This holds the form attributes</td>
178 </tr>
179 <tr>
180 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></td>
181 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
182 <td CLASS="font10">Build everything inside a form?</td>
183 </tr>
184 <tr>
185 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></td>
186 <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
187 <td CLASS="font10">prefix for all list variable names, so we can potentially have more then 1 list per page.</td>
188 </tr>
189 <tr>
190 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></td>
191 <td CLASS="font10" STYLE="white-space: nowrap">-> "/phphtmllib/images/widgets"<-</td>
192 <td CLASS="font10">This stores the base path to where the tool link images live. This lets you specify a new path to where your images live.</td>
193 </tr>
194 <tr>
195 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></td>
196 <td CLASS="font10" STYLE="white-space: nowrap">-> 200<-</td>
197 <td CLASS="font10">The max number of rows to show when the user does the "EXPAND" command.</td>
198 </tr>
199 <tr>
200 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></td>
201 <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
202 <td CLASS="font10">Keeps track of the # of columns we have</td>
203 </tr>
204 <tr>
205 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></td>
206 <td CLASS="font10" STYLE="white-space: nowrap">->1<-</td>
207 <td CLASS="font10">This value holds the number of pages of data we have to display.</td>
208 </tr>
209 <tr>
210 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></td>
211 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
212 <td CLASS="font10">This holds a list of name=&gt;value vars that the caller/child wants to propogate automatically.</td>
213 </tr>
214 <tr>
215 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></td>
216 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
217 <td CLASS="font10">Flag to let us know that search is enabled.</td>
218 </tr>
219 <tr>
220 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></td>
221 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
222 <td CLASS="font10">Holds the object block that is the</td>
223 </tr>
224 <tr>
225 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></td>
226 <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
227 <td CLASS="font10">flag to let us know if we want to show the results or not.</td>
228 </tr>
229 <tr>
230 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></td>
231 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
232 <td CLASS="font10">Flag to enable simple search modifyer.</td>
233 </tr>
234 <tr>
235 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></td>
236 <td CLASS="font10" STYLE="white-space: nowrap">->array("offsetVar" =&gt; "offset",
237 "orderbyVar" =&gt; "orderby",
238 "reverseorderVar" =&gt; "reverseorder",
239 "numrowsVar" =&gt; "numrows",
240 "showallVar" =&gt; "showall",
241 "search_fieldVar" =&gt; "search_field",
242 "search_valueVar" =&gt; "search_value",
243 "search_typeVar" =&gt; "search_type",
244 "simple_search_modifierVar" =&gt; "simple_search_modifier")<-</td>
245 <td CLASS="font10">Holds an array of all the form vars we need for this class to work.</td>
246 </tr>
247 </table>
248 <BR>
249 </TD>
250 </TR>
251 <!-- =========== Summary =========== -->
252 <TR BGCOLOR='white'>
253 <TD>
254 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
255 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
256 <tr CLASS="tableheadingcolor">
257 <th>Variable</th>
258 <th>Default Value</th>
259 <th>Description</th>
260 </tr>
261 <tr>
262 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td>
263 <td CLASS="font10" STYLE="white-space: nowrap">->''<-</td>
264 <td CLASS="font10">The title of the table.</td>
265 </tr>
266 <tr>
267 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td>
268 <td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td>
269 <td CLASS="font10">the width of the widget</td>
270 </tr>
271 </table>
272 <BR>
273 </TD>
274 </TR>
275 <!-- =========== Summary =========== -->
276 <TR BGCOLOR='white'>
277 <TD>
278 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
279 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
280 <tr CLASS="tableheadingcolor">
281 <th>Variable</th>
282 <th>Default Value</th>
283 <th>Description</th>
284 </tr>
285 <tr>
286 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
287 <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
288 <td CLASS="font10">The flags that tell us</td>
289 </tr>
290 </table>
291 <BR>
292 </TD>
293 </TR>
294 </TABLE>
295
296 <hr>
297 <!-- =========== METHOD SUMMARY =========== -->
298 <A NAME='method_summary'><!-- --></A>
299 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
300 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
301 <TD>
302 <span class="font12bold">Method Summary</span>
303 <A HREF="#top" CLASS="links">^TOP</A>
304 </TD>
305 </TR>
306
307 <!-- =========== Summary =========== -->
308 <TR BGCOLOR='white' CLASS='TableRowColor'>
309 <TD>
310 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_column_header'>mixed build_column_header ( $col_name, $col_data, $col_num )</A></B></CODE>
311 <BR>
312 <blockquote> This function builds the object/text </blockquote>
313 </TD>
314 </TR>
315 <!-- =========== Summary =========== -->
316 <TR BGCOLOR='white' CLASS='TableRowColor'>
317 <TD>
318 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_in_clause'>string build_in_clause ( $field )</A></B></CODE>
319 <BR>
320 <blockquote> This method is used to build the portion </blockquote>
321 </TD>
322 </TR>
323 <!-- =========== Summary =========== -->
324 <TR BGCOLOR='white' CLASS='TableRowColor'>
325 <TD>
326 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_options'>void build_options ( )</A></B></CODE>
327 <BR>
328 <blockquote> Build any additional custom options such as checkboxes, radiobuttons for special options for the action. </blockquote>
329 </TD>
330 </TR>
331 <!-- =========== Summary =========== -->
332 <TR BGCOLOR='white' CLASS='TableRowColor'>
333 <TD>
334 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag, $row_data )</A></B></CODE>
335 <BR>
336 <blockquote> </blockquote>
337 </TD>
338 </TR>
339 <!-- =========== Summary =========== -->
340 <TR BGCOLOR='white' CLASS='TableRowColor'>
341 <TD>
342 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_build_column_header'>void child_build_column_header ( $name, $col, $cnt )</A></B></CODE>
343 <BR>
344 <blockquote> </blockquote>
345 </TD>
346 </TR>
347 <!-- =========== Summary =========== -->
348 <TR BGCOLOR='white' CLASS='TableRowColor'>
349 <TD>
350 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_get_gui'>void child_get_gui ( )</A></B></CODE>
351 <BR>
352 <blockquote> </blockquote>
353 </TD>
354 </TR>
355 <!-- =========== Summary =========== -->
356 <TR BGCOLOR='white' CLASS='TableRowColor'>
357 <TD>
358 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodget_cancel_url'>string get_cancel_url ( )</A></B></CODE>
359 <BR>
360 <blockquote> this returns the current cancel url </blockquote>
361 </TD>
362 </TR>
363 <!-- =========== Summary =========== -->
364 <TR BGCOLOR='white' CLASS='TableRowColor'>
365 <TD>
366 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodgui_init'>void gui_init ( )</A></B></CODE>
367 <BR>
368 <blockquote> Initialize the gui layout </blockquote>
369 </TD>
370 </TR>
371 <!-- =========== Summary =========== -->
372 <TR BGCOLOR='white' CLASS='TableRowColor'>
373 <TD>
374 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_action_name'>void set_action_name ( $item )</A></B></CODE>
375 <BR>
376 <blockquote> Set the name of the action </blockquote>
377 </TD>
378 </TR>
379 <!-- =========== Summary =========== -->
380 <TR BGCOLOR='white' CLASS='TableRowColor'>
381 <TD>
382 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_align'>void set_align ( $align )</A></B></CODE>
383 <BR>
384 <blockquote> this function is used to set the overall alignment of the widget </blockquote>
385 </TD>
386 </TR>
387 <!-- =========== Summary =========== -->
388 <TR BGCOLOR='white' CLASS='TableRowColor'>
389 <TD>
390 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_cancel_url'>void set_cancel_url ( $url )</A></B></CODE>
391 <BR>
392 <blockquote> This sets the url to post to when a cancel/no action is clicked </blockquote>
393 </TD>
394 </TR>
395 <!-- =========== Summary =========== -->
396 <TR BGCOLOR='white' CLASS='TableRowColor'>
397 <TD>
398 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_item_name'>void set_item_name ( $item )</A></B></CODE>
399 <BR>
400 <blockquote> Set the name of the deleted items </blockquote>
401 </TD>
402 </TR>
403 <!-- =========== Summary =========== -->
404 <TR BGCOLOR='white' CLASS='TableRowColor'>
405 <TD>
406 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_save_vars_Flag'>void set_save_vars_Flag ( [$flag = TRUE] )</A></B></CODE>
407 <BR>
408 <blockquote> This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us. </blockquote>
409 </TD>
410 </TR>
411 <!-- =========== Summary =========== -->
412 <TR BGCOLOR='white' CLASS='TableRowColor'>
413 <TD>
414 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodwrap_column_item'><a href="../phpHtmlLib/TDtag.html">TDtag</a> wrap_column_item ( $obj, $col_name )</A></B></CODE>
415 <BR>
416 <blockquote> This function ensures that the data we place in a column is aligned according to what the user wants. </blockquote>
417 </TD>
418 </TR>
419 <!-- =========== Summary =========== -->
420 <TR BGCOLOR='white' CLASS='TableRowColor'>
421 <TD>
422 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#method_build_delete_confirm'>void _build_delete_confirm ( )</A></B></CODE>
423 <BR>
424 <blockquote> This function builds the actual form </blockquote>
425 </TD>
426 </TR>
427 <!-- =========== Summary =========== -->
428 <TR BGCOLOR='white' CLASS='TableRowColor'>
429 <TD>
430 <CODE><B><A HREF='../phpHtmlLib/ListAction.html#method_build_hidden_vars'>Container _build_hidden_vars ( )</A></B></CODE>
431 <BR>
432 <blockquote> This builds the hidden form fields of the data that was originally sent to us </blockquote>
433 </TD>
434 </TR>
435 </TABLE>
436 <!-- =========== INHERITED METHOD SUMMARY =========== -->
437 <A NAME='functions_inherited'><!-- --></A>
438 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
439 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
440 <TD>
441 <span CLASS="font12bold">Inherited Method Summary</span>
442 <A HREF="#top" CLASS="links">^TOP</A>
443 </TD>
444 </TR>
445
446 <!-- =========== Summary =========== -->
447 <TR BGCOLOR='white' CLASS='TableRowColor'>
448 <TD>
449 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
450 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
451 <tr CLASS="tableheadingcolor">
452 <th>Function</th>
453 <th>Description</th>
454 </tr>
455 <tr>
456 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></td>
457 <td CLASS="font10">The constructor</td>
458 <tr>
459 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></td>
460 <td CLASS="font10">This function adds a header item to the column headers from a list of parameters.</td>
461 <tr>
462 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></td>
463 <td CLASS="font10">Disable the advanced search</td>
464 <tr>
465 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></td>
466 <td CLASS="font10">Enable the advanced search</td>
467 <tr>
468 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></td>
469 <td CLASS="font10">This builds the base url used by the column headers as well as the page tool links.</td>
470 <tr>
471 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></td>
472 <td CLASS="font10">This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DB.</td>
473 <tr>
474 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></td>
475 <td CLASS="font10">This builds a url for a particular column header.</td>
476 <tr>
477 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></td>
478 <td CLASS="font10">This function is responsible for calling the child class's methods for building the GUI container.</td>
479 <tr>
480 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></td>
481 <td CLASS="font10">This builds a query string var for the orderby value.</td>
482 <tr>
483 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></td>
484 <td CLASS="font10">This builds a query string var for the reverseorder value.</td>
485 <tr>
486 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></td>
487 <td CLASS="font10">This builds a query string var for the searchfield value.</td>
488 <tr>
489 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></td>
490 <td CLASS="font10">This builds a query string var for the searchfield value.</td>
491 <tr>
492 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></td>
493 <td CLASS="font10">this function is used to build a sub query string</td>
494 <tr>
495 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></td>
496 <td CLASS="font10">This function builds the 'tool' images that allow you to walk through the data list itself.</td>
497 <tr>
498 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></td>
499 <td CLASS="font10">This method is supposed to be written by the child class to add the cell data to the current row in the UI</td>
500 <tr>
501 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></td>
502 <td CLASS="font10">This method is supposed to be written by the child class to build and add the column title to the UI</td>
503 <tr>
504 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></td>
505 <td CLASS="font10">This function builds the search block that lives above the results</td>
506 <tr>
507 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></td>
508 <td CLASS="font10">This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList</td>
509 <tr>
510 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></td>
511 <td CLASS="font10">This function is used to set up any</td>
512 <tr>
513 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></td>
514 <td CLASS="font10">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</td>
515 <tr>
516 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></td>
517 <td CLASS="font10">This function returns the current page that the item list is on.</td>
518 <tr>
519 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></td>
520 <td CLASS="font10">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</td>
521 <tr>
522 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></td>
523 <td CLASS="font10">This function gets the current default number of rows to display setting.</td>
524 <tr>
525 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></td>
526 <td CLASS="font10">This function is used to get the form action</td>
527 <tr>
528 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></td>
529 <td CLASS="font10">This function is used to get the form method</td>
530 <tr>
531 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></td>
532 <td CLASS="font10">This function is used to get the form name</td>
533 <tr>
534 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></td>
535 <td CLASS="font10">Return the state of the form render</td>
536 <tr>
537 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></td>
538 <td CLASS="font10">This function is used to get the form target</td>
539 <tr>
540 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></td>
541 <td CLASS="font10">returns the current variable prefix string being used.</td>
542 <tr>
543 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></td>
544 <td CLASS="font10">This function returns the path to the images used in this class</td>
545 <tr>
546 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></td>
547 <td CLASS="font10">This calculates the last page # for this list of items</td>
548 <tr>
549 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></td>
550 <td CLASS="font10">This returns the Maximum # of rows to display when in expand mode</td>
551 <tr>
552 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></td>
553 <td CLASS="font10">This function returns the # of pages that are available for this list of items.</td>
554 <tr>
555 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></td>
556 <td CLASS="font10">This function builds the string that describes the current page out of n pages the list is showing</td>
557 <tr>
558 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></td>
559 <td CLASS="font10">gets the value of the search modifier flag.</td>
560 <tr>
561 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></td>
562 <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
563 <tr>
564 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></td>
565 <td CLASS="font10">This returns the status of the advanced search flag.</td>
566 <tr>
567 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></td>
568 <td CLASS="font10">get the status of the search ability.</td>
569 <tr>
570 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></td>
571 <td CLASS="font10">This function returns the number of rows that the query found.</td>
572 <tr>
573 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></td>
574 <td CLASS="font10">This function returns the current value of the offset variable. This is an offset into the query return data set.</td>
575 <tr>
576 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></td>
577 <td CLASS="font10">This function returns the value of the current orderby variable.</td>
578 <tr>
579 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></td>
580 <td CLASS="font10">This function renders the final</td>
581 <tr>
582 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></td>
583 <td CLASS="font10">This function returns the current value of the reverse order member variable.</td>
584 <tr>
585 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></td>
586 <td CLASS="font10">Disable the search ability.</td>
587 <tr>
588 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></td>
589 <td CLASS="font10">Enable the search ability.</td>
590 <tr>
591 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></td>
592 <td CLASS="font10">returns the current value of the search field name</td>
593 <tr>
594 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></td>
595 <td CLASS="font10">returns the type of search being used</td>
596 <tr>
597 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></td>
598 <td CLASS="font10">returns the current value of te search field value.</td>
599 <tr>
600 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></td>
601 <td CLASS="font10">This function is used to make safe any query string value that is used</td>
602 <tr>
603 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></td>
604 <td CLASS="font10"></td>
605 <tr>
606 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></td>
607 <td CLASS="font10">This function is used to set the DataListSource object for this instance</td>
608 <tr>
609 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></td>
610 <td CLASS="font10">This function sets the default # of rows per page to display. By default its 10.</td>
611 <tr>
612 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></td>
613 <td CLASS="font10">Sets the form action</td>
614 <tr>
615 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></td>
616 <td CLASS="font10">This function is used to set the form method</td>
617 <tr>
618 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></td>
619 <td CLASS="font10">This function is used to set the form name</td>
620 <tr>
621 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></td>
622 <td CLASS="font10">Sets whether to the output into a form</td>
623 <tr>
624 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></td>
625 <td CLASS="font10">This function is used to set the form target</td>
626 <tr>
627 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></td>
628 <td CLASS="font10">This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.</td>
629 <tr>
630 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></td>
631 <td CLASS="font10">This function returns the path to the images used in this class</td>
632 <tr>
633 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></td>
634 <td CLASS="font10">This sets the maximum # of rows to display when in expand mode</td>
635 <tr>
636 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></td>
637 <td CLASS="font10">This function is used to set the message displayed when no data is found</td>
638 <tr>
639 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></td>
640 <td CLASS="font10">This function sets the # of rows to display per page.</td>
641 <tr>
642 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></td>
643 <td CLASS="font10">This function is used to set/change the offset for this list.</td>
644 <tr>
645 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></td>
646 <td CLASS="font10">This function sets the reverse order flag to a new value.</td>
647 <tr>
648 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></td>
649 <td CLASS="font10">This function sets the save variables that the user/child wants to automatically propogate</td>
650 <tr>
651 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></td>
652 <td CLASS="font10">This function sets the search type</td>
653 <tr>
654 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></td>
655 <td CLASS="font10">This function is used to set the value of the _show_results_flag</td>
656 <tr>
657 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></td>
658 <td CLASS="font10">Set the simple search modifyer flag.</td>
659 <tr>
660 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></td>
661 <td CLASS="font10">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</td>
662 <tr>
663 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></td>
664 <td CLASS="font10">returns the current value of the simple search modifier</td>
665 <tr>
666 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></td>
667 <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
668 <tr>
669 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></td>
670 <td CLASS="font10">This function builds the list of</td>
671 <tr>
672 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></td>
673 <td CLASS="font10">this method builds some hidden form fields to automatically be placed inside the form.</td>
674 <tr>
675 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></td>
676 <td CLASS="font10">This builds the simple search modifier select box.</td>
677 <tr>
678 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></td>
679 <td CLASS="font10">This function is used to build the url for a tool link.</td>
680 <tr>
681 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></td>
682 <td CLASS="font10">general DataListSource object checker.</td>
683 <tr>
684 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></td>
685 <td CLASS="font10">This function is used to make sure that the string we are placing in a cell has been "cleaned"</td>
686 <tr>
687 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></td>
688 <td CLASS="font10">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</td>
689 <tr>
690 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></td>
691 <td CLASS="font10">Function used to get the current value of one of the control vars for this class</td>
692 <tr>
693 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></td>
694 <td CLASS="font10">This method gets the array of searchable header fields (columns)</td>
695 <tr>
696 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></td>
697 <td CLASS="font10">This function provides a way to automatically add javascript to this object.</td>
698 <tr>
699 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></td>
700 <td CLASS="font10">This function stores the url for each of the tool urls, so we can push these out for mozilla.</td>
701 <tr>
702 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></td>
703 <td CLASS="font10">This function is used to set the value of the control var</td>
704 <tr>
705 <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></td>
706 <td CLASS="font10">This function is used to let render() know that we should show the results or not.</td>
707 </table>
708 <br>
709 </TD>
710 </TR>
711 <!-- =========== Summary =========== -->
712 <TR BGCOLOR='white' CLASS='TableRowColor'>
713 <TD>
714 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
715 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
716 <tr CLASS="tableheadingcolor">
717 <th>Function</th>
718 <th>Description</th>
719 </tr>
720 <tr>
721 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td>
722 <td CLASS="font10">This gets the alignment value for the outer table</td>
723 <tr>
724 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td>
725 <td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td>
726 <tr>
727 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td>
728 <td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td>
729 <tr>
730 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td>
731 <td CLASS="font10">Function for accessing the title of this widget</td>
732 <tr>
733 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td>
734 <td CLASS="font10">Function for getting the current widget width setting.</td>
735 <tr>
736 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td>
737 <td CLASS="font10">This function sets the align attribute for the outer table.</td>
738 <tr>
739 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td>
740 <td CLASS="font10">Set the title for the widget.</td>
741 <tr>
742 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td>
743 <td CLASS="font10">Set the width for the widget.</td>
744 </table>
745 <br>
746 </TD>
747 </TR>
748 <!-- =========== Summary =========== -->
749 <TR BGCOLOR='white' CLASS='TableRowColor'>
750 <TD>
751 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
752 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
753 <tr CLASS="tableheadingcolor">
754 <th>Function</th>
755 <th>Description</th>
756 </tr>
757 <tr>
758 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
759 <td CLASS="font10">The constructor.</td>
760 <tr>
761 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
762 <td CLASS="font10">add content onto content stack</td>
763 <tr>
764 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
765 <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
766 <tr>
767 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
768 <td CLASS="font10">counts the number of content objects</td>
769 <tr>
770 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
771 <td CLASS="font10">This flag gets the current value of the indent flag</td>
772 <tr>
773 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
774 <td CLASS="font10">Same as add().</td>
775 <tr>
776 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
777 <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
778 <tr>
779 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
780 <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
781 <tr>
782 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
783 <td CLASS="font10">destroy existing content and start with new content.</td>
784 <tr>
785 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
786 <td CLASS="font10">This function turns on the collapse flag</td>
787 <tr>
788 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
789 <td CLASS="font10">function to set the indent flag</td>
790 <tr>
791 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
792 <td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td>
793 </table>
794 <br>
795 </TD>
796 </TR>
797 </TABLE>
798 <hr>
799 <!-- ============ VARIABLE DETAIL =========== -->
800
801 <A NAME='variable_detail'></A>
802 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
803 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
804 <TD>
805 <span CLASS="font12bold">Variable Detail</span>
806 <A HREF="#top" CLASS="links">^TOP</A>
807 </TD>
808 </TR>
809 </TABLE>
810
811 <A NAME='var$_action_name'><!-- --></A><H3>$_action_name</H3> (line <span class="linenumber">25</span>)<br />
812 <b>Data type:</b> mixed<br>The string that describes
813 <br />
814 <p>the action ie. 'delete'</p>
815 <UL>
816 </UL>
817 <HR>
818 <A NAME='var$_align'><!-- --></A><H3>$_align</H3> (line <span class="linenumber">40</span>)<br />
819 <b>Data type:</b> mixed<br>The overall alignment
820 <br />
821 <p>DEFAULT: "center"</p>
822 <UL>
823 </UL>
824 <HR>
825 <A NAME='var$_cancel_url'><!-- --></A><H3>$_cancel_url</H3> (line <span class="linenumber">53</span>)<br />
826 <b>Data type:</b> mixed<br>This sets the url for the
827 <br />
828 <p>cancel action to post to</p>
829 <UL>
830 </UL>
831 <HR>
832 <A NAME='var$_data_post_name'><!-- --></A><H3>$_data_post_name</H3> (line <span class="linenumber">61</span>)<br />
833 <b>Data type:</b> mixed<br>The name of the array variable
834 <br />
835 <p>that the data was posted to us</p>
836 <UL>
837 </UL>
838 <HR>
839 <A NAME='var$_item_name'><!-- --></A><H3>$_item_name</H3> (line <span class="linenumber">33</span>)<br />
840 <b>Data type:</b> mixed<br>name/description of the type of
841 <br />
842 <p>data we are working on ie 'users', 'files'</p>
843 <UL>
844 </UL>
845 <HR>
846 <A NAME='var$_save_all_vars'><!-- --></A><H3>$_save_all_vars</H3> (line <span class="linenumber">47</span>)<br />
847 <b>Data type:</b> mixed<br>A flag to tell us to save all
848 <br />
849 <p>vars passed</p>
850 <UL>
851 </UL>
852 <HR>
853 <hr>
854 <!-- ============ METHOD DETAIL =========== -->
855
856 <A NAME='method_detail'></A>
857 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
858 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
859 <TD>
860 <span class="font12bold">Method Detail</span>
861 <A HREF="#top" CLASS="links">^TOP</A>
862 </TD>
863 </TR>
864 </TABLE>
865 <BR>
866 <DIV CLASS="function">
867 <A NAME='methodbuild_column_header'><!-- --></A>
868 <SPAN CLASS="font12bold">build_column_header</SPAN> (line <span class="linenumber">159</span>)
869 <BR>
870 <SPAN CLASS="font10bold">Usage : </SPAN>
871 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
872 <span class="font10bold" style="color: #0000FF">build_column_header(
873 string
874 $col_name, array
875 $col_data, int
876 $col_num)</SPAN>
877 <BR>
878
879 <BR>
880 <SPAN CLASS="font10bold">Description : </SPAN>
881 This function builds the object/text
882 <br />
883 <p>to be used for a column header. It can either be an href because its sortable, or it can just be text, because its not sortable.</p>
884 <DL>
885 <DT class="font10bold">Function Parameters:</DT>
886 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$col_name</SPAN></SPAN> - the column name to build from the headers.</DD>
887 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$col_data</SPAN></SPAN> - the column's data.</DD>
888 <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">$col_num</SPAN></SPAN> the column # we are working on.</DD>
889
890 <DT class="font10bold">Function Info:</DT>
891 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either an Atag object or raw text.</DD>
892 </DL>
893 </DIV>
894 <BR>
895 <DIV CLASS="function">
896 <A NAME='methodbuild_in_clause'><!-- --></A>
897 <SPAN CLASS="font12bold">build_in_clause</SPAN> (line <span class="linenumber">281</span>)
898 <BR>
899 <SPAN CLASS="font10bold">Usage : </SPAN>
900 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
901 <span class="font10bold" style="color: #0000FF">build_in_clause(
902 string
903 $field)</SPAN>
904 <BR>
905
906 <BR>
907 <SPAN CLASS="font10bold">Description : </SPAN>
908 This method is used to build the portion
909 <br />
910 <p>of the DB query that limits the list of items to show based on what was submitted from the original DataList action</p>
911 <DL>
912 <DT class="font10bold">Function Parameters:</DT>
913 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$field</SPAN></SPAN> - the field</DD>
914
915 <DT class="font10bold">Function Info:</DT>
916 </DL>
917 </DIV>
918 <BR>
919 <DIV CLASS="function">
920 <A NAME='methodbuild_options'><!-- --></A>
921 <SPAN CLASS="font12bold">build_options</SPAN> (line <span class="linenumber">267</span>)
922 <BR>
923 <SPAN CLASS="font10bold">Usage : </SPAN>
924 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
925 <span class="font10bold" style="color: #0000FF">build_options(
926 )</SPAN>
927 <BR>
928
929 <BR>
930 <SPAN CLASS="font10bold">Description : </SPAN>
931 Build any additional custom options such as checkboxes, radiobuttons for special options for the action.
932 <br />
933
934 <DL>
935
936 <DT class="font10bold">Function Info:</DT>
937 </DL>
938 </DIV>
939 <BR>
940 <DIV CLASS="function">
941 <A NAME='methodchild_add_row_cell'><!-- --></A>
942 <SPAN CLASS="font12bold">child_add_row_cell</SPAN> (line <span class="linenumber">112</span>)
943 <BR>
944 <SPAN CLASS="font10bold">Usage : </SPAN>
945 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
946 <span class="font10bold" style="color: #0000FF">child_add_row_cell(
947 mixed
948 $obj, mixed
949 $col_name, mixed
950 $last_in_row_flag, mixed
951 $row_data)</SPAN>
952 <BR>
953
954 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a> This method is supposed to be written by the child class to add the cell data to the current row in the UI
955 <BR>
956 <SPAN CLASS="font10bold">Description : </SPAN>
957
958 <br />
959
960 <DL>
961
962 <DT class="font10bold">Function Info:</DT>
963 </DL>
964 </DIV>
965 <BR>
966 <DIV CLASS="function">
967 <A NAME='methodchild_build_column_header'><!-- --></A>
968 <SPAN CLASS="font12bold">child_build_column_header</SPAN> (line <span class="linenumber">106</span>)
969 <BR>
970 <SPAN CLASS="font10bold">Usage : </SPAN>
971 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
972 <span class="font10bold" style="color: #0000FF">child_build_column_header(
973 mixed
974 $name, mixed
975 $col, mixed
976 $cnt)</SPAN>
977 <BR>
978
979 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a> This method is supposed to be written by the child class to build and add the column title to the UI
980 <BR>
981 <SPAN CLASS="font10bold">Description : </SPAN>
982
983 <br />
984
985 <DL>
986
987 <DT class="font10bold">Function Info:</DT>
988 </DL>
989 </DIV>
990 <BR>
991 <DIV CLASS="function">
992 <A NAME='methodchild_get_gui'><!-- --></A>
993 <SPAN CLASS="font12bold">child_get_gui</SPAN> (line <span class="linenumber">98</span>)
994 <BR>
995 <SPAN CLASS="font10bold">Usage : </SPAN>
996 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
997 <span class="font10bold" style="color: #0000FF">child_get_gui(
998 )</SPAN>
999 <BR>
1000
1001 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a> This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList
1002 <BR>
1003 <SPAN CLASS="font10bold">Description : </SPAN>
1004
1005 <br />
1006
1007 <DL>
1008
1009 <DT class="font10bold">Function Info:</DT>
1010 </DL>
1011 </DIV>
1012 <BR>
1013 <DIV CLASS="function">
1014 <A NAME='methodget_cancel_url'><!-- --></A>
1015 <SPAN CLASS="font12bold">get_cancel_url</SPAN> (line <span class="linenumber">427</span>)
1016 <BR>
1017 <SPAN CLASS="font10bold">Usage : </SPAN>
1018 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
1019 <span class="font10bold" style="color: #0000FF">get_cancel_url(
1020 )</SPAN>
1021 <BR>
1022
1023 <BR>
1024 <SPAN CLASS="font10bold">Description : </SPAN>
1025 this returns the current cancel url
1026 <br />
1027
1028 <DL>
1029
1030 <DT class="font10bold">Function Info:</DT>
1031 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the url</DD>
1032 </DL>
1033 </DIV>
1034 <BR>
1035 <DIV CLASS="function">
1036 <A NAME='methodgui_init'><!-- --></A>
1037 <SPAN CLASS="font12bold">gui_init</SPAN> (line <span class="linenumber">72</span>)
1038 <BR>
1039 <SPAN CLASS="font10bold">Usage : </SPAN>
1040 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1041 <span class="font10bold" style="color: #0000FF">gui_init(
1042 )</SPAN>
1043 <BR>
1044
1045 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a> A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.
1046 <BR>
1047 <SPAN CLASS="font10bold">Description : </SPAN>
1048 Initialize the gui layout
1049 <br />
1050
1051 <DL>
1052
1053 <DT class="font10bold">Function Info:</DT>
1054 </DL>
1055 </DIV>
1056 <BR>
1057 <DIV CLASS="function">
1058 <A NAME='methodset_action_name'><!-- --></A>
1059 <SPAN CLASS="font12bold">set_action_name</SPAN> (line <span class="linenumber">397</span>)
1060 <BR>
1061 <SPAN CLASS="font10bold">Usage : </SPAN>
1062 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1063 <span class="font10bold" style="color: #0000FF">set_action_name(
1064 mixed
1065 $item)</SPAN>
1066 <BR>
1067
1068 <BR>
1069 <SPAN CLASS="font10bold">Description : </SPAN>
1070 Set the name of the action
1071 <br />
1072 <p>used for display purposes only</p>
1073 <DL>
1074
1075 <DT class="font10bold">Function Info:</DT>
1076 </DL>
1077 </DIV>
1078 <BR>
1079 <DIV CLASS="function">
1080 <A NAME='methodset_align'><!-- --></A>
1081 <SPAN CLASS="font12bold">set_align</SPAN> (line <span class="linenumber">380</span>)
1082 <BR>
1083 <SPAN CLASS="font10bold">Usage : </SPAN>
1084 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1085 <span class="font10bold" style="color: #0000FF">set_align(
1086 string
1087 $align)</SPAN>
1088 <BR>
1089
1090 <BR>
1091 <SPAN CLASS="font10bold">Description : </SPAN>
1092 this function is used to set the overall alignment of the widget
1093 <br />
1094
1095 <DL>
1096 <DT class="font10bold">Function Parameters:</DT>
1097 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - the align value</DD>
1098
1099 <DT class="font10bold">Function Info:</DT>
1100 </DL>
1101 </DIV>
1102 <BR>
1103 <DIV CLASS="function">
1104 <A NAME='methodset_cancel_url'><!-- --></A>
1105 <SPAN CLASS="font12bold">set_cancel_url</SPAN> (line <span class="linenumber">418</span>)
1106 <BR>
1107 <SPAN CLASS="font10bold">Usage : </SPAN>
1108 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1109 <span class="font10bold" style="color: #0000FF">set_cancel_url(
1110 string
1111 $url)</SPAN>
1112 <BR>
1113
1114 <BR>
1115 <SPAN CLASS="font10bold">Description : </SPAN>
1116 This sets the url to post to when a cancel/no action is clicked
1117 <br />
1118
1119 <DL>
1120 <DT class="font10bold">Function Parameters:</DT>
1121 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> - the url</DD>
1122
1123 <DT class="font10bold">Function Info:</DT>
1124 </DL>
1125 </DIV>
1126 <BR>
1127 <DIV CLASS="function">
1128 <A NAME='methodset_item_name'><!-- --></A>
1129 <SPAN CLASS="font12bold">set_item_name</SPAN> (line <span class="linenumber">389</span>)
1130 <BR>
1131 <SPAN CLASS="font10bold">Usage : </SPAN>
1132 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1133 <span class="font10bold" style="color: #0000FF">set_item_name(
1134 mixed
1135 $item)</SPAN>
1136 <BR>
1137
1138 <BR>
1139 <SPAN CLASS="font10bold">Description : </SPAN>
1140 Set the name of the deleted items
1141 <br />
1142 <p>used for display purposes only</p>
1143 <DL>
1144
1145 <DT class="font10bold">Function Info:</DT>
1146 </DL>
1147 </DIV>
1148 <BR>
1149 <DIV CLASS="function">
1150 <A NAME='methodset_save_vars_Flag'><!-- --></A>
1151 <SPAN CLASS="font12bold">set_save_vars_Flag</SPAN> (line <span class="linenumber">408</span>)
1152 <BR>
1153 <SPAN CLASS="font10bold">Usage : </SPAN>
1154 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1155 <span class="font10bold" style="color: #0000FF">set_save_vars_Flag(
1156 [mixed
1157 $flag = TRUE])</SPAN>
1158 <BR>
1159
1160 <BR>
1161 <SPAN CLASS="font10bold">Description : </SPAN>
1162 This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us.
1163 <br />
1164
1165 <DL>
1166
1167 <DT class="font10bold">Function Info:</DT>
1168 </DL>
1169 </DIV>
1170 <BR>
1171 <DIV CLASS="function">
1172 <A NAME='methodwrap_column_item'><!-- --></A>
1173 <SPAN CLASS="font12bold">wrap_column_item</SPAN> (line <span class="linenumber">222</span>)
1174 <BR>
1175 <SPAN CLASS="font10bold">Usage : </SPAN>
1176 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
1177 <span class="font10bold" style="color: #0000FF">wrap_column_item(
1178 mixed
1179 $obj, string
1180 $col_name, int
1181 2, int
1182 3)</SPAN>
1183 <BR>
1184
1185 <BR>
1186 <SPAN CLASS="font10bold">Description : </SPAN>
1187 This function ensures that the data we place in a column is aligned according to what the user wants.
1188 <br />
1189
1190 <DL>
1191 <DT class="font10bold">Function Parameters:</DT>
1192 <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">2</SPAN></SPAN> - $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)</DD>
1193 <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">3</SPAN></SPAN> - the column # we are working on.</DD>
1194 <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">$obj</SPAN></SPAN> - $obj - the data for the td.</DD>
1195 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$col_name</SPAN></SPAN> - $col_name - the name of the column header for this row to render.</DD>
1196
1197 <DT class="font10bold">Function Info:</DT>
1198 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1199 </DL>
1200 </DIV>
1201 <BR>
1202 <DIV CLASS="function">
1203 <A NAME='method_build_delete_confirm'><!-- --></A>
1204 <SPAN CLASS="font12bold">_build_delete_confirm</SPAN> (line <span class="linenumber">301</span>)
1205 <BR>
1206 <SPAN CLASS="font10bold">Usage : </SPAN>
1207 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1208 <span class="font10bold" style="color: #0000FF">_build_delete_confirm(
1209 )</SPAN>
1210 <BR>
1211
1212 <BR>
1213 <SPAN CLASS="font10bold">Description : </SPAN>
1214 This function builds the actual form
1215 <br />
1216
1217 <DL>
1218
1219 <DT class="font10bold">Function Info:</DT>
1220 </DL>
1221 </DIV>
1222 <BR>
1223 <DIV CLASS="function">
1224 <A NAME='method_build_hidden_vars'><!-- --></A>
1225 <SPAN CLASS="font12bold">_build_hidden_vars</SPAN> (line <span class="linenumber">131</span>)
1226 <BR>
1227 <SPAN CLASS="font10bold">Usage : </SPAN>
1228 <span class="font10bold" style="color: #FF0000">Container</SPAN>&nbsp;
1229 <span class="font10bold" style="color: #0000FF">_build_hidden_vars(
1230 )</SPAN>
1231 <BR>
1232
1233 <BR>
1234 <SPAN CLASS="font10bold">Description : </SPAN>
1235 This builds the hidden form fields of the data that was originally sent to us
1236 <br />
1237
1238 <DL>
1239
1240 <DT class="font10bold">Function Info:</DT>
1241 </DL>
1242 </DIV>
1243 <BR>
1244 <div id="credit">
1245 <hr>
1246 Documention generated on Thu, 20 Feb 2003 16:23:03 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
1247 </div>
1248 </body>
1249 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed