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

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

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

revision 1.1.1.1 by jonen, Thu Jan 30 03:29:19 2003 UTC revision 1.4 by jonen, Thu May 6 16:24:22 2004 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 PEARSQLDataListSource</TITLE>                          <title>Docs For Class PEARSQLDataListSource</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 PEARSQLDataListSource</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 PEARSQLDataListSource">Child Classes</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>                                                  
22        <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>                                          </div>
23        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>          <div class="info-box-body">
24        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>                          <!-- ========== Info from phpDoc block ========= -->
25     </TD>  <p class="short-description">This SQLDataListSource child class interacts with  with the specific DB via the php PEAR DB abstraction  objects.</p>
26   </TR>  <p class="description"><p>How to use?  in the DataList child's get_data_source() method  you pass in the already connected PEAR DB object  in to the constructor.  PEARSQLDataListSource  takes care of the rest.</p></p>
27  </TABLE>          <ul class="tags">
28  <BR>                                  <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29                            </ul>
30  <!-- Start of Class Data -->                  <p class="notes">
31  <H2>                          Located in <a class="field" href="_widgets_data_list_PEARSQLDataListSource_inc.html">/widgets/data_list/PEARSQLDataListSource.inc</a> (line <span class="field">40</span>)
32          Class PEARSQLDataListSource                  </p>
33  </H2>                  
34                                    
35  <pre>                  <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>  
36     |     |
37     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>
38        |        |
39        --PEARSQLDataListSource</pre>        --PEARSQLDataListSource</pre>
40  </pre>          
41                            </div>
42  <A NAME="children_summary"</A>  </div>
43  <H3>  
44          Classes extended from PEARSQLDataListSource: <A HREF="#top" CLASS="links">^TOP</A>  
45  </H3>  
46            <a name="sec-var-summary"></a>
47  <p>          <div class="info-box">
48          <b><i>Located in File: Program_Root/widgets/data_list/PEARSQLDataListSource.inc</i></b><br>                  <div class="info-box-title">Variable Summary</span></div>
49  </p>                  <div class="nav-bar">
50  <hr>                          <a href="#sec-description">Description</a> |
51  <!-- ========== Info from phpDoc block ========= -->                                                  <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
52  This SQLDataListSource child class interacts with                                                          |
53  <BR>                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54  with the specific DB via the php PEAR DB abstraction                                                          
55  objects.                                                                  </div>
56                    <div class="info-box-body">
57  How to use?                          <div class="var-summary">
58  in the DataList child's get_data_source() method                                                                  <div class="var-title">
59  you pass in the already connected PEAR DB object                                          <span class="var-type">mixed</span>
60  in to the constructor.  PEARSQLDataListSource                                          <a href="#$_db" title="details" class="var-name">$_db</a>
61  takes care of the rest.                                  </div>
62                                                                    <div class="var-title">
63  <UL>                                          <span class="var-type">mixed</span>
64                                                    <a href="#$_result" title="details" class="var-name">$_result</a>
65          <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>                                  </div>
66                                                                    </div>
67  </UL>                  </div>
68            </div>
69  <hr>  
70  <!-- =========== VAR SUMMARY =========== -->          <a name="sec-method-summary"></a>
71  <A NAME='var_summary'><!-- --></A>          <div class="info-box">
72  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                  <div class="info-box-title">Method Summary</span></div>
73          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                  <div class="nav-bar">
74                  <TD>                          <a href="#sec-description">Description</a> |
75                          <span CLASS="font12bold">Class Variable Summary</span>                                                                                                                                                  <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
76              <A HREF="#top" CLASS="links">^TOP</A>                                  
77                  </TD>                                  |
78          </TR>                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
79                    </div>
80                            <div class="info-box-body">                    
81          <!-- =========== Summary =========== -->                          <div class="method-summary">
82          <TR BGCOLOR='white' CLASS='TableRowColor'>                                                                  
83                  <TD>                                  <div class="method-definition">
84                          <CODE><B><A HREF='PEARSQLDataListSource.html#$_db'>$_db</A></B></CODE>                                                                                          <span class="method-result">PEARSQLDataListSource</span>
85                          <BR>                                                                                  <a href="#PEARSQLDataListSource" title="details" class="method-name">PEARSQLDataListSource</a>
86                          <blockquote> This var holds the Database object </blockquote>                                                                                          (<span class="var-type">PEAR::DB</span>&nbsp;<span class="var-name">&$db</span>)
87                          <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>                                                                          </div>
88                  </TD>                                                                  
89          </TR>                                  <div class="method-definition">
90                                                                                                    <span class="method-result">string</span>
91          <!-- =========== Summary =========== -->                                                                                  <a href="#build_limit_clause" title="details" class="method-name">build_limit_clause</a>
92          <TR BGCOLOR='white' CLASS='TableRowColor'>                                                                                          (<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>)
93                  <TD>                                                                          </div>
94                          <CODE><B><A HREF='PEARSQLDataListSource.html#$_result'>$_result</A></B></CODE>                                                                  
95                          <BR>                                  <div class="method-definition">
96                          <blockquote> this holds the query result from the                                                                                          <span class="method-result">int</span>
97  PEAR::DB-&gt;query() call </blockquote>                                                                                  <a href="#count" title="details" class="method-name">count</a>
98                          <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>                                                                                          (<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>)
99                  </TD>                                                                          </div>
100          </TR>                                                                  
101                                            <div class="method-definition">
102  </TABLE>                                                                                          <span class="method-result">boolean</span>
103                                                                                    <a href="#do_query" title="details" class="method-name">do_query</a>
104  <hr>                                                                                  ()
105  <!-- =========== VAR INHERITED SUMMARY =========== -->                                                                          </div>
106  <A NAME='var_inherited_summary'><!-- --></A>                                                                  
107  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                  <div class="method-definition">
108          <TR CLASS='TableHeadingColor'>                                                                                          <span class="method-result">array()</span>
109                  <TD>                                                                                  <a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a>
110                          <span CLASS="font12bold">Inherited Class Variable Summary</span>                                                                                  ()
111              <A HREF="#top" CLASS="links">^TOP</A>                                                                          </div>
112                  </TD>                                                                  
113          </TR>                                  <div class="method-definition">
114                                                                                            <span class="method-result">void</span>
115                                                                                            <a href="#set_db_object" title="details" class="method-name">set_db_object</a>
116          <!-- =========== Summary =========== -->                                                                                          (<span class="var-type">object -</span>&nbsp;<span class="var-name">&$db</span>)
117          <TR BGCOLOR='white'>                                                                          </div>
118                  <TD>                                                          </div>
119                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>                  </div>
120              <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">          </div>          
121                          <tr CLASS="tableheadingcolor">  
122                                  <th>Variable</th>          <a name="sec-vars"></a>
123                                  <th>Default Value</th>          <div class="info-box">
124                                  <th>Description</th>                  <div class="info-box-title">Variables</div>
125                          </tr>                  <div class="nav-bar">
126                                                            <a href="#sec-description">Description</a> |
127                          <tr>                                                                                  <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
128                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#$_db_options'>$_db_options</A></td>                                                  
129                                  <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;values&quot; =&gt; &quot;&quot;,                          
130                                                           &quot;tables&quot; =&gt; &quot;&quot;,                                                                                  |
131                                                           &quot;where_clause&quot; =&gt; &quot;&quot;,                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
132                                                           &quot;groupby_clause&quot; =&gt; &quot;&quot;,                                                          
133                                                           &quot;count_column&quot; =&gt; &quot;*&quot;)<-</td>                                          </div>
134                                  <td CLASS="font10">this holds all of the options                  <div class="info-box-body">
135  that make up the sql query</td>                          <a name="var$_db" id="$_db"><!-- --></A>
136                          </tr>  <div class="oddrow">
137                                    
138                          <tr>          <div class="var-header">
139                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#$_query'>$_query</A></td>                  <span class="var-title">
140                                  <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>                          <span class="var-type">mixed</span>
141                                  <td CLASS="font10">The entire query built by</td>                          <span class="var-name">$_db</span>
142                          </tr>                           = <span class="var-default"> NULL</span>                       (line <span class="line-number">50</span>)
143                                                    </span>
144                          </table>          </div>
145              <BR>  
146          </TD>          <!-- ========== Info from phpDoc block ========= -->
147          </TR>  <p class="short-description">This var holds the Database object</p>
148            <p class="description"><p>that is used to do the sql queries  It is assumed that the db is already  connected to, and the object provides  2 methods:  query() - execute a sql query</p></p>
149          <!-- =========== Summary =========== -->          
150          <TR BGCOLOR='white'>          
151                  <TD>                  
152                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>                  
153              <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
154                          <tr CLASS="tableheadingcolor">  </div>
155                                  <th>Variable</th>  <a name="var$_result" id="$_result"><!-- --></A>
156                                  <th>Default Value</th>  <div class="evenrow">
157                                  <th>Description</th>  
158                          </tr>          <div class="var-header">
159                                                    <span class="var-title">
160                          <tr>                          <span class="var-type">mixed</span>
161                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_columns'>$_columns</A></td>                          <span class="var-name">$_result</span>
162                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                           = <span class="var-default"> NULL</span>                       (line <span class="line-number">57</span>)
163                                  <td CLASS="font10">The column descriptions                  </span>
164  for the data we are working on</td>          </div>
165                          </tr>  
166                                            <!-- ========== Info from phpDoc block ========= -->
167                          <tr>  <p class="short-description">this holds the query result from the</p>
168                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td>  <p class="description"><p>PEAR::DB-&gt;query() call</p></p>
169                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>          
170                                  <td CLASS="font10">A placeholder for data that is read/built</td>          
171                          </tr>                  
172                                                    
173                          <tr>  
174                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td>  </div>
175                                  <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>                                                          <h4>Inherited Variables</h4>
176                                  <td CLASS="font10">Holds the index into the array of data</td>                                  <A NAME='inherited_vars'><!-- --></A>
177                          </tr>                                                                          <p>Inherited from <span class="classname"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span></p>
178                                                                            <blockquote>
179                          <tr>                                                                                                          <span class="var-title">
180                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td>                                                                  <span class="var-name"><a href="../phpHtmlLib/SQLDataListSource.html#var$_db_options">SQLDataListSource::$_db_options</a></span><br>
181                                  <td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td>                                                          </span>
182                                  <td CLASS="font10">This is the message displayed when no data</td>                                                                                                          <span class="var-title">
183                          </tr>                                                                  <span class="var-name"><a href="../phpHtmlLib/SQLDataListSource.html#var$_default_order_sensitivity">SQLDataListSource::$_default_order_sensitivity</a></span><br>
184                                                                                            </span>
185                          <tr>                                                                                                          <span class="var-title">
186                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td>                                                                  <span class="var-name"><a href="../phpHtmlLib/SQLDataListSource.html#var$_query">SQLDataListSource::$_query</a></span><br>
187                                  <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;num_total_rows&quot; =&gt; 0,                                                          </span>
188                                                             &quot;offset&quot; =&gt; 0,                                                                                          </blockquote>
189                                                             &quot;limit&quot; =&gt; -1,                                                                          <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
190                                                             &quot;orderby&quot; =&gt; '',                                          <blockquote>
191                                                             &quot;reverseorder&quot; =&gt; '',                                                                                                          <span class="var-title">
192                                                             &quot;searchby&quot; =&gt; '',                                                                  <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br>
193                                                             &quot;searchvalue&quot; =&gt; '',                                                          </span>
194                                                             &quot;searchmodifier&quot; =&gt; '',                                                                                                          <span class="var-title">
195                                                             &quot;searchtype&quot; =&gt; 'simple')<-</td>                                                                  <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br>
196                                  <td CLASS="font10">This holds various parameters relating                                                          </span>
197  to the query of the data</td>                                                                                                          <span class="var-title">
198                          </tr>                                                                  <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br>
199                                                                                            </span>
200                          </table>                                                                                                          <span class="var-title">
201              <BR>                                                                  <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br>
202          </TD>                                                          </span>
203          </TR>                                                                                                          <span class="var-title">
204                                                                            <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br>
205  </TABLE>                                                          </span>
206                                                                                            </blockquote>
207  <hr>                                                                                  
208  <!-- =========== INHERITED METHOD SUMMARY =========== -->                  </div>
209  <A NAME='functions_inherited'><!-- --></A>          </div>
210  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">          
211          <TR CLASS='TableHeadingColor'>          <a name="sec-methods"></a>
212                  <TD>          <div class="info-box">
213                          <span CLASS="font12bold">Inherited Method Summary</span>                  <div class="info-box-title">Methods</div>
214              <A HREF="#top" CLASS="links">^TOP</A>                  <div class="nav-bar">
215                  </TD>                          <a href="#sec-description">Description</a> |
216          </TR>                                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
217                                                                                                                                            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
218                                                            
219          <!-- =========== Summary =========== -->                  </div>
220          <TR BGCOLOR='white' CLASS='TableRowColor'>                  <div class="info-box-body">
221                  <TD>                          <A NAME='method_detail'></A>
222                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>  <a name="methodPEARSQLDataListSource" id="PEARSQLDataListSource"><!-- --></a>
223              <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  <div class="oddrow">
224                                  <tr CLASS="tableheadingcolor">          
225                                          <th>Function</th>          <div class="method-header">
226                                          <th>Description</th>                  <span class="method-title">Constructor PEARSQLDataListSource</span> (line <span class="line-number">67</span>)
227                                  </tr>          </div>
228                                            
229                                  <tr>          <!-- ========== Info from phpDoc block ========= -->
230                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#advanced_search_where_clause'>advanced_search_where_clause (  )</A></td>  <p class="short-description">The constructor is used to pass in the  PEAR DB object that has already been  created and connected to the db.</p>
231                                          <td CLASS="font10">This function is responsible for          
232  building the portion of the where clause          <div class="method-signature">
233  for doing an advanced search.</td>                  <span class="method-result">PEARSQLDataListSource</span>
234                                                    <span class="method-name">
235                                  <tr>                          PEARSQLDataListSource
236                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_groupby_clause'>build_groupby_clause (  )</A></td>                  </span>
237                                          <td CLASS="font10">this builds the groupby clause of the query</td>                                          (<span class="var-type">PEAR::DB</span>&nbsp;<span class="var-name">&$db</span>)
238                                                            </div>
239                                  <tr>          
240                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_limit_clause'>build_limit_clause ( $offset, $limit )</A></td>                          <ul class="parameters">
241                                          <td CLASS="font10">This function builds the limit</td>                                          <li>
242                                                                    <span class="var-type">PEAR::DB</span>
243                                  <tr>                                  <span class="var-name">&$db</span><span class="var-description">: object - MUST BE CONNECTED</span>                     </li>
244                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_order_clause'>build_order_clause (  )</A></td>                                  </ul>
245                                          <td CLASS="font10">This builds the db query ORDER BY                  
246  clause used to sort the data from the DB.</td>                  
247                                            </div>
248                                  <tr>  <a name="methodbuild_limit_clause" id="build_limit_clause"><!-- --></a>
249                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_query'>build_query ( [$limit_flag = TRUE] )</A></td>  <div class="evenrow">
250                                          <td CLASS="font10">build the entire DB query</td>          
251                                            <div class="method-header">
252                                  <tr>                  <span class="method-title">build_limit_clause</span> (line <span class="line-number">122</span>)
253                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_search_clause'>build_search_clause (  )</A></td>          </div>
254                                          <td CLASS="font10">This method builds the where clause.</td>          
255                                            <!-- ========== Info from phpDoc block ========= -->
256                                  <tr>  <p class="short-description">This function builds the limit  clause portion of a DB query.</p>
257                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_where_clause'>build_where_clause (  )</A></td>          <ul class="tags">
258                                          <td CLASS="font10">This builds the where clause for                                  <li><span class="field">return:</span> - the limit portion of                   the query.</li>
259  the query</td>                          </ul>
260                                            
261                                  <tr>          <div class="method-signature">
262                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#count'>count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></td>                  <span class="method-result">string</span>
263                                          <td CLASS="font10">find the number of rows to be returned                  <span class="method-name">
264  from a query from a table and where clause</td>                          build_limit_clause
265                                                    </span>
266                                  <tr>                                          (<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>)
267                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#do_prequery'>do_prequery (  )</A></td>                          </div>
268                                          <td CLASS="font10"></td>          
269                                                    
270                                  <tr>                          <hr class="separator" />
271                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#do_query'>do_query (  )</A></td>                  <div class="notes">Redefinition of:</div>
272                                          <td CLASS="font10">Do the query to the DB and pull in all of                  <dl>
273  the records locally.</td>                          <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_limit_clause">SQLDataListSource::build_limit_clause()</a></dt>
274                                                                                    <dd>This function builds the limit  clause portion of a DB query.</dd>
275                                  <tr>                                          </dl>
276                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_count_column'>get_count_column (  )</A></td>                  
277                                          <td CLASS="font10">this returns the current count column</td>          </div>
278                                    <a name="methodcount" id="count"><!-- --></a>
279                                  <tr>  <div class="oddrow">
280                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_count_column'>get_count_column (  )</A></td>          
281                                          <td CLASS="font10">this gets the count column</td>          <div class="method-header">
282                                                    <span class="method-title">count</span> (line <span class="line-number">153</span>)
283                                  <tr>          </div>
284                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_db_tables'>get_db_tables (  )</A></td>          
285                                          <td CLASS="font10">returns the table(s) used in the query</td>          <!-- ========== Info from phpDoc block ========= -->
286                                    <p class="short-description">find the number of rows to be returned  from a query from a table and where clause</p>
287                                  <tr>          <ul class="tags">
288                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_db_values'>get_db_values (  )</A></td>                                  <li><span class="field">return:</span> the # of rows</li>
289                                          <td CLASS="font10">This function returns the</td>                          </ul>
290                                            
291                                  <tr>          <div class="method-signature">
292                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_next_data_row'>get_next_data_row (  )</A></td>                  <span class="method-result">int</span>
293                                          <td CLASS="font10">This function gets the next data row                  <span class="method-name">
294  from the query()</td>                          count
295                                                    </span>
296                                  <tr>                                          (<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>)
297                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#join_clauses'>join_clauses (  )</A></td>                          </div>
298                                          <td CLASS="font10"></td>          
299                                                            <ul class="parameters">
300                                  <tr>                                          <li>
301                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#search_value_filter'>search_value_filter ( $value )</A></td>                                  <span class="var-type">string</span>
302                                          <td CLASS="font10">This function does the variable cleaning</td>                                  <span class="var-name">$table</span><span class="var-description">: - the table to count from</span>                    </li>
303                                                                            <li>
304                                  <tr>                                  <span class="var-type">string</span>
305                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_db_options'>setup_db_options ( [$values = ], $tables, [$where_clause = ''], [$groupby_clause = ''] )</A></td>                                  <span class="var-name">$where_clause</span><span class="var-description">: - a where clause</span>                      </li>
306                                          <td CLASS="font10">Set which DB options                                  </ul>
307  to use for this list.</td>                  
308                                                            <hr class="separator" />
309                                  <tr>                  <div class="notes">Redefinition of:</div>
310                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_order'>setup_order ( $orderby, $reverseorder )</A></td>                  <dl>
311                                          <td CLASS="font10">This function builds the orderby clause                          <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodcount">SQLDataListSource::count()</a></dt>
312  for the DB query.</td>                                                  <dd>find the number of rows to be returned  from a query from a table and where clause</dd>
313                                                                            </dl>
314                                  <tr>                  
315                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_count_column'>set_count_column ( $var )</A></td>          </div>
316                                          <td CLASS="font10">This function changes the counted column.</td>  <a name="methoddo_query" id="do_query"><!-- --></a>
317                                    <div class="evenrow">
318                                  <tr>          
319                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_groupby_clause'>set_db_groupby_clause ( $clause )</A></td>          <div class="method-header">
320                                          <td CLASS="font10">Sets the groupby clause for the query</td>                  <span class="method-title">do_query</span> (line <span class="line-number">91</span>)
321                                            </div>
322                                  <tr>          
323                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_tables'>set_db_tables ( $tables )</A></td>          <!-- ========== Info from phpDoc block ========= -->
324                                          <td CLASS="font10">Set the tables from the DB you  <p class="short-description">This is the function that does the data fetching,  and sorting if needed.</p>
325  want to select on.</td>  <p class="description"><p>If the source is a sql database, this is where the  query gets called.  This function doesn't actually read the  data from the DB yet.  That is what get_next_data_row()  does.</p></p>
326                                            <ul class="tags">
327                                  <tr>                                  <li><span class="field">return:</span> - the query passed/failed.</li>
328                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_values'>set_db_values ( $values )</A></td>                          </ul>
329                                          <td CLASS="font10">Set the values we want to select          
330  from the db.</td>          <div class="method-signature">
331                                                    <span class="method-result">boolean</span>
332                                  <tr>                  <span class="method-name">
333                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_where_clause'>set_db_where_clause ( $where_clause )</A></td>                          do_query
334                                          <td CLASS="font10">Set the user portion of the where                  </span>
335  clause.</td>                                  ()
336                                                            </div>
337                                  <tr>          
338                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#simple_search_where_clause'>simple_search_where_clause (  )</A></td>                  
339                                          <td CLASS="font10">this builds the search clause</td>                          <hr class="separator" />
340                                                    <div class="notes">Redefinition of:</div>
341                                  <tr>                  <dl>
342                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#sql_varchar_filter'>sql_varchar_filter ( $value )</A></td>                          <dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></dt>
343                                          <td CLASS="font10">Clean up the string so it can work in a db</td>                                                  <dd>Do the query to the DB and pull in all of  the records locally.</dd>
344                                                                            </dl>
345                          </table>                  
346              <br>                                  </div>
347                  </TD>  <a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a>
348          </TR>  <div class="oddrow">
349                    
350          <!-- =========== Summary =========== -->          <div class="method-header">
351          <TR BGCOLOR='white' CLASS='TableRowColor'>                  <span class="method-title">get_next_data_row</span> (line <span class="line-number">111</span>)
352                  <TD>          </div>
353                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>          
354              <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">          <!-- ========== Info from phpDoc block ========= -->
355                                  <tr CLASS="tableheadingcolor">  <p class="short-description">This function gets the next data row  from the query()</p>
356                                          <th>Function</th>          
357                                          <th>Description</th>          <div class="method-signature">
358                                  </tr>                  <span class="method-result">array()</span>
359                                                    <span class="method-name">
360                                  <tr>                          get_next_data_row
361                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#constructor DataListSource'>constructor DataListSource (  )</A></td>                  </span>
362                                          <td CLASS="font10">The constructor</td>                                  ()
363                                                            </div>
364                                  <tr>          
365                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td>                  
366                                          <td CLASS="font10">Add a column of data to manage</td>                          <hr class="separator" />
367                                                    <div class="notes">Redefinition of:</div>
368                                  <tr>                  <dl>
369                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery (  )</A></td>                          <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a></dt>
370                                          <td CLASS="font10">This is a method that should be defined by the                                                  <dd>This function gets the next data row  from the query()</dd>
371  child class to do any pre-query type of things.</td>                                          </dl>
372                                                    
373                                  <tr>          </div>
374                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query (  )</A></td>  <a name="methodset_db_object" id="set_db_object"><!-- --></a>
375                                          <td CLASS="font10">This is the function that does the data fetching,  <div class="evenrow">
376  and sorting if needed.</td>          
377                                            <div class="method-header">
378                                  <tr>                  <span class="method-title">set_db_object</span> (line <span class="line-number">77</span>)
379                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index (  )</A></td>          </div>
380                                          <td CLASS="font10">This function returns the          
381  data_index value and increments it</td>          <!-- ========== Info from phpDoc block ========= -->
382                                    <p class="short-description">Set the DB object we will use  to talk to the DB.</p>
383                                  <tr>          
384                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit (  )</A></td>          <div class="method-signature">
385                                          <td CLASS="font10">This function gets the current                  <span class="method-result">void</span>
386  value of the limit value</td>                  <span class="method-name">
387                                                            set_db_object
388                                  <tr>                  </span>
389                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row (  )</A></td>                                          (<span class="var-type">object -</span>&nbsp;<span class="var-name">&$db</span>)
390                                          <td CLASS="font10">This function gets the next data row                          </div>
391  from the query()</td>          
392                                                            <ul class="parameters">
393                                  <tr>                                          <li>
394                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message (  )</A></td>                                  <span class="var-type">object -</span>
395                                          <td CLASS="font10">This function is used to get the                                  <span class="var-name">$db</span><span class="var-description">: the babw_db object.</span>                     </li>
396  message displayed when no data is found</td>                                  </ul>
397                                                    
398                                  <tr>                  
399                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset (  )</A></td>          </div>
400                                          <td CLASS="font10">This function returns the value of the                                                          <h4>Inherited Methods</h4>
401  offset</td>                                  <a name='inherited_methods'><!-- --></a>        
402                                                                                                            <!-- =========== Summary =========== -->
403                                  <tr>                                          <p>Inherited From <span class="classname"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span></p>
404                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby (  )</A></td>                                          <blockquote>
405                                          <td CLASS="font10">This function returns the value of the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodadvanced_search_where_clause">SQLDataListSource::advanced_search_where_clause()</a></span><br>
406  orderby</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_groupby_clause">SQLDataListSource::build_groupby_clause()</a></span><br>
407                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_limit_clause">SQLDataListSource::build_limit_clause()</a></span><br>
408                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_order_clause">SQLDataListSource::build_order_clause()</a></span><br>
409                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder (  )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_query">SQLDataListSource::build_query()</a></span><br>
410                                          <td CLASS="font10">This function returns the value of the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_search_clause">SQLDataListSource::build_search_clause()</a></span><br>
411  reverseorder</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_where_clause">SQLDataListSource::build_where_clause()</a></span><br>
412                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodcount">SQLDataListSource::count()</a></span><br>
413                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a></span><br>
414                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby (  )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></span><br>
415                                          <td CLASS="font10">This function returns the value of the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_count_column">SQLDataListSource::get_count_column()</a></span><br>
416  searchby</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_db_tables">SQLDataListSource::get_db_tables()</a></span><br>
417                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_db_values">SQLDataListSource::get_db_values()</a></span><br>
418                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_default_order_case_sensitive">SQLDataListSource::get_default_order_case_sensitive()</a></span><br>
419                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value (  )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a></span><br>
420                                          <td CLASS="font10">This function returns the value of the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodjoin_clauses">SQLDataListSource::join_clauses()</a></span><br>
421  search value</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodsearch_value_filter">SQLDataListSource::search_value_filter()</a></span><br>
422                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodsetup_db_options">SQLDataListSource::setup_db_options()</a></span><br>
423                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodsetup_order">SQLDataListSource::setup_order()</a></span><br>
424                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type (  )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_count_column">SQLDataListSource::set_count_column()</a></span><br>
425                                          <td CLASS="font10">this function returns the current search type                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_groupby_clause">SQLDataListSource::set_db_groupby_clause()</a></span><br>
426  for the DataList query</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_tables">SQLDataListSource::set_db_tables()</a></span><br>
427                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_values">SQLDataListSource::set_db_values()</a></span><br>
428                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_where_clause">SQLDataListSource::set_db_where_clause()</a></span><br>
429                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier (  )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_default_order_case_sensitive">SQLDataListSource::set_default_order_case_sensitive()</a></span><br>
430                                          <td CLASS="font10">This function returns the value of the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodsimple_search_where_clause">SQLDataListSource::simple_search_where_clause()</a></span><br>
431  search value</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/SQLDataListSource.html#methodsql_varchar_filter">SQLDataListSource::sql_varchar_filter()</a></span><br>
432                                                                                                                            </blockquote>
433                                  <tr>                                                                          <!-- =========== Summary =========== -->
434                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows (  )</A></td>                                          <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
435                                          <td CLASS="font10">This returns the total number of rows                                          <blockquote>
436  in our entire data set</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br>
437                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br>
438                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br>
439                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br>
440                                          <td CLASS="font10">The main Query function.</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br>
441                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br>
442                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br>
443                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br>
444                                          <td CLASS="font10">This function is used to set</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br>
445                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br>
446                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br>
447                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br>
448                                          <td CLASS="font10">This function is used to set the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br>
449  message displayed when no data is found</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br>
450                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_secondary_orderby">DataListSource::get_secondary_orderby()</a></span><br>
451                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br>
452                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br>
453                                          <td CLASS="font10">This sets the offset value</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br>
454                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br>
455                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br>
456                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br>
457                                          <td CLASS="font10">This sets the orderby column name.</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br>
458                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br>
459                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br>
460                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br>
461                                          <td CLASS="font10">This sets the flag that tells us the                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br>
462  direction in which to order the orderby                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br>
463  column.</td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_secondary_orderby">DataListSource::set_secondary_orderby()</a></span><br>
464                                                                                                                                            <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br>
465                                  <tr>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br>
466                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td>                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br>
467                                          <td CLASS="font10">This sets the column that we want to search                                                                                                          <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br>
468  from.</td>                                                                                          </blockquote>
469                                                                                                                    
470                                  <tr>                  </div>
471                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td>          </div>
472                                          <td CLASS="font10">This sets the data that we want to search  
473  for.</td>  
474                                            <p class="notes" id="credit">
475                                  <tr>                  Documentation generated on Thu,  1 Apr 2004 09:39:09 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
476                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td>          </p>
477                                          <td CLASS="font10">This function sets the search type          </div></body>
478  (simple or advanced)</td>  </html>
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td>  
                                         <td CLASS="font10">This sets the simple search modifier</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td>  
                                         <td CLASS="font10">This is used to set the total # of  
 rows we have in our data set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort (  )</A></td>  
                                         <td CLASS="font10">A generic method API that can be used at the bottom  
 half of the do_query() method to sort data that is  
 stored locally.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td>  
                                         <td CLASS="font10">This function determines if the column</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- should have constructor at some point -->  
 <!-- =========== Method SUMMARY =========== -->  
 <A NAME='Method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#constructor PEARSQLDataListSource'>void constructor PEARSQLDataListSource ( &$db )</A></B></CODE>  
                         <BR>  
                         <blockquote> The constructor is used to pass in the  
 PEAR DB object that has already been  
 created and connected to the db. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#build_limit_clause'>string build_limit_clause ( $offset, $limit )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function builds the limit  
 clause portion of a DB query. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#count'>int count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></B></CODE>  
                         <BR>  
                         <blockquote> find the number of rows to be returned  
 from a query from a table and where clause </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#do_query'>void do_query (  )</A></B></CODE>  
                         <BR>  
                         <blockquote>  </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#get_next_data_row'>array() get_next_data_row (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function gets the next data row  
 from the query() </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#set_db_object'>void set_db_object ( &$db )</A></B></CODE>  
                         <BR>  
                         <blockquote> Set the DB object we will use  
 to talk to the DB. </blockquote>  
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
   
 <A NAME='$_db'><!-- --></A><H3>$_db</H3>  
 <b>Data type:</b> mixed<br>  
 <!-- ========== Info from phpDoc block ========= -->  
 This var holds the Database object  
 <BR>  
 that is used to do the sql queries  
 It is assumed that the db is already  
 connected to, and the object provides  
 2 methods:  
 query() - execute a sql query  
   
 <UL>  
           
 </UL>  
   
 <HR>  
   
 <A NAME='$_result'><!-- --></A><H3>$_result</H3>  
 <b>Data type:</b> mixed<br>  
 <!-- ========== Info from phpDoc block ========= -->  
 this holds the query result from the  
 PEAR::DB-&gt;query() call  
 <BR>  
   
   
 <UL>  
           
 </UL>  
   
 <HR>  
   
   
 <hr>  
 <!-- ============ FUNCTION DETAIL =========== -->  
   
 <A NAME='function_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='constructor PEARSQLDataListSource'><!-- --></A>  
 <SPAN CLASS="font12bold">constructor PEARSQLDataListSource</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">constructor PEARSQLDataListSource ( &$db )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 The constructor is used to pass in the  
 PEAR DB object that has already been  
 created and connected to 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;">PEAR::DB</SPAN> <span style="color: #0000FF;font-weight:bold">&$db</SPAN></SPAN> object - MUST BE CONNECTED</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_limit_clause'><!-- --></A>  
 <SPAN CLASS="font12bold">build_limit_clause</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_limit_clause ( $offset, $limit )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#build_limit_clause">SQLDataListSource::build_limit_clause()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function builds the limit  
 clause portion of a DB query.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the limit portion of  
                   the query.</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='count'><!-- --></A>  
 <SPAN CLASS="font12bold">count</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#count">SQLDataListSource::count()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 find the number of rows to be returned  
 from a query from a table and 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">$table</SPAN></SPAN> - the table to count from</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$where_clause</SPAN></SPAN> - a where clause</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the # of rows</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='do_query'><!-- --></A>  
 <SPAN CLASS="font12bold">do_query</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">do_query (  )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#do_query">SQLDataListSource::do_query()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
   
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='get_next_data_row'><!-- --></A>  
 <SPAN CLASS="font12bold">get_next_data_row</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_next_data_row (  )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#get_next_data_row">SQLDataListSource::get_next_data_row()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function gets the next data row  
 from the query()  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='set_db_object'><!-- --></A>  
 <SPAN CLASS="font12bold">set_db_object</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">set_db_object ( &$db )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 Set the DB object we will use  
 to talk to 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;">object</SPAN> <span style="color: #0000FF;font-weight:bold">$db</SPAN></SPAN> -  the babw_db object.</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.4
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed