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

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

Parent Directory Parent Directory | Revision Log Revision Log

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