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

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

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

revision 1.1.1.1 by jonen, Thu Jan 30 03:29:19 2003 UTC revision 1.3 by jonen, Sat Sep 20 00:24:03 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:33 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class PEARSQLDataListSource</TITLE>                          <title>Docs For Class PEARSQLDataListSource</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>                          <link rel="stylesheet" href="../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10                        <body>
11                            <div class="page-body">                
12  <!-- Links -->  <h2 class="class-name">Class PEARSQLDataListSource</h2>
13  <a NAME="top"></A>  
14  <table WIDTH="100%" class="links">  <a name="sec-description"></a>
15   <TR>  <div class="info-box">
16     <TD class="font10">          <div class="info-box-title">Description</div>
17        Links:          <div class="nav-bar">
18        <A HREF="#children_summary" class="links" title="Classes extended from PEARSQLDataListSource">Child Classes</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>                                                  
22        <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>                          </div>
23        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>          <div class="info-box-body">
24        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>                  <!-- ========== Info from phpDoc block ========= -->
25     </TD>  <p class="short-description">This SQLDataListSource child class interacts with  with the specific DB via the php PEAR DB abstraction  objects.</p>
26   </TR>  <p class="description"><p>How to use?  in the DataList child's get_data_source() method  you pass in the already connected PEAR DB object  in to the constructor.  PEARSQLDataListSource  takes care of the rest.</p></p>
27  </TABLE>          <ul class="tags">
28  <BR>                                  <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
29                            </ul>
30  <!-- Start of Class Data -->                  <p class="notes">
31  <H2>                          Located in <a class="field" href="_widgets_data_list_PEARSQLDataListSource_inc.html">Program_Root/widgets/data_list/PEARSQLDataListSource.inc</a> (line <span class="field">40</span>)
32          Class PEARSQLDataListSource                  </p>
33  </H2>                  
34                            
35  <pre>                  <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>  
36     |     |
37     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>
38        |        |
39        --PEARSQLDataListSource</pre>        --PEARSQLDataListSource</pre>
40  </pre>          
41                            </div>
42  <A NAME="children_summary"</A>  </div>
 <H3>  
         Classes extended from PEARSQLDataListSource: <A HREF="#top" CLASS="links">^TOP</A>  
 </H3>  
   
 <p>  
         <b><i>Located in File: Program_Root/widgets/data_list/PEARSQLDataListSource.inc</i></b><br>  
 </p>  
 <hr>  
 <!-- ========== Info from phpDoc block ========= -->  
 This SQLDataListSource child class interacts with  
 <BR>  
 with the specific DB via the php PEAR DB abstraction  
 objects.  
   
 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.  
   
 <UL>  
           
         <LI><b>Package</b> - <CODE>phpHtmlLib</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='PEARSQLDataListSource.html#$_db'>$_db</A></B></CODE>  
                         <BR>  
                         <blockquote> This var holds the Database object </blockquote>  
                         <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#$_result'>$_result</A></B></CODE>  
                         <BR>  
                         <blockquote> this holds the query result from the  
 PEAR::DB-&gt;query() call </blockquote>  
                         <blockquote> Default Value: <CODE>->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 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#$_db_options'>$_db_options</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;values&quot; =&gt; &quot;&quot;,  
                                                          &quot;tables&quot; =&gt; &quot;&quot;,  
                                                          &quot;where_clause&quot; =&gt; &quot;&quot;,  
                                                          &quot;groupby_clause&quot; =&gt; &quot;&quot;,  
                                                          &quot;count_column&quot; =&gt; &quot;*&quot;)<-</td>  
                                 <td CLASS="font10">this holds all of the options  
 that make up the sql query</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#$_query'>$_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#$_columns'>$_columns</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>  
                                 <td CLASS="font10">The column descriptions  
 for the data we are working on</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>  
                                 <td CLASS="font10">A placeholder for data that is read/built</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>  
                                 <td CLASS="font10">Holds the index into the array of data</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td>  
                                 <td CLASS="font10">This is the message displayed when no data</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;num_total_rows&quot; =&gt; 0,  
                                                            &quot;offset&quot; =&gt; 0,  
                                                            &quot;limit&quot; =&gt; -1,  
                                                            &quot;orderby&quot; =&gt; '',  
                                                            &quot;reverseorder&quot; =&gt; '',  
                                                            &quot;searchby&quot; =&gt; '',  
                                                            &quot;searchvalue&quot; =&gt; '',  
                                                            &quot;searchmodifier&quot; =&gt; '',  
                                                            &quot;searchtype&quot; =&gt; 'simple')<-</td>  
                                 <td CLASS="font10">This holds various parameters relating  
 to the query of the data</td>  
                         </tr>  
                                   
                         </table>  
             <BR>  
         </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/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#advanced_search_where_clause'>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#build_groupby_clause'>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#build_limit_clause'>build_limit_clause ( $offset, $limit )</A></td>  
                                         <td CLASS="font10">This function builds the limit</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_order_clause'>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#build_query'>build_query ( [$limit_flag = TRUE] )</A></td>  
                                         <td CLASS="font10">build the entire DB query</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_search_clause'>build_search_clause (  )</A></td>  
                                         <td CLASS="font10">This method builds the where clause.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_where_clause'>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#count'>count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</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#do_prequery'>do_prequery (  )</A></td>  
                                         <td CLASS="font10"></td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#do_query'>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#get_count_column'>get_count_column (  )</A></td>  
                                         <td CLASS="font10">this returns the current count column</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_count_column'>get_count_column (  )</A></td>  
                                         <td CLASS="font10">this gets the count column</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_db_tables'>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#get_db_values'>get_db_values (  )</A></td>  
                                         <td CLASS="font10">This function returns the</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_next_data_row'>get_next_data_row (  )</A></td>  
                                         <td CLASS="font10">This function gets the next data row  
 from the query()</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#join_clauses'>join_clauses (  )</A></td>  
                                         <td CLASS="font10"></td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#search_value_filter'>search_value_filter ( $value )</A></td>  
                                         <td CLASS="font10">This function does the variable cleaning</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_db_options'>setup_db_options ( [$values = ], $tables, [$where_clause = ''], [$groupby_clause = ''] )</A></td>  
                                         <td CLASS="font10">Set which DB options  
 to use for this list.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_order'>setup_order ( $orderby, $reverseorder )</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#set_count_column'>set_count_column ( $var )</A></td>  
                                         <td CLASS="font10">This function changes the counted column.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_groupby_clause'>set_db_groupby_clause ( $clause )</A></td>  
                                         <td CLASS="font10">Sets the groupby clause for the query</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_tables'>set_db_tables ( $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#set_db_values'>set_db_values ( $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#set_db_where_clause'>set_db_where_clause ( $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#simple_search_where_clause'>simple_search_where_clause (  )</A></td>  
                                         <td CLASS="font10">this builds the search clause</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#sql_varchar_filter'>sql_varchar_filter ( $value )</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#constructor DataListSource'>constructor DataListSource (  )</A></td>  
                                         <td CLASS="font10">The constructor</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td>  
                                         <td CLASS="font10">Add a column of data to manage</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery (  )</A></td>  
                                         <td CLASS="font10">This is a method that should be defined by the  
 child class to do any pre-query type of things.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query (  )</A></td>  
                                         <td CLASS="font10">This is the function that does the data fetching,  
 and sorting if needed.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index (  )</A></td>  
                                         <td CLASS="font10">This function returns the  
 data_index value and increments it</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit (  )</A></td>  
                                         <td CLASS="font10">This function gets the current  
 value of the limit value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row (  )</A></td>  
                                         <td CLASS="font10">This function gets the next data row  
 from the query()</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message (  )</A></td>  
                                         <td CLASS="font10">This function is used to get the  
 message displayed when no data is found</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 offset</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 orderby</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 reverseorder</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 searchby</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 search value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type (  )</A></td>  
                                         <td CLASS="font10">this function returns the current search type  
 for the DataList query</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 search value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows (  )</A></td>  
                                         <td CLASS="font10">This returns the total number of rows  
 in our entire data set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td>  
                                         <td CLASS="font10">The main Query function.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td>  
                                         <td CLASS="font10">This function is used to set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>  
                                         <td CLASS="font10">This function is used to set the  
 message displayed when no data is found</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td>  
                                         <td CLASS="font10">This sets the offset value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td>  
                                         <td CLASS="font10">This sets the orderby column name.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td>  
                                         <td CLASS="font10">This sets the flag that tells us the  
 direction in which to order the orderby  
 column.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td>  
                                         <td CLASS="font10">This sets the column that we want to search  
 from.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td>  
                                         <td CLASS="font10">This sets the data that we want to search  
 for.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td>  
                                         <td CLASS="font10">This function sets the search type  
 (simple or advanced)</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td>  
                                         <td CLASS="font10">This sets the simple search modifier</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td>  
                                         <td CLASS="font10">This is used to set the total # of  
 rows we have in our data set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort (  )</A></td>  
                                         <td CLASS="font10">A generic method API that can be used at the bottom  
 half of the do_query() method to sort data that is  
 stored locally.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td>  
                                         <td CLASS="font10">This function determines if the column</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- should have constructor at some point -->  
 <!-- =========== Method SUMMARY =========== -->  
 <A NAME='Method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#constructor PEARSQLDataListSource'>void constructor PEARSQLDataListSource ( &$db )</A></B></CODE>  
                         <BR>  
                         <blockquote> The constructor is used to pass in the  
 PEAR DB object that has already been  
 created and connected to the db. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#build_limit_clause'>string build_limit_clause ( $offset, $limit )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function builds the limit  
 clause portion of a DB query. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#count'>int count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></B></CODE>  
                         <BR>  
                         <blockquote> find the number of rows to be returned  
 from a query from a table and where clause </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#do_query'>void do_query (  )</A></B></CODE>  
                         <BR>  
                         <blockquote>  </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#get_next_data_row'>array() get_next_data_row (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function gets the next data row  
 from the query() </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='PEARSQLDataListSource.html#set_db_object'>void set_db_object ( &$db )</A></B></CODE>  
                         <BR>  
                         <blockquote> Set the DB object we will use  
 to talk to the DB. </blockquote>  
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
   
 <A NAME='$_db'><!-- --></A><H3>$_db</H3>  
 <b>Data type:</b> mixed<br>  
 <!-- ========== Info from phpDoc block ========= -->  
 This var holds the Database object  
 <BR>  
 that is used to do the sql queries  
 It is assumed that the db is already  
 connected to, and the object provides  
 2 methods:  
 query() - execute a sql query  
   
 <UL>  
           
 </UL>  
   
 <HR>  
   
 <A NAME='$_result'><!-- --></A><H3>$_result</H3>  
 <b>Data type:</b> mixed<br>  
 <!-- ========== Info from phpDoc block ========= -->  
 this holds the query result from the  
 PEAR::DB-&gt;query() call  
 <BR>  
   
   
 <UL>  
           
 </UL>  
   
 <HR>  
   
   
 <hr>  
 <!-- ============ FUNCTION DETAIL =========== -->  
   
 <A NAME='function_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='constructor PEARSQLDataListSource'><!-- --></A>  
 <SPAN CLASS="font12bold">constructor PEARSQLDataListSource</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">constructor PEARSQLDataListSource ( &$db )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 The constructor is used to pass in the  
 PEAR DB object that has already been  
 created and connected to the db.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">PEAR::DB</SPAN> <span style="color: #0000FF;font-weight:bold">&$db</SPAN></SPAN> object - MUST BE CONNECTED</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_limit_clause'><!-- --></A>  
 <SPAN CLASS="font12bold">build_limit_clause</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_limit_clause ( $offset, $limit )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#build_limit_clause">SQLDataListSource::build_limit_clause()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function builds the limit  
 clause portion of a DB query.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the limit portion of  
                   the query.</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='count'><!-- --></A>  
 <SPAN CLASS="font12bold">count</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#count">SQLDataListSource::count()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 find the number of rows to be returned  
 from a query from a table and where clause  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$table</SPAN></SPAN> - the table to count from</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$where_clause</SPAN></SPAN> - a where clause</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the # of rows</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='do_query'><!-- --></A>  
 <SPAN CLASS="font12bold">do_query</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">do_query (  )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#do_query">SQLDataListSource::do_query()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
   
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='get_next_data_row'><!-- --></A>  
 <SPAN CLASS="font12bold">get_next_data_row</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_next_data_row (  )</SPAN>  
 <BR>  
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#get_next_data_row">SQLDataListSource::get_next_data_row()</a>  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function gets the next data row  
 from the query()  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='set_db_object'><!-- --></A>  
 <SPAN CLASS="font12bold">set_db_object</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">set_db_object ( &$db )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 Set the DB object we will use  
 to talk to the DB.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">object</SPAN> <span style="color: #0000FF;font-weight:bold">$db</SPAN></SPAN> -  the babw_db object.</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
43    
44    
45  <hr>          <a name="sec-var-summary"></a>
46  </HTML>          <div class="info-box">
47                    <div class="info-box-title">Variable Summary</span></div>
48                    <div class="nav-bar">
49                            <a href="#sec-description">Description</a> |
50                                                    <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
51                                                            |
52                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
53                                                            
54                                            </div>
55                    <div class="info-box-body">
56                            <div class="var-summary">
57                                                                    <div class="var-title">
58                                            <span class="var-type">mixed</span>
59                                            <a href="#$_db" title="details" class="var-name">$_db</a>
60                                    </div>
61                                                                    <div class="var-title">
62                                            <span class="var-type">mixed</span>
63                                            <a href="#$_result" title="details" class="var-name">$_result</a>
64                                    </div>
65                                                            </div>
66                    </div>
67            </div>
68    
69            <a name="sec-method-summary"></a>
70            <div class="info-box">
71                    <div class="info-box-title">Method Summary</span></div>
72                    <div class="nav-bar">
73                            <a href="#sec-description">Description</a> |
74                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
75                                    
76                                    |
77                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
78                    </div>
79                    <div class="info-box-body">                    
80                            <div class="method-summary">
81                                                                    
82                                    <div class="method-definition">
83                                                                                            <span class="method-result">void</span>
84                                                                                    <a href="#PEARSQLDataListSource" title="details" class="method-name">PEARSQLDataListSource</a>
85                                                                                            (<span class="var-type">PEAR::DB</span>&nbsp;<span class="var-name">&$db</span>)
86                                                                            </div>
87                                                                    
88                                    <div class="method-definition">
89                                                                                            <span class="method-result">string</span>
90                                                                                    <a href="#build_limit_clause" title="details" class="method-name">build_limit_clause</a>
91                                                                                            (<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                                                                            </div>
93                                                                    
94                                    <div class="method-definition">
95                                                                                            <span class="method-result">int</span>
96                                                                                    <a href="#count" title="details" class="method-name">count</a>
97                                                                                            (<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                                                                            </div>
99                                                                    
100                                    <div class="method-definition">
101                                                                                            <span class="method-result">boolean</span>
102                                                                                    <a href="#do_query" title="details" class="method-name">do_query</a>
103                                                                                    ()
104                                                                            </div>
105                                                                    
106                                    <div class="method-definition">
107                                                                                            <span class="method-result">array()</span>
108                                                                                    <a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a>
109                                                                                    ()
110                                                                            </div>
111                                                                    
112                                    <div class="method-definition">
113                                                                                            <span class="method-result">void</span>
114                                                                                    <a href="#set_db_object" title="details" class="method-name">set_db_object</a>
115                                                                                            (<span class="var-type">object -</span>&nbsp;<span class="var-name">&$db</span>)
116                                                                            </div>
117                                                            </div>
118                    </div>
119            </div>          
120    
121            <a name="sec-vars"></a>
122            <div class="info-box">
123                    <div class="info-box-title">Variables</div>
124                    <div class="nav-bar">
125                            <a href="#sec-description">Description</a> |
126                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
127                                                    
128                            
129                                                            |
130                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
131                                                            
132                                            </div>
133                    <div class="info-box-body">
134                            <a name="var$_db" id="$_db"><!-- --></A>
135    <div class="evenrow">
136    
137            <div class="var-header">
138                    <span class="var-title">
139                            <span class="var-type">mixed</span>
140                            <span class="var-name">$_db</span>
141                             = <span class="var-default"> NULL</span>                       (line <span class="line-number">50</span>)
142                    </span>
143            </div>
144    
145            <!-- ========== Info from phpDoc block ========= -->
146    <p class="short-description">This var holds the Database object</p>
147    <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            
149            
150                    
151                    
152    
153    </div>
154    <a name="var$_result" id="$_result"><!-- --></A>
155    <div class="oddrow">
156    
157            <div class="var-header">
158                    <span class="var-title">
159                            <span class="var-type">mixed</span>
160                            <span class="var-name">$_result</span>
161                             = <span class="var-default"> NULL</span>                       (line <span class="line-number">57</span>)
162                    </span>
163            </div>
164    
165            <!-- ========== Info from phpDoc block ========= -->
166    <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            
169            
170                    
171                    
172    
173    </div>
174                                                            <h4>Inherited Variables</h4>
175                                    <A NAME='inherited_vars'><!-- --></A>
176                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span></p>
177                                            <blockquote>
178                                                                                                            <span class="var-title">
179                                                                    <span class="var-name"><a href="../phpHtmlLib/SQLDataListSource.html#var$_db_options">SQLDataListSource::$_db_options</a></span><br>
180                                                            </span>
181                                                                                                            <span class="var-title">
182                                                                    <span class="var-name"><a href="../phpHtmlLib/SQLDataListSource.html#var$_query">SQLDataListSource::$_query</a></span><br>
183                                                            </span>
184                                                                                            </blockquote>
185                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
186                                            <blockquote>
187                                                                                                            <span class="var-title">
188                                                                    <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br>
189                                                            </span>
190                                                                                                            <span class="var-title">
191                                                                    <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br>
192                                                            </span>
193                                                                                                            <span class="var-title">
194                                                                    <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br>
195                                                            </span>
196                                                                                                            <span class="var-title">
197                                                                    <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br>
198                                                            </span>
199                                                                                                            <span class="var-title">
200                                                                    <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br>
201                                                            </span>
202                                                                                            </blockquote>
203                                                                                    
204                    </div>
205            </div>
206            
207            <a name="sec-methods"></a>
208            <div class="info-box">
209                    <div class="info-box-title">Methods</div>
210                    <div class="nav-bar">
211                            <a href="#sec-description">Description</a> |
212                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
213                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
214                                                    
215                    </div>
216                    <div class="info-box-body">
217                            <A NAME='method_detail'></A>
218    <a name="methodPEARSQLDataListSource" id="PEARSQLDataListSource"><!-- --></a>
219    <div class="evenrow">
220            
221            <div class="method-header">
222                    <span class="method-title">Constructor PEARSQLDataListSource</span> (line <span class="line-number">67</span>)
223            </div>
224            
225            <!-- ========== Info from phpDoc block ========= -->
226    <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            
228            <div class="method-signature">
229                    <span class="method-result">void</span>
230                    <span class="method-name">
231                            PEARSQLDataListSource
232                    </span>
233                                            (<span class="var-type">PEAR::DB</span>&nbsp;<span class="var-name">&$db</span>)
234                            </div>
235            
236                            <ul class="parameters">
237                                            <li>
238                                    <span class="var-type">PEAR::DB</span>
239                                    <span class="var-name">&$db</span><span class="var-description">: <p>object - MUST BE CONNECTED</p></span>                      </li>
240                                    </ul>
241                    
242                    
243            </div>
244    <a name="methodbuild_limit_clause" id="build_limit_clause"><!-- --></a>
245    <div class="oddrow">
246            
247            <div class="method-header">
248                    <span class="method-title">build_limit_clause</span> (line <span class="line-number">121</span>)
249            </div>
250            
251            <!-- ========== Info from phpDoc block ========= -->
252    <p class="short-description">This function builds the limit  clause portion of a DB query.</p>
253            <ul class="tags">
254                                    <li><span class="field">return:</span> <p>- the limit portion of                   the query.</p></li>
255                            </ul>
256            
257            <div class="method-signature">
258                    <span class="method-result">string</span>
259                    <span class="method-name">
260                            build_limit_clause
261                    </span>
262                                            (<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                            </div>
264            
265                    
266                            <hr class="separator" />
267                    <div class="notes">Redefinition of:</div>
268                    <dl>
269                            <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_limit_clause">SQLDataListSource::build_limit_clause()</a></dt>
270                                                    <dd>This function builds the limit  clause portion of a DB query.</dd>
271                                            </dl>
272                    
273            </div>
274    <a name="methodcount" id="count"><!-- --></a>
275    <div class="evenrow">
276            
277            <div class="method-header">
278                    <span class="method-title">count</span> (line <span class="line-number">152</span>)
279            </div>
280            
281            <!-- ========== Info from phpDoc block ========= -->
282    <p class="short-description">find the number of rows to be returned  from a query from a table and where clause</p>
283            <ul class="tags">
284                                    <li><span class="field">return:</span> <p>the # of rows</p></li>
285                            </ul>
286            
287            <div class="method-signature">
288                    <span class="method-result">int</span>
289                    <span class="method-name">
290                            count
291                    </span>
292                                            (<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                            </div>
294            
295                            <ul class="parameters">
296                                            <li>
297                                    <span class="var-type">string</span>
298                                    <span class="var-name">$table</span><span class="var-description">: <p>- the table to count from</p></span>                     </li>
299                                            <li>
300                                    <span class="var-type">string</span>
301                                    <span class="var-name">$where_clause</span><span class="var-description">: <p>- a where clause</p></span>                       </li>
302                                    </ul>
303                    
304                            <hr class="separator" />
305                    <div class="notes">Redefinition of:</div>
306                    <dl>
307                            <dt><a href="../phpHtmlLib/SQLDataListSource.html#methodcount">SQLDataListSource::count()</a></dt>
308                                                    <dd>find the number of rows to be returned  from a query from a table and where clause</dd>
309                                            </dl>
310                    
311            </div>
312    <a name="methoddo_query" id="do_query"><!-- --></a>
313    <div class="oddrow">
314            
315            <div class="method-header">
316                    <span class="method-title">do_query</span> (line <span class="line-number">91</span>)
317            </div>
318            
319            <!-- ========== Info from phpDoc block ========= -->
320    <p class="short-description">This is the function that does the data fetching,  and sorting if needed.</p>
321    <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            <ul class="tags">
323                                    <li><span class="field">return:</span> <p>- the query passed/failed.</p></li>
324                            </ul>
325            
326            <div class="method-signature">
327                    <span class="method-result">boolean</span>
328                    <span class="method-name">
329                            do_query
330                    </span>
331                                    ()
332                            </div>
333            
334                    
335                            <hr class="separator" />
336                    <div class="notes">Redefinition of:</div>
337                    <dl>
338                            <dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></dt>
339                                                    <dd>Do the query to the DB and pull in all of  the records locally.</dd>
340                                            </dl>
341                    
342            </div>
343    <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>
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed