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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Feb 22 20:56:17 2003 UTC (22 years, 8 months ago) by jonen
Branch: MAIN
Changes since 1.1: +550 -811 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.2 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 jonen 1.1 <!--NewPage-->
3     <HTML>
4     <HEAD>
5 jonen 1.2 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:36 -0800' -->
6 jonen 1.1 <TITLE>Docs For Class DataListSource</TITLE>
7 jonen 1.2 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 jonen 1.1 </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 DataListSource">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 jonen 1.2 <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 jonen 1.1 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 jonen 1.2 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 jonen 1.1 </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class DataListSource
30 jonen 1.2 </H2> (line <span class="linenumber">31</span>)
31 jonen 1.1 <pre>
32     </pre>
33 jonen 1.2 <SPAN class="type">Classes extended from DataListSource:</SPAN>
34     <dl>
35     <dt><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></dt>
36     <dd></dd>
37     </dl>
38     <dl>
39     <dt><a href="../phpHtmlLib/CSVFILEDataListSource.html">CSVFILEDataListSource</a></dt>
40     <dd>This DataListSource child class gets the data from a CSV (comma seperated values) file on disk.</dd>
41     </dl>
42     </p>
43 jonen 1.1 <p>
44     <b><i>Located in File: Program_Root/widgets/data_list/DataListSource.inc</i></b><br>
45     </p>
46     <hr>
47 jonen 1.2 This is the base class for managing data for the DataList class. This abstracts away the underlying data layer from the DataList, so the data can come from multiple sources.
48     <br />
49     <p>Most of the time the data will come from a data base such as Mysql or Oracle. This abstraction enables the data to also come from a tab delimited file, xml, php array</p>
50 jonen 1.1 <UL>
51 jonen 1.2 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
52     </UL>
53 jonen 1.1 <hr>
54     <!-- =========== VAR SUMMARY =========== -->
55     <A NAME='var_summary'><!-- --></A>
56     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
57     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
58     <TD>
59     <span CLASS="font12bold">Class Variable Summary</span>
60     <A HREF="#top" CLASS="links">^TOP</A>
61     </TD>
62     </TR>
63    
64 jonen 1.2 <!-- =========== Summary =========== -->
65 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
66     <TD>
67 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_columns">$_columns</A></B></CODE>
68 jonen 1.1 <BR>
69 jonen 1.2 <blockquote> The column descriptions for the data we are working on </blockquote>
70 jonen 1.1 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
71     </TD>
72     </TR>
73 jonen 1.2 <!-- =========== Summary =========== -->
74 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
75     <TD>
76 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_data">$_data</A></B></CODE>
77 jonen 1.1 <BR>
78 jonen 1.2 <blockquote> A placeholder for data that is read/built and stored locally. Not all data sources have to use this. </blockquote>
79 jonen 1.1 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
80     </TD>
81     </TR>
82 jonen 1.2 <!-- =========== Summary =========== -->
83 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
84     <TD>
85 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_data_index">$_data_index</A></B></CODE>
86 jonen 1.1 <BR>
87     <blockquote> Holds the index into the array of data </blockquote>
88 jonen 1.2 <blockquote> Default Value: <CODE>->&nbsp;0<-</CODE> </blockquote>
89 jonen 1.1 </TD>
90     </TR>
91 jonen 1.2 <!-- =========== Summary =========== -->
92 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
93     <TD>
94 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_not_found_message">$_not_found_message</A></B></CODE>
95 jonen 1.1 <BR>
96     <blockquote> This is the message displayed when no data </blockquote>
97 jonen 1.2 <blockquote> Default Value: <CODE>->&nbsp;"No&nbsp;data&nbsp;was&nbsp;found"<-</CODE> </blockquote>
98 jonen 1.1 </TD>
99     </TR>
100 jonen 1.2 <!-- =========== Summary =========== -->
101 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
102     <TD>
103 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_query_params">$_query_params</A></B></CODE>
104 jonen 1.1 <BR>
105 jonen 1.2 <blockquote> This holds various parameters relating </blockquote>
106     <blockquote> Default Value: <CODE>->array("num_total_rows"&nbsp;=&gt;&nbsp;0,<br>
107     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"offset"&nbsp;=&gt;&nbsp;0,<br>
108     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"limit"&nbsp;=&gt;&nbsp;-1,<br>
109     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"orderby"&nbsp;=&gt;&nbsp;'',<br>
110     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"reverseorder"&nbsp;=&gt;&nbsp;'',<br>
111     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"searchby"&nbsp;=&gt;&nbsp;'',<br>
112     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"searchvalue"&nbsp;=&gt;&nbsp;'',<br>
113     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"searchmodifier"&nbsp;=&gt;&nbsp;'',<br>
114     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"searchtype"&nbsp;=&gt;&nbsp;'simple')<-</CODE> </blockquote>
115 jonen 1.1 </TD>
116     </TR>
117 jonen 1.2 </TABLE>
118 jonen 1.1 <hr>
119     <!-- =========== VAR INHERITED SUMMARY =========== -->
120     <A NAME='var_inherited_summary'><!-- --></A>
121     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
122 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
123 jonen 1.1 <TD>
124     <span CLASS="font12bold">Inherited Class Variable Summary</span>
125     <A HREF="#top" CLASS="links">^TOP</A>
126     </TD>
127     </TR>
128    
129 jonen 1.2 </TABLE>
130 jonen 1.1
131     <hr>
132 jonen 1.2 <!-- =========== METHOD SUMMARY =========== -->
133     <A NAME='method_summary'><!-- --></A>
134 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
135     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
136     <TD>
137     <span class="font12bold">Method Summary</span>
138     <A HREF="#top" CLASS="links">^TOP</A>
139     </TD>
140     </TR>
141    
142 jonen 1.2 <!-- =========== Summary =========== -->
143 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
144     <TD>
145 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodDataListSource'>void constructor DataListSource ( )</A></B></CODE>
146 jonen 1.1 <BR>
147     <blockquote> The constructor </blockquote>
148     </TD>
149     </TR>
150 jonen 1.2 <!-- =========== Summary =========== -->
151 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
152     <TD>
153 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodadd_column'>void add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></B></CODE>
154 jonen 1.1 <BR>
155     <blockquote> Add a column of data to manage </blockquote>
156     </TD>
157     </TR>
158 jonen 1.2 <!-- =========== Summary =========== -->
159 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
160     <TD>
161 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methoddo_prequery'>void do_prequery ( )</A></B></CODE>
162 jonen 1.1 <BR>
163 jonen 1.2 <blockquote> This is a method that should be defined by the child class to do any pre-query type of things. </blockquote>
164 jonen 1.1 </TD>
165     </TR>
166 jonen 1.2 <!-- =========== Summary =========== -->
167 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
168     <TD>
169 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methoddo_query'>void do_query ( )</A></B></CODE>
170 jonen 1.1 <BR>
171 jonen 1.2 <blockquote> This is the function that does the data fetching, and sorting if needed. </blockquote>
172 jonen 1.1 </TD>
173     </TR>
174 jonen 1.2 <!-- =========== Summary =========== -->
175 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
176     <TD>
177 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_data_index'>int get_data_index ( )</A></B></CODE>
178 jonen 1.1 <BR>
179 jonen 1.2 <blockquote> This function returns the data_index value and increments it </blockquote>
180 jonen 1.1 </TD>
181     </TR>
182 jonen 1.2 <!-- =========== Summary =========== -->
183 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
184     <TD>
185 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_limit'>int get_limit ( )</A></B></CODE>
186 jonen 1.1 <BR>
187 jonen 1.2 <blockquote> This function gets the current value of the limit value </blockquote>
188 jonen 1.1 </TD>
189     </TR>
190 jonen 1.2 <!-- =========== Summary =========== -->
191 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
192     <TD>
193 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_next_data_row'>array() get_next_data_row ( )</A></B></CODE>
194 jonen 1.1 <BR>
195 jonen 1.2 <blockquote> This function gets the next data row from the query() </blockquote>
196 jonen 1.1 </TD>
197     </TR>
198 jonen 1.2 <!-- =========== Summary =========== -->
199 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
200     <TD>
201 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_not_found_message'>string get_not_found_message ( )</A></B></CODE>
202 jonen 1.1 <BR>
203 jonen 1.2 <blockquote> This function is used to get the message displayed when no data is found </blockquote>
204 jonen 1.1 </TD>
205     </TR>
206 jonen 1.2 <!-- =========== Summary =========== -->
207 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
208     <TD>
209 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_offset'>int get_offset ( )</A></B></CODE>
210 jonen 1.1 <BR>
211 jonen 1.2 <blockquote> This function returns the value of the offset </blockquote>
212 jonen 1.1 </TD>
213     </TR>
214 jonen 1.2 <!-- =========== Summary =========== -->
215 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
216     <TD>
217 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_orderby'>int get_orderby ( )</A></B></CODE>
218 jonen 1.1 <BR>
219 jonen 1.2 <blockquote> This function returns the value of the orderby </blockquote>
220 jonen 1.1 </TD>
221     </TR>
222 jonen 1.2 <!-- =========== Summary =========== -->
223 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
224     <TD>
225 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_reverseorder'>int get_reverseorder ( )</A></B></CODE>
226 jonen 1.1 <BR>
227 jonen 1.2 <blockquote> This function returns the value of the reverseorder </blockquote>
228 jonen 1.1 </TD>
229     </TR>
230 jonen 1.2 <!-- =========== Summary =========== -->
231 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
232     <TD>
233 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_searchby'>int get_searchby ( )</A></B></CODE>
234 jonen 1.1 <BR>
235 jonen 1.2 <blockquote> This function returns the value of the searchby </blockquote>
236 jonen 1.1 </TD>
237     </TR>
238 jonen 1.2 <!-- =========== Summary =========== -->
239 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
240     <TD>
241 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_searchby_value'>int get_searchby_value ( )</A></B></CODE>
242 jonen 1.1 <BR>
243 jonen 1.2 <blockquote> This function returns the value of the search value </blockquote>
244 jonen 1.1 </TD>
245     </TR>
246 jonen 1.2 <!-- =========== Summary =========== -->
247 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
248     <TD>
249 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_search_type'>string get_search_type ( )</A></B></CODE>
250 jonen 1.1 <BR>
251 jonen 1.2 <blockquote> this function returns the current search type for the DataList query </blockquote>
252 jonen 1.1 </TD>
253     </TR>
254 jonen 1.2 <!-- =========== Summary =========== -->
255 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
256     <TD>
257 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier'>int get_simplesearch_modifier ( )</A></B></CODE>
258 jonen 1.1 <BR>
259 jonen 1.2 <blockquote> This function returns the value of the search value </blockquote>
260 jonen 1.1 </TD>
261     </TR>
262 jonen 1.2 <!-- =========== Summary =========== -->
263 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
264     <TD>
265 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_total_rows'>int get_total_rows ( )</A></B></CODE>
266 jonen 1.1 <BR>
267 jonen 1.2 <blockquote> This returns the total number of rows in our entire data set </blockquote>
268 jonen 1.1 </TD>
269     </TR>
270 jonen 1.2 <!-- =========== Summary =========== -->
271 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
272     <TD>
273 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodquery'>void query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></B></CODE>
274 jonen 1.1 <BR>
275     <blockquote> The main Query function. </blockquote>
276     </TD>
277     </TR>
278 jonen 1.2 <!-- =========== Summary =========== -->
279 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
280     <TD>
281 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_limit'>void set_limit ( $limit )</A></B></CODE>
282 jonen 1.1 <BR>
283     <blockquote> This function is used to set </blockquote>
284     </TD>
285     </TR>
286 jonen 1.2 <!-- =========== Summary =========== -->
287 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
288     <TD>
289 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE>
290 jonen 1.1 <BR>
291 jonen 1.2 <blockquote> This function is used to set the message displayed when no data is found </blockquote>
292 jonen 1.1 </TD>
293     </TR>
294 jonen 1.2 <!-- =========== Summary =========== -->
295 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
296     <TD>
297 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_offset'>void set_offset ( $offset )</A></B></CODE>
298 jonen 1.1 <BR>
299 jonen 1.2 <blockquote> This sets the offset value and resets the index into the data array (in non DB children) </blockquote>
300 jonen 1.1 </TD>
301     </TR>
302 jonen 1.2 <!-- =========== Summary =========== -->
303 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
304     <TD>
305 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_orderby'>void set_orderby ( $orderby )</A></B></CODE>
306 jonen 1.1 <BR>
307     <blockquote> This sets the orderby column name. </blockquote>
308     </TD>
309     </TR>
310 jonen 1.2 <!-- =========== Summary =========== -->
311 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
312     <TD>
313 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_reverseorder'>void set_reverseorder ( $order )</A></B></CODE>
314 jonen 1.1 <BR>
315 jonen 1.2 <blockquote> This sets the flag that tells us the direction in which to order the orderby column. </blockquote>
316 jonen 1.1 </TD>
317     </TR>
318 jonen 1.2 <!-- =========== Summary =========== -->
319 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
320     <TD>
321 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_searchby'>void set_searchby ( $search_col )</A></B></CODE>
322 jonen 1.1 <BR>
323 jonen 1.2 <blockquote> This sets the column that we want to search from. </blockquote>
324 jonen 1.1 </TD>
325     </TR>
326 jonen 1.2 <!-- =========== Summary =========== -->
327 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
328     <TD>
329 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_searchby_value'>void set_searchby_value ( $search_value )</A></B></CODE>
330 jonen 1.1 <BR>
331 jonen 1.2 <blockquote> This sets the data that we want to search for. </blockquote>
332 jonen 1.1 </TD>
333     </TR>
334 jonen 1.2 <!-- =========== Summary =========== -->
335 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
336     <TD>
337 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_search_type'>void set_search_type ( $search_type )</A></B></CODE>
338 jonen 1.1 <BR>
339 jonen 1.2 <blockquote> This function sets the search type (simple or advanced) </blockquote>
340 jonen 1.1 </TD>
341     </TR>
342 jonen 1.2 <!-- =========== Summary =========== -->
343 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
344     <TD>
345 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier'>void set_simplesearch_modifier ( $search_modifier )</A></B></CODE>
346 jonen 1.1 <BR>
347     <blockquote> This sets the simple search modifier </blockquote>
348     </TD>
349     </TR>
350 jonen 1.2 <!-- =========== Summary =========== -->
351 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
352     <TD>
353 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_total_rows'>void set_total_rows ( $num )</A></B></CODE>
354 jonen 1.1 <BR>
355 jonen 1.2 <blockquote> This is used to set the total # of rows we have in our data set </blockquote>
356 jonen 1.1 </TD>
357     </TR>
358 jonen 1.2 <!-- =========== Summary =========== -->
359 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
360     <TD>
361 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodsort'>void sort ( )</A></B></CODE>
362 jonen 1.1 <BR>
363 jonen 1.2 <blockquote> A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database. </blockquote>
364 jonen 1.1 </TD>
365     </TR>
366 jonen 1.2 <!-- =========== Summary =========== -->
367 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
368     <TD>
369 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DataListSource.html#method_is_column_sortable'>boolean _is_column_sortable ( $data_name )</A></B></CODE>
370 jonen 1.1 <BR>
371 jonen 1.2 <blockquote> This function determines if the column associated w/ a data_name is sortable or not </blockquote>
372     </TD>
373     </TR>
374     </TABLE>
375     <!-- =========== INHERITED METHOD SUMMARY =========== -->
376     <A NAME='functions_inherited'><!-- --></A>
377     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
378     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
379     <TD>
380     <span CLASS="font12bold">Inherited Method Summary</span>
381     <A HREF="#top" CLASS="links">^TOP</A>
382 jonen 1.1 </TD>
383     </TR>
384    
385 jonen 1.2 </TABLE>
386 jonen 1.1 <hr>
387     <!-- ============ VARIABLE DETAIL =========== -->
388    
389     <A NAME='variable_detail'></A>
390     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
391     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
392     <TD>
393     <span CLASS="font12bold">Variable Detail</span>
394     <A HREF="#top" CLASS="links">^TOP</A>
395     </TD>
396     </TR>
397     </TABLE>
398    
399 jonen 1.2 <A NAME='var$_columns'><!-- --></A><H3>$_columns</H3> (line <span class="linenumber">39</span>)<br />
400     <b>Data type:</b> array<br>The column descriptions for the data we are working on
401     <br />
402 jonen 1.1
403     <UL>
404 jonen 1.2 </UL>
405 jonen 1.1 <HR>
406 jonen 1.2 <A NAME='var$_data'><!-- --></A><H3>$_data</H3> (line <span class="linenumber">79</span>)<br />
407     <b>Data type:</b> mixed<br>A placeholder for data that is read/built and stored locally. Not all data sources have to use this.
408     <br />
409     <p>Each entry in the array corresponds to 1 row of data.</p>
410 jonen 1.1 <UL>
411 jonen 1.2 </UL>
412 jonen 1.1 <HR>
413 jonen 1.2 <A NAME='var$_data_index'><!-- --></A><H3>$_data_index</H3> (line <span class="linenumber">70</span>)<br />
414     <b>Data type:</b> mixed<br>Holds the index into the array of data
415     <br />
416     <p>so we can keep track of where we are when we are walking the array (only usefull for non DB children)</p>
417 jonen 1.1 <UL>
418 jonen 1.2 </UL>
419 jonen 1.1 <HR>
420 jonen 1.2 <A NAME='var$_not_found_message'><!-- --></A><H3>$_not_found_message</H3> (line <span class="linenumber">45</span>)<br />
421     <b>Data type:</b> mixed<br>This is the message displayed when no data
422     <br />
423     <p>was retrieved from the database</p>
424 jonen 1.1 <UL>
425 jonen 1.2 </UL>
426 jonen 1.1 <HR>
427 jonen 1.2 <A NAME='var$_query_params'><!-- --></A><H3>$_query_params</H3> (line <span class="linenumber">53</span>)<br />
428     <b>Data type:</b> mixed<br>This holds various parameters relating
429     <br />
430     <p>to the query of the data</p>
431 jonen 1.1 <UL>
432 jonen 1.2 </UL>
433 jonen 1.1 <HR>
434     <hr>
435 jonen 1.2 <!-- ============ METHOD DETAIL =========== -->
436 jonen 1.1
437 jonen 1.2 <A NAME='method_detail'></A>
438 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
439     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
440     <TD>
441     <span class="font12bold">Method Detail</span>
442     <A HREF="#top" CLASS="links">^TOP</A>
443     </TD>
444     </TR>
445     </TABLE>
446     <BR>
447     <DIV CLASS="function">
448 jonen 1.2 <A NAME='methodDataListSource'><!-- --></A>
449     <SPAN CLASS="font12bold">Constructor DataListSource</SPAN> (line <span class="linenumber">85</span>)
450 jonen 1.1 <BR>
451 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
452 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
453 jonen 1.2 <span class="font10bold" style="color: #0000FF">DataListSource(
454     )</SPAN>
455 jonen 1.1 <BR>
456    
457     <BR>
458     <SPAN CLASS="font10bold">Description : </SPAN>
459     The constructor
460 jonen 1.2 <br />
461 jonen 1.1
462     <DL>
463    
464 jonen 1.2 <DT class="font10bold">Function Info:</DT>
465     </DL>
466 jonen 1.1 </DIV>
467     <BR>
468     <DIV CLASS="function">
469 jonen 1.2 <A NAME='methodadd_column'><!-- --></A>
470     <SPAN CLASS="font12bold">add_column</SPAN> (line <span class="linenumber">108</span>)
471 jonen 1.1 <BR>
472 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
473 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
474 jonen 1.2 <span class="font10bold" style="color: #0000FF">add_column(
475     string
476     $title, string
477     $data_name, [boolean
478     $sortable = FALSE], [boolean
479     $searchable = FALSE], [string
480     $sortorder = "ASC"])</SPAN>
481 jonen 1.1 <BR>
482    
483     <BR>
484     <SPAN CLASS="font10bold">Description : </SPAN>
485     Add a column of data to manage
486 jonen 1.2 <br />
487 jonen 1.1
488     <DL>
489 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
490     <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>
491     <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> - the data value name</DD>
492     <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> - is the column sortable? default: FALSE</DD>
493     <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> - is the column searchable default: FALSE</DD>
494     <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 sort order (ASC, DESC) default: ASC</DD>
495    
496     <DT class="font10bold">Function Info:</DT>
497     </DL>
498 jonen 1.1 </DIV>
499     <BR>
500     <DIV CLASS="function">
501 jonen 1.2 <A NAME='methoddo_prequery'><!-- --></A>
502     <SPAN CLASS="font12bold">do_prequery</SPAN> (line <span class="linenumber">185</span>)
503 jonen 1.1 <BR>
504 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
505 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
506 jonen 1.2 <span class="font10bold" style="color: #0000FF">do_prequery(
507     )</SPAN>
508 jonen 1.1 <BR>
509 jonen 1.2 <p>Overridden in child classes as:<br />
510     <dl>
511     <dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a></dt>
512     <dd></dd>
513     </dl>
514     <dl>
515     <dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a></dt>
516     <dd>The prequery. We use this to read the file</dd>
517     </dl>
518     </p>
519    
520 jonen 1.1 <BR>
521     <SPAN CLASS="font10bold">Description : </SPAN>
522 jonen 1.2 This is a method that should be defined by the child class to do any pre-query type of things.
523     <br />
524     <p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p>
525 jonen 1.1 <DL>
526    
527 jonen 1.2 <DT class="font10bold">Function Info:</DT>
528     </DL>
529 jonen 1.1 </DIV>
530     <BR>
531     <DIV CLASS="function">
532 jonen 1.2 <A NAME='methoddo_query'><!-- --></A>
533     <SPAN CLASS="font12bold">do_query</SPAN> (line <span class="linenumber">199</span>)
534 jonen 1.1 <BR>
535 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
536 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
537 jonen 1.2 <span class="font10bold" style="color: #0000FF">do_query(
538     )</SPAN>
539 jonen 1.1 <BR>
540 jonen 1.2 <p>Overridden in child classes as:<br />
541     <dl>
542     <dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></dt>
543     <dd>Do the query to the DB and pull in all of the records locally.</dd>
544     </dl>
545     <dl>
546     <dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a></dt>
547     <dd>This function does the query</dd>
548     </dl>
549     </p>
550    
551 jonen 1.1 <BR>
552     <SPAN CLASS="font10bold">Description : </SPAN>
553 jonen 1.2 This is the function that does the data fetching, and sorting if needed.
554     <br />
555     <p>If the source is a sql database, this is where the query gets called. This function doesn't actually read the data from the DB yet. That is what get_next_data_row() does.</p>
556 jonen 1.1 <DL>
557    
558 jonen 1.2 <DT class="font10bold">Function Info:</DT>
559     </DL>
560 jonen 1.1 </DIV>
561     <BR>
562     <DIV CLASS="function">
563 jonen 1.2 <A NAME='methodget_data_index'><!-- --></A>
564     <SPAN CLASS="font12bold">get_data_index</SPAN> (line <span class="linenumber">428</span>)
565 jonen 1.1 <BR>
566 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
567 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
568 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_data_index(
569     )</SPAN>
570 jonen 1.1 <BR>
571    
572     <BR>
573     <SPAN CLASS="font10bold">Description : </SPAN>
574 jonen 1.2 This function returns the data_index value and increments it
575     <br />
576 jonen 1.1
577     <DL>
578    
579 jonen 1.2 <DT class="font10bold">Function Info:</DT>
580     </DL>
581 jonen 1.1 </DIV>
582     <BR>
583     <DIV CLASS="function">
584 jonen 1.2 <A NAME='methodget_limit'><!-- --></A>
585     <SPAN CLASS="font12bold">get_limit</SPAN> (line <span class="linenumber">397</span>)
586 jonen 1.1 <BR>
587 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
588 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
589 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_limit(
590     )</SPAN>
591 jonen 1.1 <BR>
592    
593     <BR>
594     <SPAN CLASS="font10bold">Description : </SPAN>
595 jonen 1.2 This function gets the current value of the limit value
596     <br />
597 jonen 1.1
598     <DL>
599    
600 jonen 1.2 <DT class="font10bold">Function Info:</DT>
601     </DL>
602 jonen 1.1 </DIV>
603     <BR>
604     <DIV CLASS="function">
605 jonen 1.2 <A NAME='methodget_next_data_row'><!-- --></A>
606     <SPAN CLASS="font12bold">get_next_data_row</SPAN> (line <span class="linenumber">172</span>)
607 jonen 1.1 <BR>
608 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
609 jonen 1.1 <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;
610 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_next_data_row(
611     )</SPAN>
612 jonen 1.1 <BR>
613 jonen 1.2 <p>Overridden in child classes as:<br />
614     <dl>
615     <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a></dt>
616     <dd>This function gets the next data row from the query()</dd>
617     </dl>
618     <dl>
619     <dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methodget_next_data_row">CSVFILEDataListSource::get_next_data_row()</a></dt>
620     <dd>This function returns the next row of valid data.</dd>
621     </dl>
622     </p>
623    
624 jonen 1.1 <BR>
625     <SPAN CLASS="font10bold">Description : </SPAN>
626 jonen 1.2 This function gets the next data row from the query()
627     <br />
628 jonen 1.1
629     <DL>
630    
631 jonen 1.2 <DT class="font10bold">Function Info:</DT>
632     </DL>
633 jonen 1.1 </DIV>
634     <BR>
635     <DIV CLASS="function">
636 jonen 1.2 <A NAME='methodget_not_found_message'><!-- --></A>
637     <SPAN CLASS="font12bold">get_not_found_message</SPAN> (line <span class="linenumber">231</span>)
638 jonen 1.1 <BR>
639 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
640 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
641 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_not_found_message(
642     )</SPAN>
643 jonen 1.1 <BR>
644    
645     <BR>
646     <SPAN CLASS="font10bold">Description : </SPAN>
647 jonen 1.2 This function is used to get the message displayed when no data is found
648     <br />
649 jonen 1.1
650     <DL>
651    
652 jonen 1.2 <DT class="font10bold">Function Info:</DT>
653     </DL>
654 jonen 1.1 </DIV>
655     <BR>
656     <DIV CLASS="function">
657 jonen 1.2 <A NAME='methodget_offset'><!-- --></A>
658     <SPAN CLASS="font12bold">get_offset</SPAN> (line <span class="linenumber">274</span>)
659 jonen 1.1 <BR>
660 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
661 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
662 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_offset(
663     )</SPAN>
664 jonen 1.1 <BR>
665    
666     <BR>
667     <SPAN CLASS="font10bold">Description : </SPAN>
668 jonen 1.2 This function returns the value of the offset
669     <br />
670 jonen 1.1
671     <DL>
672    
673 jonen 1.2 <DT class="font10bold">Function Info:</DT>
674     </DL>
675 jonen 1.1 </DIV>
676     <BR>
677     <DIV CLASS="function">
678 jonen 1.2 <A NAME='methodget_orderby'><!-- --></A>
679     <SPAN CLASS="font12bold">get_orderby</SPAN> (line <span class="linenumber">296</span>)
680 jonen 1.1 <BR>
681 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
682 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
683 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_orderby(
684     )</SPAN>
685 jonen 1.1 <BR>
686    
687     <BR>
688     <SPAN CLASS="font10bold">Description : </SPAN>
689 jonen 1.2 This function returns the value of the orderby
690     <br />
691 jonen 1.1
692     <DL>
693    
694 jonen 1.2 <DT class="font10bold">Function Info:</DT>
695     </DL>
696 jonen 1.1 </DIV>
697     <BR>
698     <DIV CLASS="function">
699 jonen 1.2 <A NAME='methodget_reverseorder'><!-- --></A>
700     <SPAN CLASS="font12bold">get_reverseorder</SPAN> (line <span class="linenumber">317</span>)
701 jonen 1.1 <BR>
702 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
703 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
704 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_reverseorder(
705     )</SPAN>
706 jonen 1.1 <BR>
707    
708     <BR>
709     <SPAN CLASS="font10bold">Description : </SPAN>
710 jonen 1.2 This function returns the value of the reverseorder
711     <br />
712 jonen 1.1
713     <DL>
714    
715 jonen 1.2 <DT class="font10bold">Function Info:</DT>
716     </DL>
717 jonen 1.1 </DIV>
718     <BR>
719     <DIV CLASS="function">
720 jonen 1.2 <A NAME='methodget_searchby'><!-- --></A>
721     <SPAN CLASS="font12bold">get_searchby</SPAN> (line <span class="linenumber">337</span>)
722 jonen 1.1 <BR>
723 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
724 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
725 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_searchby(
726     )</SPAN>
727 jonen 1.1 <BR>
728    
729     <BR>
730     <SPAN CLASS="font10bold">Description : </SPAN>
731 jonen 1.2 This function returns the value of the searchby
732     <br />
733 jonen 1.1
734     <DL>
735    
736 jonen 1.2 <DT class="font10bold">Function Info:</DT>
737     </DL>
738 jonen 1.1 </DIV>
739     <BR>
740     <DIV CLASS="function">
741 jonen 1.2 <A NAME='methodget_searchby_value'><!-- --></A>
742     <SPAN CLASS="font12bold">get_searchby_value</SPAN> (line <span class="linenumber">357</span>)
743 jonen 1.1 <BR>
744 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
745 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
746 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_searchby_value(
747     )</SPAN>
748 jonen 1.1 <BR>
749    
750     <BR>
751     <SPAN CLASS="font10bold">Description : </SPAN>
752 jonen 1.2 This function returns the value of the search value
753     <br />
754 jonen 1.1
755     <DL>
756    
757 jonen 1.2 <DT class="font10bold">Function Info:</DT>
758     </DL>
759 jonen 1.1 </DIV>
760     <BR>
761     <DIV CLASS="function">
762 jonen 1.2 <A NAME='methodget_search_type'><!-- --></A>
763     <SPAN CLASS="font12bold">get_search_type</SPAN> (line <span class="linenumber">418</span>)
764 jonen 1.1 <BR>
765 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
766 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
767 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_search_type(
768     )</SPAN>
769 jonen 1.1 <BR>
770    
771     <BR>
772     <SPAN CLASS="font10bold">Description : </SPAN>
773 jonen 1.2 this function returns the current search type for the DataList query
774     <br />
775 jonen 1.1
776     <DL>
777    
778 jonen 1.2 <DT class="font10bold">Function Info:</DT>
779     </DL>
780 jonen 1.1 </DIV>
781     <BR>
782     <DIV CLASS="function">
783 jonen 1.2 <A NAME='methodget_simplesearch_modifier'><!-- --></A>
784     <SPAN CLASS="font12bold">get_simplesearch_modifier</SPAN> (line <span class="linenumber">377</span>)
785 jonen 1.1 <BR>
786 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
787 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
788 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_simplesearch_modifier(
789     )</SPAN>
790 jonen 1.1 <BR>
791    
792     <BR>
793     <SPAN CLASS="font10bold">Description : </SPAN>
794 jonen 1.2 This function returns the value of the search value
795     <br />
796 jonen 1.1
797     <DL>
798    
799 jonen 1.2 <DT class="font10bold">Function Info:</DT>
800     </DL>
801 jonen 1.1 </DIV>
802     <BR>
803     <DIV CLASS="function">
804 jonen 1.2 <A NAME='methodget_total_rows'><!-- --></A>
805     <SPAN CLASS="font12bold">get_total_rows</SPAN> (line <span class="linenumber">241</span>)
806 jonen 1.1 <BR>
807 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
808 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
809 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_total_rows(
810     )</SPAN>
811 jonen 1.1 <BR>
812    
813     <BR>
814     <SPAN CLASS="font10bold">Description : </SPAN>
815 jonen 1.2 This returns the total number of rows in our entire data set
816     <br />
817 jonen 1.1
818     <DL>
819    
820 jonen 1.2 <DT class="font10bold">Function Info:</DT>
821     </DL>
822 jonen 1.1 </DIV>
823     <BR>
824     <DIV CLASS="function">
825 jonen 1.2 <A NAME='methodquery'><!-- --></A>
826     <SPAN CLASS="font12bold">query</SPAN> (line <span class="linenumber">138</span>)
827 jonen 1.1 <BR>
828 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
829 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
830 jonen 1.2 <span class="font10bold" style="color: #0000FF">query(
831     int
832     $offset, int
833     $limit, string
834     $orderby, string
835     $reverseorder, string
836     $searchby, string
837     $searchby_value, string
838     $simplesearch_modifier, mixed
839     $search_type)</SPAN>
840 jonen 1.1 <BR>
841    
842     <BR>
843     <SPAN CLASS="font10bold">Description : </SPAN>
844     The main Query function.
845 jonen 1.2 <br />
846     <p>This function is responsible for doing any data prefetching from a db,file and doing any sorting and searching on it depending on the values passed in from the DataList object</p>
847     <DL>
848     <DT class="font10bold">Function Parameters:</DT>
849     <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 into the data set</DD>
850     <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">$limit</SPAN></SPAN> - the # of rows to get</DD>
851     <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">$orderby</SPAN></SPAN> - the column to order the data by</DD>
852     <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">$reverseorder</SPAN></SPAN> - order in asc or reverse?</DD>
853     <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">$searchby</SPAN></SPAN> - the column in the dataset to search by</DD>
854     <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">$searchby_value</SPAN></SPAN> - the value to look for</DD>
855     <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">$simplesearch_modifier</SPAN></SPAN> - the simple search modifier.</DD>
856    
857     <DT class="font10bold">Function Info:</DT>
858     </DL>
859 jonen 1.1 </DIV>
860     <BR>
861     <DIV CLASS="function">
862 jonen 1.2 <A NAME='methodset_limit'><!-- --></A>
863     <SPAN CLASS="font12bold">set_limit</SPAN> (line <span class="linenumber">387</span>)
864 jonen 1.1 <BR>
865 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
866 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
867 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_limit(
868     mixed
869     $limit)</SPAN>
870 jonen 1.1 <BR>
871    
872     <BR>
873     <SPAN CLASS="font10bold">Description : </SPAN>
874     This function is used to set
875 jonen 1.2 <br />
876     <p>the limit value, which limits the # of rows of data to allow to return</p>
877 jonen 1.1 <DL>
878    
879 jonen 1.2 <DT class="font10bold">Function Info:</DT>
880     </DL>
881 jonen 1.1 </DIV>
882     <BR>
883     <DIV CLASS="function">
884 jonen 1.2 <A NAME='methodset_not_found_message'><!-- --></A>
885     <SPAN CLASS="font12bold">set_not_found_message</SPAN> (line <span class="linenumber">221</span>)
886 jonen 1.1 <BR>
887 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
888 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
889 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_not_found_message(
890     string
891     $mesg)</SPAN>
892 jonen 1.1 <BR>
893    
894     <BR>
895     <SPAN CLASS="font10bold">Description : </SPAN>
896 jonen 1.2 This function is used to set the message displayed when no data is found
897     <br />
898 jonen 1.1
899     <DL>
900 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
901     <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>
902    
903     <DT class="font10bold">Function Info:</DT>
904     </DL>
905 jonen 1.1 </DIV>
906     <BR>
907     <DIV CLASS="function">
908 jonen 1.2 <A NAME='methodset_offset'><!-- --></A>
909     <SPAN CLASS="font12bold">set_offset</SPAN> (line <span class="linenumber">263</span>)
910 jonen 1.1 <BR>
911 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
912 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
913 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_offset(
914     int
915     $offset)</SPAN>
916 jonen 1.1 <BR>
917    
918     <BR>
919     <SPAN CLASS="font10bold">Description : </SPAN>
920 jonen 1.2 This sets the offset value and resets the index into the data array (in non DB children)
921     <br />
922    
923 jonen 1.1 <DL>
924 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
925     <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> offset</DD>
926    
927     <DT class="font10bold">Function Info:</DT>
928     </DL>
929 jonen 1.1 </DIV>
930     <BR>
931     <DIV CLASS="function">
932 jonen 1.2 <A NAME='methodset_orderby'><!-- --></A>
933     <SPAN CLASS="font12bold">set_orderby</SPAN> (line <span class="linenumber">286</span>)
934 jonen 1.1 <BR>
935 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
936 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
937 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_orderby(
938     int
939     $orderby)</SPAN>
940 jonen 1.1 <BR>
941    
942     <BR>
943     <SPAN CLASS="font10bold">Description : </SPAN>
944     This sets the orderby column name.
945 jonen 1.2 <br />
946     <p>This corresponds to the column that wants to be sorted/ordered, but not the actual direction (asc, desc)</p>
947 jonen 1.1 <DL>
948 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
949     <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">$orderby</SPAN></SPAN> offset</DD>
950    
951     <DT class="font10bold">Function Info:</DT>
952     </DL>
953 jonen 1.1 </DIV>
954     <BR>
955     <DIV CLASS="function">
956 jonen 1.2 <A NAME='methodset_reverseorder'><!-- --></A>
957     <SPAN CLASS="font12bold">set_reverseorder</SPAN> (line <span class="linenumber">307</span>)
958 jonen 1.1 <BR>
959 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
960 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
961 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_reverseorder(
962     int
963     $order)</SPAN>
964 jonen 1.1 <BR>
965    
966     <BR>
967     <SPAN CLASS="font10bold">Description : </SPAN>
968 jonen 1.2 This sets the flag that tells us the direction in which to order the orderby column.
969     <br />
970 jonen 1.1
971     <DL>
972 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
973     <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">$order</SPAN></SPAN> offset</DD>
974    
975     <DT class="font10bold">Function Info:</DT>
976     </DL>
977 jonen 1.1 </DIV>
978     <BR>
979     <DIV CLASS="function">
980 jonen 1.2 <A NAME='methodset_searchby'><!-- --></A>
981     <SPAN CLASS="font12bold">set_searchby</SPAN> (line <span class="linenumber">327</span>)
982 jonen 1.1 <BR>
983 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
984 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
985 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_searchby(
986     int
987     $search_col)</SPAN>
988 jonen 1.1 <BR>
989    
990     <BR>
991     <SPAN CLASS="font10bold">Description : </SPAN>
992 jonen 1.2 This sets the column that we want to search from.
993     <br />
994 jonen 1.1
995     <DL>
996 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
997     <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">$search_col</SPAN></SPAN> offset</DD>
998    
999     <DT class="font10bold">Function Info:</DT>
1000     </DL>
1001 jonen 1.1 </DIV>
1002     <BR>
1003     <DIV CLASS="function">
1004 jonen 1.2 <A NAME='methodset_searchby_value'><!-- --></A>
1005     <SPAN CLASS="font12bold">set_searchby_value</SPAN> (line <span class="linenumber">347</span>)
1006 jonen 1.1 <BR>
1007 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1008 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1009 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_searchby_value(
1010     int
1011     $search_value)</SPAN>
1012 jonen 1.1 <BR>
1013    
1014     <BR>
1015     <SPAN CLASS="font10bold">Description : </SPAN>
1016 jonen 1.2 This sets the data that we want to search for.
1017     <br />
1018 jonen 1.1
1019     <DL>
1020 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1021     <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">$search_value</SPAN></SPAN> offset</DD>
1022    
1023     <DT class="font10bold">Function Info:</DT>
1024     </DL>
1025 jonen 1.1 </DIV>
1026     <BR>
1027     <DIV CLASS="function">
1028 jonen 1.2 <A NAME='methodset_search_type'><!-- --></A>
1029     <SPAN CLASS="font12bold">set_search_type</SPAN> (line <span class="linenumber">408</span>)
1030 jonen 1.1 <BR>
1031 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1032 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1033 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_search_type(
1034     string
1035     $search_type)</SPAN>
1036 jonen 1.1 <BR>
1037    
1038     <BR>
1039     <SPAN CLASS="font10bold">Description : </SPAN>
1040 jonen 1.2 This function sets the search type (simple or advanced)
1041     <br />
1042 jonen 1.1
1043     <DL>
1044 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1045     <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">$search_type</SPAN></SPAN> </DD>
1046    
1047     <DT class="font10bold">Function Info:</DT>
1048     </DL>
1049 jonen 1.1 </DIV>
1050     <BR>
1051     <DIV CLASS="function">
1052 jonen 1.2 <A NAME='methodset_simplesearch_modifier'><!-- --></A>
1053     <SPAN CLASS="font12bold">set_simplesearch_modifier</SPAN> (line <span class="linenumber">367</span>)
1054 jonen 1.1 <BR>
1055 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1056 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1057 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_simplesearch_modifier(
1058     int
1059     $search_modifier)</SPAN>
1060 jonen 1.1 <BR>
1061    
1062     <BR>
1063     <SPAN CLASS="font10bold">Description : </SPAN>
1064     This sets the simple search modifier
1065 jonen 1.2 <br />
1066 jonen 1.1
1067     <DL>
1068 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1069     <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">$search_modifier</SPAN></SPAN> offset</DD>
1070    
1071     <DT class="font10bold">Function Info:</DT>
1072     </DL>
1073 jonen 1.1 </DIV>
1074     <BR>
1075     <DIV CLASS="function">
1076 jonen 1.2 <A NAME='methodset_total_rows'><!-- --></A>
1077     <SPAN CLASS="font12bold">set_total_rows</SPAN> (line <span class="linenumber">251</span>)
1078 jonen 1.1 <BR>
1079 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1080 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1081 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_total_rows(
1082     int
1083     $num)</SPAN>
1084 jonen 1.1 <BR>
1085    
1086     <BR>
1087     <SPAN CLASS="font10bold">Description : </SPAN>
1088 jonen 1.2 This is used to set the total # of rows we have in our data set
1089     <br />
1090 jonen 1.1
1091     <DL>
1092 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1093     <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</SPAN></SPAN> </DD>
1094    
1095     <DT class="font10bold">Function Info:</DT>
1096     </DL>
1097 jonen 1.1 </DIV>
1098     <BR>
1099     <DIV CLASS="function">
1100 jonen 1.2 <A NAME='methodsort'><!-- --></A>
1101     <SPAN CLASS="font12bold">sort</SPAN> (line <span class="linenumber">211</span>)
1102 jonen 1.1 <BR>
1103 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1104 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1105 jonen 1.2 <span class="font10bold" style="color: #0000FF">sort(
1106     )</SPAN>
1107 jonen 1.1 <BR>
1108 jonen 1.2 <p>Overridden in child classes as:<br />
1109     <dl>
1110     <dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methodsort">CSVFILEDataListSource::sort()</a></dt>
1111     <dd></dd>
1112     </dl>
1113     </p>
1114    
1115 jonen 1.1 <BR>
1116     <SPAN CLASS="font10bold">Description : </SPAN>
1117 jonen 1.2 A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database.
1118     <br />
1119     <p>It should operate on the $this-&gt;_data array</p>
1120 jonen 1.1 <DL>
1121    
1122 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1123     </DL>
1124 jonen 1.1 </DIV>
1125     <BR>
1126     <DIV CLASS="function">
1127 jonen 1.2 <A NAME='method_is_column_sortable'><!-- --></A>
1128     <SPAN CLASS="font12bold">_is_column_sortable</SPAN> (line <span class="linenumber">442</span>)
1129 jonen 1.1 <BR>
1130 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1131 jonen 1.1 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1132 jonen 1.2 <span class="font10bold" style="color: #0000FF">_is_column_sortable(
1133     string
1134     $data_name)</SPAN>
1135 jonen 1.1 <BR>
1136    
1137     <BR>
1138     <SPAN CLASS="font10bold">Description : </SPAN>
1139 jonen 1.2 This function determines if the column associated w/ a data_name is sortable or not
1140     <br />
1141    
1142 jonen 1.1 <DL>
1143 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1144     <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> - the data_name filed in the _columns array to look for</DD>
1145    
1146     <DT class="font10bold">Function Info:</DT>
1147     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - is that column sortable?</DD>
1148     </DL>
1149 jonen 1.1 </DIV>
1150     <BR>
1151 jonen 1.2 <div id="credit">
1152     <hr>
1153     Documention generated on Thu, 20 Feb 2003 16:22:36 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
1154     </div>
1155     </body>
1156     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed