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

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

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

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