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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (hide annotations)
Sat Sep 20 00:24:00 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.2: +3352 -3264 lines
File MIME type: text/html 
+ updated whole phphtmllib to v2.3.0
1 jonen 1.3 <?xml version="1.0" encoding="iso-8859-1"?>
2     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3     <html xmlns="http://www.w3.org/1999/xhtml">
4     <head>
5     <!-- template designed by Marco Von Ballmoos -->
6     <title>Docs For Class DataList</title>
7     <link rel="stylesheet" href="../media/stylesheet.css" />
8     <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9     </head>
10     <body>
11     <div class="page-body">
12     <h2 class="class-name">Class DataList</h2>
13    
14     <a name="sec-description"></a>
15     <div class="info-box">
16     <div class="info-box-title">Description</div>
17     <div class="nav-bar">
18     <span class="disabled">Description</span> |
19     <a href="#sec-descendents">Descendents</a>
20     | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22    
23     </div>
24     <div class="info-box-body">
25     <!-- ========== Info from phpDoc block ========= -->
26     <p class="short-description">This object is the base class that can be</p>
27     <p class="description"><p>used to build a widget that shows lists of data from any source via the DataListSource object. It fetches/builds/gets its data from the DataListSource object, which can be written to support any data source (MySQL, Oracle, comma delimited file, xml, etc.)</p><p>This base class MUST be extended by a child to actually render the list. The job of the DataList class is to provide the basic API and abstraction mechanism to handling searching, showing, sorting lists of data.</p><p>Each column of data is associated with a title and a name. The title is what is shown to the user for that column. The name is the mapping between the column and the DataListSource. Each column can be marked as sortable and searchable. If a column is sortable, the title is a link that can be clicked on to sort. The sorting is done in the DataListSource object ( via the sql query, or sort() functions depending on the data source itself)</p><p>The DataList object will build the title, the search block (if any), the datalist controls (the links/imges for first, prev, next, last, all). Then the data columns/labels. Then it will fetch each of the rows of data to display from the DataListSource.</p><p>The logic of the output calls follows in the order:</p><p>title search table/block datalist controls (first, prev, next, last, all) data columns/labels data rows x through y</p><p>REQUIREMENTS: You must use/define a DataListSource object. You MUST override/extend the following methods:</p><p>* get_data_source() - used to set the DataListSource by this class. * user_setup() - used to set the columns to show and any options used by the DataList class and DataListSource object.</p><p>UI ABSTRACTION METHODS These methods allow for some level of abstraction for the layout/look/feel of the actual list of data.</p><p>* gui_init() - the function gives the child class a chance to do any building of the objects that will hold the search area, column headers and the rows of data.</p><p>* child_build_column_header() - This method is responsible for building and inserting the column header title into the UI object.</p><p>* child_add_row_cell() - This function is responsible for adding the cell in the current row. The method is responsible for keeping track of the location in its UI object for the current row.</p><p>* child_get_gui() - This method returns the entire UI in 1 object or container. At this point the entire UI has been constructed, the entire list of data has been walked and inserted.</p></p>
28     <ul class="tags">
29     <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
30     </ul>
31     <p class="notes">
32     Located in <a class="field" href="_widgets_data_list_DataList_inc.html">Program_Root/widgets/data_list/DataList.inc</a> (line <span class="field">108</span>)
33     </p>
34    
35    
36     <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 jonen 1.1 |
38     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39     |
40     --DataList</pre>
41 jonen 1.3
42     </div>
43     </div>
44    
45     <a name="sec-descendents"></a>
46     <div class="info-box">
47     <div class="info-box-title">Direct descendents</div>
48     <div class="nav-bar">
49     <a href="#sec-description">Description</a> |
50     <span class="disabled">Descendents</span>
51     | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
52     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
53    
54     </div>
55     <div class="info-box-body">
56     <table cellpadding="2" cellspacing="0" class="class-table">
57     <tr>
58     <th class="class-table-header">Class</th>
59     <th class="class-table-header">Description</th>
60 jonen 1.2 </tr>
61     <tr>
62 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a></td>
63     <td>
64     This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList.
65     </td>
66     </tr>
67 jonen 1.2 <tr>
68 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/SimpleGUIDataList.html">SimpleGUIDataList</a></td>
69     <td>
70     This object is the base class that can be
71     </td>
72     </tr>
73 jonen 1.2 <tr>
74 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/ListAction.html">ListAction</a></td>
75     <td>
76     A class for showing a list of items to preform an action on
77     </td>
78 jonen 1.2 </tr>
79     </table>
80 jonen 1.3 </div>
81     </div>
82    
83     <a name="sec-var-summary"></a>
84     <div class="info-box">
85     <div class="info-box-title">Variable Summary</span></div>
86     <div class="nav-bar">
87     <a href="#sec-description">Description</a> |
88     <a href="#sec-descendents">Descendents</a> |
89     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
90     |
91     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
92    
93     </div>
94     <div class="info-box-body">
95     <div class="var-summary">
96     <div class="var-title">
97     <span class="var-type">mixed</span>
98     <a href="#$alternating_row_colors" title="details" class="var-name">$alternating_row_colors</a>
99     </div>
100     <div class="var-title">
101     <span class="var-type">mixed</span>
102     <a href="#$_advanced_search_flag" title="details" class="var-name">$_advanced_search_flag</a>
103     </div>
104     <div class="var-title">
105     <span class="var-type">array</span>
106     <a href="#$_columns" title="details" class="var-name">$_columns</a>
107     </div>
108     <div class="var-title">
109     <span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
110     <a href="#$_datasource" title="details" class="var-name">$_datasource</a>
111     </div>
112     <div class="var-title">
113     <span class="var-type">mixed</span>
114     <a href="#$_default_orderby" title="details" class="var-name">$_default_orderby</a>
115     </div>
116     <div class="var-title">
117     <span class="var-type">mixed</span>
118     <a href="#$_default_reverseorder" title="details" class="var-name">$_default_reverseorder</a>
119     </div>
120     <div class="var-title">
121     <span class="var-type">mixed</span>
122     <a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a>
123     </div>
124     <div class="var-title">
125     <span class="var-type">mixed</span>
126     <a href="#$_form_attributes" title="details" class="var-name">$_form_attributes</a>
127     </div>
128     <div class="var-title">
129     <span class="var-type">mixed</span>
130     <a href="#$_form_render_flag" title="details" class="var-name">$_form_render_flag</a>
131     </div>
132     <div class="var-title">
133     <span class="var-type">mixed</span>
134     <a href="#$_global_prefix" title="details" class="var-name">$_global_prefix</a>
135     </div>
136     <div class="var-title">
137     <span class="var-type">mixed</span>
138     <a href="#$_image_path" title="details" class="var-name">$_image_path</a>
139     </div>
140     <div class="var-title">
141     <span class="var-type">mixed</span>
142     <a href="#$_max_rows" title="details" class="var-name">$_max_rows</a>
143     </div>
144     <div class="var-title">
145     <span class="var-type">mixed</span>
146     <a href="#$_num_columns" title="details" class="var-name">$_num_columns</a>
147     </div>
148     <div class="var-title">
149     <span class="var-type">mixed</span>
150     <a href="#$_num_pages" title="details" class="var-name">$_num_pages</a>
151     </div>
152     <div class="var-title">
153     <span class="var-type">mixed</span>
154     <a href="#$_save_vars" title="details" class="var-name">$_save_vars</a>
155     </div>
156     <div class="var-title">
157     <span class="var-type">mixed</span>
158     <a href="#$_search_flag" title="details" class="var-name">$_search_flag</a>
159     </div>
160     <div class="var-title">
161     <span class="var-type">mixed</span>
162     <a href="#$_search_table" title="details" class="var-name">$_search_table</a>
163     </div>
164     <div class="var-title">
165     <span class="var-type">mixed</span>
166     <a href="#$_show_results_flag" title="details" class="var-name">$_show_results_flag</a>
167     </div>
168     <div class="var-title">
169     <span class="var-type">mixed</span>
170     <a href="#$_simple_search_modifier" title="details" class="var-name">$_simple_search_modifier</a>
171     </div>
172     <div class="var-title">
173     <span class="var-type">mixed</span>
174     <a href="#$_vars" title="details" class="var-name">$_vars</a>
175     </div>
176     </div>
177     </div>
178     </div>
179    
180     <a name="sec-method-summary"></a>
181     <div class="info-box">
182     <div class="info-box-title">Method Summary</span></div>
183     <div class="nav-bar">
184     <a href="#sec-description">Description</a> |
185     <a href="#sec-descendents">Descendents</a> |
186     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
187    
188     |
189     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
190     </div>
191     <div class="info-box-body">
192     <div class="method-summary">
193    
194     <div class="method-definition">
195     <span class="method-result">void</span>
196     <a href="#DataList" title="details" class="method-name">DataList</a>
197     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$default_orderby</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$default_reverseorder</span> = <span class="var-default">FALSE</span>])
198     </div>
199    
200     <div class="method-definition">
201     <span class="method-result">array</span>
202     <a href="#add_header_item" title="details" class="method-name">add_header_item</a>
203     (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$data_name</span> = <span class="var-default">NULL</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">"left"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sortorder</span> = <span class="var-default">""</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$max_text_length</span> = <span class="var-default">NULL</span>])
204     </div>
205    
206     <div class="method-definition">
207     <span class="method-result">void</span>
208     <a href="#advanced_search_disable" title="details" class="method-name">advanced_search_disable</a>
209     ()
210     </div>
211    
212     <div class="method-definition">
213     <span class="method-result">void</span>
214     <a href="#advanced_search_enable" title="details" class="method-name">advanced_search_enable</a>
215     ()
216     </div>
217    
218     <div class="method-definition">
219     <span class="method-result">string</span>
220     <a href="#build_base_url" title="details" class="method-name">build_base_url</a>
221     ()
222     </div>
223    
224     <div class="method-definition">
225     <span class="method-result">mixed</span>
226     <a href="#build_column_item" title="details" class="method-name">build_column_item</a>
227     (<span class="var-type">array</span>&nbsp;<span class="var-name">$row_data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
228     </div>
229    
230     <div class="method-definition">
231     <span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span>
232     <a href="#build_column_url" title="details" class="method-name">build_column_url</a>
233     (<span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
234     </div>
235    
236     <div class="method-definition">
237     <span class="method-result">Container</span>
238     <a href="#build_gui" title="details" class="method-name">build_gui</a>
239     ()
240     </div>
241    
242     <div class="method-definition">
243     <span class="method-result">string</span>
244     <a href="#build_orderby_querystring" title="details" class="method-name">build_orderby_querystring</a>
245     ()
246     </div>
247    
248     <div class="method-definition">
249     <span class="method-result">string</span>
250     <a href="#build_reverseorder_querystring" title="details" class="method-name">build_reverseorder_querystring</a>
251     ()
252     </div>
253    
254     <div class="method-definition">
255     <span class="method-result">string</span>
256     <a href="#build_searchfield_querystring" title="details" class="method-name">build_searchfield_querystring</a>
257     ()
258     </div>
259    
260     <div class="method-definition">
261     <span class="method-result">string</span>
262     <a href="#build_searchvalue_querystring" title="details" class="method-name">build_searchvalue_querystring</a>
263     ()
264     </div>
265    
266     <div class="method-definition">
267     <span class="method-result">string</span>
268     <a href="#build_state_vars_query_string" title="details" class="method-name">build_state_vars_query_string</a>
269     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$showall_value</span>)
270     </div>
271    
272     <div class="method-definition">
273     <span class="method-result">Object</span>
274     <a href="#build_tool_link" title="details" class="method-name">build_tool_link</a>
275     (<span class="var-type">string</span>&nbsp;<span class="var-name">$which</span>)
276     </div>
277    
278     <div class="method-definition">
279     <span class="method-result">void</span>
280     <a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a>
281     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$last_in_row_flag</span>)
282     </div>
283    
284     <div class="method-definition">
285     <span class="method-result">void</span>
286     <a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a>
287     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$col_data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$col_count</span>)
288     </div>
289    
290     <div class="method-definition">
291     <span class="method-result">Container</span>
292     <a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a>
293     ()
294     </div>
295    
296     <div class="method-definition">
297     <span class="method-result">Container</span>
298     <a href="#child_get_gui" title="details" class="method-name">child_get_gui</a>
299     ()
300     </div>
301    
302     <div class="method-definition">
303     <span class="method-result">void</span>
304     <a href="#data_prefetch" title="details" class="method-name">data_prefetch</a>
305     ()
306     </div>
307    
308     <div class="method-definition">
309     <span class="method-result">void</span>
310     <a href="#do_action" title="details" class="method-name">do_action</a>
311     ()
312     </div>
313    
314     <div class="method-definition">
315     <span class="method-result">string</span>
316     <a href="#filter_column_string" title="details" class="method-name">filter_column_string</a>
317     (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
318     </div>
319    
320     <div class="method-definition">
321     <span class="method-result">int</span>
322     <a href="#get_current_page" title="details" class="method-name">get_current_page</a>
323     ()
324     </div>
325    
326     <div class="method-definition">
327     <span class="method-result">void</span>
328     <a href="#get_data_source" title="details" class="method-name">get_data_source</a>
329     ()
330     </div>
331    
332     <div class="method-definition">
333     <span class="method-result">int</span>
334     <a href="#get_default_num_rows" title="details" class="method-name">get_default_num_rows</a>
335     ()
336     </div>
337    
338     <div class="method-definition">
339     <span class="method-result">string</span>
340     <a href="#get_form_action" title="details" class="method-name">get_form_action</a>
341     ()
342     </div>
343    
344     <div class="method-definition">
345     <span class="method-result">string</span>
346     <a href="#get_form_method" title="details" class="method-name">get_form_method</a>
347     ()
348     </div>
349    
350     <div class="method-definition">
351     <span class="method-result">string</span>
352     <a href="#get_form_name" title="details" class="method-name">get_form_name</a>
353     ()
354     </div>
355    
356     <div class="method-definition">
357     <span class="method-result">bool</span>
358     <a href="#get_form_render" title="details" class="method-name">get_form_render</a>
359     ()
360     </div>
361    
362     <div class="method-definition">
363     <span class="method-result">string</span>
364     <a href="#get_form_target" title="details" class="method-name">get_form_target</a>
365     ()
366     </div>
367    
368     <div class="method-definition">
369     <span class="method-result">string</span>
370     <a href="#get_global_prefix" title="details" class="method-name">get_global_prefix</a>
371     ()
372     </div>
373    
374     <div class="method-definition">
375     <span class="method-result">string</span>
376     <a href="#get_image_path" title="details" class="method-name">get_image_path</a>
377     ()
378     </div>
379    
380     <div class="method-definition">
381     <span class="method-result">int</span>
382     <a href="#get_last_page" title="details" class="method-name">get_last_page</a>
383     ()
384     </div>
385    
386     <div class="method-definition">
387     <span class="method-result">int</span>
388     <a href="#get_max_rows" title="details" class="method-name">get_max_rows</a>
389     ()
390     </div>
391    
392     <div class="method-definition">
393     <span class="method-result">int</span>
394     <a href="#get_num_pages" title="details" class="method-name">get_num_pages</a>
395     ()
396     </div>
397    
398     <div class="method-definition">
399     <span class="method-result">string</span>
400     <a href="#get_page_info" title="details" class="method-name">get_page_info</a>
401     ()
402     </div>
403    
404     <div class="method-definition">
405     <span class="method-result">void</span>
406     <a href="#get_simple_search_modifier" title="details" class="method-name">get_simple_search_modifier</a>
407     ()
408     </div>
409    
410     <div class="method-definition">
411     <span class="method-result">void</span>
412     <a href="#gui_init" title="details" class="method-name">gui_init</a>
413     ()
414     </div>
415    
416     <div class="method-definition">
417     <span class="method-result">boolean</span>
418     <a href="#is_advanced_search_enabled" title="details" class="method-name">is_advanced_search_enabled</a>
419     ()
420     </div>
421    
422     <div class="method-definition">
423     <span class="method-result">boolean</span>
424     <a href="#is_search_enabled" title="details" class="method-name">is_search_enabled</a>
425     ()
426     </div>
427    
428     <div class="method-definition">
429     <span class="method-result">int</span>
430     <a href="#numrows" title="details" class="method-name">numrows</a>
431     ()
432     </div>
433    
434     <div class="method-definition">
435     <span class="method-result">int</span>
436     <a href="#offset" title="details" class="method-name">offset</a>
437     ()
438     </div>
439    
440     <div class="method-definition">
441     <span class="method-result">string.</span>
442     <a href="#orderby" title="details" class="method-name">orderby</a>
443     ()
444     </div>
445    
446     <div class="method-definition">
447     <span class="method-result">void</span>
448     <a href="#render" title="details" class="method-name">render</a>
449     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
450     </div>
451    
452     <div class="method-definition">
453     <span class="method-result">string.</span>
454     <a href="#reverseorder" title="details" class="method-name">reverseorder</a>
455     ()
456     </div>
457    
458     <div class="method-definition">
459     <span class="method-result">void</span>
460     <a href="#search_disable" title="details" class="method-name">search_disable</a>
461     (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
462     </div>
463    
464     <div class="method-definition">
465     <span class="method-result">void</span>
466     <a href="#search_enable" title="details" class="method-name">search_enable</a>
467     (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
468     </div>
469    
470     <div class="method-definition">
471     <span class="method-result">string</span>
472     <a href="#search_field" title="details" class="method-name">search_field</a>
473     ()
474     </div>
475    
476     <div class="method-definition">
477     <span class="method-result">string</span>
478     <a href="#search_type" title="details" class="method-name">search_type</a>
479     ()
480     </div>
481    
482     <div class="method-definition">
483     <span class="method-result">string</span>
484     <a href="#search_value" title="details" class="method-name">search_value</a>
485     ()
486     </div>
487    
488     <div class="method-definition">
489     <span class="method-result">string</span>
490     <a href="#search_value_filter" title="details" class="method-name">search_value_filter</a>
491     (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
492     </div>
493    
494     <div class="method-definition">
495     <span class="method-result">void</span>
496     <a href="#setup_columns" title="details" class="method-name">setup_columns</a>
497     ()
498     </div>
499    
500     <div class="method-definition">
501     <span class="method-result">void</span>
502     <a href="#set_data_source" title="details" class="method-name">set_data_source</a>
503     (<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>&nbsp;<span class="var-name">$datasource</span>)
504     </div>
505    
506     <div class="method-definition">
507     <span class="method-result">void</span>
508     <a href="#set_default_num_rows" title="details" class="method-name">set_default_num_rows</a>
509     (<span class="var-type">int</span>&nbsp;<span class="var-name">$num_rows</span>)
510     </div>
511    
512     <div class="method-definition">
513     <span class="method-result">void</span>
514     <a href="#set_form_action" title="details" class="method-name">set_form_action</a>
515     (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
516     </div>
517    
518     <div class="method-definition">
519     <span class="method-result">void</span>
520     <a href="#set_form_method" title="details" class="method-name">set_form_method</a>
521     (<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
522     </div>
523    
524     <div class="method-definition">
525     <span class="method-result">void</span>
526     <a href="#set_form_name" title="details" class="method-name">set_form_name</a>
527     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
528     </div>
529    
530     <div class="method-definition">
531     <span class="method-result">void</span>
532     <a href="#set_form_render" title="details" class="method-name">set_form_render</a>
533     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
534     </div>
535    
536     <div class="method-definition">
537     <span class="method-result">void</span>
538     <a href="#set_form_target" title="details" class="method-name">set_form_target</a>
539     (<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
540     </div>
541    
542     <div class="method-definition">
543     <span class="method-result">void</span>
544     <a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a>
545     (<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>)
546     </div>
547    
548     <div class="method-definition">
549     <span class="method-result">string</span>
550     <a href="#set_image_path" title="details" class="method-name">set_image_path</a>
551     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$path</span>)
552     </div>
553    
554     <div class="method-definition">
555     <span class="method-result">void</span>
556     <a href="#set_max_rows" title="details" class="method-name">set_max_rows</a>
557     (<span class="var-type">int</span>&nbsp;<span class="var-name">$max</span>)
558     </div>
559    
560     <div class="method-definition">
561     <span class="method-result">void</span>
562     <a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a>
563     (<span class="var-type">string</span>&nbsp;<span class="var-name">$mesg</span>)
564     </div>
565    
566     <div class="method-definition">
567     <span class="method-result">void</span>
568     <a href="#set_numrows" title="details" class="method-name">set_numrows</a>
569     (<span class="var-type">int</span>&nbsp;<span class="var-name">$new_numrows</span>)
570     </div>
571    
572     <div class="method-definition">
573     <span class="method-result">void</span>
574     <a href="#set_offset" title="details" class="method-name">set_offset</a>
575     (<span class="var-type">int</span>&nbsp;<span class="var-name">$new_offset</span>)
576     </div>
577    
578     <div class="method-definition">
579     <span class="method-result">void</span>
580     <a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a>
581     (<span class="var-type">string</span>&nbsp;<span class="var-name">$new_value</span>)
582     </div>
583    
584     <div class="method-definition">
585     <span class="method-result">void</span>
586     <a href="#set_save_vars" title="details" class="method-name">set_save_vars</a>
587     (<span class="var-type">array</span>&nbsp;<span class="var-name">$vars</span>)
588     </div>
589    
590     <div class="method-definition">
591     <span class="method-result">void</span>
592     <a href="#set_search_type" title="details" class="method-name">set_search_type</a>
593     (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
594     </div>
595    
596     <div class="method-definition">
597     <span class="method-result">void</span>
598     <a href="#set_show_results" title="details" class="method-name">set_show_results</a>
599     ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
600     </div>
601    
602     <div class="method-definition">
603     <span class="method-result">void</span>
604     <a href="#set_simple_search_modifier" title="details" class="method-name">set_simple_search_modifier</a>
605     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>])
606     </div>
607    
608     <div class="method-definition">
609     <span class="method-result">string</span>
610     <a href="#showall" title="details" class="method-name">showall</a>
611     ()
612     </div>
613    
614     <div class="method-definition">
615     <span class="method-result">string</span>
616     <a href="#simple_search_modifier_value" title="details" class="method-name">simple_search_modifier_value</a>
617     ()
618     </div>
619    
620     <div class="method-definition">
621     <span class="method-result">void</span>
622     <a href="#user_setup" title="details" class="method-name">user_setup</a>
623     ()
624     </div>
625    
626     <div class="method-definition">
627     <span class="method-result">Container</span>
628     <a href="#_build_default_vars" title="details" class="method-name">_build_default_vars</a>
629     ()
630     </div>
631    
632     <div class="method-definition">
633     <span class="method-result">mixed</span>
634     <a href="#_build_save_vars" title="details" class="method-name">_build_save_vars</a>
635     ()
636     </div>
637    
638     <div class="method-definition">
639     <span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
640     <a href="#_build_simple_search_modifier" title="details" class="method-name">_build_simple_search_modifier</a>
641     ()
642     </div>
643    
644     <div class="method-definition">
645     <span class="method-result">string</span>
646     <a href="#_build_tool_url" title="details" class="method-name">_build_tool_url</a>
647     (<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$showall_value</span>)
648     </div>
649    
650     <div class="method-definition">
651     <span class="method-result">void</span>
652     <a href="#_check_datasource" title="details" class="method-name">_check_datasource</a>
653     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$function_name</span>)
654     </div>
655    
656     <div class="method-definition">
657     <span class="method-result">mixed</span>
658     <a href="#_clean_string" title="details" class="method-name">_clean_string</a>
659     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
660     </div>
661    
662     <div class="method-definition">
663     <span class="method-result">string</span>
664     <a href="#_filter_column_string" title="details" class="method-name">_filter_column_string</a>
665     (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
666     </div>
667    
668     <div class="method-definition">
669     <span class="method-result">the</span>
670     <a href="#_get" title="details" class="method-name">_get</a>
671     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$default_value</span> = <span class="var-default">NULL</span>])
672     </div>
673    
674     <div class="method-definition">
675     <span class="method-result">array</span>
676     <a href="#_get_searchable_fields" title="details" class="method-name">_get_searchable_fields</a>
677     ()
678     </div>
679    
680     <div class="method-definition">
681     <span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span>
682     <a href="#_javascript" title="details" class="method-name">_javascript</a>
683     ()
684     </div>
685    
686     <div class="method-definition">
687     <span class="method-result">void</span>
688     <a href="#_save_mozilla_nav_link" title="details" class="method-name">_save_mozilla_nav_link</a>
689     (<span class="var-type">string</span>&nbsp;<span class="var-name">$which</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
690     </div>
691    
692     <div class="method-definition">
693     <span class="method-result">void</span>
694     <a href="#_set" title="details" class="method-name">_set</a>
695     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
696     </div>
697    
698     <div class="method-definition">
699     <span class="method-result">boolean</span>
700     <a href="#_show_results" title="details" class="method-name">_show_results</a>
701     ()
702     </div>
703     </div>
704     </div>
705     </div>
706    
707     <a name="sec-vars"></a>
708     <div class="info-box">
709     <div class="info-box-title">Variables</div>
710     <div class="nav-bar">
711     <a href="#sec-description">Description</a> |
712     <a href="#sec-descendents">Descendents</a> |
713     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
714    
715    
716     |
717     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
718    
719     </div>
720     <div class="info-box-body">
721     <a name="var$alternating_row_colors" id="$alternating_row_colors"><!-- --></A>
722     <div class="oddrow">
723    
724     <div class="var-header">
725     <span class="var-title">
726     <span class="var-type">mixed</span>
727     <span class="var-name">$alternating_row_colors</span>
728     = <span class="var-default"> TRUE</span> (line <span class="line-number">138</span>)
729     </span>
730     </div>
731    
732     <!-- ========== Info from phpDoc block ========= -->
733     <p class="short-description">Do we want to alternate the row colors? This helps to see each row easier.</p>
734    
735    
736    
737    
738    
739     </div>
740     <a name="var$_advanced_search_flag" id="$_advanced_search_flag"><!-- --></A>
741     <div class="evenrow">
742    
743     <div class="var-header">
744     <span class="var-title">
745     <span class="var-type">mixed</span>
746     <span class="var-name">$_advanced_search_flag</span>
747     = <span class="var-default"> FALSE</span> (line <span class="line-number">187</span>)
748     </span>
749     </div>
750    
751     <!-- ========== Info from phpDoc block ========= -->
752     <p class="short-description">Flag to let us know that</p>
753     <p class="description"><p>advanced search is enabled</p></p>
754    
755    
756    
757    
758    
759     </div>
760     <a name="var$_columns" id="$_columns"><!-- --></A>
761     <div class="oddrow">
762    
763     <div class="var-header">
764     <span class="var-title">
765     <span class="var-type">array</span>
766     <span class="var-name">$_columns</span>
767     = <span class="var-default">array()</span> (line <span class="line-number">220</span>)
768     </span>
769     </div>
770    
771     <!-- ========== Info from phpDoc block ========= -->
772     <p class="short-description">The column descriptions for the data we are working on</p>
773    
774    
775    
776    
777    
778     </div>
779     <a name="var$_datasource" id="$_datasource"><!-- --></A>
780     <div class="evenrow">
781    
782     <div class="var-header">
783     <span class="var-title">
784     <span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
785     <span class="var-name">$_datasource</span>
786     = <span class="var-default"> NULL</span> (line <span class="line-number">258</span>)
787     </span>
788     </div>
789    
790     <!-- ========== Info from phpDoc block ========= -->
791     <p class="short-description">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</p>
792     <ul class="tags">
793     <li><span class="field">var:</span> <p>object</p></li>
794     </ul>
795    
796    
797    
798    
799    
800     </div>
801     <a name="var$_default_orderby" id="$_default_orderby"><!-- --></A>
802     <div class="oddrow">
803    
804     <div class="var-header">
805     <span class="var-title">
806     <span class="var-type">mixed</span>
807     <span class="var-name">$_default_orderby</span>
808     = <span class="var-default"> ''</span> (line <span class="line-number">167</span>)
809     </span>
810     </div>
811    
812     <!-- ========== Info from phpDoc block ========= -->
813     <p class="short-description">Holds the db column name that we want to order by default.</p>
814    
815    
816    
817    
818    
819     </div>
820     <a name="var$_default_reverseorder" id="$_default_reverseorder"><!-- --></A>
821     <div class="evenrow">
822    
823     <div class="var-header">
824     <span class="var-title">
825     <span class="var-type">mixed</span>
826     <span class="var-name">$_default_reverseorder</span>
827     = <span class="var-default"> &quot;false&quot;</span> (line <span class="line-number">173</span>)
828     </span>
829     </div>
830    
831     <!-- ========== Info from phpDoc block ========= -->
832     <p class="short-description">Holds a flag to let us know to</p>
833     <p class="description"><p>reverse order the column by default</p></p>
834    
835    
836    
837    
838    
839     </div>
840     <a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A>
841     <div class="oddrow">
842    
843     <div class="var-header">
844     <span class="var-title">
845     <span class="var-type">mixed</span>
846     <span class="var-name">$_default_rows_per_page</span>
847     = <span class="var-default"> 10</span> (line <span class="line-number">124</span>)
848     </span>
849     </div>
850    
851     <!-- ========== Info from phpDoc block ========= -->
852     <p class="short-description">The number of rows of data to show per &quot;page&quot;.</p>
853     <p class="description"><p>The default is 20.</p></p>
854    
855    
856    
857    
858    
859     </div>
860     <a name="var$_form_attributes" id="$_form_attributes"><!-- --></A>
861     <div class="evenrow">
862    
863     <div class="var-header">
864     <span class="var-title">
865     <span class="var-type">mixed</span>
866     <span class="var-name">$_form_attributes</span>
867     = <span class="var-default">array(&quot;method&quot; =&gt; &quot;GET&quot;,<br /> &quot;target&quot; =&gt; &quot;&quot;,<br /> &quot;action&quot; =&gt; &quot;&quot;,<br /> &quot;name&quot; =&gt; &quot;datalist&quot;)</span> (line <span class="line-number">232</span>)
868     </span>
869     </div>
870    
871     <!-- ========== Info from phpDoc block ========= -->
872     <p class="short-description">This holds the form attributes</p>
873    
874    
875    
876    
877    
878     </div>
879     <a name="var$_form_render_flag" id="$_form_render_flag"><!-- --></A>
880     <div class="oddrow">
881    
882     <div class="var-header">
883     <span class="var-title">
884     <span class="var-type">mixed</span>
885     <span class="var-name">$_form_render_flag</span>
886     = <span class="var-default"> FALSE</span> (line <span class="line-number">241</span>)
887     </span>
888     </div>
889    
890     <!-- ========== Info from phpDoc block ========= -->
891     <p class="short-description">Build everything inside a form?</p>
892    
893    
894    
895    
896    
897     </div>
898     <a name="var$_global_prefix" id="$_global_prefix"><!-- --></A>
899     <div class="evenrow">
900    
901     <div class="var-header">
902     <span class="var-title">
903     <span class="var-type">mixed</span>
904     <span class="var-name">$_global_prefix</span>
905     = <span class="var-default"> ''</span> (line <span class="line-number">145</span>)
906     </span>
907     </div>
908    
909     <!-- ========== Info from phpDoc block ========= -->
910     <p class="short-description">prefix for all list variable names, so we can potentially have more then 1 list per page.</p>
911    
912    
913    
914    
915    
916     </div>
917     <a name="var$_image_path" id="$_image_path"><!-- --></A>
918     <div class="oddrow">
919    
920     <div class="var-header">
921     <span class="var-title">
922     <span class="var-type">mixed</span>
923     <span class="var-name">$_image_path</span>
924     = <span class="var-default"> &quot;/phphtmllib/images/widgets&quot;</span> (line <span class="line-number">266</span>)
925     </span>
926     </div>
927    
928     <!-- ========== Info from phpDoc block ========= -->
929     <p class="short-description">This stores the base path to where the tool link images live. This lets you specify a new path to where your images live.</p>
930    
931    
932    
933    
934    
935     </div>
936     <a name="var$_max_rows" id="$_max_rows"><!-- --></A>
937     <div class="evenrow">
938    
939     <div class="var-header">
940     <span class="var-title">
941     <span class="var-type">mixed</span>
942     <span class="var-name">$_max_rows</span>
943     = <span class="var-default"> 200</span> (line <span class="line-number">131</span>)
944     </span>
945     </div>
946    
947     <!-- ========== Info from phpDoc block ========= -->
948     <p class="short-description">The max number of rows to show when the user does the &quot;EXPAND&quot; command.</p>
949    
950    
951    
952    
953    
954     </div>
955     <a name="var$_num_columns" id="$_num_columns"><!-- --></A>
956     <div class="oddrow">
957    
958     <div class="var-header">
959     <span class="var-title">
960     <span class="var-type">mixed</span>
961     <span class="var-name">$_num_columns</span>
962     = <span class="var-default"> 0</span> (line <span class="line-number">225</span>)
963     </span>
964     </div>
965    
966     <!-- ========== Info from phpDoc block ========= -->
967     <p class="short-description">Keeps track of the # of columns we have</p>
968    
969    
970    
971    
972    
973     </div>
974     <a name="var$_num_pages" id="$_num_pages"><!-- --></A>
975     <div class="evenrow">
976    
977     <div class="var-header">
978     <span class="var-title">
979     <span class="var-type">mixed</span>
980     <span class="var-name">$_num_pages</span>
981     = <span class="var-default">1</span> (line <span class="line-number">116</span>)
982     </span>
983     </div>
984    
985     <!-- ========== Info from phpDoc block ========= -->
986     <p class="short-description">This value holds the number of pages of data we have to display.</p>
987    
988    
989    
990    
991    
992     </div>
993     <a name="var$_save_vars" id="$_save_vars"><!-- --></A>
994     <div class="oddrow">
995    
996     <div class="var-header">
997     <span class="var-title">
998     <span class="var-type">mixed</span>
999     <span class="var-name">$_save_vars</span>
1000     = <span class="var-default">array()</span> (line <span class="line-number">211</span>)
1001     </span>
1002     </div>
1003    
1004     <!-- ========== Info from phpDoc block ========= -->
1005     <p class="short-description">This holds a list of name=&gt;value vars that the caller/child wants to propogate automatically.</p>
1006    
1007    
1008    
1009    
1010    
1011     </div>
1012     <a name="var$_search_flag" id="$_search_flag"><!-- --></A>
1013     <div class="evenrow">
1014    
1015     <div class="var-header">
1016     <span class="var-title">
1017     <span class="var-type">mixed</span>
1018     <span class="var-name">$_search_flag</span>
1019     = <span class="var-default"> FALSE</span> (line <span class="line-number">180</span>)
1020     </span>
1021     </div>
1022    
1023     <!-- ========== Info from phpDoc block ========= -->
1024     <p class="short-description">Flag to let us know that search is enabled.</p>
1025    
1026    
1027    
1028    
1029    
1030     </div>
1031     <a name="var$_search_table" id="$_search_table"><!-- --></A>
1032     <div class="oddrow">
1033    
1034     <div class="var-header">
1035     <span class="var-title">
1036     <span class="var-type">mixed</span>
1037     <span class="var-name">$_search_table</span>
1038     = <span class="var-default"> NULL</span> (line <span class="line-number">202</span>)
1039     </span>
1040     </div>
1041 jonen 1.2
1042 jonen 1.3 <!-- ========== Info from phpDoc block ========= -->
1043     <p class="short-description">Holds the object block that is the</p>
1044     <p class="description"><p>search UI</p></p>
1045    
1046    
1047    
1048    
1049    
1050     </div>
1051     <a name="var$_show_results_flag" id="$_show_results_flag"><!-- --></A>
1052     <div class="evenrow">
1053    
1054     <div class="var-header">
1055     <span class="var-title">
1056     <span class="var-type">mixed</span>
1057     <span class="var-name">$_show_results_flag</span>
1058     = <span class="var-default"> TRUE</span> (line <span class="line-number">248</span>)
1059     </span>
1060     </div>
1061 jonen 1.2
1062 jonen 1.3 <!-- ========== Info from phpDoc block ========= -->
1063     <p class="short-description">flag to let us know if we want to show the results or not.</p>
1064    
1065    
1066    
1067    
1068 jonen 1.2
1069 jonen 1.3 </div>
1070     <a name="var$_simple_search_modifier" id="$_simple_search_modifier"><!-- --></A>
1071     <div class="oddrow">
1072    
1073     <div class="var-header">
1074     <span class="var-title">
1075     <span class="var-type">mixed</span>
1076     <span class="var-name">$_simple_search_modifier</span>
1077     = <span class="var-default"> FALSE</span> (line <span class="line-number">195</span>)
1078     </span>
1079     </div>
1080 jonen 1.2
1081 jonen 1.3 <!-- ========== Info from phpDoc block ========= -->
1082     <p class="short-description">Flag to enable simple search modifyer.</p>
1083     <p class="description"><p>IF enabled it will add a select that adds the &quot;beings with&quot;, &quot;contains&quot; options for a simple search.</p></p>
1084    
1085    
1086    
1087    
1088    
1089     </div>
1090     <a name="var$_vars" id="$_vars"><!-- --></A>
1091     <div class="evenrow">
1092    
1093     <div class="var-header">
1094     <span class="var-title">
1095     <span class="var-type">mixed</span>
1096     <span class="var-name">$_vars</span>
1097     = <span class="var-default">array(&quot;offsetVar&quot; =&gt; &quot;offset&quot;,<br /> &quot;orderbyVar&quot; =&gt; &quot;orderby&quot;,<br /> &quot;reverseorderVar&quot; =&gt; &quot;reverseorder&quot;,<br /> &quot;numrowsVar&quot; =&gt; &quot;numrows&quot;,<br /> &quot;showallVar&quot; =&gt; &quot;showall&quot;,<br /> &quot;search_fieldVar&quot; =&gt; &quot;search_field&quot;,<br /> &quot;search_valueVar&quot; =&gt; &quot;search_value&quot;,<br /> &quot;search_typeVar&quot; =&gt; &quot;search_type&quot;,<br /> &quot;simple_search_modifierVar&quot; =&gt; &quot;simple_search_modifier&quot;)</span> (line <span class="line-number">153</span>)
1098     </span>
1099     </div>
1100 jonen 1.2
1101 jonen 1.3 <!-- ========== Info from phpDoc block ========= -->
1102     <p class="short-description">Holds an array of all the form vars we need for this class to work.</p>
1103    
1104    
1105    
1106    
1107 jonen 1.1
1108 jonen 1.3 </div>
1109     <h4>Inherited Variables</h4>
1110     <A NAME='inherited_vars'><!-- --></A>
1111     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
1112     <blockquote>
1113     <span class="var-title">
1114     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
1115     </span>
1116     <span class="var-title">
1117     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
1118     </span>
1119     </blockquote>
1120     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
1121     <blockquote>
1122     <span class="var-title">
1123     <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
1124     </span>
1125     </blockquote>
1126    
1127     </div>
1128     </div>
1129    
1130     <a name="sec-methods"></a>
1131     <div class="info-box">
1132     <div class="info-box-title">Methods</div>
1133     <div class="nav-bar">
1134     <a href="#sec-description">Description</a> |
1135     <a href="#sec-descendents">Descendents</a> |
1136     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
1137     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
1138    
1139     </div>
1140     <div class="info-box-body">
1141     <A NAME='method_detail'></A>
1142     <a name="methodDataList" id="DataList"><!-- --></a>
1143     <div class="oddrow">
1144    
1145     <div class="method-header">
1146     <span class="method-title">Constructor DataList</span> (line <span class="line-number">277</span>)
1147     </div>
1148    
1149     <!-- ========== Info from phpDoc block ========= -->
1150     <p class="short-description">The constructor</p>
1151    
1152     <div class="method-signature">
1153     <span class="method-result">void</span>
1154     <span class="method-name">
1155     DataList
1156     </span>
1157     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$default_orderby</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$default_reverseorder</span> = <span class="var-default">FALSE</span>])
1158     </div>
1159    
1160     <ul class="parameters">
1161     <li>
1162     <span class="var-type">string</span>
1163     <span class="var-name">$title</span><span class="var-description">: <p>- the title of the data list</p></span> </li>
1164     <li>
1165     <span class="var-type">string</span>
1166     <span class="var-name">$width</span><span class="var-description">: <p>- the overall width</p></span> </li>
1167     <li>
1168     <span class="var-type">string</span>
1169     <span class="var-name">$default_orderby</span><span class="var-description">: <p>- the column to use as the default sorting order</p></span> </li>
1170     <li>
1171     <span class="var-type">boolean</span>
1172     <span class="var-name">$default_reverseorder</span><span class="var-description">: <p>- sort the default column in reverse order?</p></span> </li>
1173     </ul>
1174    
1175    
1176     </div>
1177     <a name="methodadd_header_item" id="add_header_item"><!-- --></a>
1178     <div class="evenrow">
1179    
1180     <div class="method-header">
1181     <span class="method-title">add_header_item</span> (line <span class="line-number">592</span>)
1182     </div>
1183    
1184     <!-- ========== Info from phpDoc block ========= -->
1185     <p class="short-description">This function adds a header item to the column headers from a list of parameters.</p>
1186     <ul class="tags">
1187     <li><span class="field">return:</span> <p>a single header array</p></li>
1188     </ul>
1189    
1190     <div class="method-signature">
1191     <span class="method-result">array</span>
1192     <span class="method-name">
1193     add_header_item
1194     </span>
1195     (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$data_name</span> = <span class="var-default">NULL</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">"left"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sortorder</span> = <span class="var-default">""</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$max_text_length</span> = <span class="var-default">NULL</span>])
1196     </div>
1197    
1198     <ul class="parameters">
1199     <li>
1200     <span class="var-type">string</span>
1201     <span class="var-name">$label</span><span class="var-description">: <p>- $label - the label to use for the column header.</p></span> </li>
1202     <li>
1203     <span class="var-type">int</span>
1204     <span class="var-name">$size</span><span class="var-description">: <p>- $size - the size for the table column.</p></span> </li>
1205     <li>
1206     <span class="var-type">string</span>
1207     <span class="var-name">$data_name</span><span class="var-description">: <p>- $dbfield - the db field associated with this label from the query.</p></span> </li>
1208     <li>
1209     <span class="var-type">boolean</span>
1210     <span class="var-name">$sortable</span><span class="var-description">: <p>- $sortable - flag to make this column sortable.</p></span> </li>
1211     <li>
1212     <span class="var-type">boolean</span>
1213     <span class="var-name">$searchable</span><span class="var-description">: <p>- $searchable - flag to make this column searchable.</p></span> </li>
1214     <li>
1215     <span class="var-type">string</span>
1216     <span class="var-name">$align</span><span class="var-description">: <p>- header align value.</p></span> </li>
1217     <li>
1218     <span class="var-type">string</span>
1219     <span class="var-name">$sortorder</span><span class="var-description">: <p>- the sort order</p></span> </li>
1220     <li>
1221     <span class="var-type">string</span>
1222     <span class="var-name">$max_text_length</span><span class="var-description">: <p>- the maximum # of characters to allow in the cell.</p></span> </li>
1223     </ul>
1224    
1225    
1226     </div>
1227     <a name="methodadvanced_search_disable" id="advanced_search_disable"><!-- --></a>
1228     <div class="oddrow">
1229    
1230     <div class="method-header">
1231     <span class="method-title">advanced_search_disable</span> (line <span class="line-number">700</span>)
1232     </div>
1233    
1234     <!-- ========== Info from phpDoc block ========= -->
1235     <p class="short-description">Disable the advanced search</p>
1236     <p class="description"><p>capability</p></p>
1237    
1238     <div class="method-signature">
1239     <span class="method-result">void</span>
1240     <span class="method-name">
1241     advanced_search_disable
1242     </span>
1243     ()
1244     </div>
1245    
1246    
1247    
1248     </div>
1249     <a name="methodadvanced_search_enable" id="advanced_search_enable"><!-- --></a>
1250     <div class="evenrow">
1251    
1252     <div class="method-header">
1253     <span class="method-title">advanced_search_enable</span> (line <span class="line-number">688</span>)
1254     </div>
1255    
1256     <!-- ========== Info from phpDoc block ========= -->
1257     <p class="short-description">Enable the advanced search</p>
1258     <p class="description"><p>capability NOTE: Child class MUST extend the _build_advanced_search_table</p></p>
1259    
1260     <div class="method-signature">
1261     <span class="method-result">void</span>
1262     <span class="method-name">
1263     advanced_search_enable
1264     </span>
1265     ()
1266     </div>
1267    
1268    
1269    
1270     </div>
1271     <a name="methodbuild_base_url" id="build_base_url"><!-- --></a>
1272     <div class="oddrow">
1273    
1274     <div class="method-header">
1275     <span class="method-title">build_base_url</span> (line <span class="line-number">1303</span>)
1276     </div>
1277    
1278     <!-- ========== Info from phpDoc block ========= -->
1279     <p class="short-description">This builds the base url used by the column headers as well as the page tool links.</p>
1280     <p class="description"><p>it basically builds: $_SELF?$_GET</p></p>
1281    
1282     <div class="method-signature">
1283     <span class="method-result">string</span>
1284     <span class="method-name">
1285     build_base_url
1286     </span>
1287     ()
1288     </div>
1289    
1290    
1291    
1292     </div>
1293     <a name="methodbuild_column_item" id="build_column_item"><!-- --></a>
1294     <div class="evenrow">
1295    
1296     <div class="method-header">
1297     <span class="method-title">build_column_item</span> (line <span class="line-number">1079</span>)
1298     </div>
1299    
1300     <!-- ========== Info from phpDoc block ========= -->
1301     <p class="short-description">This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DB.</p>
1302     <p class="description"><p>NOTE: this function is meant to be overridden so that you can push whatever you want.</p></p>
1303     <ul class="tags">
1304     <li><span class="field">return:</span> <p>- either a HTMLTag object, or raw text.</p></li>
1305     </ul>
1306    
1307     <div class="method-signature">
1308     <span class="method-result">mixed</span>
1309     <span class="method-name">
1310     build_column_item
1311     </span>
1312     (<span class="var-type">array</span>&nbsp;<span class="var-name">$row_data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
1313     </div>
1314    
1315     <ul class="parameters">
1316     <li>
1317     <span class="var-type">array</span>
1318     <span class="var-name">$row_data</span><span class="var-description">: <p>- $row_data - the entire data for the row</p></span> </li>
1319     <li>
1320     <span class="var-type">string</span>
1321     <span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name - the name of the column header for this row to render.</p></span> </li>
1322     </ul>
1323    
1324    
1325     </div>
1326     <a name="methodbuild_column_url" id="build_column_url"><!-- --></a>
1327     <div class="oddrow">
1328    
1329     <div class="method-header">
1330     <span class="method-title">build_column_url</span> (line <span class="line-number">1610</span>)
1331     </div>
1332    
1333     <!-- ========== Info from phpDoc block ========= -->
1334     <p class="short-description">This builds a url for a particular column header.</p>
1335     <ul class="tags">
1336     <li><span class="field">return:</span> <p>object;</p></li>
1337     </ul>
1338    
1339     <div class="method-signature">
1340     <span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span>
1341     <span class="method-name">
1342     build_column_url
1343     </span>
1344     (<span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
1345     </div>
1346    
1347     <ul class="parameters">
1348     <li>
1349     <span class="var-type">string</span>
1350     <span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name</p></span> </li>
1351     </ul>
1352    
1353    
1354     </div>
1355     <a name="methodbuild_gui" id="build_gui"><!-- --></a>
1356     <div class="evenrow">
1357    
1358     <div class="method-header">
1359     <span class="method-title">build_gui</span> (line <span class="line-number">399</span>)
1360     </div>
1361    
1362     <!-- ========== Info from phpDoc block ========= -->
1363     <p class="short-description">This function is responsible for calling the child class's methods for building the GUI container.</p>
1364     <p class="description"><p>This function builds the search area, the title, page controls, the column headers, and walks the rows of data and adds them</p><p>A child class can override this method to move the placement of the search box relative to the data list. By default the search area comes above the table for the data list and page controls</p></p>
1365    
1366     <div class="method-signature">
1367     <span class="method-result">Container</span>
1368     <span class="method-name">
1369     build_gui
1370     </span>
1371     ()
1372     </div>
1373    
1374    
1375    
1376     <hr class="separator" />
1377     <div class="notes">Redefined in descendants as:</div>
1378     <ul class="redefinitions">
1379     <li>
1380     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodbuild_gui">DefaultGUIDatalist::build_gui()</a>
1381     : Override the parent's method so we can wrap everything in a div to hold it all together when we change the alignment
1382     </li>
1383     </ul>
1384     </div>
1385     <a name="methodbuild_orderby_querystring" id="build_orderby_querystring"><!-- --></a>
1386     <div class="oddrow">
1387    
1388     <div class="method-header">
1389     <span class="method-title">build_orderby_querystring</span> (line <span class="line-number">926</span>)
1390     </div>
1391    
1392     <!-- ========== Info from phpDoc block ========= -->
1393     <p class="short-description">This builds a query string var for the orderby value.</p>
1394     <ul class="tags">
1395     <li><span class="field">return:</span> <p>- &quot;orderby=(thevalue)&quot;</p></li>
1396     </ul>
1397    
1398     <div class="method-signature">
1399     <span class="method-result">string</span>
1400     <span class="method-name">
1401     build_orderby_querystring
1402     </span>
1403     ()
1404     </div>
1405    
1406    
1407    
1408     </div>
1409     <a name="methodbuild_reverseorder_querystring" id="build_reverseorder_querystring"><!-- --></a>
1410     <div class="evenrow">
1411    
1412     <div class="method-header">
1413     <span class="method-title">build_reverseorder_querystring</span> (line <span class="line-number">957</span>)
1414     </div>
1415    
1416     <!-- ========== Info from phpDoc block ========= -->
1417     <p class="short-description">This builds a query string var for the reverseorder value.</p>
1418     <ul class="tags">
1419     <li><span class="field">return:</span> <p>- &quot;orderby=(thevalue)&quot;</p></li>
1420     </ul>
1421    
1422     <div class="method-signature">
1423     <span class="method-result">string</span>
1424     <span class="method-name">
1425     build_reverseorder_querystring
1426     </span>
1427     ()
1428     </div>
1429    
1430    
1431    
1432     </div>
1433     <a name="methodbuild_searchfield_querystring" id="build_searchfield_querystring"><!-- --></a>
1434     <div class="oddrow">
1435    
1436     <div class="method-header">
1437     <span class="method-title">build_searchfield_querystring</span> (line <span class="line-number">998</span>)
1438     </div>
1439    
1440     <!-- ========== Info from phpDoc block ========= -->
1441     <p class="short-description">This builds a query string var for the searchfield value.</p>
1442     <ul class="tags">
1443     <li><span class="field">return:</span> <p>- &quot;orderby=(thevalue)&quot;</p></li>
1444     </ul>
1445    
1446     <div class="method-signature">
1447     <span class="method-result">string</span>
1448     <span class="method-name">
1449     build_searchfield_querystring
1450     </span>
1451     ()
1452     </div>
1453    
1454    
1455    
1456     </div>
1457     <a name="methodbuild_searchvalue_querystring" id="build_searchvalue_querystring"><!-- --></a>
1458     <div class="evenrow">
1459    
1460     <div class="method-header">
1461     <span class="method-title">build_searchvalue_querystring</span> (line <span class="line-number">1019</span>)
1462     </div>
1463    
1464     <!-- ========== Info from phpDoc block ========= -->
1465     <p class="short-description">This builds a query string var for the searchfield value.</p>
1466     <ul class="tags">
1467     <li><span class="field">return:</span> <p>- &quot;orderby=(thevalue)&quot;</p></li>
1468     </ul>
1469    
1470     <div class="method-signature">
1471     <span class="method-result">string</span>
1472     <span class="method-name">
1473     build_searchvalue_querystring
1474     </span>
1475     ()
1476     </div>
1477    
1478    
1479    
1480     </div>
1481     <a name="methodbuild_state_vars_query_string" id="build_state_vars_query_string"><!-- --></a>
1482     <div class="oddrow">
1483    
1484     <div class="method-header">
1485     <span class="method-title">build_state_vars_query_string</span> (line <span class="line-number">1480</span>)
1486     </div>
1487    
1488     <!-- ========== Info from phpDoc block ========= -->
1489     <p class="short-description">this function is used to build a sub query string</p>
1490     <p class="description"><p>of all of the query string vars to save the state of the DBItemList. This is used for pages that want to come back to the list at the same state</p></p>
1491     <ul class="tags">
1492     <li><span class="field">return:</span> <p>- name=value&amp; pairs</p></li>
1493     </ul>
1494    
1495     <div class="method-signature">
1496     <span class="method-result">string</span>
1497     <span class="method-name">
1498     build_state_vars_query_string
1499     </span>
1500     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$showall_value</span>)
1501     </div>
1502    
1503    
1504    
1505     </div>
1506     <a name="methodbuild_tool_link" id="build_tool_link"><!-- --></a>
1507     <div class="evenrow">
1508    
1509     <div class="method-header">
1510     <span class="method-title">build_tool_link</span> (line <span class="line-number">1349</span>)
1511     </div>
1512    
1513     <!-- ========== Info from phpDoc block ========= -->
1514     <p class="short-description">This function builds the 'tool' images that allow you to walk through the data list itself.</p>
1515     <p class="description"><p>It provides image links for first - go to the first page in the data list prev - go to the previous page in the data list next - go to the next page in the data list last - go to the last page in the data list all - show the rest of the list from the current offset</p></p>
1516    
1517     <div class="method-signature">
1518     <span class="method-result">Object</span>
1519     <span class="method-name">
1520     build_tool_link
1521     </span>
1522     (<span class="var-type">string</span>&nbsp;<span class="var-name">$which</span>)
1523     </div>
1524    
1525     <ul class="parameters">
1526     <li>
1527     <span class="var-type">string</span>
1528     <span class="var-name">$which</span><span class="var-description">: <p>- which tool image to build</p></span> </li>
1529     </ul>
1530    
1531    
1532     </div>
1533     <a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a>
1534     <div class="oddrow">
1535    
1536     <div class="method-header">
1537     <span class="method-title">child_add_row_cell</span> (line <span class="line-number">530</span>)
1538     </div>
1539    
1540     <!-- ========== Info from phpDoc block ========= -->
1541     <p class="short-description">This method is supposed to be written by the child class to add the cell data to the current row in the UI</p>
1542    
1543     <div class="method-signature">
1544     <span class="method-result">void</span>
1545     <span class="method-name">
1546     child_add_row_cell
1547     </span>
1548     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$last_in_row_flag</span>)
1549     </div>
1550    
1551     <ul class="parameters">
1552     <li>
1553     <span class="var-type">mixed</span>
1554     <span class="var-name">$obj</span><span class="var-description">: <p>- the object/string/entity that should get put into the column row cell.</p></span> </li>
1555     <li>
1556     <span class="var-type">string</span>
1557     <span class="var-name">$col_name</span><span class="var-description">: <p>- the name/title of the column that the object will live in</p></span> </li>
1558     <li>
1559     <span class="var-type">boolean</span>
1560     <span class="var-name">$last_in_row_flag</span><span class="var-description">: <p>- flag that tells the function if this is is the last cell for the current row.</p></span> </li>
1561     </ul>
1562    
1563    
1564     <hr class="separator" />
1565     <div class="notes">Redefined in descendants as:</div>
1566     <ul class="redefinitions">
1567     <li>
1568     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a>
1569     </li>
1570     <li>
1571     <a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_add_row_cell">SimpleGUIDataList::child_add_row_cell()</a>
1572     </li>
1573     <li>
1574     <a href="../phpHtmlLib/ListAction.html#methodchild_add_row_cell">ListAction::child_add_row_cell()</a>
1575     </li>
1576     </ul>
1577     </div>
1578     <a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a>
1579     <div class="evenrow">
1580    
1581     <div class="method-header">
1582     <span class="method-title">child_build_column_header</span> (line <span class="line-number">510</span>)
1583     </div>
1584    
1585     <!-- ========== Info from phpDoc block ========= -->
1586     <p class="short-description">This method is supposed to be written by the child class to build and add the column title to the UI</p>
1587    
1588     <div class="method-signature">
1589     <span class="method-result">void</span>
1590     <span class="method-name">
1591     child_build_column_header
1592     </span>
1593     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$col_data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$col_count</span>)
1594     </div>
1595    
1596     <ul class="parameters">
1597     <li>
1598     <span class="var-type">string</span>
1599     <span class="var-name">$title</span><span class="var-description">: <p>- the title of the column</p></span> </li>
1600     <li>
1601     <span class="var-type">array</span>
1602     <span class="var-name">$col_data</span><span class="var-description">: <p>- the column data ( from $this-&gt;_columns )</p></span> </li>
1603     <li>
1604     <span class="var-type">int</span>
1605     <span class="var-name">$col_count</span><span class="var-description">: <p>- the column #</p></span> </li>
1606     </ul>
1607    
1608    
1609     <hr class="separator" />
1610     <div class="notes">Redefined in descendants as:</div>
1611     <ul class="redefinitions">
1612     <li>
1613     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_column_header">DefaultGUIDatalist::child_build_column_header()</a>
1614     </li>
1615     <li>
1616     <a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_build_column_header">SimpleGUIDataList::child_build_column_header()</a>
1617     </li>
1618     <li>
1619     <a href="../phpHtmlLib/ListAction.html#methodchild_build_column_header">ListAction::child_build_column_header()</a>
1620     </li>
1621     </ul>
1622     </div>
1623     <a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a>
1624     <div class="oddrow">
1625    
1626     <div class="method-header">
1627     <span class="method-title">child_build_search_table</span> (line <span class="line-number">557</span>)
1628     </div>
1629    
1630     <!-- ========== Info from phpDoc block ========= -->
1631     <p class="short-description">This function builds the search block that lives above the results</p>
1632    
1633     <div class="method-signature">
1634     <span class="method-result">Container</span>
1635     <span class="method-name">
1636     child_build_search_table
1637     </span>
1638     ()
1639     </div>
1640    
1641    
1642    
1643     <hr class="separator" />
1644     <div class="notes">Redefined in descendants as:</div>
1645     <ul class="redefinitions">
1646     <li>
1647     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_search_table">DefaultGUIDatalist::child_build_search_table()</a>
1648     : This builds the table that holds the search capability.
1649     </li>
1650     </ul>
1651     </div>
1652     <a name="methodchild_get_gui" id="child_get_gui"><!-- --></a>
1653     <div class="evenrow">
1654    
1655     <div class="method-header">
1656     <span class="method-title">child_get_gui</span> (line <span class="line-number">544</span>)
1657     </div>
1658    
1659     <!-- ========== Info from phpDoc block ========= -->
1660     <p class="short-description">This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList</p>
1661    
1662     <div class="method-signature">
1663     <span class="method-result">Container</span>
1664     <span class="method-name">
1665     child_get_gui
1666     </span>
1667     ()
1668     </div>
1669    
1670    
1671    
1672     <hr class="separator" />
1673     <div class="notes">Redefined in descendants as:</div>
1674     <ul class="redefinitions">
1675     <li>
1676     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_get_gui">DefaultGUIDatalist::child_get_gui()</a>
1677     </li>
1678     <li>
1679     <a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_get_gui">SimpleGUIDataList::child_get_gui()</a>
1680     </li>
1681     <li>
1682     <a href="../phpHtmlLib/ListAction.html#methodchild_get_gui">ListAction::child_get_gui()</a>
1683     </li>
1684     </ul>
1685     </div>
1686     <a name="methoddata_prefetch" id="data_prefetch"><!-- --></a>
1687     <div class="oddrow">
1688    
1689     <div class="method-header">
1690     <span class="method-title">data_prefetch</span> (line <span class="line-number">805</span>)
1691     </div>
1692    
1693     <!-- ========== Info from phpDoc block ========= -->
1694     <p class="short-description">This function is used to set up any</p>
1695     <p class="description"><p>data that needs to be munged before the data is fetched from the DataListSource</p></p>
1696    
1697     <div class="method-signature">
1698     <span class="method-result">void</span>
1699     <span class="method-name">
1700     data_prefetch
1701     </span>
1702     ()
1703     </div>
1704    
1705    
1706    
1707     </div>
1708     <a name="methoddo_action" id="do_action"><!-- --></a>
1709     <div class="evenrow">
1710    
1711     <div class="method-header">
1712     <span class="method-title">do_action</span> (line <span class="line-number">453</span>)
1713     </div>
1714    
1715     <!-- ========== Info from phpDoc block ========= -->
1716     <p class="short-description">This method is called prior to get_data_source and user_setup() to allow you to do some generic action on data. By default this does nothing.</p>
1717    
1718     <div class="method-signature">
1719     <span class="method-result">void</span>
1720     <span class="method-name">
1721     do_action
1722     </span>
1723     ()
1724     </div>
1725    
1726    
1727    
1728     </div>
1729     <a name="methodfilter_column_string" id="filter_column_string"><!-- --></a>
1730     <div class="oddrow">
1731    
1732     <div class="method-header">
1733     <span class="method-title">filter_column_string</span> (line <span class="line-number">1664</span>)
1734     </div>
1735    
1736     <!-- ========== Info from phpDoc block ========= -->
1737     <p class="short-description">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</p>
1738     <ul class="tags">
1739     <li><span class="field">return:</span> <p>the cleaned/filtered data</p></li>
1740     </ul>
1741    
1742     <div class="method-signature">
1743     <span class="method-result">string</span>
1744     <span class="method-name">
1745     filter_column_string
1746     </span>
1747     (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
1748     </div>
1749    
1750     <ul class="parameters">
1751     <li>
1752     <span class="var-type">string</span>
1753     <span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li>
1754     </ul>
1755    
1756    
1757     </div>
1758     <a name="methodget_current_page" id="get_current_page"><!-- --></a>
1759     <div class="evenrow">
1760    
1761     <div class="method-header">
1762     <span class="method-title">get_current_page</span> (line <span class="line-number">1538</span>)
1763     </div>
1764    
1765     <!-- ========== Info from phpDoc block ========= -->
1766     <p class="short-description">This function returns the current page that the item list is on.</p>
1767    
1768     <div class="method-signature">
1769     <span class="method-result">int</span>
1770     <span class="method-name">
1771     get_current_page
1772     </span>
1773     ()
1774     </div>
1775    
1776    
1777    
1778     </div>
1779     <a name="methodget_data_source" id="get_data_source"><!-- --></a>
1780     <div class="oddrow">
1781    
1782     <div class="method-header">
1783     <span class="method-title">get_data_source</span> (line <span class="line-number">465</span>)
1784     </div>
1785    
1786     <!-- ========== Info from phpDoc block ========= -->
1787     <p class="short-description">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</p>
1788    
1789     <div class="method-signature">
1790     <span class="method-result">void</span>
1791     <span class="method-name">
1792     get_data_source
1793     </span>
1794     ()
1795     </div>
1796    
1797    
1798    
1799     </div>
1800     <a name="methodget_default_num_rows" id="get_default_num_rows"><!-- --></a>
1801     <div class="evenrow">
1802    
1803     <div class="method-header">
1804     <span class="method-title">get_default_num_rows</span> (line <span class="line-number">771</span>)
1805     </div>
1806    
1807     <!-- ========== Info from phpDoc block ========= -->
1808     <p class="short-description">This function gets the current default number of rows to display setting.</p>
1809    
1810     <div class="method-signature">
1811     <span class="method-result">int</span>
1812     <span class="method-name">
1813     get_default_num_rows
1814     </span>
1815     ()
1816     </div>
1817    
1818    
1819    
1820     </div>
1821     <a name="methodget_form_action" id="get_form_action"><!-- --></a>
1822     <div class="oddrow">
1823    
1824     <div class="method-header">
1825     <span class="method-title">get_form_action</span> (line <span class="line-number">1187</span>)
1826     </div>
1827    
1828     <!-- ========== Info from phpDoc block ========= -->
1829     <p class="short-description">This function is used to get the form action</p>
1830     <ul class="tags">
1831     <li><span class="field">return:</span> <p>(POST or GET)</p></li>
1832     </ul>
1833    
1834     <div class="method-signature">
1835     <span class="method-result">string</span>
1836     <span class="method-name">
1837     get_form_action
1838     </span>
1839     ()
1840     </div>
1841    
1842    
1843    
1844     </div>
1845     <a name="methodget_form_method" id="get_form_method"><!-- --></a>
1846     <div class="evenrow">
1847    
1848     <div class="method-header">
1849     <span class="method-title">get_form_method</span> (line <span class="line-number">1168</span>)
1850     </div>
1851    
1852     <!-- ========== Info from phpDoc block ========= -->
1853     <p class="short-description">This function is used to get the form method</p>
1854     <ul class="tags">
1855     <li><span class="field">return:</span> <p>(POST or GET)</p></li>
1856     </ul>
1857    
1858     <div class="method-signature">
1859     <span class="method-result">string</span>
1860     <span class="method-name">
1861     get_form_method
1862     </span>
1863     ()
1864     </div>
1865    
1866    
1867    
1868     </div>
1869     <a name="methodget_form_name" id="get_form_name"><!-- --></a>
1870     <div class="oddrow">
1871    
1872     <div class="method-header">
1873     <span class="method-title">get_form_name</span> (line <span class="line-number">1124</span>)
1874     </div>
1875    
1876     <!-- ========== Info from phpDoc block ========= -->
1877     <p class="short-description">This function is used to get the form name</p>
1878    
1879     <div class="method-signature">
1880     <span class="method-result">string</span>
1881     <span class="method-name">
1882     get_form_name
1883     </span>
1884     ()
1885     </div>
1886    
1887    
1888    
1889     </div>
1890     <a name="methodget_form_render" id="get_form_render"><!-- --></a>
1891     <div class="evenrow">
1892    
1893     <div class="method-header">
1894     <span class="method-title">get_form_render</span> (line <span class="line-number">1205</span>)
1895     </div>
1896    
1897     <!-- ========== Info from phpDoc block ========= -->
1898     <p class="short-description">Return the state of the form render</p>
1899    
1900     <div class="method-signature">
1901     <span class="method-result">bool</span>
1902     <span class="method-name">
1903     get_form_render
1904     </span>
1905     ()
1906     </div>
1907    
1908    
1909    
1910     </div>
1911     <a name="methodget_form_target" id="get_form_target"><!-- --></a>
1912     <div class="oddrow">
1913    
1914     <div class="method-header">
1915     <span class="method-title">get_form_target</span> (line <span class="line-number">1144</span>)
1916     </div>
1917    
1918     <!-- ========== Info from phpDoc block ========= -->
1919     <p class="short-description">This function is used to get the form target</p>
1920    
1921     <div class="method-signature">
1922     <span class="method-result">string</span>
1923     <span class="method-name">
1924     get_form_target
1925     </span>
1926     ()
1927     </div>
1928    
1929    
1930    
1931     </div>
1932     <a name="methodget_global_prefix" id="get_global_prefix"><!-- --></a>
1933     <div class="evenrow">
1934    
1935     <div class="method-header">
1936     <span class="method-title">get_global_prefix</span> (line <span class="line-number">635</span>)
1937     </div>
1938    
1939     <!-- ========== Info from phpDoc block ========= -->
1940     <p class="short-description">returns the current variable prefix string being used.</p>
1941     <ul class="tags">
1942     <li><span class="field">return:</span> <p>- current global prefix</p></li>
1943     </ul>
1944    
1945     <div class="method-signature">
1946     <span class="method-result">string</span>
1947     <span class="method-name">
1948     get_global_prefix
1949     </span>
1950     ()
1951     </div>
1952    
1953    
1954    
1955     </div>
1956     <a name="methodget_image_path" id="get_image_path"><!-- --></a>
1957     <div class="oddrow">
1958    
1959     <div class="method-header">
1960     <span class="method-title">get_image_path</span> (line <span class="line-number">1518</span>)
1961     </div>
1962    
1963     <!-- ========== Info from phpDoc block ========= -->
1964     <p class="short-description">This function returns the path to the images used in this class</p>
1965    
1966     <div class="method-signature">
1967     <span class="method-result">string</span>
1968     <span class="method-name">
1969     get_image_path
1970     </span>
1971     ()
1972     </div>
1973    
1974    
1975    
1976     </div>
1977     <a name="methodget_last_page" id="get_last_page"><!-- --></a>
1978     <div class="evenrow">
1979    
1980     <div class="method-header">
1981     <span class="method-title">get_last_page</span> (line <span class="line-number">1566</span>)
1982     </div>
1983    
1984     <!-- ========== Info from phpDoc block ========= -->
1985     <p class="short-description">This calculates the last page # for this list of items</p>
1986    
1987     <div class="method-signature">
1988     <span class="method-result">int</span>
1989     <span class="method-name">
1990     get_last_page
1991     </span>
1992     ()
1993     </div>
1994    
1995    
1996    
1997     </div>
1998     <a name="methodget_max_rows" id="get_max_rows"><!-- --></a>
1999     <div class="oddrow">
2000    
2001     <div class="method-header">
2002     <span class="method-title">get_max_rows</span> (line <span class="line-number">781</span>)
2003     </div>
2004    
2005     <!-- ========== Info from phpDoc block ========= -->
2006     <p class="short-description">This returns the Maximum # of rows to display when in expand mode</p>
2007    
2008     <div class="method-signature">
2009     <span class="method-result">int</span>
2010     <span class="method-name">
2011     get_max_rows
2012     </span>
2013     ()
2014     </div>
2015    
2016    
2017    
2018     </div>
2019     <a name="methodget_num_pages" id="get_num_pages"><!-- --></a>
2020     <div class="evenrow">
2021    
2022     <div class="method-header">
2023     <span class="method-title">get_num_pages</span> (line <span class="line-number">1549</span>)
2024     </div>
2025    
2026     <!-- ========== Info from phpDoc block ========= -->
2027     <p class="short-description">This function returns the # of pages that are available for this list of items.</p>
2028    
2029     <div class="method-signature">
2030     <span class="method-result">int</span>
2031     <span class="method-name">
2032     get_num_pages
2033     </span>
2034     ()
2035     </div>
2036    
2037    
2038    
2039     </div>
2040     <a name="methodget_page_info" id="get_page_info"><!-- --></a>
2041     <div class="oddrow">
2042    
2043     <div class="method-header">
2044     <span class="method-title">get_page_info</span> (line <span class="line-number">1577</span>)
2045     </div>
2046    
2047     <!-- ========== Info from phpDoc block ========= -->
2048     <p class="short-description">This function builds the string that describes the current page out of n pages the list is showing</p>
2049     <ul class="tags">
2050     <li><span class="field">return:</span> <p>(ie. 1 to 10 of 25)</p></li>
2051     </ul>
2052    
2053     <div class="method-signature">
2054     <span class="method-result">string</span>
2055     <span class="method-name">
2056     get_page_info
2057     </span>
2058     ()
2059     </div>
2060    
2061    
2062    
2063     </div>
2064     <a name="methodget_simple_search_modifier" id="get_simple_search_modifier"><!-- --></a>
2065     <div class="evenrow">
2066    
2067     <div class="method-header">
2068     <span class="method-title">get_simple_search_modifier</span> (line <span class="line-number">750</span>)
2069     </div>
2070    
2071     <!-- ========== Info from phpDoc block ========= -->
2072     <p class="short-description">gets the value of the search modifier flag.</p>
2073    
2074     <div class="method-signature">
2075     <span class="method-result">void</span>
2076     <span class="method-name">
2077     get_simple_search_modifier
2078     </span>
2079     ()
2080     </div>
2081    
2082    
2083    
2084     </div>
2085     <a name="methodgui_init" id="gui_init"><!-- --></a>
2086     <div class="oddrow">
2087    
2088     <div class="method-header">
2089     <span class="method-title">gui_init</span> (line <span class="line-number">492</span>)
2090     </div>
2091    
2092     <!-- ========== Info from phpDoc block ========= -->
2093     <p class="short-description">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</p>
2094    
2095     <div class="method-signature">
2096     <span class="method-result">void</span>
2097     <span class="method-name">
2098     gui_init
2099     </span>
2100     ()
2101     </div>
2102    
2103    
2104    
2105     <hr class="separator" />
2106     <div class="notes">Redefined in descendants as:</div>
2107     <ul class="redefinitions">
2108     <li>
2109     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodgui_init">DefaultGUIDatalist::gui_init()</a>
2110     </li>
2111     <li>
2112     <a href="../phpHtmlLib/SimpleGUIDataList.html#methodgui_init">SimpleGUIDataList::gui_init()</a>
2113     : Initialize the gui layout
2114     </li>
2115     <li>
2116     <a href="../phpHtmlLib/ListAction.html#methodgui_init">ListAction::gui_init()</a>
2117     : Initialize the gui layout
2118     </li>
2119     </ul>
2120     </div>
2121     <a name="methodis_advanced_search_enabled" id="is_advanced_search_enabled"><!-- --></a>
2122     <div class="evenrow">
2123    
2124     <div class="method-header">
2125     <span class="method-title">is_advanced_search_enabled</span> (line <span class="line-number">710</span>)
2126     </div>
2127    
2128     <!-- ========== Info from phpDoc block ========= -->
2129     <p class="short-description">This returns the status of the advanced search flag.</p>
2130    
2131     <div class="method-signature">
2132     <span class="method-result">boolean</span>
2133     <span class="method-name">
2134     is_advanced_search_enabled
2135     </span>
2136     ()
2137     </div>
2138    
2139    
2140    
2141     </div>
2142     <a name="methodis_search_enabled" id="is_search_enabled"><!-- --></a>
2143     <div class="oddrow">
2144    
2145     <div class="method-header">
2146     <span class="method-title">is_search_enabled</span> (line <span class="line-number">676</span>)
2147     </div>
2148    
2149     <!-- ========== Info from phpDoc block ========= -->
2150     <p class="short-description">get the status of the search ability.</p>
2151    
2152     <div class="method-signature">
2153     <span class="method-result">boolean</span>
2154     <span class="method-name">
2155     is_search_enabled
2156     </span>
2157     ()
2158     </div>
2159    
2160    
2161    
2162     </div>
2163     <a name="methodnumrows" id="numrows"><!-- --></a>
2164     <div class="evenrow">
2165    
2166     <div class="method-header">
2167     <span class="method-title">numrows</span> (line <span class="line-number">968</span>)
2168     </div>
2169    
2170     <!-- ========== Info from phpDoc block ========= -->
2171     <p class="short-description">This function returns the number of rows that the query found.</p>
2172     <ul class="tags">
2173     <li><span class="field">return:</span> <p>- the number of rows</p></li>
2174     </ul>
2175    
2176     <div class="method-signature">
2177     <span class="method-result">int</span>
2178     <span class="method-name">
2179     numrows
2180     </span>
2181     ()
2182     </div>
2183    
2184    
2185    
2186     </div>
2187     <a name="methodoffset" id="offset"><!-- --></a>
2188     <div class="oddrow">
2189    
2190     <div class="method-header">
2191     <span class="method-title">offset</span> (line <span class="line-number">896</span>)
2192     </div>
2193    
2194     <!-- ========== Info from phpDoc block ========= -->
2195     <p class="short-description">This function returns the current value of the offset variable. This is an offset into the query return data set.</p>
2196     <ul class="tags">
2197     <li><span class="field">return:</span> <p>- the current value.</p></li>
2198     </ul>
2199    
2200     <div class="method-signature">
2201     <span class="method-result">int</span>
2202     <span class="method-name">
2203     offset
2204     </span>
2205     ()
2206     </div>
2207    
2208    
2209    
2210     </div>
2211     <a name="methodorderby" id="orderby"><!-- --></a>
2212     <div class="evenrow">
2213    
2214     <div class="method-header">
2215     <span class="method-title">orderby</span> (line <span class="line-number">916</span>)
2216     </div>
2217    
2218     <!-- ========== Info from phpDoc block ========= -->
2219     <p class="short-description">This function returns the value of the current orderby variable.</p>
2220    
2221     <div class="method-signature">
2222     <span class="method-result">string.</span>
2223     <span class="method-name">
2224     orderby
2225     </span>
2226     ()
2227     </div>
2228    
2229    
2230    
2231     </div>
2232     <a name="methodrender" id="render"><!-- --></a>
2233     <div class="oddrow">
2234    
2235     <div class="method-header">
2236     <span class="method-title">render</span> (line <span class="line-number">321</span>)
2237     </div>
2238    
2239     <!-- ========== Info from phpDoc block ========= -->
2240     <p class="short-description">This function renders the final</p>
2241     <p class="description"><p>widget</p></p>
2242    
2243     <div class="method-signature">
2244     <span class="method-result">void</span>
2245     <span class="method-name">
2246     render
2247     </span>
2248     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
2249     </div>
2250    
2251    
2252     <hr class="separator" />
2253     <div class="notes">Redefinition of:</div>
2254 jonen 1.2 <dl>
2255 jonen 1.3 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
2256     <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
2257     </dl>
2258    
2259     </div>
2260     <a name="methodreverseorder" id="reverseorder"><!-- --></a>
2261     <div class="evenrow">
2262    
2263     <div class="method-header">
2264     <span class="method-title">reverseorder</span> (line <span class="line-number">937</span>)
2265     </div>
2266    
2267     <!-- ========== Info from phpDoc block ========= -->
2268     <p class="short-description">This function returns the current value of the reverse order member variable.</p>
2269    
2270     <div class="method-signature">
2271     <span class="method-result">string.</span>
2272     <span class="method-name">
2273     reverseorder
2274     </span>
2275     ()
2276     </div>
2277    
2278    
2279    
2280     </div>
2281     <a name="methodsearch_disable" id="search_disable"><!-- --></a>
2282     <div class="oddrow">
2283    
2284     <div class="method-header">
2285     <span class="method-title">search_disable</span> (line <span class="line-number">666</span>)
2286     </div>
2287    
2288     <!-- ========== Info from phpDoc block ========= -->
2289     <p class="short-description">Disable the search ability.</p>
2290    
2291     <div class="method-signature">
2292     <span class="method-result">void</span>
2293     <span class="method-name">
2294     search_disable
2295     </span>
2296     (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
2297     </div>
2298    
2299     <ul class="parameters">
2300     <li>
2301     <span class="var-type">boolean</span>
2302     <span class="var-name">0</span> </li>
2303     </ul>
2304    
2305    
2306     </div>
2307     <a name="methodsearch_enable" id="search_enable"><!-- --></a>
2308     <div class="evenrow">
2309    
2310     <div class="method-header">
2311     <span class="method-title">search_enable</span> (line <span class="line-number">654</span>)
2312     </div>
2313    
2314     <!-- ========== Info from phpDoc block ========= -->
2315     <p class="short-description">Enable the search ability.</p>
2316    
2317     <div class="method-signature">
2318     <span class="method-result">void</span>
2319     <span class="method-name">
2320     search_enable
2321     </span>
2322     (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
2323     </div>
2324    
2325     <ul class="parameters">
2326     <li>
2327     <span class="var-type">boolean</span>
2328     <span class="var-name">0</span> </li>
2329     </ul>
2330    
2331    
2332     </div>
2333     <a name="methodsearch_field" id="search_field"><!-- --></a>
2334     <div class="oddrow">
2335    
2336     <div class="method-header">
2337     <span class="method-title">search_field</span> (line <span class="line-number">988</span>)
2338     </div>
2339    
2340     <!-- ========== Info from phpDoc block ========= -->
2341     <p class="short-description">returns the current value of the search field name</p>
2342    
2343     <div class="method-signature">
2344     <span class="method-result">string</span>
2345     <span class="method-name">
2346     search_field
2347     </span>
2348     ()
2349     </div>
2350    
2351    
2352    
2353     </div>
2354     <a name="methodsearch_type" id="search_type"><!-- --></a>
2355     <div class="evenrow">
2356    
2357     <div class="method-header">
2358     <span class="method-title">search_type</span> (line <span class="line-number">1040</span>)
2359     </div>
2360    
2361     <!-- ========== Info from phpDoc block ========= -->
2362     <p class="short-description">returns the type of search being used</p>
2363    
2364     <div class="method-signature">
2365     <span class="method-result">string</span>
2366     <span class="method-name">
2367     search_type
2368     </span>
2369     ()
2370     </div>
2371    
2372    
2373    
2374     </div>
2375     <a name="methodsearch_value" id="search_value"><!-- --></a>
2376     <div class="oddrow">
2377    
2378     <div class="method-header">
2379     <span class="method-title">search_value</span> (line <span class="line-number">1009</span>)
2380     </div>
2381    
2382     <!-- ========== Info from phpDoc block ========= -->
2383     <p class="short-description">returns the current value of te search field value.</p>
2384    
2385     <div class="method-signature">
2386     <span class="method-result">string</span>
2387     <span class="method-name">
2388     search_value
2389     </span>
2390     ()
2391     </div>
2392    
2393    
2394    
2395     </div>
2396     <a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a>
2397     <div class="evenrow">
2398    
2399     <div class="method-header">
2400     <span class="method-title">search_value_filter</span> (line <span class="line-number">1756</span>)
2401     </div>
2402    
2403     <!-- ========== Info from phpDoc block ========= -->
2404     <p class="short-description">This function is used to make safe any query string value that is used</p>
2405    
2406     <div class="method-signature">
2407     <span class="method-result">string</span>
2408     <span class="method-name">
2409     search_value_filter
2410     </span>
2411     (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
2412     </div>
2413    
2414     <ul class="parameters">
2415     <li>
2416     <span class="var-type">string</span>
2417     <span class="var-name">$value</span> </li>
2418     </ul>
2419    
2420    
2421     </div>
2422     <a name="methodsetup_columns" id="setup_columns"><!-- --></a>
2423     <div class="oddrow">
2424    
2425     <div class="method-header">
2426     <span class="method-title">setup_columns</span> (line <span class="line-number">827</span>)
2427     </div>
2428    
2429     <!-- ========== Info from phpDoc block ========= -->
2430    
2431     <div class="method-signature">
2432     <span class="method-result">void</span>
2433     <span class="method-name">
2434     setup_columns
2435     </span>
2436     ()
2437     </div>
2438    
2439    
2440    
2441     </div>
2442     <a name="methodset_data_source" id="set_data_source"><!-- --></a>
2443     <div class="evenrow">
2444    
2445     <div class="method-header">
2446     <span class="method-title">set_data_source</span> (line <span class="line-number">645</span>)
2447     </div>
2448    
2449     <!-- ========== Info from phpDoc block ========= -->
2450     <p class="short-description">This function is used to set the DataListSource object for this instance</p>
2451    
2452     <div class="method-signature">
2453     <span class="method-result">void</span>
2454     <span class="method-name">
2455     set_data_source
2456     </span>
2457     (<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>&nbsp;<span class="var-name">$datasource</span>)
2458     </div>
2459    
2460     <ul class="parameters">
2461     <li>
2462     <span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
2463     <span class="var-name">$datasource</span><span class="var-description">: <p>object</p></span> </li>
2464     </ul>
2465    
2466    
2467     </div>
2468     <a name="methodset_default_num_rows" id="set_default_num_rows"><!-- --></a>
2469     <div class="oddrow">
2470    
2471     <div class="method-header">
2472     <span class="method-title">set_default_num_rows</span> (line <span class="line-number">761</span>)
2473     </div>
2474    
2475     <!-- ========== Info from phpDoc block ========= -->
2476     <p class="short-description">This function sets the default # of rows per page to display. By default its 10.</p>
2477     <p class="description"><p>This lets the user override this value.</p></p>
2478    
2479     <div class="method-signature">
2480     <span class="method-result">void</span>
2481     <span class="method-name">
2482     set_default_num_rows
2483     </span>
2484     (<span class="var-type">int</span>&nbsp;<span class="var-name">$num_rows</span>)
2485     </div>
2486    
2487     <ul class="parameters">
2488     <li>
2489     <span class="var-type">int</span>
2490     <span class="var-name">$num_rows</span><span class="var-description">: <p>- the # of rows to use.</p></span> </li>
2491     </ul>
2492    
2493    
2494     </div>
2495     <a name="methodset_form_action" id="set_form_action"><!-- --></a>
2496     <div class="evenrow">
2497    
2498     <div class="method-header">
2499     <span class="method-title">set_form_action</span> (line <span class="line-number">1177</span>)
2500     </div>
2501    
2502     <!-- ========== Info from phpDoc block ========= -->
2503     <p class="short-description">Sets the form action</p>
2504    
2505     <div class="method-signature">
2506     <span class="method-result">void</span>
2507     <span class="method-name">
2508     set_form_action
2509     </span>
2510     (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>)
2511     </div>
2512    
2513     <ul class="parameters">
2514     <li>
2515     <span class="var-type">string</span>
2516     <span class="var-name">$action</span> </li>
2517     </ul>
2518    
2519    
2520     </div>
2521     <a name="methodset_form_method" id="set_form_method"><!-- --></a>
2522     <div class="oddrow">
2523    
2524     <div class="method-header">
2525     <span class="method-title">set_form_method</span> (line <span class="line-number">1154</span>)
2526     </div>
2527    
2528     <!-- ========== Info from phpDoc block ========= -->
2529     <p class="short-description">This function is used to set the form method</p>
2530    
2531     <div class="method-signature">
2532     <span class="method-result">void</span>
2533     <span class="method-name">
2534     set_form_method
2535     </span>
2536     (<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
2537     </div>
2538    
2539     <ul class="parameters">
2540     <li>
2541     <span class="var-type">string</span>
2542     <span class="var-name">$method</span><span class="var-description">: <p>(POST or GET)</p></span> </li>
2543     </ul>
2544    
2545    
2546     </div>
2547     <a name="methodset_form_name" id="set_form_name"><!-- --></a>
2548     <div class="evenrow">
2549    
2550     <div class="method-header">
2551     <span class="method-title">set_form_name</span> (line <span class="line-number">1114</span>)
2552     </div>
2553    
2554     <!-- ========== Info from phpDoc block ========= -->
2555     <p class="short-description">This function is used to set the form name</p>
2556    
2557     <div class="method-signature">
2558     <span class="method-result">void</span>
2559     <span class="method-name">
2560     set_form_name
2561     </span>
2562     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
2563     </div>
2564    
2565     <ul class="parameters">
2566     <li>
2567     <span class="var-type">string</span>
2568     <span class="var-name">$name</span> </li>
2569     </ul>
2570    
2571    
2572     </div>
2573     <a name="methodset_form_render" id="set_form_render"><!-- --></a>
2574     <div class="oddrow">
2575    
2576     <div class="method-header">
2577     <span class="method-title">set_form_render</span> (line <span class="line-number">1196</span>)
2578     </div>
2579    
2580     <!-- ========== Info from phpDoc block ========= -->
2581     <p class="short-description">Sets whether to the output into a form</p>
2582    
2583     <div class="method-signature">
2584     <span class="method-result">void</span>
2585     <span class="method-name">
2586     set_form_render
2587     </span>
2588     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
2589     </div>
2590    
2591     <ul class="parameters">
2592     <li>
2593     <span class="var-type">bool</span>
2594     <span class="var-name">$flag</span> </li>
2595     </ul>
2596    
2597    
2598     </div>
2599     <a name="methodset_form_target" id="set_form_target"><!-- --></a>
2600     <div class="evenrow">
2601    
2602     <div class="method-header">
2603     <span class="method-title">set_form_target</span> (line <span class="line-number">1134</span>)
2604     </div>
2605    
2606     <!-- ========== Info from phpDoc block ========= -->
2607     <p class="short-description">This function is used to set the form target</p>
2608    
2609     <div class="method-signature">
2610     <span class="method-result">void</span>
2611     <span class="method-name">
2612     set_form_target
2613     </span>
2614     (<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
2615     </div>
2616    
2617     <ul class="parameters">
2618     <li>
2619     <span class="var-type">string</span>
2620     <span class="var-name">$target</span> </li>
2621     </ul>
2622    
2623    
2624     </div>
2625     <a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a>
2626     <div class="oddrow">
2627    
2628     <div class="method-header">
2629     <span class="method-title">set_global_prefix</span> (line <span class="line-number">621</span>)
2630     </div>
2631    
2632     <!-- ========== Info from phpDoc block ========= -->
2633     <p class="short-description">This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.</p>
2634    
2635     <div class="method-signature">
2636     <span class="method-result">void</span>
2637     <span class="method-name">
2638     set_global_prefix
2639     </span>
2640     (<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>)
2641     </div>
2642    
2643     <ul class="parameters">
2644     <li>
2645     <span class="var-type">string</span>
2646     <span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for all vars.</p></span> </li>
2647     </ul>
2648    
2649    
2650     <hr class="separator" />
2651     <div class="notes">Redefined in descendants as:</div>
2652     <ul class="redefinitions">
2653     <li>
2654     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_global_prefix">DefaultGUIDatalist::set_global_prefix()</a>
2655     : This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.
2656     </li>
2657     </ul>
2658     </div>
2659     <a name="methodset_image_path" id="set_image_path"><!-- --></a>
2660     <div class="evenrow">
2661    
2662     <div class="method-header">
2663     <span class="method-title">set_image_path</span> (line <span class="line-number">1528</span>)
2664     </div>
2665    
2666     <!-- ========== Info from phpDoc block ========= -->
2667     <p class="short-description">This function returns the path to the images used in this class</p>
2668    
2669     <div class="method-signature">
2670     <span class="method-result">string</span>
2671     <span class="method-name">
2672     set_image_path
2673     </span>
2674     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$path</span>)
2675     </div>
2676    
2677    
2678    
2679     </div>
2680     <a name="methodset_max_rows" id="set_max_rows"><!-- --></a>
2681     <div class="oddrow">
2682    
2683     <div class="method-header">
2684     <span class="method-title">set_max_rows</span> (line <span class="line-number">793</span>)
2685     </div>
2686    
2687     <!-- ========== Info from phpDoc block ========= -->
2688     <p class="short-description">This sets the maximum # of rows to display when in expand mode</p>
2689    
2690     <div class="method-signature">
2691     <span class="method-result">void</span>
2692     <span class="method-name">
2693     set_max_rows
2694     </span>
2695     (<span class="var-type">int</span>&nbsp;<span class="var-name">$max</span>)
2696     </div>
2697    
2698     <ul class="parameters">
2699     <li>
2700     <span class="var-type">int</span>
2701     <span class="var-name">$max</span><span class="var-description">: <p>- new # of maximum rows to display when in 'expand' mode</p></span> </li>
2702     </ul>
2703    
2704    
2705     </div>
2706     <a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a>
2707     <div class="evenrow">
2708    
2709     <div class="method-header">
2710     <span class="method-title">set_not_found_message</span> (line <span class="line-number">1215</span>)
2711     </div>
2712    
2713     <!-- ========== Info from phpDoc block ========= -->
2714     <p class="short-description">This function is used to set the message displayed when no data is found</p>
2715    
2716     <div class="method-signature">
2717     <span class="method-result">void</span>
2718     <span class="method-name">
2719     set_not_found_message
2720     </span>
2721     (<span class="var-type">string</span>&nbsp;<span class="var-name">$mesg</span>)
2722     </div>
2723    
2724     <ul class="parameters">
2725     <li>
2726     <span class="var-type">string</span>
2727     <span class="var-name">$mesg</span> </li>
2728     </ul>
2729    
2730    
2731     </div>
2732     <a name="methodset_numrows" id="set_numrows"><!-- --></a>
2733     <div class="oddrow">
2734    
2735     <div class="method-header">
2736     <span class="method-title">set_numrows</span> (line <span class="line-number">978</span>)
2737     </div>
2738    
2739     <!-- ========== Info from phpDoc block ========= -->
2740     <p class="short-description">This function sets the # of rows to display per page.</p>
2741    
2742     <div class="method-signature">
2743     <span class="method-result">void</span>
2744     <span class="method-name">
2745     set_numrows
2746     </span>
2747     (<span class="var-type">int</span>&nbsp;<span class="var-name">$new_numrows</span>)
2748     </div>
2749    
2750     <ul class="parameters">
2751     <li>
2752     <span class="var-type">int</span>
2753     <span class="var-name">$new_numrows</span><span class="var-description">: <p>- the # of rows</p></span> </li>
2754     </ul>
2755    
2756    
2757     </div>
2758     <a name="methodset_offset" id="set_offset"><!-- --></a>
2759     <div class="evenrow">
2760    
2761     <div class="method-header">
2762     <span class="method-title">set_offset</span> (line <span class="line-number">906</span>)
2763     </div>
2764    
2765     <!-- ========== Info from phpDoc block ========= -->
2766     <p class="short-description">This function is used to set/change the offset for this list.</p>
2767    
2768     <div class="method-signature">
2769     <span class="method-result">void</span>
2770     <span class="method-name">
2771     set_offset
2772     </span>
2773     (<span class="var-type">int</span>&nbsp;<span class="var-name">$new_offset</span>)
2774     </div>
2775    
2776     <ul class="parameters">
2777     <li>
2778     <span class="var-type">int</span>
2779     <span class="var-name">$new_offset</span><span class="var-description">: <p>- the new offset.</p></span> </li>
2780     </ul>
2781    
2782    
2783     </div>
2784     <a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a>
2785     <div class="oddrow">
2786    
2787     <div class="method-header">
2788     <span class="method-title">set_reverseorder</span> (line <span class="line-number">947</span>)
2789     </div>
2790    
2791     <!-- ========== Info from phpDoc block ========= -->
2792     <p class="short-description">This function sets the reverse order flag to a new value.</p>
2793    
2794     <div class="method-signature">
2795     <span class="method-result">void</span>
2796     <span class="method-name">
2797     set_reverseorder
2798     </span>
2799     (<span class="var-type">string</span>&nbsp;<span class="var-name">$new_value</span>)
2800     </div>
2801    
2802     <ul class="parameters">
2803     <li>
2804     <span class="var-type">string</span>
2805     <span class="var-name">$new_value</span><span class="var-description">: <p>- the new value.</p></span> </li>
2806     </ul>
2807    
2808    
2809     </div>
2810     <a name="methodset_save_vars" id="set_save_vars"><!-- --></a>
2811     <div class="evenrow">
2812    
2813     <div class="method-header">
2814     <span class="method-title">set_save_vars</span> (line <span class="line-number">1270</span>)
2815     </div>
2816    
2817     <!-- ========== Info from phpDoc block ========= -->
2818     <p class="short-description">This function sets the save variables that the user/child wants to automatically propogate</p>
2819    
2820     <div class="method-signature">
2821     <span class="method-result">void</span>
2822     <span class="method-name">
2823     set_save_vars
2824     </span>
2825     (<span class="var-type">array</span>&nbsp;<span class="var-name">$vars</span>)
2826     </div>
2827    
2828     <ul class="parameters">
2829     <li>
2830     <span class="var-type">array</span>
2831     <span class="var-name">$vars</span><span class="var-description">: <p>- name=&gt;value pairs of the data that they want to propogate</p></span> </li>
2832     </ul>
2833    
2834    
2835     </div>
2836     <a name="methodset_search_type" id="set_search_type"><!-- --></a>
2837     <div class="oddrow">
2838    
2839     <div class="method-header">
2840     <span class="method-title">set_search_type</span> (line <span class="line-number">1050</span>)
2841     </div>
2842    
2843     <!-- ========== Info from phpDoc block ========= -->
2844     <p class="short-description">This function sets the search type</p>
2845    
2846     <div class="method-signature">
2847     <span class="method-result">void</span>
2848     <span class="method-name">
2849     set_search_type
2850     </span>
2851     (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
2852     </div>
2853    
2854     <ul class="parameters">
2855     <li>
2856     <span class="var-type">string</span>
2857     <span class="var-name">$type</span><span class="var-description">: <p>- the search type &quot;simple&quot; or &quot;advanced&quot;</p></span> </li>
2858     </ul>
2859    
2860    
2861     </div>
2862     <a name="methodset_show_results" id="set_show_results"><!-- --></a>
2863     <div class="evenrow">
2864    
2865     <div class="method-header">
2866     <span class="method-title">set_show_results</span> (line <span class="line-number">1227</span>)
2867     </div>
2868    
2869     <!-- ========== Info from phpDoc block ========= -->
2870     <p class="short-description">This function is used to set the value of the _show_results_flag</p>
2871    
2872     <div class="method-signature">
2873     <span class="method-result">void</span>
2874     <span class="method-name">
2875     set_show_results
2876     </span>
2877     ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
2878     </div>
2879    
2880     <ul class="parameters">
2881     <li>
2882     <span class="var-type">boolean</span>
2883     <span class="var-name">$flag</span><span class="var-description">: <p>- TRUE to show the results</p></span> </li>
2884     </ul>
2885    
2886    
2887     </div>
2888     <a name="methodset_simple_search_modifier" id="set_simple_search_modifier"><!-- --></a>
2889     <div class="oddrow">
2890    
2891     <div class="method-header">
2892     <span class="method-title">set_simple_search_modifier</span> (line <span class="line-number">735</span>)
2893     </div>
2894    
2895     <!-- ========== Info from phpDoc block ========= -->
2896     <p class="short-description">Set the simple search modifyer flag.</p>
2897     <p class="description"><p>NOTE: by default all the modifiers are enabled. You can limit the modifiers by passing in the string of defines of which ones you want enabled.</p><p>MODIFIERS: SEARCH_BEGINS_WITH SEARCH_CONTAINS SEARCH_EXACT SEARCH_ENDS_WITH</p><p>ie. SEARCH_BEGINS_WITH.SEARCH_EXACT will enable ONLY the &quot;begins with&quot; and &quot;exact&quot; modifiers.</p></p>
2898    
2899     <div class="method-signature">
2900     <span class="method-result">void</span>
2901     <span class="method-name">
2902     set_simple_search_modifier
2903     </span>
2904     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>])
2905     </div>
2906    
2907     <ul class="parameters">
2908     <li>
2909     <span class="var-type">string</span>
2910     <span class="var-name">$modifier</span> </li>
2911     </ul>
2912    
2913    
2914     </div>
2915     <a name="methodshowall" id="showall"><!-- --></a>
2916     <div class="evenrow">
2917    
2918     <div class="method-header">
2919     <span class="method-title">showall</span> (line <span class="line-number">1062</span>)
2920     </div>
2921    
2922     <!-- ========== Info from phpDoc block ========= -->
2923     <p class="short-description">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</p>
2924     <ul class="tags">
2925     <li><span class="field">return:</span> <p>- the current value</p></li>
2926     </ul>
2927    
2928     <div class="method-signature">
2929     <span class="method-result">string</span>
2930     <span class="method-name">
2931     showall
2932     </span>
2933     ()
2934     </div>
2935    
2936    
2937    
2938     </div>
2939     <a name="methodsimple_search_modifier_value" id="simple_search_modifier_value"><!-- --></a>
2940     <div class="oddrow">
2941    
2942     <div class="method-header">
2943     <span class="method-title">simple_search_modifier_value</span> (line <span class="line-number">1030</span>)
2944     </div>
2945    
2946     <!-- ========== Info from phpDoc block ========= -->
2947     <p class="short-description">returns the current value of the simple search modifier</p>
2948    
2949     <div class="method-signature">
2950     <span class="method-result">string</span>
2951     <span class="method-name">
2952     simple_search_modifier_value
2953     </span>
2954     ()
2955     </div>
2956    
2957    
2958    
2959     </div>
2960     <a name="methoduser_setup" id="user_setup"><!-- --></a>
2961     <div class="evenrow">
2962    
2963     <div class="method-header">
2964     <span class="method-title">user_setup</span> (line <span class="line-number">478</span>)
2965     </div>
2966    
2967     <!-- ========== Info from phpDoc block ========= -->
2968     <p class="short-description">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</p>
2969    
2970     <div class="method-signature">
2971     <span class="method-result">void</span>
2972     <span class="method-name">
2973     user_setup
2974     </span>
2975     ()
2976     </div>
2977    
2978    
2979    
2980     </div>
2981     <a name="method_build_default_vars" id="_build_default_vars"><!-- --></a>
2982     <div class="oddrow">
2983    
2984     <div class="method-header">
2985     <span class="method-title">_build_default_vars</span> (line <span class="line-number">1282</span>)
2986     </div>
2987    
2988     <!-- ========== Info from phpDoc block ========= -->
2989     <p class="short-description">This function builds the list of</p>
2990     <p class="description"><p>default hidden form vars for when the datalist is being rendered as a POST</p></p>
2991    
2992     <div class="method-signature">
2993     <span class="method-result">Container</span>
2994     <span class="method-name">
2995     _build_default_vars
2996     </span>
2997     ()
2998     </div>
2999    
3000    
3001    
3002     </div>
3003     <a name="method_build_save_vars" id="_build_save_vars"><!-- --></a>
3004     <div class="evenrow">
3005    
3006     <div class="method-header">
3007     <span class="method-title">_build_save_vars</span> (line <span class="line-number">1254</span>)
3008     </div>
3009    
3010     <!-- ========== Info from phpDoc block ========= -->
3011     <p class="short-description">this method builds some hidden form fields to automatically be placed inside the form.</p>
3012     <p class="description"><p>This method returns a list of hidden form fields if we are a POST. It returns a portion of a query string If we are a GET.</p></p>
3013     <ul class="tags">
3014     <li><span class="field">return:</span> <p>depending on form method</p></li>
3015     </ul>
3016    
3017     <div class="method-signature">
3018     <span class="method-result">mixed</span>
3019     <span class="method-name">
3020     _build_save_vars
3021     </span>
3022     ()
3023     </div>
3024    
3025    
3026    
3027     </div>
3028     <a name="method_build_simple_search_modifier" id="_build_simple_search_modifier"><!-- --></a>
3029     <div class="oddrow">
3030    
3031     <div class="method-header">
3032     <span class="method-title">_build_simple_search_modifier</span> (line <span class="line-number">1721</span>)
3033     </div>
3034    
3035     <!-- ========== Info from phpDoc block ========= -->
3036     <p class="short-description">This builds the simple search modifier select box.</p>
3037     <ul class="tags">
3038     <li><span class="field">return:</span> <p>object.</p></li>
3039     </ul>
3040    
3041     <div class="method-signature">
3042     <span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
3043     <span class="method-name">
3044     _build_simple_search_modifier
3045     </span>
3046     ()
3047     </div>
3048    
3049    
3050    
3051     </div>
3052     <a name="method_build_tool_url" id="_build_tool_url"><!-- --></a>
3053     <div class="evenrow">
3054    
3055     <div class="method-header">
3056     <span class="method-title">_build_tool_url</span> (line <span class="line-number">1450</span>)
3057     </div>
3058    
3059     <!-- ========== Info from phpDoc block ========= -->
3060     <p class="short-description">This function is used to build the url for a tool link.</p>
3061     <p class="description"><p>(first, prev, next, last, all)</p></p>
3062    
3063     <div class="method-signature">
3064     <span class="method-result">string</span>
3065     <span class="method-name">
3066     _build_tool_url
3067     </span>
3068     (<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$showall_value</span>)
3069     </div>
3070    
3071     <ul class="parameters">
3072     <li>
3073     <span class="var-type">int</span>
3074     <span class="var-name">$offset</span><span class="var-description">: <p>- the offset for the link</p></span> </li>
3075     <li>
3076     <span class="var-type">boolean</span>
3077     <span class="var-name">$showall_flag</span><span class="var-description">: <p>- add the showall value to the url</p></span> </li>
3078     <li>
3079     <span class="var-type">int</span>
3080     <span class="var-name">$showall_value</span><span class="var-description">: <p>- the showall value to use if the flag is on</p></span> </li>
3081     </ul>
3082    
3083    
3084     </div>
3085     <a name="method_check_datasource" id="_check_datasource"><!-- --></a>
3086     <div class="oddrow">
3087    
3088     <div class="method-header">
3089     <span class="method-title">_check_datasource</span> (line <span class="line-number">847</span>)
3090     </div>
3091    
3092     <!-- ========== Info from phpDoc block ========= -->
3093     <p class="short-description">general DataListSource object checker.</p>
3094    
3095     <div class="method-signature">
3096     <span class="method-result">void</span>
3097     <span class="method-name">
3098     _check_datasource
3099     </span>
3100     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$function_name</span>)
3101     </div>
3102    
3103    
3104    
3105     </div>
3106     <a name="method_clean_string" id="_clean_string"><!-- --></a>
3107     <div class="evenrow">
3108    
3109     <div class="method-header">
3110     <span class="method-title">_clean_string</span> (line <span class="line-number">1680</span>)
3111     </div>
3112    
3113     <!-- ========== Info from phpDoc block ========= -->
3114     <p class="short-description">This function is used to make sure that the string we are placing in a cell has been &quot;cleaned&quot;</p>
3115     <ul class="tags">
3116     <li><span class="field">return:</span> <p>- the cleaned string or object</p></li>
3117     </ul>
3118    
3119     <div class="method-signature">
3120     <span class="method-result">mixed</span>
3121     <span class="method-name">
3122     _clean_string
3123     </span>
3124     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>)
3125     </div>
3126    
3127     <ul class="parameters">
3128     <li>
3129     <span class="var-type">mixed</span>
3130     <span class="var-name">$obj</span><span class="var-description">: <p>- the cell object. It can be a string.</p></span> </li>
3131     <li>
3132     <span class="var-type">string</span>
3133     <span class="var-name">$col_name</span><span class="var-description">: <p>- the name of the column this object/string will live</p></span> </li>
3134     </ul>
3135    
3136    
3137     </div>
3138     <a name="method_filter_column_string" id="_filter_column_string"><!-- --></a>
3139     <div class="oddrow">
3140    
3141     <div class="method-header">
3142     <span class="method-title">_filter_column_string</span> (line <span class="line-number">1099</span>)
3143     </div>
3144    
3145     <!-- ========== Info from phpDoc block ========= -->
3146     <p class="short-description">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</p>
3147     <ul class="tags">
3148     <li><span class="field">return:</span> <p>the cleaned/filtered data</p></li>
3149     </ul>
3150    
3151     <div class="method-signature">
3152     <span class="method-result">string</span>
3153     <span class="method-name">
3154     _filter_column_string
3155     </span>
3156     (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
3157     </div>
3158    
3159     <ul class="parameters">
3160     <li>
3161     <span class="var-type">string</span>
3162     <span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li>
3163     </ul>
3164    
3165    
3166     </div>
3167     <a name="method_get" id="_get"><!-- --></a>
3168     <div class="evenrow">
3169    
3170     <div class="method-header">
3171     <span class="method-title">_get</span> (line <span class="line-number">870</span>)
3172     </div>
3173    
3174     <!-- ========== Info from phpDoc block ========= -->
3175     <p class="short-description">Function used to get the current value of one of the control vars for this class</p>
3176     <ul class="tags">
3177     <li><span class="field">return:</span> <p>current value or default if not set</p></li>
3178     </ul>
3179    
3180     <div class="method-signature">
3181     <span class="method-result">the</span>
3182     <span class="method-name">
3183     _get
3184     </span>
3185     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$default_value</span> = <span class="var-default">NULL</span>])
3186     </div>
3187    
3188     <ul class="parameters">
3189     <li>
3190     <span class="var-type">string</span>
3191     <span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li>
3192     <li>
3193     <span class="var-type">mixed</span>
3194     <span class="var-name">$default_value</span><span class="var-description">: <p>- the default value if not set</p></span> </li>
3195     </ul>
3196    
3197    
3198     </div>
3199     <a name="method_get_searchable_fields" id="_get_searchable_fields"><!-- --></a>
3200     <div class="oddrow">
3201    
3202     <div class="method-header">
3203     <span class="method-title">_get_searchable_fields</span> (line <span class="line-number">1705</span>)
3204     </div>
3205    
3206     <!-- ========== Info from phpDoc block ========= -->
3207     <p class="short-description">This method gets the array of searchable header fields (columns)</p>
3208    
3209     <div class="method-signature">
3210     <span class="method-result">array</span>
3211     <span class="method-name">
3212     _get_searchable_fields
3213     </span>
3214     ()
3215     </div>
3216    
3217    
3218    
3219     </div>
3220     <a name="method_javascript" id="_javascript"><!-- --></a>
3221     <div class="evenrow">
3222    
3223     <div class="method-header">
3224     <span class="method-title">_javascript</span> (line <span class="line-number">571</span>)
3225     </div>
3226    
3227     <!-- ========== Info from phpDoc block ========= -->
3228     <p class="short-description">This function provides a way to automatically add javascript to this object.</p>
3229     <p class="description"><p>This function is meant to be extended by the child class.</p></p>
3230     <ul class="tags">
3231     <li><span class="field">return:</span> <p>object</p></li>
3232     </ul>
3233    
3234     <div class="method-signature">
3235     <span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span>
3236     <span class="method-name">
3237     _javascript
3238     </span>
3239     ()
3240     </div>
3241    
3242    
3243    
3244     <hr class="separator" />
3245     <div class="notes">Redefined in descendants as:</div>
3246     <ul class="redefinitions">
3247     <li>
3248     <a href="../phpHtmlLib/DefaultGUIDatalist.html#method_javascript">DefaultGUIDatalist::_javascript()</a>
3249     : This function returns any Javascript required for this widget
3250     </li>
3251     </ul>
3252     </div>
3253     <a name="method_save_mozilla_nav_link" id="_save_mozilla_nav_link"><!-- --></a>
3254     <div class="oddrow">
3255    
3256     <div class="method-header">
3257     <span class="method-title">_save_mozilla_nav_link</span> (line <span class="line-number">1507</span>)
3258     </div>
3259    
3260     <!-- ========== Info from phpDoc block ========= -->
3261     <p class="short-description">This function stores the url for each of the tool urls, so we can push these out for mozilla.</p>
3262     <p class="description"><p>Mozilla has a nice navigation bar feature that lets you program first, prev, next, last links</p></p>
3263    
3264     <div class="method-signature">
3265     <span class="method-result">void</span>
3266     <span class="method-name">
3267     _save_mozilla_nav_link
3268     </span>
3269     (<span class="var-type">string</span>&nbsp;<span class="var-name">$which</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
3270     </div>
3271    
3272     <ul class="parameters">
3273     <li>
3274     <span class="var-type">string</span>
3275     <span class="var-name">$which</span><span class="var-description">: <p>- which tool link</p></span> </li>
3276     <li>
3277     <span class="var-type">string</span>
3278     <span class="var-name">$url</span><span class="var-description">: <p>- the url for that link</p></span> </li>
3279     </ul>
3280    
3281    
3282     </div>
3283     <a name="method_set" id="_set"><!-- --></a>
3284     <div class="evenrow">
3285    
3286     <div class="method-header">
3287     <span class="method-title">_set</span> (line <span class="line-number">885</span>)
3288     </div>
3289    
3290     <!-- ========== Info from phpDoc block ========= -->
3291     <p class="short-description">This function is used to set the value of the control var</p>
3292    
3293     <div class="method-signature">
3294     <span class="method-result">void</span>
3295     <span class="method-name">
3296     _set
3297     </span>
3298     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
3299     </div>
3300    
3301     <ul class="parameters">
3302     <li>
3303     <span class="var-type">string</span>
3304     <span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li>
3305     <li>
3306     <span class="var-type">mixed</span>
3307     <span class="var-name">$value</span><span class="var-description">: <p>- the new value for it.</p></span> </li>
3308     </ul>
3309    
3310    
3311     </div>
3312     <a name="method_show_results" id="_show_results"><!-- --></a>
3313     <div class="oddrow">
3314    
3315     <div class="method-header">
3316     <span class="method-title">_show_results</span> (line <span class="line-number">1238</span>)
3317     </div>
3318    
3319     <!-- ========== Info from phpDoc block ========= -->
3320     <p class="short-description">This function is used to let render() know that we should show the results or not.</p>
3321    
3322     <div class="method-signature">
3323     <span class="method-result">boolean</span>
3324     <span class="method-name">
3325     _show_results
3326     </span>
3327     ()
3328     </div>
3329    
3330    
3331    
3332     </div>
3333     <h4>Inherited Methods</h4>
3334     <a name='inherited_methods'><!-- --></a>
3335     <!-- =========== Summary =========== -->
3336     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
3337     <blockquote>
3338     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
3339     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
3340     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
3341     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
3342     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
3343     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
3344     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
3345     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
3346     </blockquote>
3347     <!-- =========== Summary =========== -->
3348     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
3349     <blockquote>
3350     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
3351     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
3352     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
3353     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
3354     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
3355     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
3356     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
3357     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
3358     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
3359     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
3360     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
3361     <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>
3362     </blockquote>
3363    
3364     </div>
3365     </div>
3366    
3367     <p class="notes" id="credit">
3368     Documention generated on Thu, 31 Jul 2003 18:32:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
3369 jonen 1.2 </p>
3370 jonen 1.3 </div></body>
3371 jonen 1.2 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed