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