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