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