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