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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:29 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' -->
6 <TITLE>Docs For Class DataList</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from DataList">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class DataList
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39 |
40 --DataList</pre>
41 </pre>
42
43 <A NAME="children_summary"</A>
44 <H3>
45 Classes extended from DataList: <A HREF="#top" CLASS="links">^TOP</A>
46 </H3>
47 <a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a>
48 <p>
49 <b><i>Located in File: Program_Root/widgets/data_list/DataList.inc</i></b><br>
50 </p>
51 <hr>
52 <!-- ========== Info from phpDoc block ========= -->
53 This object is the base class that can be
54 <BR>
55 used to build a widget that shows lists of
56 data from any source via the DataListSource
57 object. It fetches/builds/gets its data
58 from the DataListSource object, which can
59 be written to support any data source
60 (MySQL, Oracle, comma delimited file, xml, etc.)
61
62 This base class MUST be extended by a child to
63 actually render the list. The job of the DataList
64 class is to provide the basic API and abstraction
65 mechanism to handling searching, showing, sorting
66 lists of data.
67
68 Each column of data is associated with a title and a
69 name. The title is what is shown to the user for that
70 column. The name is the mapping between the column and
71 the DataListSource. Each column can be marked
72 as sortable and searchable. If a column is sortable,
73 the title is a link that can be clicked on to sort.
74 The sorting is done in the DataListSource object (
75 via the sql query, or sort() functions depending on the
76 data source itself)
77
78 The DataList object will build the title, the search block
79 (if any), the datalist controls (the links/imges for
80 first, prev, next, last, all). Then the data columns/labels.
81 Then it will fetch each of the rows of data to display
82 from the DataListSource.
83
84 The logic of the output calls follows in the order:
85
86 title
87 search table/block
88 datalist controls (first, prev, next, last, all)
89 data columns/labels
90 data rows x through y
91
92
93 REQUIREMENTS:
94 You must use/define a DataListSource object.
95 You MUST override/extend the following methods:
96
97 * get_data_source() - used to set the DataListSource
98 by this class.
99 * user_setup() - used to set the columns to show and any
100 options used by the DataList class and
101 DataListSource object.
102
103
104 UI ABSTRACTION METHODS
105 These methods allow for some level of abstraction for
106 the layout/look/feel of the actual list of data.
107
108
109 * gui_init() - the function gives the child class a chance
110 to do any building of the objects that will
111 hold the search area, column headers and the
112 rows of data.
113
114 * child_build_column_header() - This method is responsible
115 for building and inserting
116 the column header title into
117 the UI object.
118
119 * child_add_row_cell() - This function is responsible for adding
120 the cell in the current row. The method
121 is responsible for keeping track of the
122 location in its UI object for the current
123 row.
124
125 * child_get_gui() - This method returns the entire UI in 1 object
126 or container. At this point the entire UI
127 has been constructed, the entire list of data
128 has been walked and inserted.
129
130 <UL>
131
132 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
133
134 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
135
136 </UL>
137
138 <hr>
139 <!-- =========== VAR SUMMARY =========== -->
140 <A NAME='var_summary'><!-- --></A>
141 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
142 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
143 <TD>
144 <span CLASS="font12bold">Class Variable Summary</span>
145 <A HREF="#top" CLASS="links">^TOP</A>
146 </TD>
147 </TR>
148
149
150 <!-- =========== Summary =========== -->
151 <TR BGCOLOR='white' CLASS='TableRowColor'>
152 <TD>
153 <CODE><B><A HREF='DataList.html#$alternating_row_colors'>$alternating_row_colors</A></B></CODE>
154 <BR>
155 <blockquote> Do we want to alternate the row colors?
156 This helps to see each row easier. </blockquote>
157 <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
158 </TD>
159 </TR>
160
161 <!-- =========== Summary =========== -->
162 <TR BGCOLOR='white' CLASS='TableRowColor'>
163 <TD>
164 <CODE><B><A HREF='DataList.html#$_advanced_search_flag'>$_advanced_search_flag</A></B></CODE>
165 <BR>
166 <blockquote> Flag to let us know that
167 advanced search is enabled </blockquote>
168 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
169 </TD>
170 </TR>
171
172 <!-- =========== Summary =========== -->
173 <TR BGCOLOR='white' CLASS='TableRowColor'>
174 <TD>
175 <CODE><B><A HREF='DataList.html#$_columns'>$_columns</A></B></CODE>
176 <BR>
177 <blockquote> The column descriptions
178 for the data we are working on </blockquote>
179 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
180 </TD>
181 </TR>
182
183 <!-- =========== Summary =========== -->
184 <TR BGCOLOR='white' CLASS='TableRowColor'>
185 <TD>
186 <CODE><B><A HREF='DataList.html#$_datasource'>$_datasource</A></B></CODE>
187 <BR>
188 <blockquote> Holds our reference/copy of the </blockquote>
189 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
190 </TD>
191 </TR>
192
193 <!-- =========== Summary =========== -->
194 <TR BGCOLOR='white' CLASS='TableRowColor'>
195 <TD>
196 <CODE><B><A HREF='DataList.html#$_default_orderby'>$_default_orderby</A></B></CODE>
197 <BR>
198 <blockquote> Holds the db column name that
199 we want to order by default. </blockquote>
200 <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
201 </TD>
202 </TR>
203
204 <!-- =========== Summary =========== -->
205 <TR BGCOLOR='white' CLASS='TableRowColor'>
206 <TD>
207 <CODE><B><A HREF='DataList.html#$_default_reverseorder'>$_default_reverseorder</A></B></CODE>
208 <BR>
209 <blockquote> Holds a flag to let us know to </blockquote>
210 <blockquote> Default Value: <CODE>->false<-</CODE> </blockquote>
211 </TD>
212 </TR>
213
214 <!-- =========== Summary =========== -->
215 <TR BGCOLOR='white' CLASS='TableRowColor'>
216 <TD>
217 <CODE><B><A HREF='DataList.html#$_default_rows_per_page'>$_default_rows_per_page</A></B></CODE>
218 <BR>
219 <blockquote> The number of rows of data
220 to show per &quot;page&quot;. </blockquote>
221 <blockquote> Default Value: <CODE>->10<-</CODE> </blockquote>
222 </TD>
223 </TR>
224
225 <!-- =========== Summary =========== -->
226 <TR BGCOLOR='white' CLASS='TableRowColor'>
227 <TD>
228 <CODE><B><A HREF='DataList.html#$_form_attributes'>$_form_attributes</A></B></CODE>
229 <BR>
230 <blockquote> This holds the form attributes </blockquote>
231 <blockquote> Default Value: <CODE>->array(&quot;method&quot; =&gt; &quot;GET&quot;,
232 &quot;target&quot; =&gt; &quot;&quot;,
233 &quot;action&quot; =&gt; &quot;&quot;,
234 &quot;name&quot; =&gt; &quot;&quot;)<-</CODE> </blockquote>
235 </TD>
236 </TR>
237
238 <!-- =========== Summary =========== -->
239 <TR BGCOLOR='white' CLASS='TableRowColor'>
240 <TD>
241 <CODE><B><A HREF='DataList.html#$_form_render_flag'>$_form_render_flag</A></B></CODE>
242 <BR>
243 <blockquote> Build everything inside a form? </blockquote>
244 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
245 </TD>
246 </TR>
247
248 <!-- =========== Summary =========== -->
249 <TR BGCOLOR='white' CLASS='TableRowColor'>
250 <TD>
251 <CODE><B><A HREF='DataList.html#$_global_prefix'>$_global_prefix</A></B></CODE>
252 <BR>
253 <blockquote> prefix for all list variable
254 names, so we can potentially
255 have more then 1 list per page. </blockquote>
256 <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
257 </TD>
258 </TR>
259
260 <!-- =========== Summary =========== -->
261 <TR BGCOLOR='white' CLASS='TableRowColor'>
262 <TD>
263 <CODE><B><A HREF='DataList.html#$_image_path'>$_image_path</A></B></CODE>
264 <BR>
265 <blockquote> This stores the base path to where the
266 tool link images live. </blockquote>
267 <blockquote> Default Value: <CODE>->/phphtmllib/images/widgets<-</CODE> </blockquote>
268 </TD>
269 </TR>
270
271 <!-- =========== Summary =========== -->
272 <TR BGCOLOR='white' CLASS='TableRowColor'>
273 <TD>
274 <CODE><B><A HREF='DataList.html#$_max_rows'>$_max_rows</A></B></CODE>
275 <BR>
276 <blockquote> The max number of rows to
277 show when the user does the
278 &quot;EXPAND&quot; command. </blockquote>
279 <blockquote> Default Value: <CODE>->200<-</CODE> </blockquote>
280 </TD>
281 </TR>
282
283 <!-- =========== Summary =========== -->
284 <TR BGCOLOR='white' CLASS='TableRowColor'>
285 <TD>
286 <CODE><B><A HREF='DataList.html#$_numrowsVar'>$_numrowsVar</A></B></CODE>
287 <BR>
288 <blockquote> The number of rows variable name </blockquote>
289 <blockquote> Default Value: <CODE>->numrows<-</CODE> </blockquote>
290 </TD>
291 </TR>
292
293 <!-- =========== Summary =========== -->
294 <TR BGCOLOR='white' CLASS='TableRowColor'>
295 <TD>
296 <CODE><B><A HREF='DataList.html#$_num_columns'>$_num_columns</A></B></CODE>
297 <BR>
298 <blockquote> Keeps track of the # of columns we have </blockquote>
299 <blockquote> Default Value: <CODE>->0<-</CODE> </blockquote>
300 </TD>
301 </TR>
302
303 <!-- =========== Summary =========== -->
304 <TR BGCOLOR='white' CLASS='TableRowColor'>
305 <TD>
306 <CODE><B><A HREF='DataList.html#$_num_pages'>$_num_pages</A></B></CODE>
307 <BR>
308 <blockquote> This value holds the number
309 of pages of data we have
310 to display. </blockquote>
311 <blockquote> Default Value: <CODE>->1<-</CODE> </blockquote>
312 </TD>
313 </TR>
314
315 <!-- =========== Summary =========== -->
316 <TR BGCOLOR='white' CLASS='TableRowColor'>
317 <TD>
318 <CODE><B><A HREF='DataList.html#$_offsetVar'>$_offsetVar</A></B></CODE>
319 <BR>
320 <blockquote> The offset variable name </blockquote>
321 <blockquote> Default Value: <CODE>->offset<-</CODE> </blockquote>
322 </TD>
323 </TR>
324
325 <!-- =========== Summary =========== -->
326 <TR BGCOLOR='white' CLASS='TableRowColor'>
327 <TD>
328 <CODE><B><A HREF='DataList.html#$_orderbyVar'>$_orderbyVar</A></B></CODE>
329 <BR>
330 <blockquote> The order by variable name </blockquote>
331 <blockquote> Default Value: <CODE>->orderby<-</CODE> </blockquote>
332 </TD>
333 </TR>
334
335 <!-- =========== Summary =========== -->
336 <TR BGCOLOR='white' CLASS='TableRowColor'>
337 <TD>
338 <CODE><B><A HREF='DataList.html#$_reverseorderVar'>$_reverseorderVar</A></B></CODE>
339 <BR>
340 <blockquote> The reverseorder variable name </blockquote>
341 <blockquote> Default Value: <CODE>->reverseorder<-</CODE> </blockquote>
342 </TD>
343 </TR>
344
345 <!-- =========== Summary =========== -->
346 <TR BGCOLOR='white' CLASS='TableRowColor'>
347 <TD>
348 <CODE><B><A HREF='DataList.html#$_save_vars'>$_save_vars</A></B></CODE>
349 <BR>
350 <blockquote> This holds a list of </blockquote>
351 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
352 </TD>
353 </TR>
354
355 <!-- =========== Summary =========== -->
356 <TR BGCOLOR='white' CLASS='TableRowColor'>
357 <TD>
358 <CODE><B><A HREF='DataList.html#$_search_fieldVar'>$_search_fieldVar</A></B></CODE>
359 <BR>
360 <blockquote> The search field variable </blockquote>
361 <blockquote> Default Value: <CODE>->search_field<-</CODE> </blockquote>
362 </TD>
363 </TR>
364
365 <!-- =========== Summary =========== -->
366 <TR BGCOLOR='white' CLASS='TableRowColor'>
367 <TD>
368 <CODE><B><A HREF='DataList.html#$_search_flag'>$_search_flag</A></B></CODE>
369 <BR>
370 <blockquote> Flag to let us know that search
371 is enabled. </blockquote>
372 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
373 </TD>
374 </TR>
375
376 <!-- =========== Summary =========== -->
377 <TR BGCOLOR='white' CLASS='TableRowColor'>
378 <TD>
379 <CODE><B><A HREF='DataList.html#$_search_table'>$_search_table</A></B></CODE>
380 <BR>
381 <blockquote> Holds the object block that is the </blockquote>
382 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
383 </TD>
384 </TR>
385
386 <!-- =========== Summary =========== -->
387 <TR BGCOLOR='white' CLASS='TableRowColor'>
388 <TD>
389 <CODE><B><A HREF='DataList.html#$_search_typeVar'>$_search_typeVar</A></B></CODE>
390 <BR>
391 <blockquote> The type of search </blockquote>
392 <blockquote> Default Value: <CODE>->search_type<-</CODE> </blockquote>
393 </TD>
394 </TR>
395
396 <!-- =========== Summary =========== -->
397 <TR BGCOLOR='white' CLASS='TableRowColor'>
398 <TD>
399 <CODE><B><A HREF='DataList.html#$_search_valueVar'>$_search_valueVar</A></B></CODE>
400 <BR>
401 <blockquote> The search value </blockquote>
402 <blockquote> Default Value: <CODE>->search_value<-</CODE> </blockquote>
403 </TD>
404 </TR>
405
406 <!-- =========== Summary =========== -->
407 <TR BGCOLOR='white' CLASS='TableRowColor'>
408 <TD>
409 <CODE><B><A HREF='DataList.html#$_showallVar'>$_showallVar</A></B></CODE>
410 <BR>
411 <blockquote> This var to tell us to show all
412 data or not. </blockquote>
413 <blockquote> Default Value: <CODE>->showall<-</CODE> </blockquote>
414 </TD>
415 </TR>
416
417 <!-- =========== Summary =========== -->
418 <TR BGCOLOR='white' CLASS='TableRowColor'>
419 <TD>
420 <CODE><B><A HREF='DataList.html#$_show_results_flag'>$_show_results_flag</A></B></CODE>
421 <BR>
422 <blockquote> flag to let us know if we want to show
423 the results or not. </blockquote>
424 <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
425 </TD>
426 </TR>
427
428 <!-- =========== Summary =========== -->
429 <TR BGCOLOR='white' CLASS='TableRowColor'>
430 <TD>
431 <CODE><B><A HREF='DataList.html#$_simple_search_modifier'>$_simple_search_modifier</A></B></CODE>
432 <BR>
433 <blockquote> Flag to enable simple search modifyer. </blockquote>
434 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
435 </TD>
436 </TR>
437
438 <!-- =========== Summary =========== -->
439 <TR BGCOLOR='white' CLASS='TableRowColor'>
440 <TD>
441 <CODE><B><A HREF='DataList.html#$_simple_search_modifierVar'>$_simple_search_modifierVar</A></B></CODE>
442 <BR>
443 <blockquote> The simple search modifier
444 var name. </blockquote>
445 <blockquote> Default Value: <CODE>->simple_search_modifier<-</CODE> </blockquote>
446 </TD>
447 </TR>
448
449 </TABLE>
450
451 <hr>
452 <!-- =========== VAR INHERITED SUMMARY =========== -->
453 <A NAME='var_inherited_summary'><!-- --></A>
454 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
455 <TR CLASS='TableHeadingColor'>
456 <TD>
457 <span CLASS="font12bold">Inherited Class Variable Summary</span>
458 <A HREF="#top" CLASS="links">^TOP</A>
459 </TD>
460 </TR>
461
462
463 <!-- =========== Summary =========== -->
464 <TR BGCOLOR='white'>
465 <TD>
466 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
467 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
468 <tr CLASS="tableheadingcolor">
469 <th>Variable</th>
470 <th>Default Value</th>
471 <th>Description</th>
472 </tr>
473
474 <tr>
475 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
476 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
477 <td CLASS="font10">The title of the table.</td>
478 </tr>
479
480 <tr>
481 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
482 <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
483 <td CLASS="font10">the width of the widget</td>
484 </tr>
485
486 </table>
487 <BR>
488 </TD>
489 </TR>
490
491 <!-- =========== Summary =========== -->
492 <TR BGCOLOR='white'>
493 <TD>
494 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
495 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
496 <tr CLASS="tableheadingcolor">
497 <th>Variable</th>
498 <th>Default Value</th>
499 <th>Description</th>
500 </tr>
501
502 <tr>
503 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
504 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
505 <td CLASS="font10">Flag for pretty (indented) output</td>
506 </tr>
507
508 <tr>
509 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
510 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
511 <td CLASS="font10">Do we render a newline after the
512 contents has been rendered?</td>
513 </tr>
514
515 </table>
516 <BR>
517 </TD>
518 </TR>
519
520 </TABLE>
521
522 <hr>
523 <!-- =========== INHERITED METHOD SUMMARY =========== -->
524 <A NAME='functions_inherited'><!-- --></A>
525 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
526 <TR CLASS='TableHeadingColor'>
527 <TD>
528 <span CLASS="font12bold">Inherited Method Summary</span>
529 <A HREF="#top" CLASS="links">^TOP</A>
530 </TD>
531 </TR>
532
533
534 <!-- =========== Summary =========== -->
535 <TR BGCOLOR='white' CLASS='TableRowColor'>
536 <TD>
537 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
538 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
539 <tr CLASS="tableheadingcolor">
540 <th>Function</th>
541 <th>Description</th>
542 </tr>
543
544 <tr>
545 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
546 <td CLASS="font10">This gets the alignment value
547 for the outer table</td>
548
549 <tr>
550 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
551 <td CLASS="font10">This function provides the</td>
552
553 <tr>
554 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
555 <td CLASS="font10">Function for returning the raw javascript
556 that is required for this widget.</td>
557
558 <tr>
559 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
560 <td CLASS="font10">Function for accessing the
561 title of this widget</td>
562
563 <tr>
564 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
565 <td CLASS="font10">Function for getting the current
566 widget width setting.</td>
567
568 <tr>
569 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
570 <td CLASS="font10">This function sets the align attribute
571 for the outer table.</td>
572
573 <tr>
574 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
575 <td CLASS="font10">Set the title for the widget.</td>
576
577 <tr>
578 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
579 <td CLASS="font10">Set the width for the widget.</td>
580
581 </table>
582 <br>
583 </TD>
584 </TR>
585
586 <!-- =========== Summary =========== -->
587 <TR BGCOLOR='white' CLASS='TableRowColor'>
588 <TD>
589 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
590 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
591 <tr CLASS="tableheadingcolor">
592 <th>Function</th>
593 <th>Description</th>
594 </tr>
595
596 <tr>
597 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
598 <td CLASS="font10">The constructor.</td>
599
600 <tr>
601 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
602 <td CLASS="font10">add content onto content stack</td>
603
604 <tr>
605 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
606 <td CLASS="font10">Add content onto content stack
607 so you can change the item later.</td>
608
609 <tr>
610 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
611 <td CLASS="font10">counts the number of content objects</td>
612
613 <tr>
614 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
615 <td CLASS="font10">This flag gets the current value
616 of the indent flag</td>
617
618 <tr>
619 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
620 <td CLASS="font10">Same as add().</td>
621
622 <tr>
623 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
624 <td CLASS="font10">Same as add_reference
625 NOTE : only exists for compatibility with 1.1.x</td>
626
627 <tr>
628 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
629 <td CLASS="font10">This function is compatible with the
630 rest of the phpHtmllib API spec.</td>
631
632 <tr>
633 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
634 <td CLASS="font10">destroy existing content and start with new content.</td>
635
636 <tr>
637 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
638 <td CLASS="font10">This function turns on the collapse flag</td>
639
640 <tr>
641 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
642 <td CLASS="font10">function to set the indent flag</td>
643
644 </table>
645 <br>
646 </TD>
647 </TR>
648
649 </TABLE>
650
651 <hr>
652 <!-- should have constructor at some point -->
653 <!-- =========== Method SUMMARY =========== -->
654 <A NAME='Method_summary'><!-- --></A>
655 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
656 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
657 <TD>
658 <span class="font12bold">Method Summary</span>
659 <A HREF="#top" CLASS="links">^TOP</A>
660 </TD>
661 </TR>
662
663
664 <!-- =========== Summary =========== -->
665 <TR BGCOLOR='white' CLASS='TableRowColor'>
666 <TD>
667 <CODE><B><A HREF='DataList.html#constructor DataList'>void constructor DataList ( $title, [$width = "100%"], [$default_orderby = ''], [$default_reverseorder = FALSE] )</A></B></CODE>
668 <BR>
669 <blockquote> The constructor </blockquote>
670 </TD>
671 </TR>
672
673 <!-- =========== Summary =========== -->
674 <TR BGCOLOR='white' CLASS='TableRowColor'>
675 <TD>
676 <CODE><B><A HREF='DataList.html#add_header_item'>array add_header_item ( $label, [$size = 100], [$data_name = NULL], [$sortable = FALSE], [$searchable = FALSE], [$align = "left"], $sortorder, [$max_text_length = ""NULL] )</A></B></CODE>
677 <BR>
678 <blockquote> This function adds a header item to the column headers
679 from a list of parameters. </blockquote>
680 </TD>
681 </TR>
682
683 <!-- =========== Summary =========== -->
684 <TR BGCOLOR='white' CLASS='TableRowColor'>
685 <TD>
686 <CODE><B><A HREF='DataList.html#advanced_search_disable'>void advanced_search_disable ( )</A></B></CODE>
687 <BR>
688 <blockquote> Disable the advanced search
689 capability </blockquote>
690 </TD>
691 </TR>
692
693 <!-- =========== Summary =========== -->
694 <TR BGCOLOR='white' CLASS='TableRowColor'>
695 <TD>
696 <CODE><B><A HREF='DataList.html#advanced_search_enable'>void advanced_search_enable ( )</A></B></CODE>
697 <BR>
698 <blockquote> Enable the advanced search </blockquote>
699 </TD>
700 </TR>
701
702 <!-- =========== Summary =========== -->
703 <TR BGCOLOR='white' CLASS='TableRowColor'>
704 <TD>
705 <CODE><B><A HREF='DataList.html#build_base_url'>string build_base_url ( )</A></B></CODE>
706 <BR>
707 <blockquote> This builds the base url used
708 by the column headers as well
709 as the page tool links. </blockquote>
710 </TD>
711 </TR>
712
713 <!-- =========== Summary =========== -->
714 <TR BGCOLOR='white' CLASS='TableRowColor'>
715 <TD>
716 <CODE><B><A HREF='DataList.html#build_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE>
717 <BR>
718 <blockquote> This is the basic function for letting us
719 do a mapping between the column name in
720 the header, to the value found in the DB. </blockquote>
721 </TD>
722 </TR>
723
724 <!-- =========== Summary =========== -->
725 <TR BGCOLOR='white' CLASS='TableRowColor'>
726 <TD>
727 <CODE><B><A HREF='DataList.html#build_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE>
728 <BR>
729 <blockquote> This is the basic function for letting us
730 do a mapping between the column name in
731 the header, to the value found in the DB. </blockquote>
732 </TD>
733 </TR>
734
735 <!-- =========== Summary =========== -->
736 <TR BGCOLOR='white' CLASS='TableRowColor'>
737 <TD>
738 <CODE><B><A HREF='DataList.html#build_column_url'><a href="../phpHtmlLib/Atag.html">Atag</a> build_column_url ( $col_name )</A></B></CODE>
739 <BR>
740 <blockquote> This builds a url for a particular
741 column header. </blockquote>
742 </TD>
743 </TR>
744
745 <!-- =========== Summary =========== -->
746 <TR BGCOLOR='white' CLASS='TableRowColor'>
747 <TD>
748 <CODE><B><A HREF='DataList.html#build_gui'>Container build_gui ( )</A></B></CODE>
749 <BR>
750 <blockquote> This function is responsible for calling the child </blockquote>
751 </TD>
752 </TR>
753
754 <!-- =========== Summary =========== -->
755 <TR BGCOLOR='white' CLASS='TableRowColor'>
756 <TD>
757 <CODE><B><A HREF='DataList.html#build_orderby_querystring'>string build_orderby_querystring ( )</A></B></CODE>
758 <BR>
759 <blockquote> This builds a query string var for the
760 orderby value. </blockquote>
761 </TD>
762 </TR>
763
764 <!-- =========== Summary =========== -->
765 <TR BGCOLOR='white' CLASS='TableRowColor'>
766 <TD>
767 <CODE><B><A HREF='DataList.html#build_reverseorder_querystring'>string build_reverseorder_querystring ( )</A></B></CODE>
768 <BR>
769 <blockquote> This builds a query string var for the
770 reverseorder value. </blockquote>
771 </TD>
772 </TR>
773
774 <!-- =========== Summary =========== -->
775 <TR BGCOLOR='white' CLASS='TableRowColor'>
776 <TD>
777 <CODE><B><A HREF='DataList.html#build_searchfield_querystring'>string build_searchfield_querystring ( )</A></B></CODE>
778 <BR>
779 <blockquote> This builds a query string var for the
780 searchfield value. </blockquote>
781 </TD>
782 </TR>
783
784 <!-- =========== Summary =========== -->
785 <TR BGCOLOR='white' CLASS='TableRowColor'>
786 <TD>
787 <CODE><B><A HREF='DataList.html#build_searchvalue_querystring'>string build_searchvalue_querystring ( )</A></B></CODE>
788 <BR>
789 <blockquote> This builds a query string var for the
790 searchfield value. </blockquote>
791 </TD>
792 </TR>
793
794 <!-- =========== Summary =========== -->
795 <TR BGCOLOR='white' CLASS='TableRowColor'>
796 <TD>
797 <CODE><B><A HREF='DataList.html#build_state_vars_query_string'>string build_state_vars_query_string ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></B></CODE>
798 <BR>
799 <blockquote> this function is used to build a sub query string
800 of all of the query string vars to save the
801 state of the DBItemList. </blockquote>
802 </TD>
803 </TR>
804
805 <!-- =========== Summary =========== -->
806 <TR BGCOLOR='white' CLASS='TableRowColor'>
807 <TD>
808 <CODE><B><A HREF='DataList.html#build_tool_link'>Object build_tool_link ( $which )</A></B></CODE>
809 <BR>
810 <blockquote> This function builds the 'tool' images that
811 allow you to walk through the data list itself. </blockquote>
812 </TD>
813 </TR>
814
815 <!-- =========== Summary =========== -->
816 <TR BGCOLOR='white' CLASS='TableRowColor'>
817 <TD>
818 <CODE><B><A HREF='DataList.html#child_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</A></B></CODE>
819 <BR>
820 <blockquote> This method is supposed to be written by </blockquote>
821 </TD>
822 </TR>
823
824 <!-- =========== Summary =========== -->
825 <TR BGCOLOR='white' CLASS='TableRowColor'>
826 <TD>
827 <CODE><B><A HREF='DataList.html#child_build_column_header'>void child_build_column_header ( $title, $col_data, $col_count )</A></B></CODE>
828 <BR>
829 <blockquote> This method is supposed to be written by </blockquote>
830 </TD>
831 </TR>
832
833 <!-- =========== Summary =========== -->
834 <TR BGCOLOR='white' CLASS='TableRowColor'>
835 <TD>
836 <CODE><B><A HREF='DataList.html#child_build_search_table'>Container child_build_search_table ( )</A></B></CODE>
837 <BR>
838 <blockquote> This function builds the search
839 block that lives above the results </blockquote>
840 </TD>
841 </TR>
842
843 <!-- =========== Summary =========== -->
844 <TR BGCOLOR='white' CLASS='TableRowColor'>
845 <TD>
846 <CODE><B><A HREF='DataList.html#child_get_gui'>Container child_get_gui ( )</A></B></CODE>
847 <BR>
848 <blockquote> This function is called after all of the data has
849 been added to the UI object. </blockquote>
850 </TD>
851 </TR>
852
853 <!-- =========== Summary =========== -->
854 <TR BGCOLOR='white' CLASS='TableRowColor'>
855 <TD>
856 <CODE><B><A HREF='DataList.html#data_prefetch'>void data_prefetch ( )</A></B></CODE>
857 <BR>
858 <blockquote> This function is used to set up any </blockquote>
859 </TD>
860 </TR>
861
862 <!-- =========== Summary =========== -->
863 <TR BGCOLOR='white' CLASS='TableRowColor'>
864 <TD>
865 <CODE><B><A HREF='DataList.html#filter_column_string'>string filter_column_string ( $data )</A></B></CODE>
866 <BR>
867 <blockquote> This does some magic filtering on the data
868 that we display in a column. </blockquote>
869 </TD>
870 </TR>
871
872 <!-- =========== Summary =========== -->
873 <TR BGCOLOR='white' CLASS='TableRowColor'>
874 <TD>
875 <CODE><B><A HREF='DataList.html#get_current_page'>int get_current_page ( )</A></B></CODE>
876 <BR>
877 <blockquote> This function returns the current
878 page that the item list is on. </blockquote>
879 </TD>
880 </TR>
881
882 <!-- =========== Summary =========== -->
883 <TR BGCOLOR='white' CLASS='TableRowColor'>
884 <TD>
885 <CODE><B><A HREF='DataList.html#get_data_source'>void get_data_source ( )</A></B></CODE>
886 <BR>
887 <blockquote> This function is called automatically by
888 the DataList constructor. </blockquote>
889 </TD>
890 </TR>
891
892 <!-- =========== Summary =========== -->
893 <TR BGCOLOR='white' CLASS='TableRowColor'>
894 <TD>
895 <CODE><B><A HREF='DataList.html#get_default_num_rows'>int get_default_num_rows ( )</A></B></CODE>
896 <BR>
897 <blockquote> This function gets the current default
898 number of rows to display setting. </blockquote>
899 </TD>
900 </TR>
901
902 <!-- =========== Summary =========== -->
903 <TR BGCOLOR='white' CLASS='TableRowColor'>
904 <TD>
905 <CODE><B><A HREF='DataList.html#get_form_action'>string get_form_action ( )</A></B></CODE>
906 <BR>
907 <blockquote> This function is used to get
908 the form action </blockquote>
909 </TD>
910 </TR>
911
912 <!-- =========== Summary =========== -->
913 <TR BGCOLOR='white' CLASS='TableRowColor'>
914 <TD>
915 <CODE><B><A HREF='DataList.html#get_form_method'>string get_form_method ( )</A></B></CODE>
916 <BR>
917 <blockquote> This function is used to get
918 the form method </blockquote>
919 </TD>
920 </TR>
921
922 <!-- =========== Summary =========== -->
923 <TR BGCOLOR='white' CLASS='TableRowColor'>
924 <TD>
925 <CODE><B><A HREF='DataList.html#get_form_name'>string get_form_name ( )</A></B></CODE>
926 <BR>
927 <blockquote> This function is used to get
928 the form name </blockquote>
929 </TD>
930 </TR>
931
932 <!-- =========== Summary =========== -->
933 <TR BGCOLOR='white' CLASS='TableRowColor'>
934 <TD>
935 <CODE><B><A HREF='DataList.html#get_form_render'>bool get_form_render ( )</A></B></CODE>
936 <BR>
937 <blockquote> Return the state of the form render </blockquote>
938 </TD>
939 </TR>
940
941 <!-- =========== Summary =========== -->
942 <TR BGCOLOR='white' CLASS='TableRowColor'>
943 <TD>
944 <CODE><B><A HREF='DataList.html#get_form_target'>string get_form_target ( )</A></B></CODE>
945 <BR>
946 <blockquote> This function is used to get
947 the form target </blockquote>
948 </TD>
949 </TR>
950
951 <!-- =========== Summary =========== -->
952 <TR BGCOLOR='white' CLASS='TableRowColor'>
953 <TD>
954 <CODE><B><A HREF='DataList.html#get_global_prefix'>string get_global_prefix ( )</A></B></CODE>
955 <BR>
956 <blockquote> returns the current variable prefix
957 string being used. </blockquote>
958 </TD>
959 </TR>
960
961 <!-- =========== Summary =========== -->
962 <TR BGCOLOR='white' CLASS='TableRowColor'>
963 <TD>
964 <CODE><B><A HREF='DataList.html#get_image_path'>string get_image_path ( )</A></B></CODE>
965 <BR>
966 <blockquote> This function returns the path to the
967 images used in this class </blockquote>
968 </TD>
969 </TR>
970
971 <!-- =========== Summary =========== -->
972 <TR BGCOLOR='white' CLASS='TableRowColor'>
973 <TD>
974 <CODE><B><A HREF='DataList.html#get_last_page'>int get_last_page ( )</A></B></CODE>
975 <BR>
976 <blockquote> This calculates the last page #
977 for this list of items </blockquote>
978 </TD>
979 </TR>
980
981 <!-- =========== Summary =========== -->
982 <TR BGCOLOR='white' CLASS='TableRowColor'>
983 <TD>
984 <CODE><B><A HREF='DataList.html#get_max_rows'>int get_max_rows ( )</A></B></CODE>
985 <BR>
986 <blockquote> This returns the Maximum # of rows to
987 display when in expand mode </blockquote>
988 </TD>
989 </TR>
990
991 <!-- =========== Summary =========== -->
992 <TR BGCOLOR='white' CLASS='TableRowColor'>
993 <TD>
994 <CODE><B><A HREF='DataList.html#get_num_pages'>int get_num_pages ( )</A></B></CODE>
995 <BR>
996 <blockquote> This function returns the #
997 of pages that are available
998 for this list of items. </blockquote>
999 </TD>
1000 </TR>
1001
1002 <!-- =========== Summary =========== -->
1003 <TR BGCOLOR='white' CLASS='TableRowColor'>
1004 <TD>
1005 <CODE><B><A HREF='DataList.html#get_page_info'>string get_page_info ( )</A></B></CODE>
1006 <BR>
1007 <blockquote> This function builds the string </blockquote>
1008 </TD>
1009 </TR>
1010
1011 <!-- =========== Summary =========== -->
1012 <TR BGCOLOR='white' CLASS='TableRowColor'>
1013 <TD>
1014 <CODE><B><A HREF='DataList.html#get_simple_search_modifier'>void get_simple_search_modifier ( )</A></B></CODE>
1015 <BR>
1016 <blockquote> gets the value of the search modifier
1017 flag. </blockquote>
1018 </TD>
1019 </TR>
1020
1021 <!-- =========== Summary =========== -->
1022 <TR BGCOLOR='white' CLASS='TableRowColor'>
1023 <TD>
1024 <CODE><B><A HREF='DataList.html#gui_init'>void gui_init ( )</A></B></CODE>
1025 <BR>
1026 <blockquote> A subclass can override this function
1027 to setup the class variables after
1028 the constructor. </blockquote>
1029 </TD>
1030 </TR>
1031
1032 <!-- =========== Summary =========== -->
1033 <TR BGCOLOR='white' CLASS='TableRowColor'>
1034 <TD>
1035 <CODE><B><A HREF='DataList.html#is_advanced_search_enabled'>boolean is_advanced_search_enabled ( )</A></B></CODE>
1036 <BR>
1037 <blockquote> This returns the status of the
1038 advanced search flag. </blockquote>
1039 </TD>
1040 </TR>
1041
1042 <!-- =========== Summary =========== -->
1043 <TR BGCOLOR='white' CLASS='TableRowColor'>
1044 <TD>
1045 <CODE><B><A HREF='DataList.html#is_search_enabled'>boolean is_search_enabled ( )</A></B></CODE>
1046 <BR>
1047 <blockquote> get the status of the search
1048 ability. </blockquote>
1049 </TD>
1050 </TR>
1051
1052 <!-- =========== Summary =========== -->
1053 <TR BGCOLOR='white' CLASS='TableRowColor'>
1054 <TD>
1055 <CODE><B><A HREF='DataList.html#numrows'>int numrows ( )</A></B></CODE>
1056 <BR>
1057 <blockquote> This function returns the number of rows
1058 that the query found. </blockquote>
1059 </TD>
1060 </TR>
1061
1062 <!-- =========== Summary =========== -->
1063 <TR BGCOLOR='white' CLASS='TableRowColor'>
1064 <TD>
1065 <CODE><B><A HREF='DataList.html#offset'>int offset ( )</A></B></CODE>
1066 <BR>
1067 <blockquote> This function returns the current value
1068 of the offset variable. </blockquote>
1069 </TD>
1070 </TR>
1071
1072 <!-- =========== Summary =========== -->
1073 <TR BGCOLOR='white' CLASS='TableRowColor'>
1074 <TD>
1075 <CODE><B><A HREF='DataList.html#orderby'>string. orderby ( )</A></B></CODE>
1076 <BR>
1077 <blockquote> This function returns the value of the
1078 current orderby variable. </blockquote>
1079 </TD>
1080 </TR>
1081
1082 <!-- =========== Summary =========== -->
1083 <TR BGCOLOR='white' CLASS='TableRowColor'>
1084 <TD>
1085 <CODE><B><A HREF='DataList.html#render'>void render ( $indent_level, $output_debug )</A></B></CODE>
1086 <BR>
1087 <blockquote> This function renders the final
1088 widget </blockquote>
1089 </TD>
1090 </TR>
1091
1092 <!-- =========== Summary =========== -->
1093 <TR BGCOLOR='white' CLASS='TableRowColor'>
1094 <TD>
1095 <CODE><B><A HREF='DataList.html#reverseorder'>string. reverseorder ( )</A></B></CODE>
1096 <BR>
1097 <blockquote> This function returns the current value of
1098 the reverse order member variable. </blockquote>
1099 </TD>
1100 </TR>
1101
1102 <!-- =========== Summary =========== -->
1103 <TR BGCOLOR='white' CLASS='TableRowColor'>
1104 <TD>
1105 <CODE><B><A HREF='DataList.html#search_disable'>void search_disable ( )</A></B></CODE>
1106 <BR>
1107 <blockquote> Disable the search ability. </blockquote>
1108 </TD>
1109 </TR>
1110
1111 <!-- =========== Summary =========== -->
1112 <TR BGCOLOR='white' CLASS='TableRowColor'>
1113 <TD>
1114 <CODE><B><A HREF='DataList.html#search_enable'>void search_enable ( )</A></B></CODE>
1115 <BR>
1116 <blockquote> Enable the search ability. </blockquote>
1117 </TD>
1118 </TR>
1119
1120 <!-- =========== Summary =========== -->
1121 <TR BGCOLOR='white' CLASS='TableRowColor'>
1122 <TD>
1123 <CODE><B><A HREF='DataList.html#search_field'>string search_field ( )</A></B></CODE>
1124 <BR>
1125 <blockquote> returns the current value of
1126 the search field name </blockquote>
1127 </TD>
1128 </TR>
1129
1130 <!-- =========== Summary =========== -->
1131 <TR BGCOLOR='white' CLASS='TableRowColor'>
1132 <TD>
1133 <CODE><B><A HREF='DataList.html#search_type'>string search_type ( )</A></B></CODE>
1134 <BR>
1135 <blockquote> returns the type of search being used </blockquote>
1136 </TD>
1137 </TR>
1138
1139 <!-- =========== Summary =========== -->
1140 <TR BGCOLOR='white' CLASS='TableRowColor'>
1141 <TD>
1142 <CODE><B><A HREF='DataList.html#search_value'>string search_value ( )</A></B></CODE>
1143 <BR>
1144 <blockquote> returns the current value of
1145 te search field value. </blockquote>
1146 </TD>
1147 </TR>
1148
1149 <!-- =========== Summary =========== -->
1150 <TR BGCOLOR='white' CLASS='TableRowColor'>
1151 <TD>
1152 <CODE><B><A HREF='DataList.html#search_value_filter'>string search_value_filter ( $value )</A></B></CODE>
1153 <BR>
1154 <blockquote> This function is used to make safe
1155 any query string value that is used </blockquote>
1156 </TD>
1157 </TR>
1158
1159 <!-- =========== Summary =========== -->
1160 <TR BGCOLOR='white' CLASS='TableRowColor'>
1161 <TD>
1162 <CODE><B><A HREF='DataList.html#setup_columns'>void setup_columns ( )</A></B></CODE>
1163 <BR>
1164 <blockquote> </blockquote>
1165 </TD>
1166 </TR>
1167
1168 <!-- =========== Summary =========== -->
1169 <TR BGCOLOR='white' CLASS='TableRowColor'>
1170 <TD>
1171 <CODE><B><A HREF='DataList.html#set_data_source'>void set_data_source ( $datasource )</A></B></CODE>
1172 <BR>
1173 <blockquote> This function is used to set the
1174 DataListSource object for this instance </blockquote>
1175 </TD>
1176 </TR>
1177
1178 <!-- =========== Summary =========== -->
1179 <TR BGCOLOR='white' CLASS='TableRowColor'>
1180 <TD>
1181 <CODE><B><A HREF='DataList.html#set_default_num_rows'>void set_default_num_rows ( $num_rows )</A></B></CODE>
1182 <BR>
1183 <blockquote> This function sets the default # of rows
1184 per page to display. </blockquote>
1185 </TD>
1186 </TR>
1187
1188 <!-- =========== Summary =========== -->
1189 <TR BGCOLOR='white' CLASS='TableRowColor'>
1190 <TD>
1191 <CODE><B><A HREF='DataList.html#set_form_action'>void set_form_action ( $action )</A></B></CODE>
1192 <BR>
1193 <blockquote> Sets the form action </blockquote>
1194 </TD>
1195 </TR>
1196
1197 <!-- =========== Summary =========== -->
1198 <TR BGCOLOR='white' CLASS='TableRowColor'>
1199 <TD>
1200 <CODE><B><A HREF='DataList.html#set_form_method'>void set_form_method ( $method )</A></B></CODE>
1201 <BR>
1202 <blockquote> This function is used to set the
1203 form method </blockquote>
1204 </TD>
1205 </TR>
1206
1207 <!-- =========== Summary =========== -->
1208 <TR BGCOLOR='white' CLASS='TableRowColor'>
1209 <TD>
1210 <CODE><B><A HREF='DataList.html#set_form_name'>void set_form_name ( $name )</A></B></CODE>
1211 <BR>
1212 <blockquote> This function is used to set the
1213 form name </blockquote>
1214 </TD>
1215 </TR>
1216
1217 <!-- =========== Summary =========== -->
1218 <TR BGCOLOR='white' CLASS='TableRowColor'>
1219 <TD>
1220 <CODE><B><A HREF='DataList.html#set_form_render'>void set_form_render ( $flag )</A></B></CODE>
1221 <BR>
1222 <blockquote> Sets whether to the output into a form </blockquote>
1223 </TD>
1224 </TR>
1225
1226 <!-- =========== Summary =========== -->
1227 <TR BGCOLOR='white' CLASS='TableRowColor'>
1228 <TD>
1229 <CODE><B><A HREF='DataList.html#set_form_target'>void set_form_target ( $target )</A></B></CODE>
1230 <BR>
1231 <blockquote> This function is used to set the
1232 form target </blockquote>
1233 </TD>
1234 </TR>
1235
1236 <!-- =========== Summary =========== -->
1237 <TR BGCOLOR='white' CLASS='TableRowColor'>
1238 <TD>
1239 <CODE><B><A HREF='DataList.html#set_global_prefix'>void set_global_prefix ( $prefix )</A></B></CODE>
1240 <BR>
1241 <blockquote> This function sets a prefix for all
1242 variables that are used in the item list
1243 table on a page. </blockquote>
1244 </TD>
1245 </TR>
1246
1247 <!-- =========== Summary =========== -->
1248 <TR BGCOLOR='white' CLASS='TableRowColor'>
1249 <TD>
1250 <CODE><B><A HREF='DataList.html#set_image_path'>string set_image_path ( $path )</A></B></CODE>
1251 <BR>
1252 <blockquote> This function returns the path to the
1253 images used in this class </blockquote>
1254 </TD>
1255 </TR>
1256
1257 <!-- =========== Summary =========== -->
1258 <TR BGCOLOR='white' CLASS='TableRowColor'>
1259 <TD>
1260 <CODE><B><A HREF='DataList.html#set_max_rows'>void set_max_rows ( $max )</A></B></CODE>
1261 <BR>
1262 <blockquote> This sets the maximum # of rows to
1263 display when in expand mode </blockquote>
1264 </TD>
1265 </TR>
1266
1267 <!-- =========== Summary =========== -->
1268 <TR BGCOLOR='white' CLASS='TableRowColor'>
1269 <TD>
1270 <CODE><B><A HREF='DataList.html#set_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE>
1271 <BR>
1272 <blockquote> This function is used to set the
1273 message displayed when no data is found </blockquote>
1274 </TD>
1275 </TR>
1276
1277 <!-- =========== Summary =========== -->
1278 <TR BGCOLOR='white' CLASS='TableRowColor'>
1279 <TD>
1280 <CODE><B><A HREF='DataList.html#set_numrows'>void set_numrows ( $new_numrows )</A></B></CODE>
1281 <BR>
1282 <blockquote> This function sets the # of rows to display
1283 per page. </blockquote>
1284 </TD>
1285 </TR>
1286
1287 <!-- =========== Summary =========== -->
1288 <TR BGCOLOR='white' CLASS='TableRowColor'>
1289 <TD>
1290 <CODE><B><A HREF='DataList.html#set_offset'>void set_offset ( $new_offset )</A></B></CODE>
1291 <BR>
1292 <blockquote> This function is used to set/change
1293 the offset for this list. </blockquote>
1294 </TD>
1295 </TR>
1296
1297 <!-- =========== Summary =========== -->
1298 <TR BGCOLOR='white' CLASS='TableRowColor'>
1299 <TD>
1300 <CODE><B><A HREF='DataList.html#set_reverseorder'>void set_reverseorder ( $new_value )</A></B></CODE>
1301 <BR>
1302 <blockquote> This function sets the reverse order flag
1303 to a new value. </blockquote>
1304 </TD>
1305 </TR>
1306
1307 <!-- =========== Summary =========== -->
1308 <TR BGCOLOR='white' CLASS='TableRowColor'>
1309 <TD>
1310 <CODE><B><A HREF='DataList.html#set_save_vars'>void set_save_vars ( $vars )</A></B></CODE>
1311 <BR>
1312 <blockquote> This function sets the save variables </blockquote>
1313 </TD>
1314 </TR>
1315
1316 <!-- =========== Summary =========== -->
1317 <TR BGCOLOR='white' CLASS='TableRowColor'>
1318 <TD>
1319 <CODE><B><A HREF='DataList.html#set_save_vars'>void set_save_vars ( $vars )</A></B></CODE>
1320 <BR>
1321 <blockquote> This function sets the save variables </blockquote>
1322 </TD>
1323 </TR>
1324
1325 <!-- =========== Summary =========== -->
1326 <TR BGCOLOR='white' CLASS='TableRowColor'>
1327 <TD>
1328 <CODE><B><A HREF='DataList.html#set_search_type'>void set_search_type ( $type )</A></B></CODE>
1329 <BR>
1330 <blockquote> This function sets the search type </blockquote>
1331 </TD>
1332 </TR>
1333
1334 <!-- =========== Summary =========== -->
1335 <TR BGCOLOR='white' CLASS='TableRowColor'>
1336 <TD>
1337 <CODE><B><A HREF='DataList.html#set_show_results'>void set_show_results ( [$flag = TRUE] )</A></B></CODE>
1338 <BR>
1339 <blockquote> This function is used to set the value
1340 of the _show_results_flag </blockquote>
1341 </TD>
1342 </TR>
1343
1344 <!-- =========== Summary =========== -->
1345 <TR BGCOLOR='white' CLASS='TableRowColor'>
1346 <TD>
1347 <CODE><B><A HREF='DataList.html#set_simple_search_modifier'>void set_simple_search_modifier ( [$modifier = SEARCH_ALL] )</A></B></CODE>
1348 <BR>
1349 <blockquote> Set the simple search modifyer </blockquote>
1350 </TD>
1351 </TR>
1352
1353 <!-- =========== Summary =========== -->
1354 <TR BGCOLOR='white' CLASS='TableRowColor'>
1355 <TD>
1356 <CODE><B><A HREF='DataList.html#showall'>string showall ( )</A></B></CODE>
1357 <BR>
1358 <blockquote> returns the current value of the showall
1359 flag. </blockquote>
1360 </TD>
1361 </TR>
1362
1363 <!-- =========== Summary =========== -->
1364 <TR BGCOLOR='white' CLASS='TableRowColor'>
1365 <TD>
1366 <CODE><B><A HREF='DataList.html#simple_search_modifier_value'>string simple_search_modifier_value ( )</A></B></CODE>
1367 <BR>
1368 <blockquote> returns the current value of the
1369 simple search modifier </blockquote>
1370 </TD>
1371 </TR>
1372
1373 <!-- =========== Summary =========== -->
1374 <TR BGCOLOR='white' CLASS='TableRowColor'>
1375 <TD>
1376 <CODE><B><A HREF='DataList.html#user_setup'>void user_setup ( )</A></B></CODE>
1377 <BR>
1378 <blockquote> A subclass can override this function
1379 to setup the class variables after
1380 the constructor. </blockquote>
1381 </TD>
1382 </TR>
1383
1384 <!-- =========== Summary =========== -->
1385 <TR BGCOLOR='white' CLASS='TableRowColor'>
1386 <TD>
1387 <CODE><B><A HREF='DataList.html#_build_save_vars'><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> _build_save_vars ( )</A></B></CODE>
1388 <BR>
1389 <blockquote> this method builds some hidden
1390 form fields to automatically
1391 be placed inside the form. </blockquote>
1392 </TD>
1393 </TR>
1394
1395 <!-- =========== Summary =========== -->
1396 <TR BGCOLOR='white' CLASS='TableRowColor'>
1397 <TD>
1398 <CODE><B><A HREF='DataList.html#_build_simple_search_modifier'><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a> _build_simple_search_modifier ( )</A></B></CODE>
1399 <BR>
1400 <blockquote> This builds the simple search modifier
1401 select box. </blockquote>
1402 </TD>
1403 </TR>
1404
1405 <!-- =========== Summary =========== -->
1406 <TR BGCOLOR='white' CLASS='TableRowColor'>
1407 <TD>
1408 <CODE><B><A HREF='DataList.html#_build_tool_url'>string _build_tool_url ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></B></CODE>
1409 <BR>
1410 <blockquote> This function is used to build the url
1411 for a tool link. </blockquote>
1412 </TD>
1413 </TR>
1414
1415 <!-- =========== Summary =========== -->
1416 <TR BGCOLOR='white' CLASS='TableRowColor'>
1417 <TD>
1418 <CODE><B><A HREF='DataList.html#_check_datasource'>void _check_datasource ( $function_name )</A></B></CODE>
1419 <BR>
1420 <blockquote> general DataListSource object checker. </blockquote>
1421 </TD>
1422 </TR>
1423
1424 <!-- =========== Summary =========== -->
1425 <TR BGCOLOR='white' CLASS='TableRowColor'>
1426 <TD>
1427 <CODE><B><A HREF='DataList.html#_clean_string'>mixed _clean_string ( $obj, $col_name )</A></B></CODE>
1428 <BR>
1429 <blockquote> This function is used to make sure that the string we are
1430 placing in a cell has been &quot;cleaned&quot; </blockquote>
1431 </TD>
1432 </TR>
1433
1434 <!-- =========== Summary =========== -->
1435 <TR BGCOLOR='white' CLASS='TableRowColor'>
1436 <TD>
1437 <CODE><B><A HREF='DataList.html#_filter_column_string'>string _filter_column_string ( $data )</A></B></CODE>
1438 <BR>
1439 <blockquote> This does some magic filtering on the data
1440 that we display in a column. </blockquote>
1441 </TD>
1442 </TR>
1443
1444 <!-- =========== Summary =========== -->
1445 <TR BGCOLOR='white' CLASS='TableRowColor'>
1446 <TD>
1447 <CODE><B><A HREF='DataList.html#_get_searchable_fields'>array _get_searchable_fields ( )</A></B></CODE>
1448 <BR>
1449 <blockquote> This method gets the array of
1450 searchable header fields (columns) </blockquote>
1451 </TD>
1452 </TR>
1453
1454 <!-- =========== Summary =========== -->
1455 <TR BGCOLOR='white' CLASS='TableRowColor'>
1456 <TD>
1457 <CODE><B><A HREF='DataList.html#_javascript'><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a> _javascript ( )</A></B></CODE>
1458 <BR>
1459 <blockquote> This function provides a way to automatically
1460 add javascript to this object. </blockquote>
1461 </TD>
1462 </TR>
1463
1464 <!-- =========== Summary =========== -->
1465 <TR BGCOLOR='white' CLASS='TableRowColor'>
1466 <TD>
1467 <CODE><B><A HREF='DataList.html#_save_mozilla_nav_link'>void _save_mozilla_nav_link ( $which, $url )</A></B></CODE>
1468 <BR>
1469 <blockquote> This function stores the url for each of the tool
1470 urls, so we can push these out for mozilla. </blockquote>
1471 </TD>
1472 </TR>
1473
1474 <!-- =========== Summary =========== -->
1475 <TR BGCOLOR='white' CLASS='TableRowColor'>
1476 <TD>
1477 <CODE><B><A HREF='DataList.html#_show_results'>boolean _show_results ( )</A></B></CODE>
1478 <BR>
1479 <blockquote> This function is used to let render() know
1480 that we should show the results or not. </blockquote>
1481 </TD>
1482 </TR>
1483
1484 </TABLE>
1485
1486 <hr>
1487 <!-- ============ VARIABLE DETAIL =========== -->
1488
1489 <A NAME='variable_detail'></A>
1490 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
1491 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
1492 <TD>
1493 <span CLASS="font12bold">Variable Detail</span>
1494 <A HREF="#top" CLASS="links">^TOP</A>
1495 </TD>
1496 </TR>
1497 </TABLE>
1498
1499
1500 <A NAME='$alternating_row_colors'><!-- --></A><H3>$alternating_row_colors</H3>
1501 <b>Data type:</b> mixed<br>
1502 <!-- ========== Info from phpDoc block ========= -->
1503 Do we want to alternate the row colors?
1504 This helps to see each row easier.
1505 <BR>
1506
1507
1508 <UL>
1509
1510 </UL>
1511
1512 <HR>
1513
1514 <A NAME='$_advanced_search_flag'><!-- --></A><H3>$_advanced_search_flag</H3>
1515 <b>Data type:</b> mixed<br>
1516 <!-- ========== Info from phpDoc block ========= -->
1517 Flag to let us know that
1518 advanced search is enabled
1519 <BR>
1520
1521
1522 <UL>
1523
1524 </UL>
1525
1526 <HR>
1527
1528 <A NAME='$_columns'><!-- --></A><H3>$_columns</H3>
1529 <b>Data type:</b> array<br>
1530 <!-- ========== Info from phpDoc block ========= -->
1531 The column descriptions
1532 for the data we are working on
1533 <BR>
1534
1535
1536 <UL>
1537
1538 </UL>
1539
1540 <HR>
1541
1542 <A NAME='$_datasource'><!-- --></A><H3>$_datasource</H3>
1543 <b>Data type:</b> <a href="../phpHtmlLib/DataListSource.html">DataListSource</a><br>
1544 <!-- ========== Info from phpDoc block ========= -->
1545 Holds our reference/copy of the
1546 <BR>
1547 DataListSource object which is used to
1548 access the data that this object uses
1549
1550 <UL>
1551
1552 <LI><b>Var</b> - <CODE>object</CODE></LI>
1553
1554 </UL>
1555
1556 <HR>
1557
1558 <A NAME='$_default_orderby'><!-- --></A><H3>$_default_orderby</H3>
1559 <b>Data type:</b> mixed<br>
1560 <!-- ========== Info from phpDoc block ========= -->
1561 Holds the db column name that
1562 we want to order by default.
1563 <BR>
1564
1565
1566 <UL>
1567
1568 </UL>
1569
1570 <HR>
1571
1572 <A NAME='$_default_reverseorder'><!-- --></A><H3>$_default_reverseorder</H3>
1573 <b>Data type:</b> mixed<br>
1574 <!-- ========== Info from phpDoc block ========= -->
1575 Holds a flag to let us know to
1576 <BR>
1577 reverse order the column by default
1578
1579 <UL>
1580
1581 </UL>
1582
1583 <HR>
1584
1585 <A NAME='$_default_rows_per_page'><!-- --></A><H3>$_default_rows_per_page</H3>
1586 <b>Data type:</b> mixed<br>
1587 <!-- ========== Info from phpDoc block ========= -->
1588 The number of rows of data
1589 to show per &quot;page&quot;.
1590 <BR>
1591 The default is 20.
1592
1593 <UL>
1594
1595 </UL>
1596
1597 <HR>
1598
1599 <A NAME='$_form_attributes'><!-- --></A><H3>$_form_attributes</H3>
1600 <b>Data type:</b> mixed<br>
1601 <!-- ========== Info from phpDoc block ========= -->
1602 This holds the form attributes
1603 <BR>
1604
1605
1606 <UL>
1607
1608 </UL>
1609
1610 <HR>
1611
1612 <A NAME='$_form_render_flag'><!-- --></A><H3>$_form_render_flag</H3>
1613 <b>Data type:</b> mixed<br>
1614 <!-- ========== Info from phpDoc block ========= -->
1615 Build everything inside a form?
1616 <BR>
1617
1618
1619 <UL>
1620
1621 </UL>
1622
1623 <HR>
1624
1625 <A NAME='$_global_prefix'><!-- --></A><H3>$_global_prefix</H3>
1626 <b>Data type:</b> mixed<br>
1627 <!-- ========== Info from phpDoc block ========= -->
1628 prefix for all list variable
1629 names, so we can potentially
1630 have more then 1 list per page.
1631 <BR>
1632
1633
1634 <UL>
1635
1636 </UL>
1637
1638 <HR>
1639
1640 <A NAME='$_image_path'><!-- --></A><H3>$_image_path</H3>
1641 <b>Data type:</b> mixed<br>
1642 <!-- ========== Info from phpDoc block ========= -->
1643 This stores the base path to where the
1644 tool link images live.
1645 <BR>
1646 This lets you
1647 specify a new path to where your images
1648 live.
1649
1650 <UL>
1651
1652 </UL>
1653
1654 <HR>
1655
1656 <A NAME='$_max_rows'><!-- --></A><H3>$_max_rows</H3>
1657 <b>Data type:</b> mixed<br>
1658 <!-- ========== Info from phpDoc block ========= -->
1659 The max number of rows to
1660 show when the user does the
1661 &quot;EXPAND&quot; command.
1662 <BR>
1663
1664
1665 <UL>
1666
1667 </UL>
1668
1669 <HR>
1670
1671 <A NAME='$_numrowsVar'><!-- --></A><H3>$_numrowsVar</H3>
1672 <b>Data type:</b> mixed<br>
1673 <!-- ========== Info from phpDoc block ========= -->
1674 The number of rows variable name
1675 <BR>
1676
1677
1678 <UL>
1679
1680 </UL>
1681
1682 <HR>
1683
1684 <A NAME='$_num_columns'><!-- --></A><H3>$_num_columns</H3>
1685 <b>Data type:</b> mixed<br>
1686 <!-- ========== Info from phpDoc block ========= -->
1687 Keeps track of the # of columns we have
1688 <BR>
1689
1690
1691 <UL>
1692
1693 </UL>
1694
1695 <HR>
1696
1697 <A NAME='$_num_pages'><!-- --></A><H3>$_num_pages</H3>
1698 <b>Data type:</b> mixed<br>
1699 <!-- ========== Info from phpDoc block ========= -->
1700 This value holds the number
1701 of pages of data we have
1702 to display.
1703 <BR>
1704
1705
1706 <UL>
1707
1708 </UL>
1709
1710 <HR>
1711
1712 <A NAME='$_offsetVar'><!-- --></A><H3>$_offsetVar</H3>
1713 <b>Data type:</b> mixed<br>
1714 <!-- ========== Info from phpDoc block ========= -->
1715 The offset variable name
1716 <BR>
1717
1718
1719 <UL>
1720
1721 </UL>
1722
1723 <HR>
1724
1725 <A NAME='$_orderbyVar'><!-- --></A><H3>$_orderbyVar</H3>
1726 <b>Data type:</b> mixed<br>
1727 <!-- ========== Info from phpDoc block ========= -->
1728 The order by variable name
1729 <BR>
1730
1731
1732 <UL>
1733
1734 </UL>
1735
1736 <HR>
1737
1738 <A NAME='$_reverseorderVar'><!-- --></A><H3>$_reverseorderVar</H3>
1739 <b>Data type:</b> mixed<br>
1740 <!-- ========== Info from phpDoc block ========= -->
1741 The reverseorder variable name
1742 <BR>
1743
1744
1745 <UL>
1746
1747 </UL>
1748
1749 <HR>
1750
1751 <A NAME='$_save_vars'><!-- --></A><H3>$_save_vars</H3>
1752 <b>Data type:</b> mixed<br>
1753 <!-- ========== Info from phpDoc block ========= -->
1754 This holds a list of
1755 <BR>
1756 name=&gt;value vars that the
1757 caller/child wants to propogate
1758 automatically.
1759
1760 <UL>
1761
1762 </UL>
1763
1764 <HR>
1765
1766 <A NAME='$_search_fieldVar'><!-- --></A><H3>$_search_fieldVar</H3>
1767 <b>Data type:</b> mixed<br>
1768 <!-- ========== Info from phpDoc block ========= -->
1769 The search field variable
1770 <BR>
1771
1772
1773 <UL>
1774
1775 </UL>
1776
1777 <HR>
1778
1779 <A NAME='$_search_flag'><!-- --></A><H3>$_search_flag</H3>
1780 <b>Data type:</b> mixed<br>
1781 <!-- ========== Info from phpDoc block ========= -->
1782 Flag to let us know that search
1783 is enabled.
1784 <BR>
1785
1786
1787 <UL>
1788
1789 </UL>
1790
1791 <HR>
1792
1793 <A NAME='$_search_table'><!-- --></A><H3>$_search_table</H3>
1794 <b>Data type:</b> mixed<br>
1795 <!-- ========== Info from phpDoc block ========= -->
1796 Holds the object block that is the
1797 <BR>
1798 search UI
1799
1800 <UL>
1801
1802 </UL>
1803
1804 <HR>
1805
1806 <A NAME='$_search_typeVar'><!-- --></A><H3>$_search_typeVar</H3>
1807 <b>Data type:</b> mixed<br>
1808 <!-- ========== Info from phpDoc block ========= -->
1809 The type of search
1810 <BR>
1811 advanced/simple
1812
1813 <UL>
1814
1815 </UL>
1816
1817 <HR>
1818
1819 <A NAME='$_search_valueVar'><!-- --></A><H3>$_search_valueVar</H3>
1820 <b>Data type:</b> mixed<br>
1821 <!-- ========== Info from phpDoc block ========= -->
1822 The search value
1823 <BR>
1824
1825
1826 <UL>
1827
1828 </UL>
1829
1830 <HR>
1831
1832 <A NAME='$_showallVar'><!-- --></A><H3>$_showallVar</H3>
1833 <b>Data type:</b> mixed<br>
1834 <!-- ========== Info from phpDoc block ========= -->
1835 This var to tell us to show all
1836 data or not.
1837 <BR>
1838
1839
1840 <UL>
1841
1842 </UL>
1843
1844 <HR>
1845
1846 <A NAME='$_show_results_flag'><!-- --></A><H3>$_show_results_flag</H3>
1847 <b>Data type:</b> mixed<br>
1848 <!-- ========== Info from phpDoc block ========= -->
1849 flag to let us know if we want to show
1850 the results or not.
1851 <BR>
1852
1853
1854 <UL>
1855
1856 </UL>
1857
1858 <HR>
1859
1860 <A NAME='$_simple_search_modifier'><!-- --></A><H3>$_simple_search_modifier</H3>
1861 <b>Data type:</b> mixed<br>
1862 <!-- ========== Info from phpDoc block ========= -->
1863 Flag to enable simple search modifyer.
1864 <BR>
1865 IF enabled it will add a select that adds
1866 the &quot;beings with&quot;, &quot;contains&quot; options for
1867 a simple search.
1868
1869 <UL>
1870
1871 </UL>
1872
1873 <HR>
1874
1875 <A NAME='$_simple_search_modifierVar'><!-- --></A><H3>$_simple_search_modifierVar</H3>
1876 <b>Data type:</b> mixed<br>
1877 <!-- ========== Info from phpDoc block ========= -->
1878 The simple search modifier
1879 var name.
1880 <BR>
1881
1882
1883 <UL>
1884
1885 </UL>
1886
1887 <HR>
1888
1889
1890 <hr>
1891 <!-- ============ FUNCTION DETAIL =========== -->
1892
1893 <A NAME='function_detail'></A>
1894 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
1895 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
1896 <TD>
1897 <span class="font12bold">Method Detail</span>
1898 <A HREF="#top" CLASS="links">^TOP</A>
1899 </TD>
1900 </TR>
1901 </TABLE>
1902 <BR>
1903
1904 <DIV CLASS="function">
1905 <A NAME='constructor DataList'><!-- --></A>
1906 <SPAN CLASS="font12bold">constructor DataList</SPAN>
1907 <BR>
1908 <SPAN CLASS="font10bold">Useage : </SPAN>
1909 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1910 <span class="font10bold" style="color: #0000FF">constructor DataList ( $title, [$width = "100%"], [$default_orderby = ''], [$default_reverseorder = FALSE] )</SPAN>
1911 <BR>
1912
1913 <BR>
1914 <SPAN CLASS="font10bold">Description : </SPAN>
1915 <!-- ========== Info from phpDoc block ========= -->
1916 The constructor
1917 <BR>
1918
1919 <DL>
1920 <DT class="font10bold">Function Parameters:</DT>
1921
1922 <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">$title</SPAN></SPAN> - the title of the data list</DD>
1923
1924 <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">$width</SPAN></SPAN> - the overall width</DD>
1925
1926 <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">$default_orderby</SPAN></SPAN> - the column to use as the default sorting order</DD>
1927
1928 <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">$default_reverseorder</SPAN></SPAN> - sort the default column in reverse order?</DD>
1929
1930
1931 <DT class="font10bold">Function Info:</DT>
1932
1933 </DL>
1934
1935 </DIV>
1936 <BR>
1937
1938 <DIV CLASS="function">
1939 <A NAME='add_header_item'><!-- --></A>
1940 <SPAN CLASS="font12bold">add_header_item</SPAN>
1941 <BR>
1942 <SPAN CLASS="font10bold">Useage : </SPAN>
1943 <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
1944 <span class="font10bold" style="color: #0000FF">add_header_item ( $label, [$size = 100], [$data_name = NULL], [$sortable = FALSE], [$searchable = FALSE], [$align = "left"], $sortorder, [$max_text_length = ""NULL] )</SPAN>
1945 <BR>
1946
1947 <BR>
1948 <SPAN CLASS="font10bold">Description : </SPAN>
1949 <!-- ========== Info from phpDoc block ========= -->
1950 This function adds a header item to the column headers
1951 from a list of parameters.
1952 <BR>
1953
1954 <DL>
1955 <DT class="font10bold">Function Parameters:</DT>
1956
1957 <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">$label</SPAN></SPAN> - header align value.</DD>
1958
1959 <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">$size</SPAN></SPAN> - the maximum # of characters to allow in the cell.</DD>
1960
1961 <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">$dbfield</SPAN></SPAN> - - the db field associated
1962 with this label from the query.</DD>
1963
1964 <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">$sortable</SPAN></SPAN> - - flag to make this column sortable.</DD>
1965
1966 <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">$searchable</SPAN></SPAN> - - flag to make this column searchable.</DD>
1967
1968
1969 <DT class="font10bold">Function Info:</DT>
1970
1971 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - a single header array</DD>
1972
1973 </DL>
1974
1975 </DIV>
1976 <BR>
1977
1978 <DIV CLASS="function">
1979 <A NAME='advanced_search_disable'><!-- --></A>
1980 <SPAN CLASS="font12bold">advanced_search_disable</SPAN>
1981 <BR>
1982 <SPAN CLASS="font10bold">Useage : </SPAN>
1983 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1984 <span class="font10bold" style="color: #0000FF">advanced_search_disable ( )</SPAN>
1985 <BR>
1986
1987 <BR>
1988 <SPAN CLASS="font10bold">Description : </SPAN>
1989 <!-- ========== Info from phpDoc block ========= -->
1990 Disable the advanced search
1991 capability
1992 <BR>
1993
1994 <DL>
1995 <DT class="font10bold">Function Parameters:</DT>
1996
1997
1998 <DT class="font10bold">Function Info:</DT>
1999
2000 </DL>
2001
2002 </DIV>
2003 <BR>
2004
2005 <DIV CLASS="function">
2006 <A NAME='advanced_search_enable'><!-- --></A>
2007 <SPAN CLASS="font12bold">advanced_search_enable</SPAN>
2008 <BR>
2009 <SPAN CLASS="font10bold">Useage : </SPAN>
2010 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2011 <span class="font10bold" style="color: #0000FF">advanced_search_enable ( )</SPAN>
2012 <BR>
2013
2014 <BR>
2015 <SPAN CLASS="font10bold">Description : </SPAN>
2016 <!-- ========== Info from phpDoc block ========= -->
2017 Enable the advanced search
2018 <BR>
2019 capability
2020 NOTE: Child class MUST
2021 extend the
2022 _build_advanced_search_table
2023 <DL>
2024 <DT class="font10bold">Function Parameters:</DT>
2025
2026
2027 <DT class="font10bold">Function Info:</DT>
2028
2029 </DL>
2030
2031 </DIV>
2032 <BR>
2033
2034 <DIV CLASS="function">
2035 <A NAME='build_base_url'><!-- --></A>
2036 <SPAN CLASS="font12bold">build_base_url</SPAN>
2037 <BR>
2038 <SPAN CLASS="font10bold">Useage : </SPAN>
2039 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2040 <span class="font10bold" style="color: #0000FF">build_base_url ( )</SPAN>
2041 <BR>
2042
2043 <BR>
2044 <SPAN CLASS="font10bold">Description : </SPAN>
2045 <!-- ========== Info from phpDoc block ========= -->
2046 This builds the base url used
2047 by the column headers as well
2048 as the page tool links.
2049 <BR>
2050 it basically builds:
2051 $_SELF?$_GET
2052 <DL>
2053 <DT class="font10bold">Function Parameters:</DT>
2054
2055
2056 <DT class="font10bold">Function Info:</DT>
2057
2058 </DL>
2059
2060 </DIV>
2061 <BR>
2062
2063 <DIV CLASS="function">
2064 <A NAME='build_column_item'><!-- --></A>
2065 <SPAN CLASS="font12bold">build_column_item</SPAN>
2066 <BR>
2067 <SPAN CLASS="font10bold">Useage : </SPAN>
2068 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
2069 <span class="font10bold" style="color: #0000FF">build_column_item ( $row_data, $col_name )</SPAN>
2070 <BR>
2071
2072 <BR>
2073 <SPAN CLASS="font10bold">Description : </SPAN>
2074 <!-- ========== Info from phpDoc block ========= -->
2075 This is the basic function for letting us
2076 do a mapping between the column name in
2077 the header, to the value found in the DB.
2078 <BR>
2079 NOTE: this function is meant to be overridden
2080 so that you can push whatever you want.
2081 <DL>
2082 <DT class="font10bold">Function Parameters:</DT>
2083
2084 <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">$row_data</SPAN></SPAN> - - the entire data for the row</DD>
2085
2086 <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 name of the column header
2087 for this row to render.</DD>
2088
2089
2090 <DT class="font10bold">Function Info:</DT>
2091
2092 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either a HTMLTag object, or raw text.</DD>
2093
2094 </DL>
2095
2096 </DIV>
2097 <BR>
2098
2099 <DIV CLASS="function">
2100 <A NAME='build_column_item'><!-- --></A>
2101 <SPAN CLASS="font12bold">build_column_item</SPAN>
2102 <BR>
2103 <SPAN CLASS="font10bold">Useage : </SPAN>
2104 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
2105 <span class="font10bold" style="color: #0000FF">build_column_item ( $row_data, $col_name )</SPAN>
2106 <BR>
2107
2108 <BR>
2109 <SPAN CLASS="font10bold">Description : </SPAN>
2110 <!-- ========== Info from phpDoc block ========= -->
2111 This is the basic function for letting us
2112 do a mapping between the column name in
2113 the header, to the value found in the DB.
2114 <BR>
2115 NOTE: this function is meant to be overridden
2116 so that you can push whatever you want.
2117 <DL>
2118 <DT class="font10bold">Function Parameters:</DT>
2119
2120 <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">$row_data</SPAN></SPAN> - - the entire data for the row</DD>
2121
2122 <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 name of the column header
2123 for this row to render.</DD>
2124
2125
2126 <DT class="font10bold">Function Info:</DT>
2127
2128 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either a HTMLTag object, or raw text.</DD>
2129
2130 </DL>
2131
2132 </DIV>
2133 <BR>
2134
2135 <DIV CLASS="function">
2136 <A NAME='build_column_url'><!-- --></A>
2137 <SPAN CLASS="font12bold">build_column_url</SPAN>
2138 <BR>
2139 <SPAN CLASS="font10bold">Useage : </SPAN>
2140 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/Atag.html">Atag</a></SPAN>&nbsp;
2141 <span class="font10bold" style="color: #0000FF">build_column_url ( $col_name )</SPAN>
2142 <BR>
2143
2144 <BR>
2145 <SPAN CLASS="font10bold">Description : </SPAN>
2146 <!-- ========== Info from phpDoc block ========= -->
2147 This builds a url for a particular
2148 column header.
2149 <BR>
2150
2151 <DL>
2152 <DT class="font10bold">Function Parameters:</DT>
2153
2154 <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> -</DD>
2155
2156
2157 <DT class="font10bold">Function Info:</DT>
2158
2159 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object;</DD>
2160
2161 </DL>
2162
2163 </DIV>
2164 <BR>
2165
2166 <DIV CLASS="function">
2167 <A NAME='build_gui'><!-- --></A>
2168 <SPAN CLASS="font12bold">build_gui</SPAN>
2169 <BR>
2170 <SPAN CLASS="font10bold">Useage : </SPAN>
2171 <span class="font10bold" style="color: #FF0000">Container</SPAN>&nbsp;
2172 <span class="font10bold" style="color: #0000FF">build_gui ( )</SPAN>
2173 <BR>
2174
2175 <BR>
2176 <SPAN CLASS="font10bold">Description : </SPAN>
2177 <!-- ========== Info from phpDoc block ========= -->
2178 This function is responsible for calling the child
2179 <BR>
2180 class's methods for building the GUI container.
2181 This function builds the search area, the
2182 title, page controls, the column headers,
2183 and walks the rows of data and adds them
2184
2185 A child class can override this method to
2186 move the placement of the search box
2187 relative to the data list. By default
2188 the search area comes above the table
2189 for the data list and page controls
2190 <DL>
2191 <DT class="font10bold">Function Parameters:</DT>
2192
2193
2194 <DT class="font10bold">Function Info:</DT>
2195
2196 </DL>
2197
2198 </DIV>
2199 <BR>
2200
2201 <DIV CLASS="function">
2202 <A NAME='build_orderby_querystring'><!-- --></A>
2203 <SPAN CLASS="font12bold">build_orderby_querystring</SPAN>
2204 <BR>
2205 <SPAN CLASS="font10bold">Useage : </SPAN>
2206 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2207 <span class="font10bold" style="color: #0000FF">build_orderby_querystring ( )</SPAN>
2208 <BR>
2209
2210 <BR>
2211 <SPAN CLASS="font10bold">Description : </SPAN>
2212 <!-- ========== Info from phpDoc block ========= -->
2213 This builds a query string var for the
2214 orderby value.
2215 <BR>
2216
2217 <DL>
2218 <DT class="font10bold">Function Parameters:</DT>
2219
2220
2221 <DT class="font10bold">Function Info:</DT>
2222
2223 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - &quot;orderby=(thevalue)&quot;</DD>
2224
2225 </DL>
2226
2227 </DIV>
2228 <BR>
2229
2230 <DIV CLASS="function">
2231 <A NAME='build_reverseorder_querystring'><!-- --></A>
2232 <SPAN CLASS="font12bold">build_reverseorder_querystring</SPAN>
2233 <BR>
2234 <SPAN CLASS="font10bold">Useage : </SPAN>
2235 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2236 <span class="font10bold" style="color: #0000FF">build_reverseorder_querystring ( )</SPAN>
2237 <BR>
2238
2239 <BR>
2240 <SPAN CLASS="font10bold">Description : </SPAN>
2241 <!-- ========== Info from phpDoc block ========= -->
2242 This builds a query string var for the
2243 reverseorder value.
2244 <BR>
2245
2246 <DL>
2247 <DT class="font10bold">Function Parameters:</DT>
2248
2249
2250 <DT class="font10bold">Function Info:</DT>
2251
2252 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - &quot;orderby=(thevalue)&quot;</DD>
2253
2254 </DL>
2255
2256 </DIV>
2257 <BR>
2258
2259 <DIV CLASS="function">
2260 <A NAME='build_searchfield_querystring'><!-- --></A>
2261 <SPAN CLASS="font12bold">build_searchfield_querystring</SPAN>
2262 <BR>
2263 <SPAN CLASS="font10bold">Useage : </SPAN>
2264 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2265 <span class="font10bold" style="color: #0000FF">build_searchfield_querystring ( )</SPAN>
2266 <BR>
2267
2268 <BR>
2269 <SPAN CLASS="font10bold">Description : </SPAN>
2270 <!-- ========== Info from phpDoc block ========= -->
2271 This builds a query string var for the
2272 searchfield value.
2273 <BR>
2274
2275 <DL>
2276 <DT class="font10bold">Function Parameters:</DT>
2277
2278
2279 <DT class="font10bold">Function Info:</DT>
2280
2281 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - &quot;orderby=(thevalue)&quot;</DD>
2282
2283 </DL>
2284
2285 </DIV>
2286 <BR>
2287
2288 <DIV CLASS="function">
2289 <A NAME='build_searchvalue_querystring'><!-- --></A>
2290 <SPAN CLASS="font12bold">build_searchvalue_querystring</SPAN>
2291 <BR>
2292 <SPAN CLASS="font10bold">Useage : </SPAN>
2293 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2294 <span class="font10bold" style="color: #0000FF">build_searchvalue_querystring ( )</SPAN>
2295 <BR>
2296
2297 <BR>
2298 <SPAN CLASS="font10bold">Description : </SPAN>
2299 <!-- ========== Info from phpDoc block ========= -->
2300 This builds a query string var for the
2301 searchfield value.
2302 <BR>
2303
2304 <DL>
2305 <DT class="font10bold">Function Parameters:</DT>
2306
2307
2308 <DT class="font10bold">Function Info:</DT>
2309
2310 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - &quot;orderby=(thevalue)&quot;</DD>
2311
2312 </DL>
2313
2314 </DIV>
2315 <BR>
2316
2317 <DIV CLASS="function">
2318 <A NAME='build_state_vars_query_string'><!-- --></A>
2319 <SPAN CLASS="font12bold">build_state_vars_query_string</SPAN>
2320 <BR>
2321 <SPAN CLASS="font10bold">Useage : </SPAN>
2322 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2323 <span class="font10bold" style="color: #0000FF">build_state_vars_query_string ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</SPAN>
2324 <BR>
2325
2326 <BR>
2327 <SPAN CLASS="font10bold">Description : </SPAN>
2328 <!-- ========== Info from phpDoc block ========= -->
2329 this function is used to build a sub query string
2330 of all of the query string vars to save the
2331 state of the DBItemList.
2332 <BR>
2333 This is used for pages
2334 that want to come back to the list at the same state
2335 <DL>
2336 <DT class="font10bold">Function Parameters:</DT>
2337
2338
2339 <DT class="font10bold">Function Info:</DT>
2340
2341 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - name=value&amp; pairs</DD>
2342
2343 </DL>
2344
2345 </DIV>
2346 <BR>
2347
2348 <DIV CLASS="function">
2349 <A NAME='build_tool_link'><!-- --></A>
2350 <SPAN CLASS="font12bold">build_tool_link</SPAN>
2351 <BR>
2352 <SPAN CLASS="font10bold">Useage : </SPAN>
2353 <span class="font10bold" style="color: #FF0000">Object</SPAN>&nbsp;
2354 <span class="font10bold" style="color: #0000FF">build_tool_link ( $which )</SPAN>
2355 <BR>
2356
2357 <BR>
2358 <SPAN CLASS="font10bold">Description : </SPAN>
2359 <!-- ========== Info from phpDoc block ========= -->
2360 This function builds the 'tool' images that
2361 allow you to walk through the data list itself.
2362 <BR>
2363 It provides image links for
2364 first - go to the first page in the data list
2365 prev - go to the previous page in the data list
2366 next - go to the next page in the data list
2367 last - go to the last page in the data list
2368 all - show the rest of the list from the current offset
2369 <DL>
2370 <DT class="font10bold">Function Parameters:</DT>
2371
2372 <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">$which</SPAN></SPAN> - which tool image to build</DD>
2373
2374
2375 <DT class="font10bold">Function Info:</DT>
2376
2377 </DL>
2378
2379 </DIV>
2380 <BR>
2381
2382 <DIV CLASS="function">
2383 <A NAME='child_add_row_cell'><!-- --></A>
2384 <SPAN CLASS="font12bold">child_add_row_cell</SPAN>
2385 <BR>
2386 <SPAN CLASS="font10bold">Useage : </SPAN>
2387 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2388 <span class="font10bold" style="color: #0000FF">child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</SPAN>
2389 <BR>
2390 Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a><br>
2391 <BR>
2392 <SPAN CLASS="font10bold">Description : </SPAN>
2393 <!-- ========== Info from phpDoc block ========= -->
2394 This method is supposed to be written by
2395 <BR>
2396 the child class to add the cell data to the
2397 current row in the UI
2398 <DL>
2399 <DT class="font10bold">Function Parameters:</DT>
2400
2401 <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> - the object/string/entity that
2402 should get put into the column row cell.</DD>
2403
2404 <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 name/title of the column that the
2405 object will live in</DD>
2406
2407 <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">$last_in_row_flag</SPAN></SPAN> - flag that tells the function if this is
2408 is the last cell for the current row.</DD>
2409
2410
2411 <DT class="font10bold">Function Info:</DT>
2412
2413 </DL>
2414
2415 </DIV>
2416 <BR>
2417
2418 <DIV CLASS="function">
2419 <A NAME='child_build_column_header'><!-- --></A>
2420 <SPAN CLASS="font12bold">child_build_column_header</SPAN>
2421 <BR>
2422 <SPAN CLASS="font10bold">Useage : </SPAN>
2423 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2424 <span class="font10bold" style="color: #0000FF">child_build_column_header ( $title, $col_data, $col_count )</SPAN>
2425 <BR>
2426 Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_build_column_header">DefaultGUIDatalist::child_build_column_header()</a><br>
2427 <BR>
2428 <SPAN CLASS="font10bold">Description : </SPAN>
2429 <!-- ========== Info from phpDoc block ========= -->
2430 This method is supposed to be written by
2431 <BR>
2432 the child class to build and add the column
2433 title to the UI
2434 <DL>
2435 <DT class="font10bold">Function Parameters:</DT>
2436
2437 <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">$this-</SPAN></SPAN> - the column data ( from &gt;_columns )</DD>
2438
2439 <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">$title</SPAN></SPAN> - the title of the column</DD>
2440
2441 <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_data</SPAN></SPAN> - the column #</DD>
2442
2443
2444 <DT class="font10bold">Function Info:</DT>
2445
2446 </DL>
2447
2448 </DIV>
2449 <BR>
2450
2451 <DIV CLASS="function">
2452 <A NAME='child_build_search_table'><!-- --></A>
2453 <SPAN CLASS="font12bold">child_build_search_table</SPAN>
2454 <BR>
2455 <SPAN CLASS="font10bold">Useage : </SPAN>
2456 <span class="font10bold" style="color: #FF0000">Container</SPAN>&nbsp;
2457 <span class="font10bold" style="color: #0000FF">child_build_search_table ( )</SPAN>
2458 <BR>
2459 Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_build_search_table">DefaultGUIDatalist::child_build_search_table()</a><br>
2460 <BR>
2461 <SPAN CLASS="font10bold">Description : </SPAN>
2462 <!-- ========== Info from phpDoc block ========= -->
2463 This function builds the search
2464 block that lives above the results
2465 <BR>
2466
2467 <DL>
2468 <DT class="font10bold">Function Parameters:</DT>
2469
2470
2471 <DT class="font10bold">Function Info:</DT>
2472
2473 </DL>
2474
2475 </DIV>
2476 <BR>
2477
2478 <DIV CLASS="function">
2479 <A NAME='child_get_gui'><!-- --></A>
2480 <SPAN CLASS="font12bold">child_get_gui</SPAN>
2481 <BR>
2482 <SPAN CLASS="font10bold">Useage : </SPAN>
2483 <span class="font10bold" style="color: #FF0000">Container</SPAN>&nbsp;
2484 <span class="font10bold" style="color: #0000FF">child_get_gui ( )</SPAN>
2485 <BR>
2486 Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_get_gui">DefaultGUIDatalist::child_get_gui()</a><br>
2487 <BR>
2488 <SPAN CLASS="font10bold">Description : </SPAN>
2489 <!-- ========== Info from phpDoc block ========= -->
2490 This function is called after all of the data has
2491 been added to the UI object.
2492 <BR>
2493 It just returns the
2494 container that is the entire UI for the DataList
2495 <DL>
2496 <DT class="font10bold">Function Parameters:</DT>
2497
2498
2499 <DT class="font10bold">Function Info:</DT>
2500
2501 </DL>
2502
2503 </DIV>
2504 <BR>
2505
2506 <DIV CLASS="function">
2507 <A NAME='data_prefetch'><!-- --></A>
2508 <SPAN CLASS="font12bold">data_prefetch</SPAN>
2509 <BR>
2510 <SPAN CLASS="font10bold">Useage : </SPAN>
2511 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2512 <span class="font10bold" style="color: #0000FF">data_prefetch ( )</SPAN>
2513 <BR>
2514
2515 <BR>
2516 <SPAN CLASS="font10bold">Description : </SPAN>
2517 <!-- ========== Info from phpDoc block ========= -->
2518 This function is used to set up any
2519 <BR>
2520 data that needs to be munged before the
2521 data is fetched from the DataListSource
2522 <DL>
2523 <DT class="font10bold">Function Parameters:</DT>
2524
2525
2526 <DT class="font10bold">Function Info:</DT>
2527
2528 </DL>
2529
2530 </DIV>
2531 <BR>
2532
2533 <DIV CLASS="function">
2534 <A NAME='filter_column_string'><!-- --></A>
2535 <SPAN CLASS="font12bold">filter_column_string</SPAN>
2536 <BR>
2537 <SPAN CLASS="font10bold">Useage : </SPAN>
2538 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2539 <span class="font10bold" style="color: #0000FF">filter_column_string ( $data )</SPAN>
2540 <BR>
2541
2542 <BR>
2543 <SPAN CLASS="font10bold">Description : </SPAN>
2544 <!-- ========== Info from phpDoc block ========= -->
2545 This does some magic filtering on the data
2546 that we display in a column.
2547 <BR>
2548 This helps
2549 to prevent nast data that may have html
2550 tags in it.
2551 <DL>
2552 <DT class="font10bold">Function Parameters:</DT>
2553
2554 <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">$data</SPAN></SPAN> - the column data u want to filter</DD>
2555
2556
2557 <DT class="font10bold">Function Info:</DT>
2558
2559 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the cleaned/filtered data</DD>
2560
2561 </DL>
2562
2563 </DIV>
2564 <BR>
2565
2566 <DIV CLASS="function">
2567 <A NAME='get_current_page'><!-- --></A>
2568 <SPAN CLASS="font12bold">get_current_page</SPAN>
2569 <BR>
2570 <SPAN CLASS="font10bold">Useage : </SPAN>
2571 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
2572 <span class="font10bold" style="color: #0000FF">get_current_page ( )</SPAN>
2573 <BR>
2574
2575 <BR>
2576 <SPAN CLASS="font10bold">Description : </SPAN>
2577 <!-- ========== Info from phpDoc block ========= -->
2578 This function returns the current
2579 page that the item list is on.
2580 <BR>
2581
2582 <DL>
2583 <DT class="font10bold">Function Parameters:</DT>
2584
2585
2586 <DT class="font10bold">Function Info:</DT>
2587
2588 </DL>
2589
2590 </DIV>
2591 <BR>
2592
2593 <DIV CLASS="function">
2594 <A NAME='get_data_source'><!-- --></A>
2595 <SPAN CLASS="font12bold">get_data_source</SPAN>
2596 <BR>
2597 <SPAN CLASS="font10bold">Useage : </SPAN>
2598 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2599 <span class="font10bold" style="color: #0000FF">get_data_source ( )</SPAN>
2600 <BR>
2601
2602 <BR>
2603 <SPAN CLASS="font10bold">Description : </SPAN>
2604 <!-- ========== Info from phpDoc block ========= -->
2605 This function is called automatically by
2606 the DataList constructor.
2607 <BR>
2608 It must be
2609 extended by the child class to actually
2610 set the DataListSource object.
2611 <DL>
2612 <DT class="font10bold">Function Parameters:</DT>
2613
2614
2615 <DT class="font10bold">Function Info:</DT>
2616
2617 </DL>
2618
2619 </DIV>
2620 <BR>
2621
2622 <DIV CLASS="function">
2623 <A NAME='get_default_num_rows'><!-- --></A>
2624 <SPAN CLASS="font12bold">get_default_num_rows</SPAN>
2625 <BR>
2626 <SPAN CLASS="font10bold">Useage : </SPAN>
2627 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
2628 <span class="font10bold" style="color: #0000FF">get_default_num_rows ( )</SPAN>
2629 <BR>
2630
2631 <BR>
2632 <SPAN CLASS="font10bold">Description : </SPAN>
2633 <!-- ========== Info from phpDoc block ========= -->
2634 This function gets the current default
2635 number of rows to display setting.
2636 <BR>
2637
2638 <DL>
2639 <DT class="font10bold">Function Parameters:</DT>
2640
2641
2642 <DT class="font10bold">Function Info:</DT>
2643
2644 </DL>
2645
2646 </DIV>
2647 <BR>
2648
2649 <DIV CLASS="function">
2650 <A NAME='get_form_action'><!-- --></A>
2651 <SPAN CLASS="font12bold">get_form_action</SPAN>
2652 <BR>
2653 <SPAN CLASS="font10bold">Useage : </SPAN>
2654 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2655 <span class="font10bold" style="color: #0000FF">get_form_action ( )</SPAN>
2656 <BR>
2657
2658 <BR>
2659 <SPAN CLASS="font10bold">Description : </SPAN>
2660 <!-- ========== Info from phpDoc block ========= -->
2661 This function is used to get
2662 the form action
2663 <BR>
2664
2665 <DL>
2666 <DT class="font10bold">Function Parameters:</DT>
2667
2668
2669 <DT class="font10bold">Function Info:</DT>
2670
2671 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (POST or GET)</DD>
2672
2673 </DL>
2674
2675 </DIV>
2676 <BR>
2677
2678 <DIV CLASS="function">
2679 <A NAME='get_form_method'><!-- --></A>
2680 <SPAN CLASS="font12bold">get_form_method</SPAN>
2681 <BR>
2682 <SPAN CLASS="font10bold">Useage : </SPAN>
2683 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2684 <span class="font10bold" style="color: #0000FF">get_form_method ( )</SPAN>
2685 <BR>
2686
2687 <BR>
2688 <SPAN CLASS="font10bold">Description : </SPAN>
2689 <!-- ========== Info from phpDoc block ========= -->
2690 This function is used to get
2691 the form method
2692 <BR>
2693
2694 <DL>
2695 <DT class="font10bold">Function Parameters:</DT>
2696
2697
2698 <DT class="font10bold">Function Info:</DT>
2699
2700 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (POST or GET)</DD>
2701
2702 </DL>
2703
2704 </DIV>
2705 <BR>
2706
2707 <DIV CLASS="function">
2708 <A NAME='get_form_name'><!-- --></A>
2709 <SPAN CLASS="font12bold">get_form_name</SPAN>
2710 <BR>
2711 <SPAN CLASS="font10bold">Useage : </SPAN>
2712 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2713 <span class="font10bold" style="color: #0000FF">get_form_name ( )</SPAN>
2714 <BR>
2715
2716 <BR>
2717 <SPAN CLASS="font10bold">Description : </SPAN>
2718 <!-- ========== Info from phpDoc block ========= -->
2719 This function is used to get
2720 the form name
2721 <BR>
2722
2723 <DL>
2724 <DT class="font10bold">Function Parameters:</DT>
2725
2726
2727 <DT class="font10bold">Function Info:</DT>
2728
2729 </DL>
2730
2731 </DIV>
2732 <BR>
2733
2734 <DIV CLASS="function">
2735 <A NAME='get_form_render'><!-- --></A>
2736 <SPAN CLASS="font12bold">get_form_render</SPAN>
2737 <BR>
2738 <SPAN CLASS="font10bold">Useage : </SPAN>
2739 <span class="font10bold" style="color: #FF0000">bool</SPAN>&nbsp;
2740 <span class="font10bold" style="color: #0000FF">get_form_render ( )</SPAN>
2741 <BR>
2742
2743 <BR>
2744 <SPAN CLASS="font10bold">Description : </SPAN>
2745 <!-- ========== Info from phpDoc block ========= -->
2746 Return the state of the form render
2747 <BR>
2748
2749 <DL>
2750 <DT class="font10bold">Function Parameters:</DT>
2751
2752
2753 <DT class="font10bold">Function Info:</DT>
2754
2755 </DL>
2756
2757 </DIV>
2758 <BR>
2759
2760 <DIV CLASS="function">
2761 <A NAME='get_form_target'><!-- --></A>
2762 <SPAN CLASS="font12bold">get_form_target</SPAN>
2763 <BR>
2764 <SPAN CLASS="font10bold">Useage : </SPAN>
2765 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2766 <span class="font10bold" style="color: #0000FF">get_form_target ( )</SPAN>
2767 <BR>
2768
2769 <BR>
2770 <SPAN CLASS="font10bold">Description : </SPAN>
2771 <!-- ========== Info from phpDoc block ========= -->
2772 This function is used to get
2773 the form target
2774 <BR>
2775
2776 <DL>
2777 <DT class="font10bold">Function Parameters:</DT>
2778
2779
2780 <DT class="font10bold">Function Info:</DT>
2781
2782 </DL>
2783
2784 </DIV>
2785 <BR>
2786
2787 <DIV CLASS="function">
2788 <A NAME='get_global_prefix'><!-- --></A>
2789 <SPAN CLASS="font12bold">get_global_prefix</SPAN>
2790 <BR>
2791 <SPAN CLASS="font10bold">Useage : </SPAN>
2792 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2793 <span class="font10bold" style="color: #0000FF">get_global_prefix ( )</SPAN>
2794 <BR>
2795
2796 <BR>
2797 <SPAN CLASS="font10bold">Description : </SPAN>
2798 <!-- ========== Info from phpDoc block ========= -->
2799 returns the current variable prefix
2800 string being used.
2801 <BR>
2802
2803 <DL>
2804 <DT class="font10bold">Function Parameters:</DT>
2805
2806
2807 <DT class="font10bold">Function Info:</DT>
2808
2809 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - current global prefix</DD>
2810
2811 </DL>
2812
2813 </DIV>
2814 <BR>
2815
2816 <DIV CLASS="function">
2817 <A NAME='get_image_path'><!-- --></A>
2818 <SPAN CLASS="font12bold">get_image_path</SPAN>
2819 <BR>
2820 <SPAN CLASS="font10bold">Useage : </SPAN>
2821 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2822 <span class="font10bold" style="color: #0000FF">get_image_path ( )</SPAN>
2823 <BR>
2824
2825 <BR>
2826 <SPAN CLASS="font10bold">Description : </SPAN>
2827 <!-- ========== Info from phpDoc block ========= -->
2828 This function returns the path to the
2829 images used in this class
2830 <BR>
2831
2832 <DL>
2833 <DT class="font10bold">Function Parameters:</DT>
2834
2835
2836 <DT class="font10bold">Function Info:</DT>
2837
2838 </DL>
2839
2840 </DIV>
2841 <BR>
2842
2843 <DIV CLASS="function">
2844 <A NAME='get_last_page'><!-- --></A>
2845 <SPAN CLASS="font12bold">get_last_page</SPAN>
2846 <BR>
2847 <SPAN CLASS="font10bold">Useage : </SPAN>
2848 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
2849 <span class="font10bold" style="color: #0000FF">get_last_page ( )</SPAN>
2850 <BR>
2851
2852 <BR>
2853 <SPAN CLASS="font10bold">Description : </SPAN>
2854 <!-- ========== Info from phpDoc block ========= -->
2855 This calculates the last page #
2856 for this list of items
2857 <BR>
2858
2859 <DL>
2860 <DT class="font10bold">Function Parameters:</DT>
2861
2862
2863 <DT class="font10bold">Function Info:</DT>
2864
2865 </DL>
2866
2867 </DIV>
2868 <BR>
2869
2870 <DIV CLASS="function">
2871 <A NAME='get_max_rows'><!-- --></A>
2872 <SPAN CLASS="font12bold">get_max_rows</SPAN>
2873 <BR>
2874 <SPAN CLASS="font10bold">Useage : </SPAN>
2875 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
2876 <span class="font10bold" style="color: #0000FF">get_max_rows ( )</SPAN>
2877 <BR>
2878
2879 <BR>
2880 <SPAN CLASS="font10bold">Description : </SPAN>
2881 <!-- ========== Info from phpDoc block ========= -->
2882 This returns the Maximum # of rows to
2883 display when in expand mode
2884 <BR>
2885
2886 <DL>
2887 <DT class="font10bold">Function Parameters:</DT>
2888
2889
2890 <DT class="font10bold">Function Info:</DT>
2891
2892 </DL>
2893
2894 </DIV>
2895 <BR>
2896
2897 <DIV CLASS="function">
2898 <A NAME='get_num_pages'><!-- --></A>
2899 <SPAN CLASS="font12bold">get_num_pages</SPAN>
2900 <BR>
2901 <SPAN CLASS="font10bold">Useage : </SPAN>
2902 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
2903 <span class="font10bold" style="color: #0000FF">get_num_pages ( )</SPAN>
2904 <BR>
2905
2906 <BR>
2907 <SPAN CLASS="font10bold">Description : </SPAN>
2908 <!-- ========== Info from phpDoc block ========= -->
2909 This function returns the #
2910 of pages that are available
2911 for this list of items.
2912 <BR>
2913
2914 <DL>
2915 <DT class="font10bold">Function Parameters:</DT>
2916
2917
2918 <DT class="font10bold">Function Info:</DT>
2919
2920 </DL>
2921
2922 </DIV>
2923 <BR>
2924
2925 <DIV CLASS="function">
2926 <A NAME='get_page_info'><!-- --></A>
2927 <SPAN CLASS="font12bold">get_page_info</SPAN>
2928 <BR>
2929 <SPAN CLASS="font10bold">Useage : </SPAN>
2930 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
2931 <span class="font10bold" style="color: #0000FF">get_page_info ( )</SPAN>
2932 <BR>
2933
2934 <BR>
2935 <SPAN CLASS="font10bold">Description : </SPAN>
2936 <!-- ========== Info from phpDoc block ========= -->
2937 This function builds the string
2938 <BR>
2939 that describes the current page
2940 out of n pages the list is showing
2941 <DL>
2942 <DT class="font10bold">Function Parameters:</DT>
2943
2944
2945 <DT class="font10bold">Function Info:</DT>
2946
2947 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (ie. 1 to 10 of 25)</DD>
2948
2949 </DL>
2950
2951 </DIV>
2952 <BR>
2953
2954 <DIV CLASS="function">
2955 <A NAME='get_simple_search_modifier'><!-- --></A>
2956 <SPAN CLASS="font12bold">get_simple_search_modifier</SPAN>
2957 <BR>
2958 <SPAN CLASS="font10bold">Useage : </SPAN>
2959 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2960 <span class="font10bold" style="color: #0000FF">get_simple_search_modifier ( )</SPAN>
2961 <BR>
2962
2963 <BR>
2964 <SPAN CLASS="font10bold">Description : </SPAN>
2965 <!-- ========== Info from phpDoc block ========= -->
2966 gets the value of the search modifier
2967 flag.
2968 <BR>
2969
2970 <DL>
2971 <DT class="font10bold">Function Parameters:</DT>
2972
2973
2974 <DT class="font10bold">Function Info:</DT>
2975
2976 </DL>
2977
2978 </DIV>
2979 <BR>
2980
2981 <DIV CLASS="function">
2982 <A NAME='gui_init'><!-- --></A>
2983 <SPAN CLASS="font12bold">gui_init</SPAN>
2984 <BR>
2985 <SPAN CLASS="font10bold">Useage : </SPAN>
2986 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
2987 <span class="font10bold" style="color: #0000FF">gui_init ( )</SPAN>
2988 <BR>
2989 Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#gui_init">DefaultGUIDatalist::gui_init()</a><br>
2990 <BR>
2991 <SPAN CLASS="font10bold">Description : </SPAN>
2992 <!-- ========== Info from phpDoc block ========= -->
2993 A subclass can override this function
2994 to setup the class variables after
2995 the constructor.
2996 <BR>
2997 The constructor
2998 automatically calls this function.
2999 <DL>
3000 <DT class="font10bold">Function Parameters:</DT>
3001
3002
3003 <DT class="font10bold">Function Info:</DT>
3004
3005 </DL>
3006
3007 </DIV>
3008 <BR>
3009
3010 <DIV CLASS="function">
3011 <A NAME='is_advanced_search_enabled'><!-- --></A>
3012 <SPAN CLASS="font12bold">is_advanced_search_enabled</SPAN>
3013 <BR>
3014 <SPAN CLASS="font10bold">Useage : </SPAN>
3015 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
3016 <span class="font10bold" style="color: #0000FF">is_advanced_search_enabled ( )</SPAN>
3017 <BR>
3018
3019 <BR>
3020 <SPAN CLASS="font10bold">Description : </SPAN>
3021 <!-- ========== Info from phpDoc block ========= -->
3022 This returns the status of the
3023 advanced search flag.
3024 <BR>
3025
3026 <DL>
3027 <DT class="font10bold">Function Parameters:</DT>
3028
3029
3030 <DT class="font10bold">Function Info:</DT>
3031
3032 </DL>
3033
3034 </DIV>
3035 <BR>
3036
3037 <DIV CLASS="function">
3038 <A NAME='is_search_enabled'><!-- --></A>
3039 <SPAN CLASS="font12bold">is_search_enabled</SPAN>
3040 <BR>
3041 <SPAN CLASS="font10bold">Useage : </SPAN>
3042 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
3043 <span class="font10bold" style="color: #0000FF">is_search_enabled ( )</SPAN>
3044 <BR>
3045
3046 <BR>
3047 <SPAN CLASS="font10bold">Description : </SPAN>
3048 <!-- ========== Info from phpDoc block ========= -->
3049 get the status of the search
3050 ability.
3051 <BR>
3052
3053 <DL>
3054 <DT class="font10bold">Function Parameters:</DT>
3055
3056
3057 <DT class="font10bold">Function Info:</DT>
3058
3059 </DL>
3060
3061 </DIV>
3062 <BR>
3063
3064 <DIV CLASS="function">
3065 <A NAME='numrows'><!-- --></A>
3066 <SPAN CLASS="font12bold">numrows</SPAN>
3067 <BR>
3068 <SPAN CLASS="font10bold">Useage : </SPAN>
3069 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
3070 <span class="font10bold" style="color: #0000FF">numrows ( )</SPAN>
3071 <BR>
3072
3073 <BR>
3074 <SPAN CLASS="font10bold">Description : </SPAN>
3075 <!-- ========== Info from phpDoc block ========= -->
3076 This function returns the number of rows
3077 that the query found.
3078 <BR>
3079
3080 <DL>
3081 <DT class="font10bold">Function Parameters:</DT>
3082
3083
3084 <DT class="font10bold">Function Info:</DT>
3085
3086 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the number of rows</DD>
3087
3088 </DL>
3089
3090 </DIV>
3091 <BR>
3092
3093 <DIV CLASS="function">
3094 <A NAME='offset'><!-- --></A>
3095 <SPAN CLASS="font12bold">offset</SPAN>
3096 <BR>
3097 <SPAN CLASS="font10bold">Useage : </SPAN>
3098 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
3099 <span class="font10bold" style="color: #0000FF">offset ( )</SPAN>
3100 <BR>
3101
3102 <BR>
3103 <SPAN CLASS="font10bold">Description : </SPAN>
3104 <!-- ========== Info from phpDoc block ========= -->
3105 This function returns the current value
3106 of the offset variable.
3107 <BR>
3108 This is an offset
3109 into the query return data set.
3110 <DL>
3111 <DT class="font10bold">Function Parameters:</DT>
3112
3113
3114 <DT class="font10bold">Function Info:</DT>
3115
3116 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current value.</DD>
3117
3118 </DL>
3119
3120 </DIV>
3121 <BR>
3122
3123 <DIV CLASS="function">
3124 <A NAME='orderby'><!-- --></A>
3125 <SPAN CLASS="font12bold">orderby</SPAN>
3126 <BR>
3127 <SPAN CLASS="font10bold">Useage : </SPAN>
3128 <span class="font10bold" style="color: #FF0000">string.</SPAN>&nbsp;
3129 <span class="font10bold" style="color: #0000FF">orderby ( )</SPAN>
3130 <BR>
3131
3132 <BR>
3133 <SPAN CLASS="font10bold">Description : </SPAN>
3134 <!-- ========== Info from phpDoc block ========= -->
3135 This function returns the value of the
3136 current orderby variable.
3137 <BR>
3138
3139 <DL>
3140 <DT class="font10bold">Function Parameters:</DT>
3141
3142
3143 <DT class="font10bold">Function Info:</DT>
3144
3145 </DL>
3146
3147 </DIV>
3148 <BR>
3149
3150 <DIV CLASS="function">
3151 <A NAME='render'><!-- --></A>
3152 <SPAN CLASS="font12bold">render</SPAN>
3153 <BR>
3154 <SPAN CLASS="font10bold">Useage : </SPAN>
3155 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3156 <span class="font10bold" style="color: #0000FF">render ( $indent_level, $output_debug )</SPAN>
3157 <BR>
3158
3159 <BR>
3160 <SPAN CLASS="font10bold">Description : </SPAN>
3161 <!-- ========== Info from phpDoc block ========= -->
3162 This function renders the final
3163 widget
3164 <BR>
3165
3166 <DL>
3167 <DT class="font10bold">Function Parameters:</DT>
3168
3169
3170 <DT class="font10bold">Function Info:</DT>
3171
3172 </DL>
3173
3174 </DIV>
3175 <BR>
3176
3177 <DIV CLASS="function">
3178 <A NAME='reverseorder'><!-- --></A>
3179 <SPAN CLASS="font12bold">reverseorder</SPAN>
3180 <BR>
3181 <SPAN CLASS="font10bold">Useage : </SPAN>
3182 <span class="font10bold" style="color: #FF0000">string.</SPAN>&nbsp;
3183 <span class="font10bold" style="color: #0000FF">reverseorder ( )</SPAN>
3184 <BR>
3185
3186 <BR>
3187 <SPAN CLASS="font10bold">Description : </SPAN>
3188 <!-- ========== Info from phpDoc block ========= -->
3189 This function returns the current value of
3190 the reverse order member variable.
3191 <BR>
3192
3193 <DL>
3194 <DT class="font10bold">Function Parameters:</DT>
3195
3196
3197 <DT class="font10bold">Function Info:</DT>
3198
3199 </DL>
3200
3201 </DIV>
3202 <BR>
3203
3204 <DIV CLASS="function">
3205 <A NAME='search_disable'><!-- --></A>
3206 <SPAN CLASS="font12bold">search_disable</SPAN>
3207 <BR>
3208 <SPAN CLASS="font10bold">Useage : </SPAN>
3209 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3210 <span class="font10bold" style="color: #0000FF">search_disable ( )</SPAN>
3211 <BR>
3212
3213 <BR>
3214 <SPAN CLASS="font10bold">Description : </SPAN>
3215 <!-- ========== Info from phpDoc block ========= -->
3216 Disable the search ability.
3217 <BR>
3218
3219 <DL>
3220 <DT class="font10bold">Function Parameters:</DT>
3221
3222 <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">0</SPAN></SPAN> </DD>
3223
3224
3225 <DT class="font10bold">Function Info:</DT>
3226
3227 </DL>
3228
3229 </DIV>
3230 <BR>
3231
3232 <DIV CLASS="function">
3233 <A NAME='search_enable'><!-- --></A>
3234 <SPAN CLASS="font12bold">search_enable</SPAN>
3235 <BR>
3236 <SPAN CLASS="font10bold">Useage : </SPAN>
3237 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3238 <span class="font10bold" style="color: #0000FF">search_enable ( )</SPAN>
3239 <BR>
3240
3241 <BR>
3242 <SPAN CLASS="font10bold">Description : </SPAN>
3243 <!-- ========== Info from phpDoc block ========= -->
3244 Enable the search ability.
3245 <BR>
3246
3247 <DL>
3248 <DT class="font10bold">Function Parameters:</DT>
3249
3250 <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">0</SPAN></SPAN> </DD>
3251
3252
3253 <DT class="font10bold">Function Info:</DT>
3254
3255 </DL>
3256
3257 </DIV>
3258 <BR>
3259
3260 <DIV CLASS="function">
3261 <A NAME='search_field'><!-- --></A>
3262 <SPAN CLASS="font12bold">search_field</SPAN>
3263 <BR>
3264 <SPAN CLASS="font10bold">Useage : </SPAN>
3265 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3266 <span class="font10bold" style="color: #0000FF">search_field ( )</SPAN>
3267 <BR>
3268
3269 <BR>
3270 <SPAN CLASS="font10bold">Description : </SPAN>
3271 <!-- ========== Info from phpDoc block ========= -->
3272 returns the current value of
3273 the search field name
3274 <BR>
3275
3276 <DL>
3277 <DT class="font10bold">Function Parameters:</DT>
3278
3279
3280 <DT class="font10bold">Function Info:</DT>
3281
3282 </DL>
3283
3284 </DIV>
3285 <BR>
3286
3287 <DIV CLASS="function">
3288 <A NAME='search_type'><!-- --></A>
3289 <SPAN CLASS="font12bold">search_type</SPAN>
3290 <BR>
3291 <SPAN CLASS="font10bold">Useage : </SPAN>
3292 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3293 <span class="font10bold" style="color: #0000FF">search_type ( )</SPAN>
3294 <BR>
3295
3296 <BR>
3297 <SPAN CLASS="font10bold">Description : </SPAN>
3298 <!-- ========== Info from phpDoc block ========= -->
3299 returns the type of search being used
3300 <BR>
3301
3302 <DL>
3303 <DT class="font10bold">Function Parameters:</DT>
3304
3305
3306 <DT class="font10bold">Function Info:</DT>
3307
3308 </DL>
3309
3310 </DIV>
3311 <BR>
3312
3313 <DIV CLASS="function">
3314 <A NAME='search_value'><!-- --></A>
3315 <SPAN CLASS="font12bold">search_value</SPAN>
3316 <BR>
3317 <SPAN CLASS="font10bold">Useage : </SPAN>
3318 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3319 <span class="font10bold" style="color: #0000FF">search_value ( )</SPAN>
3320 <BR>
3321
3322 <BR>
3323 <SPAN CLASS="font10bold">Description : </SPAN>
3324 <!-- ========== Info from phpDoc block ========= -->
3325 returns the current value of
3326 te search field value.
3327 <BR>
3328
3329 <DL>
3330 <DT class="font10bold">Function Parameters:</DT>
3331
3332
3333 <DT class="font10bold">Function Info:</DT>
3334
3335 </DL>
3336
3337 </DIV>
3338 <BR>
3339
3340 <DIV CLASS="function">
3341 <A NAME='search_value_filter'><!-- --></A>
3342 <SPAN CLASS="font12bold">search_value_filter</SPAN>
3343 <BR>
3344 <SPAN CLASS="font10bold">Useage : </SPAN>
3345 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3346 <span class="font10bold" style="color: #0000FF">search_value_filter ( $value )</SPAN>
3347 <BR>
3348
3349 <BR>
3350 <SPAN CLASS="font10bold">Description : </SPAN>
3351 <!-- ========== Info from phpDoc block ========= -->
3352 This function is used to make safe
3353 any query string value that is used
3354 <BR>
3355
3356 <DL>
3357 <DT class="font10bold">Function Parameters:</DT>
3358
3359 <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">$value</SPAN></SPAN> </DD>
3360
3361
3362 <DT class="font10bold">Function Info:</DT>
3363
3364 </DL>
3365
3366 </DIV>
3367 <BR>
3368
3369 <DIV CLASS="function">
3370 <A NAME='setup_columns'><!-- --></A>
3371 <SPAN CLASS="font12bold">setup_columns</SPAN>
3372 <BR>
3373 <SPAN CLASS="font10bold">Useage : </SPAN>
3374 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3375 <span class="font10bold" style="color: #0000FF">setup_columns ( )</SPAN>
3376 <BR>
3377
3378 <BR>
3379 <SPAN CLASS="font10bold">Description : </SPAN>
3380 <!-- ========== Info from phpDoc block ========= -->
3381
3382 <BR>
3383
3384 <DL>
3385 <DT class="font10bold">Function Parameters:</DT>
3386
3387
3388 <DT class="font10bold">Function Info:</DT>
3389
3390 </DL>
3391
3392 </DIV>
3393 <BR>
3394
3395 <DIV CLASS="function">
3396 <A NAME='set_data_source'><!-- --></A>
3397 <SPAN CLASS="font12bold">set_data_source</SPAN>
3398 <BR>
3399 <SPAN CLASS="font10bold">Useage : </SPAN>
3400 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3401 <span class="font10bold" style="color: #0000FF">set_data_source ( $datasource )</SPAN>
3402 <BR>
3403
3404 <BR>
3405 <SPAN CLASS="font10bold">Description : </SPAN>
3406 <!-- ========== Info from phpDoc block ========= -->
3407 This function is used to set the
3408 DataListSource object for this instance
3409 <BR>
3410
3411 <DL>
3412 <DT class="font10bold">Function Parameters:</DT>
3413
3414 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></SPAN> <span style="color: #0000FF;font-weight:bold">$datasource</SPAN></SPAN> object</DD>
3415
3416
3417 <DT class="font10bold">Function Info:</DT>
3418
3419 </DL>
3420
3421 </DIV>
3422 <BR>
3423
3424 <DIV CLASS="function">
3425 <A NAME='set_default_num_rows'><!-- --></A>
3426 <SPAN CLASS="font12bold">set_default_num_rows</SPAN>
3427 <BR>
3428 <SPAN CLASS="font10bold">Useage : </SPAN>
3429 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3430 <span class="font10bold" style="color: #0000FF">set_default_num_rows ( $num_rows )</SPAN>
3431 <BR>
3432
3433 <BR>
3434 <SPAN CLASS="font10bold">Description : </SPAN>
3435 <!-- ========== Info from phpDoc block ========= -->
3436 This function sets the default # of rows
3437 per page to display.
3438 <BR>
3439 By default its 10.
3440 This lets the user override this value.
3441 <DL>
3442 <DT class="font10bold">Function Parameters:</DT>
3443
3444 <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">$num_rows</SPAN></SPAN> - the # of rows to use.</DD>
3445
3446
3447 <DT class="font10bold">Function Info:</DT>
3448
3449 </DL>
3450
3451 </DIV>
3452 <BR>
3453
3454 <DIV CLASS="function">
3455 <A NAME='set_form_action'><!-- --></A>
3456 <SPAN CLASS="font12bold">set_form_action</SPAN>
3457 <BR>
3458 <SPAN CLASS="font10bold">Useage : </SPAN>
3459 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3460 <span class="font10bold" style="color: #0000FF">set_form_action ( $action )</SPAN>
3461 <BR>
3462
3463 <BR>
3464 <SPAN CLASS="font10bold">Description : </SPAN>
3465 <!-- ========== Info from phpDoc block ========= -->
3466 Sets the form action
3467 <BR>
3468
3469 <DL>
3470 <DT class="font10bold">Function Parameters:</DT>
3471
3472 <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">$action</SPAN></SPAN> </DD>
3473
3474
3475 <DT class="font10bold">Function Info:</DT>
3476
3477 </DL>
3478
3479 </DIV>
3480 <BR>
3481
3482 <DIV CLASS="function">
3483 <A NAME='set_form_method'><!-- --></A>
3484 <SPAN CLASS="font12bold">set_form_method</SPAN>
3485 <BR>
3486 <SPAN CLASS="font10bold">Useage : </SPAN>
3487 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3488 <span class="font10bold" style="color: #0000FF">set_form_method ( $method )</SPAN>
3489 <BR>
3490
3491 <BR>
3492 <SPAN CLASS="font10bold">Description : </SPAN>
3493 <!-- ========== Info from phpDoc block ========= -->
3494 This function is used to set the
3495 form method
3496 <BR>
3497
3498 <DL>
3499 <DT class="font10bold">Function Parameters:</DT>
3500
3501 <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">$method</SPAN></SPAN> (POST or GET)</DD>
3502
3503
3504 <DT class="font10bold">Function Info:</DT>
3505
3506 </DL>
3507
3508 </DIV>
3509 <BR>
3510
3511 <DIV CLASS="function">
3512 <A NAME='set_form_name'><!-- --></A>
3513 <SPAN CLASS="font12bold">set_form_name</SPAN>
3514 <BR>
3515 <SPAN CLASS="font10bold">Useage : </SPAN>
3516 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3517 <span class="font10bold" style="color: #0000FF">set_form_name ( $name )</SPAN>
3518 <BR>
3519
3520 <BR>
3521 <SPAN CLASS="font10bold">Description : </SPAN>
3522 <!-- ========== Info from phpDoc block ========= -->
3523 This function is used to set the
3524 form name
3525 <BR>
3526
3527 <DL>
3528 <DT class="font10bold">Function Parameters:</DT>
3529
3530 <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">$name</SPAN></SPAN> </DD>
3531
3532
3533 <DT class="font10bold">Function Info:</DT>
3534
3535 </DL>
3536
3537 </DIV>
3538 <BR>
3539
3540 <DIV CLASS="function">
3541 <A NAME='set_form_render'><!-- --></A>
3542 <SPAN CLASS="font12bold">set_form_render</SPAN>
3543 <BR>
3544 <SPAN CLASS="font10bold">Useage : </SPAN>
3545 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3546 <span class="font10bold" style="color: #0000FF">set_form_render ( $flag )</SPAN>
3547 <BR>
3548
3549 <BR>
3550 <SPAN CLASS="font10bold">Description : </SPAN>
3551 <!-- ========== Info from phpDoc block ========= -->
3552 Sets whether to the output into a form
3553 <BR>
3554
3555 <DL>
3556 <DT class="font10bold">Function Parameters:</DT>
3557
3558 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">bool</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD>
3559
3560
3561 <DT class="font10bold">Function Info:</DT>
3562
3563 </DL>
3564
3565 </DIV>
3566 <BR>
3567
3568 <DIV CLASS="function">
3569 <A NAME='set_form_target'><!-- --></A>
3570 <SPAN CLASS="font12bold">set_form_target</SPAN>
3571 <BR>
3572 <SPAN CLASS="font10bold">Useage : </SPAN>
3573 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3574 <span class="font10bold" style="color: #0000FF">set_form_target ( $target )</SPAN>
3575 <BR>
3576
3577 <BR>
3578 <SPAN CLASS="font10bold">Description : </SPAN>
3579 <!-- ========== Info from phpDoc block ========= -->
3580 This function is used to set the
3581 form target
3582 <BR>
3583
3584 <DL>
3585 <DT class="font10bold">Function Parameters:</DT>
3586
3587 <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">$target</SPAN></SPAN> </DD>
3588
3589
3590 <DT class="font10bold">Function Info:</DT>
3591
3592 </DL>
3593
3594 </DIV>
3595 <BR>
3596
3597 <DIV CLASS="function">
3598 <A NAME='set_global_prefix'><!-- --></A>
3599 <SPAN CLASS="font12bold">set_global_prefix</SPAN>
3600 <BR>
3601 <SPAN CLASS="font10bold">Useage : </SPAN>
3602 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3603 <span class="font10bold" style="color: #0000FF">set_global_prefix ( $prefix )</SPAN>
3604 <BR>
3605
3606 <BR>
3607 <SPAN CLASS="font10bold">Description : </SPAN>
3608 <!-- ========== Info from phpDoc block ========= -->
3609 This function sets a prefix for all
3610 variables that are used in the item list
3611 table on a page.
3612 <BR>
3613 This allows you to have
3614 multiple itemlists on a single html page.
3615 <DL>
3616 <DT class="font10bold">Function Parameters:</DT>
3617
3618 <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">$prefix</SPAN></SPAN> - the prefix for all vars.</DD>
3619
3620
3621 <DT class="font10bold">Function Info:</DT>
3622
3623 </DL>
3624
3625 </DIV>
3626 <BR>
3627
3628 <DIV CLASS="function">
3629 <A NAME='set_image_path'><!-- --></A>
3630 <SPAN CLASS="font12bold">set_image_path</SPAN>
3631 <BR>
3632 <SPAN CLASS="font10bold">Useage : </SPAN>
3633 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3634 <span class="font10bold" style="color: #0000FF">set_image_path ( $path )</SPAN>
3635 <BR>
3636
3637 <BR>
3638 <SPAN CLASS="font10bold">Description : </SPAN>
3639 <!-- ========== Info from phpDoc block ========= -->
3640 This function returns the path to the
3641 images used in this class
3642 <BR>
3643
3644 <DL>
3645 <DT class="font10bold">Function Parameters:</DT>
3646
3647
3648 <DT class="font10bold">Function Info:</DT>
3649
3650 </DL>
3651
3652 </DIV>
3653 <BR>
3654
3655 <DIV CLASS="function">
3656 <A NAME='set_max_rows'><!-- --></A>
3657 <SPAN CLASS="font12bold">set_max_rows</SPAN>
3658 <BR>
3659 <SPAN CLASS="font10bold">Useage : </SPAN>
3660 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3661 <span class="font10bold" style="color: #0000FF">set_max_rows ( $max )</SPAN>
3662 <BR>
3663
3664 <BR>
3665 <SPAN CLASS="font10bold">Description : </SPAN>
3666 <!-- ========== Info from phpDoc block ========= -->
3667 This sets the maximum # of rows to
3668 display when in expand mode
3669 <BR>
3670
3671 <DL>
3672 <DT class="font10bold">Function Parameters:</DT>
3673
3674 <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">$max</SPAN></SPAN> - new # of maximum rows
3675 to display when in 'expand' mode</DD>
3676
3677
3678 <DT class="font10bold">Function Info:</DT>
3679
3680 </DL>
3681
3682 </DIV>
3683 <BR>
3684
3685 <DIV CLASS="function">
3686 <A NAME='set_not_found_message'><!-- --></A>
3687 <SPAN CLASS="font12bold">set_not_found_message</SPAN>
3688 <BR>
3689 <SPAN CLASS="font10bold">Useage : </SPAN>
3690 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3691 <span class="font10bold" style="color: #0000FF">set_not_found_message ( $mesg )</SPAN>
3692 <BR>
3693
3694 <BR>
3695 <SPAN CLASS="font10bold">Description : </SPAN>
3696 <!-- ========== Info from phpDoc block ========= -->
3697 This function is used to set the
3698 message displayed when no data is found
3699 <BR>
3700
3701 <DL>
3702 <DT class="font10bold">Function Parameters:</DT>
3703
3704 <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">$mesg</SPAN></SPAN> </DD>
3705
3706
3707 <DT class="font10bold">Function Info:</DT>
3708
3709 </DL>
3710
3711 </DIV>
3712 <BR>
3713
3714 <DIV CLASS="function">
3715 <A NAME='set_numrows'><!-- --></A>
3716 <SPAN CLASS="font12bold">set_numrows</SPAN>
3717 <BR>
3718 <SPAN CLASS="font10bold">Useage : </SPAN>
3719 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3720 <span class="font10bold" style="color: #0000FF">set_numrows ( $new_numrows )</SPAN>
3721 <BR>
3722
3723 <BR>
3724 <SPAN CLASS="font10bold">Description : </SPAN>
3725 <!-- ========== Info from phpDoc block ========= -->
3726 This function sets the # of rows to display
3727 per page.
3728 <BR>
3729
3730 <DL>
3731 <DT class="font10bold">Function Parameters:</DT>
3732
3733 <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">$new_numrows</SPAN></SPAN> - the # of rows</DD>
3734
3735
3736 <DT class="font10bold">Function Info:</DT>
3737
3738 </DL>
3739
3740 </DIV>
3741 <BR>
3742
3743 <DIV CLASS="function">
3744 <A NAME='set_offset'><!-- --></A>
3745 <SPAN CLASS="font12bold">set_offset</SPAN>
3746 <BR>
3747 <SPAN CLASS="font10bold">Useage : </SPAN>
3748 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3749 <span class="font10bold" style="color: #0000FF">set_offset ( $new_offset )</SPAN>
3750 <BR>
3751
3752 <BR>
3753 <SPAN CLASS="font10bold">Description : </SPAN>
3754 <!-- ========== Info from phpDoc block ========= -->
3755 This function is used to set/change
3756 the offset for this list.
3757 <BR>
3758
3759 <DL>
3760 <DT class="font10bold">Function Parameters:</DT>
3761
3762 <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">$new_offset</SPAN></SPAN> - the new offset.</DD>
3763
3764
3765 <DT class="font10bold">Function Info:</DT>
3766
3767 </DL>
3768
3769 </DIV>
3770 <BR>
3771
3772 <DIV CLASS="function">
3773 <A NAME='set_reverseorder'><!-- --></A>
3774 <SPAN CLASS="font12bold">set_reverseorder</SPAN>
3775 <BR>
3776 <SPAN CLASS="font10bold">Useage : </SPAN>
3777 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3778 <span class="font10bold" style="color: #0000FF">set_reverseorder ( $new_value )</SPAN>
3779 <BR>
3780
3781 <BR>
3782 <SPAN CLASS="font10bold">Description : </SPAN>
3783 <!-- ========== Info from phpDoc block ========= -->
3784 This function sets the reverse order flag
3785 to a new value.
3786 <BR>
3787
3788 <DL>
3789 <DT class="font10bold">Function Parameters:</DT>
3790
3791 <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">$new_value</SPAN></SPAN> - the new value.</DD>
3792
3793
3794 <DT class="font10bold">Function Info:</DT>
3795
3796 </DL>
3797
3798 </DIV>
3799 <BR>
3800
3801 <DIV CLASS="function">
3802 <A NAME='set_save_vars'><!-- --></A>
3803 <SPAN CLASS="font12bold">set_save_vars</SPAN>
3804 <BR>
3805 <SPAN CLASS="font10bold">Useage : </SPAN>
3806 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3807 <span class="font10bold" style="color: #0000FF">set_save_vars ( $vars )</SPAN>
3808 <BR>
3809
3810 <BR>
3811 <SPAN CLASS="font10bold">Description : </SPAN>
3812 <!-- ========== Info from phpDoc block ========= -->
3813 This function sets the save variables
3814 <BR>
3815 that the user/child wants to automatically
3816 propogate
3817 <DL>
3818 <DT class="font10bold">Function Parameters:</DT>
3819
3820 <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">$vars</SPAN></SPAN> - name=&gt;value pairs of the data
3821 that they want to propogate</DD>
3822
3823
3824 <DT class="font10bold">Function Info:</DT>
3825
3826 </DL>
3827
3828 </DIV>
3829 <BR>
3830
3831 <DIV CLASS="function">
3832 <A NAME='set_save_vars'><!-- --></A>
3833 <SPAN CLASS="font12bold">set_save_vars</SPAN>
3834 <BR>
3835 <SPAN CLASS="font10bold">Useage : </SPAN>
3836 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3837 <span class="font10bold" style="color: #0000FF">set_save_vars ( $vars )</SPAN>
3838 <BR>
3839
3840 <BR>
3841 <SPAN CLASS="font10bold">Description : </SPAN>
3842 <!-- ========== Info from phpDoc block ========= -->
3843 This function sets the save variables
3844 <BR>
3845 that the user/child wants to automatically
3846 propogate
3847 <DL>
3848 <DT class="font10bold">Function Parameters:</DT>
3849
3850 <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">$vars</SPAN></SPAN> - name=&gt;value pairs of the data
3851 that they want to propogate</DD>
3852
3853
3854 <DT class="font10bold">Function Info:</DT>
3855
3856 </DL>
3857
3858 </DIV>
3859 <BR>
3860
3861 <DIV CLASS="function">
3862 <A NAME='set_search_type'><!-- --></A>
3863 <SPAN CLASS="font12bold">set_search_type</SPAN>
3864 <BR>
3865 <SPAN CLASS="font10bold">Useage : </SPAN>
3866 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3867 <span class="font10bold" style="color: #0000FF">set_search_type ( $type )</SPAN>
3868 <BR>
3869
3870 <BR>
3871 <SPAN CLASS="font10bold">Description : </SPAN>
3872 <!-- ========== Info from phpDoc block ========= -->
3873 This function sets the search type
3874 <BR>
3875
3876 <DL>
3877 <DT class="font10bold">Function Parameters:</DT>
3878
3879 <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">$type</SPAN></SPAN> - the search type
3880 &quot;simple&quot; or &quot;advanced&quot;</DD>
3881
3882
3883 <DT class="font10bold">Function Info:</DT>
3884
3885 </DL>
3886
3887 </DIV>
3888 <BR>
3889
3890 <DIV CLASS="function">
3891 <A NAME='set_show_results'><!-- --></A>
3892 <SPAN CLASS="font12bold">set_show_results</SPAN>
3893 <BR>
3894 <SPAN CLASS="font10bold">Useage : </SPAN>
3895 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3896 <span class="font10bold" style="color: #0000FF">set_show_results ( [$flag = TRUE] )</SPAN>
3897 <BR>
3898
3899 <BR>
3900 <SPAN CLASS="font10bold">Description : </SPAN>
3901 <!-- ========== Info from phpDoc block ========= -->
3902 This function is used to set the value
3903 of the _show_results_flag
3904 <BR>
3905
3906 <DL>
3907 <DT class="font10bold">Function Parameters:</DT>
3908
3909 <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 to show the results</DD>
3910
3911
3912 <DT class="font10bold">Function Info:</DT>
3913
3914 </DL>
3915
3916 </DIV>
3917 <BR>
3918
3919 <DIV CLASS="function">
3920 <A NAME='set_simple_search_modifier'><!-- --></A>
3921 <SPAN CLASS="font12bold">set_simple_search_modifier</SPAN>
3922 <BR>
3923 <SPAN CLASS="font10bold">Useage : </SPAN>
3924 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
3925 <span class="font10bold" style="color: #0000FF">set_simple_search_modifier ( [$modifier = SEARCH_ALL] )</SPAN>
3926 <BR>
3927
3928 <BR>
3929 <SPAN CLASS="font10bold">Description : </SPAN>
3930 <!-- ========== Info from phpDoc block ========= -->
3931 Set the simple search modifyer
3932 <BR>
3933 flag.
3934 NOTE: by default all the modifiers
3935 are enabled. You can limit the
3936 modifiers by passing in the
3937 string of defines of which ones
3938 you want enabled.
3939
3940 MODIFIERS:
3941 SEARCH_BEGINS_WITH
3942 SEARCH_CONTAINS
3943 SEARCH_EXACT
3944 SEARCH_ENDS_WITH
3945
3946 ie. SEARCH_BEGINS_WITH.SEARCH_EXACT
3947 will enable ONLY the
3948 &quot;begins with&quot; and &quot;exact&quot; modifiers.
3949 <DL>
3950 <DT class="font10bold">Function Parameters:</DT>
3951
3952 <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">$modifier</SPAN></SPAN> </DD>
3953
3954
3955 <DT class="font10bold">Function Info:</DT>
3956
3957 </DL>
3958
3959 </DIV>
3960 <BR>
3961
3962 <DIV CLASS="function">
3963 <A NAME='showall'><!-- --></A>
3964 <SPAN CLASS="font12bold">showall</SPAN>
3965 <BR>
3966 <SPAN CLASS="font10bold">Useage : </SPAN>
3967 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3968 <span class="font10bold" style="color: #0000FF">showall ( )</SPAN>
3969 <BR>
3970
3971 <BR>
3972 <SPAN CLASS="font10bold">Description : </SPAN>
3973 <!-- ========== Info from phpDoc block ========= -->
3974 returns the current value of the showall
3975 flag.
3976 <BR>
3977 This tells us if they want the entire
3978 list of data back from the DB.
3979 <DL>
3980 <DT class="font10bold">Function Parameters:</DT>
3981
3982
3983 <DT class="font10bold">Function Info:</DT>
3984
3985 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current value</DD>
3986
3987 </DL>
3988
3989 </DIV>
3990 <BR>
3991
3992 <DIV CLASS="function">
3993 <A NAME='simple_search_modifier_value'><!-- --></A>
3994 <SPAN CLASS="font12bold">simple_search_modifier_value</SPAN>
3995 <BR>
3996 <SPAN CLASS="font10bold">Useage : </SPAN>
3997 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
3998 <span class="font10bold" style="color: #0000FF">simple_search_modifier_value ( )</SPAN>
3999 <BR>
4000
4001 <BR>
4002 <SPAN CLASS="font10bold">Description : </SPAN>
4003 <!-- ========== Info from phpDoc block ========= -->
4004 returns the current value of the
4005 simple search modifier
4006 <BR>
4007
4008 <DL>
4009 <DT class="font10bold">Function Parameters:</DT>
4010
4011
4012 <DT class="font10bold">Function Info:</DT>
4013
4014 </DL>
4015
4016 </DIV>
4017 <BR>
4018
4019 <DIV CLASS="function">
4020 <A NAME='user_setup'><!-- --></A>
4021 <SPAN CLASS="font12bold">user_setup</SPAN>
4022 <BR>
4023 <SPAN CLASS="font10bold">Useage : </SPAN>
4024 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
4025 <span class="font10bold" style="color: #0000FF">user_setup ( )</SPAN>
4026 <BR>
4027
4028 <BR>
4029 <SPAN CLASS="font10bold">Description : </SPAN>
4030 <!-- ========== Info from phpDoc block ========= -->
4031 A subclass can override this function
4032 to setup the class variables after
4033 the constructor.
4034 <BR>
4035 The constructor
4036 automatically calls this function.
4037 <DL>
4038 <DT class="font10bold">Function Parameters:</DT>
4039
4040
4041 <DT class="font10bold">Function Info:</DT>
4042
4043 </DL>
4044
4045 </DIV>
4046 <BR>
4047
4048 <DIV CLASS="function">
4049 <A NAME='_build_save_vars'><!-- --></A>
4050 <SPAN CLASS="font12bold">_build_save_vars</SPAN>
4051 <BR>
4052 <SPAN CLASS="font10bold">Useage : </SPAN>
4053 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN>&nbsp;
4054 <span class="font10bold" style="color: #0000FF">_build_save_vars ( )</SPAN>
4055 <BR>
4056
4057 <BR>
4058 <SPAN CLASS="font10bold">Description : </SPAN>
4059 <!-- ========== Info from phpDoc block ========= -->
4060 this method builds some hidden
4061 form fields to automatically
4062 be placed inside the form.
4063 <BR>
4064
4065 <DL>
4066 <DT class="font10bold">Function Parameters:</DT>
4067
4068
4069 <DT class="font10bold">Function Info:</DT>
4070
4071 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>
4072
4073 </DL>
4074
4075 </DIV>
4076 <BR>
4077
4078 <DIV CLASS="function">
4079 <A NAME='_build_simple_search_modifier'><!-- --></A>
4080 <SPAN CLASS="font12bold">_build_simple_search_modifier</SPAN>
4081 <BR>
4082 <SPAN CLASS="font10bold">Useage : </SPAN>
4083 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></SPAN>&nbsp;
4084 <span class="font10bold" style="color: #0000FF">_build_simple_search_modifier ( )</SPAN>
4085 <BR>
4086
4087 <BR>
4088 <SPAN CLASS="font10bold">Description : </SPAN>
4089 <!-- ========== Info from phpDoc block ========= -->
4090 This builds the simple search modifier
4091 select box.
4092 <BR>
4093
4094 <DL>
4095 <DT class="font10bold">Function Parameters:</DT>
4096
4097
4098 <DT class="font10bold">Function Info:</DT>
4099
4100 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>
4101
4102 </DL>
4103
4104 </DIV>
4105 <BR>
4106
4107 <DIV CLASS="function">
4108 <A NAME='_build_tool_url'><!-- --></A>
4109 <SPAN CLASS="font12bold">_build_tool_url</SPAN>
4110 <BR>
4111 <SPAN CLASS="font10bold">Useage : </SPAN>
4112 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
4113 <span class="font10bold" style="color: #0000FF">_build_tool_url ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</SPAN>
4114 <BR>
4115
4116 <BR>
4117 <SPAN CLASS="font10bold">Description : </SPAN>
4118 <!-- ========== Info from phpDoc block ========= -->
4119 This function is used to build the url
4120 for a tool link.
4121 <BR>
4122 (first, prev, next, last, all)
4123 <DL>
4124 <DT class="font10bold">Function Parameters:</DT>
4125
4126 <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">$offset</SPAN></SPAN> - the offset for the link</DD>
4127
4128 <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">$showall_flag</SPAN></SPAN> - add the showall value to the url</DD>
4129
4130 <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">$showall_value</SPAN></SPAN> - the showall value to use if the flag is on</DD>
4131
4132
4133 <DT class="font10bold">Function Info:</DT>
4134
4135 </DL>
4136
4137 </DIV>
4138 <BR>
4139
4140 <DIV CLASS="function">
4141 <A NAME='_check_datasource'><!-- --></A>
4142 <SPAN CLASS="font12bold">_check_datasource</SPAN>
4143 <BR>
4144 <SPAN CLASS="font10bold">Useage : </SPAN>
4145 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
4146 <span class="font10bold" style="color: #0000FF">_check_datasource ( $function_name )</SPAN>
4147 <BR>
4148
4149 <BR>
4150 <SPAN CLASS="font10bold">Description : </SPAN>
4151 <!-- ========== Info from phpDoc block ========= -->
4152 general DataListSource object checker.
4153 <BR>
4154
4155 <DL>
4156 <DT class="font10bold">Function Parameters:</DT>
4157
4158
4159 <DT class="font10bold">Function Info:</DT>
4160
4161 </DL>
4162
4163 </DIV>
4164 <BR>
4165
4166 <DIV CLASS="function">
4167 <A NAME='_clean_string'><!-- --></A>
4168 <SPAN CLASS="font12bold">_clean_string</SPAN>
4169 <BR>
4170 <SPAN CLASS="font10bold">Useage : </SPAN>
4171 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
4172 <span class="font10bold" style="color: #0000FF">_clean_string ( $obj, $col_name )</SPAN>
4173 <BR>
4174
4175 <BR>
4176 <SPAN CLASS="font10bold">Description : </SPAN>
4177 <!-- ========== Info from phpDoc block ========= -->
4178 This function is used to make sure that the string we are
4179 placing in a cell has been &quot;cleaned&quot;
4180 <BR>
4181
4182 <DL>
4183 <DT class="font10bold">Function Parameters:</DT>
4184
4185 <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> - the cell object. It can be a string.</DD>
4186
4187 <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 name of the column this object/string
4188 will live</DD>
4189
4190
4191 <DT class="font10bold">Function Info:</DT>
4192
4193 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the cleaned string or object</DD>
4194
4195 </DL>
4196
4197 </DIV>
4198 <BR>
4199
4200 <DIV CLASS="function">
4201 <A NAME='_filter_column_string'><!-- --></A>
4202 <SPAN CLASS="font12bold">_filter_column_string</SPAN>
4203 <BR>
4204 <SPAN CLASS="font10bold">Useage : </SPAN>
4205 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
4206 <span class="font10bold" style="color: #0000FF">_filter_column_string ( $data )</SPAN>
4207 <BR>
4208
4209 <BR>
4210 <SPAN CLASS="font10bold">Description : </SPAN>
4211 <!-- ========== Info from phpDoc block ========= -->
4212 This does some magic filtering on the data
4213 that we display in a column.
4214 <BR>
4215 This helps
4216 to prevent nast data that may have html
4217 tags in it.
4218 <DL>
4219 <DT class="font10bold">Function Parameters:</DT>
4220
4221 <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">$data</SPAN></SPAN> - the column data u want to filter</DD>
4222
4223
4224 <DT class="font10bold">Function Info:</DT>
4225
4226 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the cleaned/filtered data</DD>
4227
4228 </DL>
4229
4230 </DIV>
4231 <BR>
4232
4233 <DIV CLASS="function">
4234 <A NAME='_get_searchable_fields'><!-- --></A>
4235 <SPAN CLASS="font12bold">_get_searchable_fields</SPAN>
4236 <BR>
4237 <SPAN CLASS="font10bold">Useage : </SPAN>
4238 <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
4239 <span class="font10bold" style="color: #0000FF">_get_searchable_fields ( )</SPAN>
4240 <BR>
4241
4242 <BR>
4243 <SPAN CLASS="font10bold">Description : </SPAN>
4244 <!-- ========== Info from phpDoc block ========= -->
4245 This method gets the array of
4246 searchable header fields (columns)
4247 <BR>
4248
4249 <DL>
4250 <DT class="font10bold">Function Parameters:</DT>
4251
4252
4253 <DT class="font10bold">Function Info:</DT>
4254
4255 </DL>
4256
4257 </DIV>
4258 <BR>
4259
4260 <DIV CLASS="function">
4261 <A NAME='_javascript'><!-- --></A>
4262 <SPAN CLASS="font12bold">_javascript</SPAN>
4263 <BR>
4264 <SPAN CLASS="font10bold">Useage : </SPAN>
4265 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></SPAN>&nbsp;
4266 <span class="font10bold" style="color: #0000FF">_javascript ( )</SPAN>
4267 <BR>
4268
4269 <BR>
4270 <SPAN CLASS="font10bold">Description : </SPAN>
4271 <!-- ========== Info from phpDoc block ========= -->
4272 This function provides a way to automatically
4273 add javascript to this object.
4274 <BR>
4275 This function is meant to be extended by the
4276 child class.
4277 <DL>
4278 <DT class="font10bold">Function Parameters:</DT>
4279
4280
4281 <DT class="font10bold">Function Info:</DT>
4282
4283 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
4284
4285 </DL>
4286
4287 </DIV>
4288 <BR>
4289
4290 <DIV CLASS="function">
4291 <A NAME='_save_mozilla_nav_link'><!-- --></A>
4292 <SPAN CLASS="font12bold">_save_mozilla_nav_link</SPAN>
4293 <BR>
4294 <SPAN CLASS="font10bold">Useage : </SPAN>
4295 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
4296 <span class="font10bold" style="color: #0000FF">_save_mozilla_nav_link ( $which, $url )</SPAN>
4297 <BR>
4298
4299 <BR>
4300 <SPAN CLASS="font10bold">Description : </SPAN>
4301 <!-- ========== Info from phpDoc block ========= -->
4302 This function stores the url for each of the tool
4303 urls, so we can push these out for mozilla.
4304 <BR>
4305 Mozilla has a nice navigation bar feature that
4306 lets you program first, prev, next, last links
4307 <DL>
4308 <DT class="font10bold">Function Parameters:</DT>
4309
4310 <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">$which</SPAN></SPAN> - which tool link</DD>
4311
4312 <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 for that link</DD>
4313
4314
4315 <DT class="font10bold">Function Info:</DT>
4316
4317 </DL>
4318
4319 </DIV>
4320 <BR>
4321
4322 <DIV CLASS="function">
4323 <A NAME='_show_results'><!-- --></A>
4324 <SPAN CLASS="font12bold">_show_results</SPAN>
4325 <BR>
4326 <SPAN CLASS="font10bold">Useage : </SPAN>
4327 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
4328 <span class="font10bold" style="color: #0000FF">_show_results ( )</SPAN>
4329 <BR>
4330
4331 <BR>
4332 <SPAN CLASS="font10bold">Description : </SPAN>
4333 <!-- ========== Info from phpDoc block ========= -->
4334 This function is used to let render() know
4335 that we should show the results or not.
4336 <BR>
4337
4338 <DL>
4339 <DT class="font10bold">Function Parameters:</DT>
4340
4341
4342 <DT class="font10bold">Function Info:</DT>
4343
4344 </DL>
4345
4346 </DIV>
4347 <BR>
4348
4349
4350 <hr>
4351 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed