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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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