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