|
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
|
|
<!--NewPage--> |
|
|
<HTML> |
|
|
<HEAD> |
|
|
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:36 -0800' --> |
|
|
<TITLE>Docs For Class DataListSource</TITLE> |
|
|
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
|
|
</HEAD> |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
|
|
<!-- Links --> |
|
|
<a NAME="top"></A> |
|
|
<table WIDTH="100%" class="links"> |
|
|
<TR> |
|
|
<TD class="font10"> |
|
|
Links: |
|
|
<A HREF="#children_summary" class="links" title="Classes extended from DataListSource">Child Classes</A> |
|
|
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
|
|
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
|
|
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
|
|
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
|
|
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
|
|
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<BR> |
|
|
<!-- Start of Class Data --> |
|
|
<H2> |
|
|
Class DataListSource |
|
|
</H2> (line <span class="linenumber">31</span>) |
|
|
<pre> |
|
|
</pre> |
|
|
<SPAN class="type">Classes extended from DataListSource:</SPAN> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></dt> |
|
|
<dd></dd> |
|
|
</dl> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/CSVFILEDataListSource.html">CSVFILEDataListSource</a></dt> |
|
|
<dd>This DataListSource child class gets the data from a CSV (comma seperated values) file on disk.</dd> |
|
|
</dl> |
|
|
</p> |
|
|
<p> |
|
|
<b><i>Located in File: Program_Root/widgets/data_list/DataListSource.inc</i></b><br> |
|
|
</p> |
|
|
<hr> |
|
|
This is the base class for managing data for the DataList class. This abstracts away the underlying data layer from the DataList, so the data can come from multiple sources. |
|
|
<br /> |
|
|
<p>Most of the time the data will come from a data base such as Mysql or Oracle. This abstraction enables the data to also come from a tab delimited file, xml, php array</p> |
|
|
<UL> |
|
|
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></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/DataListSource.html#var$_columns">$_columns</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The column descriptions for the data we are working on </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_data">$_data</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> A placeholder for data that is read/built and stored locally. Not all data sources have to use this. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_data_index">$_data_index</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds the index into the array of data </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> 0<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_not_found_message">$_not_found_message</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This is the message displayed when no data </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> "No data was found"<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/DataListSource.html#var$_query_params">$_query_params</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This holds various parameters relating </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array("num_total_rows" => 0,<br> |
|
|
"offset" => 0,<br> |
|
|
"limit" => -1,<br> |
|
|
"orderby" => '',<br> |
|
|
"reverseorder" => '',<br> |
|
|
"searchby" => '',<br> |
|
|
"searchvalue" => '',<br> |
|
|
"searchmodifier" => '',<br> |
|
|
"searchtype" => 'simple')<-</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> |
|
|
|
|
|
</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/DataListSource.html#methodDataListSource'>void constructor DataListSource ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The constructor </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodadd_column'>void add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Add a column of data to manage </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methoddo_prequery'>void do_prequery ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This is a method that should be defined by the child class to do any pre-query type of things. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methoddo_query'>void do_query ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This is the function that does the data fetching, and sorting if needed. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_data_index'>int get_data_index ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the data_index value and increments it </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_limit'>int get_limit ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function gets the current value of the limit value </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.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/DataListSource.html#methodget_not_found_message'>string get_not_found_message ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to get the message displayed when no data is found </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_offset'>int get_offset ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the offset </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_orderby'>int get_orderby ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the orderby </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_reverseorder'>int get_reverseorder ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the reverseorder </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_searchby'>int get_searchby ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the searchby </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_searchby_value'>int get_searchby_value ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the search value </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_search_type'>string get_search_type ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> this function returns the current search type for the DataList query </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier'>int get_simplesearch_modifier ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the value of the search value </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodget_total_rows'>int get_total_rows ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This returns the total number of rows in our entire data set </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodquery'>void query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The main Query function. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_limit'>void set_limit ( $limit )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to set </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to set the message displayed when no data is found </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_offset'>void set_offset ( $offset )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the offset value and resets the index into the data array (in non DB children) </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_orderby'>void set_orderby ( $orderby )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the orderby column name. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_reverseorder'>void set_reverseorder ( $order )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the flag that tells us the direction in which to order the orderby column. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_searchby'>void set_searchby ( $search_col )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the column that we want to search from. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_searchby_value'>void set_searchby_value ( $search_value )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the data that we want to search for. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_search_type'>void set_search_type ( $search_type )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function sets the search type (simple or advanced) </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier'>void set_simplesearch_modifier ( $search_modifier )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the simple search modifier </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodset_total_rows'>void set_total_rows ( $num )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This is used to set the total # of rows we have in our data set </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#methodsort'>void sort ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> 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. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/DataListSource.html#method_is_column_sortable'>boolean _is_column_sortable ( $data_name )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function determines if the column associated w/ a data_name is sortable or not </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> |
|
|
|
|
|
</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$_columns'><!-- --></A><H3>$_columns</H3> (line <span class="linenumber">39</span>)<br /> |
|
|
<b>Data type:</b> array<br>The column descriptions for the data we are working on |
|
|
<br /> |
|
|
|
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_data'><!-- --></A><H3>$_data</H3> (line <span class="linenumber">79</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>A placeholder for data that is read/built and stored locally. Not all data sources have to use this. |
|
|
<br /> |
|
|
<p>Each entry in the array corresponds to 1 row of data.</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_data_index'><!-- --></A><H3>$_data_index</H3> (line <span class="linenumber">70</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>Holds the index into the array of data |
|
|
<br /> |
|
|
<p>so we can keep track of where we are when we are walking the array (only usefull for non DB children)</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_not_found_message'><!-- --></A><H3>$_not_found_message</H3> (line <span class="linenumber">45</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>This is the message displayed when no data |
|
|
<br /> |
|
|
<p>was retrieved from the database</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_query_params'><!-- --></A><H3>$_query_params</H3> (line <span class="linenumber">53</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>This holds various parameters relating |
|
|
<br /> |
|
|
<p>to the query of the data</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='methodDataListSource'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">Constructor DataListSource</SPAN> (line <span class="linenumber">85</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">DataListSource( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
The constructor |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodadd_column'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add_column</SPAN> (line <span class="linenumber">108</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add_column( |
|
|
string |
|
|
$title, string |
|
|
$data_name, [boolean |
|
|
$sortable = FALSE], [boolean |
|
|
$searchable = FALSE], [string |
|
|
$sortorder = "ASC"])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Add a column of data to manage |
|
|
<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">$title</SPAN></SPAN> - the title of the column</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">$data_name</SPAN></SPAN> - the data value name</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$sortable</SPAN></SPAN> - is the column sortable? default: FALSE</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$searchable</SPAN></SPAN> - is the column searchable default: FALSE</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">$sortorder</SPAN></SPAN> - the sort order (ASC, DESC) default: ASC</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methoddo_prequery'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">do_prequery</SPAN> (line <span class="linenumber">185</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">do_prequery( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
<p>Overridden in child classes as:<br /> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a></dt> |
|
|
<dd></dd> |
|
|
</dl> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a></dt> |
|
|
<dd>The prequery. We use this to read the file</dd> |
|
|
</dl> |
|
|
</p> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This is a method that should be defined by the child class to do any pre-query type of things. |
|
|
<br /> |
|
|
<p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methoddo_query'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">do_query</SPAN> (line <span class="linenumber">199</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">do_query( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
<p>Overridden in child classes as:<br /> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></dt> |
|
|
<dd>Do the query to the DB and pull in all of the records locally.</dd> |
|
|
</dl> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a></dt> |
|
|
<dd>This function does the query</dd> |
|
|
</dl> |
|
|
</p> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This is the function that does the data fetching, and sorting if needed. |
|
|
<br /> |
|
|
<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> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_data_index'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_data_index</SPAN> (line <span class="linenumber">428</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_data_index( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the data_index value and increments it |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_limit'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_limit</SPAN> (line <span class="linenumber">397</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_limit( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function gets the current value of the limit value |
|
|
<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">172</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">array()</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_next_data_row( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
<p>Overridden in child classes as:<br /> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a></dt> |
|
|
<dd>This function gets the next data row from the query()</dd> |
|
|
</dl> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methodget_next_data_row">CSVFILEDataListSource::get_next_data_row()</a></dt> |
|
|
<dd>This function returns the next row of valid data.</dd> |
|
|
</dl> |
|
|
</p> |
|
|
|
|
|
<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='methodget_not_found_message'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_not_found_message</SPAN> (line <span class="linenumber">231</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_not_found_message( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function is used to get the message displayed when no data is found |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_offset'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_offset</SPAN> (line <span class="linenumber">274</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_offset( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the offset |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_orderby'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_orderby</SPAN> (line <span class="linenumber">296</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_orderby( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the orderby |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_reverseorder'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_reverseorder</SPAN> (line <span class="linenumber">317</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_reverseorder( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the reverseorder |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_searchby'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_searchby</SPAN> (line <span class="linenumber">337</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_searchby( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the searchby |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_searchby_value'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_searchby_value</SPAN> (line <span class="linenumber">357</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_searchby_value( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the search value |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_search_type'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_search_type</SPAN> (line <span class="linenumber">418</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_search_type( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
this function returns the current search type for the DataList query |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_simplesearch_modifier'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_simplesearch_modifier</SPAN> (line <span class="linenumber">377</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_simplesearch_modifier( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function returns the value of the search value |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_total_rows'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_total_rows</SPAN> (line <span class="linenumber">241</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_total_rows( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This returns the total number of rows in our entire data set |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodquery'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">query</SPAN> (line <span class="linenumber">138</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">query( |
|
|
int |
|
|
$offset, int |
|
|
$limit, string |
|
|
$orderby, string |
|
|
$reverseorder, string |
|
|
$searchby, string |
|
|
$searchby_value, string |
|
|
$simplesearch_modifier, mixed |
|
|
$search_type)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
The main Query function. |
|
|
<br /> |
|
|
<p>This function is responsible for doing any data prefetching from a db,file and doing any sorting and searching on it depending on the values passed in from the DataList object</p> |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> - the offset into the data set</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$limit</SPAN></SPAN> - the # of rows to get</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">$orderby</SPAN></SPAN> - the column to order the data by</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">$reverseorder</SPAN></SPAN> - order in asc or reverse?</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">$searchby</SPAN></SPAN> - the column in the dataset to search by</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">$searchby_value</SPAN></SPAN> - the value to look for</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">$simplesearch_modifier</SPAN></SPAN> - the simple search modifier.</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_limit'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_limit</SPAN> (line <span class="linenumber">387</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_limit( |
|
|
mixed |
|
|
$limit)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function is used to set |
|
|
<br /> |
|
|
<p>the limit value, which limits the # of rows of data to allow to return</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_not_found_message'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_not_found_message</SPAN> (line <span class="linenumber">221</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_not_found_message( |
|
|
string |
|
|
$mesg)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function is used to set the message displayed when no data is found |
|
|
<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">$mesg</SPAN></SPAN> </DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_offset'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_offset</SPAN> (line <span class="linenumber">263</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_offset( |
|
|
int |
|
|
$offset)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the offset value and resets the index into the data array (in non DB children) |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_orderby'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_orderby</SPAN> (line <span class="linenumber">286</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_orderby( |
|
|
int |
|
|
$orderby)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the orderby column name. |
|
|
<br /> |
|
|
<p>This corresponds to the column that wants to be sorted/ordered, but not the actual direction (asc, desc)</p> |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$orderby</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_reverseorder'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_reverseorder</SPAN> (line <span class="linenumber">307</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_reverseorder( |
|
|
int |
|
|
$order)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the flag that tells us the direction in which to order the orderby column. |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$order</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_searchby'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_searchby</SPAN> (line <span class="linenumber">327</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_searchby( |
|
|
int |
|
|
$search_col)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the column that we want to search from. |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_col</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_searchby_value'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_searchby_value</SPAN> (line <span class="linenumber">347</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_searchby_value( |
|
|
int |
|
|
$search_value)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the data that we want to search for. |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_value</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_search_type'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_search_type</SPAN> (line <span class="linenumber">408</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_search_type( |
|
|
string |
|
|
$search_type)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function sets the search type (simple or advanced) |
|
|
<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">$search_type</SPAN></SPAN> </DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_simplesearch_modifier'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_simplesearch_modifier</SPAN> (line <span class="linenumber">367</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_simplesearch_modifier( |
|
|
int |
|
|
$search_modifier)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the simple search modifier |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_modifier</SPAN></SPAN> offset</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_total_rows'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_total_rows</SPAN> (line <span class="linenumber">251</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_total_rows( |
|
|
int |
|
|
$num)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This is used to set the total # of rows we have in our data set |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$num</SPAN></SPAN> </DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodsort'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">sort</SPAN> (line <span class="linenumber">211</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">sort( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
<p>Overridden in child classes as:<br /> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/CSVFILEDataListSource.html#methodsort">CSVFILEDataListSource::sort()</a></dt> |
|
|
<dd></dd> |
|
|
</dl> |
|
|
</p> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
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. |
|
|
<br /> |
|
|
<p>It should operate on the $this->_data array</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='method_is_column_sortable'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_is_column_sortable</SPAN> (line <span class="linenumber">442</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_is_column_sortable( |
|
|
string |
|
|
$data_name)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function determines if the column associated w/ a data_name is sortable or not |
|
|
<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">$data_name</SPAN></SPAN> - the data_name filed in the _columns array to look for</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - is that column sortable?</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<div id="credit"> |
|
|
<hr> |
|
|
Documention generated on Thu, 20 Feb 2003 16:22:36 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
|
|
</div> |
|
|
</body> |
|
|
</html> |
|
| 1 |
|
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
|
<head> |
| 5 |
|
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
|
<title>Docs For Class DataListSource</title> |
| 7 |
|
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
|
</head> |
| 10 |
|
<body> |
| 11 |
|
<div class="page-body"> |
| 12 |
|
<h2 class="class-name">Class DataListSource</h2> |
| 13 |
|
|
| 14 |
|
<a name="sec-description"></a> |
| 15 |
|
<div class="info-box"> |
| 16 |
|
<div class="info-box-title">Description</div> |
| 17 |
|
<div class="nav-bar"> |
| 18 |
|
<span class="disabled">Description</span> | |
| 19 |
|
<a href="#sec-descendents">Descendents</a> |
| 20 |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 21 |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 22 |
|
|
| 23 |
|
</div> |
| 24 |
|
<div class="info-box-body"> |
| 25 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 26 |
|
<p class="short-description">This is the base class for managing data for the DataList class. This abstracts away the underlying data layer from the DataList, so the data can come from multiple sources.</p> |
| 27 |
|
<p class="description"><p>Most of the time the data will come from a data base such as Mysql or Oracle. This abstraction enables the data to also come from a tab delimited file, xml, php array</p></p> |
| 28 |
|
<ul class="tags"> |
| 29 |
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 30 |
|
</ul> |
| 31 |
|
<p class="notes"> |
| 32 |
|
Located in <a class="field" href="_widgets_data_list_DataListSource_inc.html">/widgets/data_list/DataListSource.inc</a> (line <span class="field">31</span>) |
| 33 |
|
</p> |
| 34 |
|
|
| 35 |
|
|
| 36 |
|
<pre></pre> |
| 37 |
|
|
| 38 |
|
</div> |
| 39 |
|
</div> |
| 40 |
|
|
| 41 |
|
<a name="sec-descendents"></a> |
| 42 |
|
<div class="info-box"> |
| 43 |
|
<div class="info-box-title">Direct descendents</div> |
| 44 |
|
<div class="nav-bar"> |
| 45 |
|
<a href="#sec-description">Description</a> | |
| 46 |
|
<span class="disabled">Descendents</span> |
| 47 |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 48 |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 49 |
|
|
| 50 |
|
</div> |
| 51 |
|
<div class="info-box-body"> |
| 52 |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 53 |
|
<tr> |
| 54 |
|
<th class="class-table-header">Class</th> |
| 55 |
|
<th class="class-table-header">Description</th> |
| 56 |
|
</tr> |
| 57 |
|
<tr> |
| 58 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ArrayDataListSource.html">ArrayDataListSource</a></td> |
| 59 |
|
<td> |
| 60 |
|
This DataListSource child class gets the data from an external array |
| 61 |
|
</td> |
| 62 |
|
</tr> |
| 63 |
|
<tr> |
| 64 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></td> |
| 65 |
|
<td> |
| 66 |
|
|
| 67 |
|
</td> |
| 68 |
|
</tr> |
| 69 |
|
</table> |
| 70 |
|
</div> |
| 71 |
|
</div> |
| 72 |
|
|
| 73 |
|
|
| 74 |
|
<a name="sec-var-summary"></a> |
| 75 |
|
<div class="info-box"> |
| 76 |
|
<div class="info-box-title">Variable Summary</span></div> |
| 77 |
|
<div class="nav-bar"> |
| 78 |
|
<a href="#sec-description">Description</a> | |
| 79 |
|
<a href="#sec-descendents">Descendents</a> | |
| 80 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 81 |
|
| |
| 82 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 83 |
|
|
| 84 |
|
</div> |
| 85 |
|
<div class="info-box-body"> |
| 86 |
|
<div class="var-summary"> |
| 87 |
|
<div class="var-title"> |
| 88 |
|
<span class="var-type">array</span> |
| 89 |
|
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
| 90 |
|
</div> |
| 91 |
|
<div class="var-title"> |
| 92 |
|
<span class="var-type">mixed</span> |
| 93 |
|
<a href="#$_data" title="details" class="var-name">$_data</a> |
| 94 |
|
</div> |
| 95 |
|
<div class="var-title"> |
| 96 |
|
<span class="var-type">mixed</span> |
| 97 |
|
<a href="#$_data_index" title="details" class="var-name">$_data_index</a> |
| 98 |
|
</div> |
| 99 |
|
<div class="var-title"> |
| 100 |
|
<span class="var-type">mixed</span> |
| 101 |
|
<a href="#$_not_found_message" title="details" class="var-name">$_not_found_message</a> |
| 102 |
|
</div> |
| 103 |
|
<div class="var-title"> |
| 104 |
|
<span class="var-type">mixed</span> |
| 105 |
|
<a href="#$_query_params" title="details" class="var-name">$_query_params</a> |
| 106 |
|
</div> |
| 107 |
|
</div> |
| 108 |
|
</div> |
| 109 |
|
</div> |
| 110 |
|
|
| 111 |
|
<a name="sec-method-summary"></a> |
| 112 |
|
<div class="info-box"> |
| 113 |
|
<div class="info-box-title">Method Summary</span></div> |
| 114 |
|
<div class="nav-bar"> |
| 115 |
|
<a href="#sec-description">Description</a> | |
| 116 |
|
<a href="#sec-descendents">Descendents</a> | |
| 117 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 118 |
|
|
| 119 |
|
| |
| 120 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 121 |
|
</div> |
| 122 |
|
<div class="info-box-body"> |
| 123 |
|
<div class="method-summary"> |
| 124 |
|
|
| 125 |
|
<div class="method-definition"> |
| 126 |
|
<span class="method-result">DataListSource</span> |
| 127 |
|
<a href="#DataListSource" title="details" class="method-name">DataListSource</a> |
| 128 |
|
() |
| 129 |
|
</div> |
| 130 |
|
|
| 131 |
|
<div class="method-definition"> |
| 132 |
|
<span class="method-result">void</span> |
| 133 |
|
<a href="#add_column" title="details" class="method-name">add_column</a> |
| 134 |
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
| 135 |
|
</div> |
| 136 |
|
|
| 137 |
|
<div class="method-definition"> |
| 138 |
|
<span class="method-result">void</span> |
| 139 |
|
<a href="#do_prequery" title="details" class="method-name">do_prequery</a> |
| 140 |
|
() |
| 141 |
|
</div> |
| 142 |
|
|
| 143 |
|
<div class="method-definition"> |
| 144 |
|
<span class="method-result">boolean</span> |
| 145 |
|
<a href="#do_query" title="details" class="method-name">do_query</a> |
| 146 |
|
() |
| 147 |
|
</div> |
| 148 |
|
|
| 149 |
|
<div class="method-definition"> |
| 150 |
|
<span class="method-result">int</span> |
| 151 |
|
<a href="#get_data_index" title="details" class="method-name">get_data_index</a> |
| 152 |
|
() |
| 153 |
|
</div> |
| 154 |
|
|
| 155 |
|
<div class="method-definition"> |
| 156 |
|
<span class="method-result">int</span> |
| 157 |
|
<a href="#get_limit" title="details" class="method-name">get_limit</a> |
| 158 |
|
() |
| 159 |
|
</div> |
| 160 |
|
|
| 161 |
|
<div class="method-definition"> |
| 162 |
|
<span class="method-result">array()</span> |
| 163 |
|
<a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a> |
| 164 |
|
() |
| 165 |
|
</div> |
| 166 |
|
|
| 167 |
|
<div class="method-definition"> |
| 168 |
|
<span class="method-result">string</span> |
| 169 |
|
<a href="#get_not_found_message" title="details" class="method-name">get_not_found_message</a> |
| 170 |
|
() |
| 171 |
|
</div> |
| 172 |
|
|
| 173 |
|
<div class="method-definition"> |
| 174 |
|
<span class="method-result">int</span> |
| 175 |
|
<a href="#get_offset" title="details" class="method-name">get_offset</a> |
| 176 |
|
() |
| 177 |
|
</div> |
| 178 |
|
|
| 179 |
|
<div class="method-definition"> |
| 180 |
|
<span class="method-result">int</span> |
| 181 |
|
<a href="#get_orderby" title="details" class="method-name">get_orderby</a> |
| 182 |
|
() |
| 183 |
|
</div> |
| 184 |
|
|
| 185 |
|
<div class="method-definition"> |
| 186 |
|
<span class="method-result">int</span> |
| 187 |
|
<a href="#get_reverseorder" title="details" class="method-name">get_reverseorder</a> |
| 188 |
|
() |
| 189 |
|
</div> |
| 190 |
|
|
| 191 |
|
<div class="method-definition"> |
| 192 |
|
<span class="method-result">int</span> |
| 193 |
|
<a href="#get_searchby" title="details" class="method-name">get_searchby</a> |
| 194 |
|
() |
| 195 |
|
</div> |
| 196 |
|
|
| 197 |
|
<div class="method-definition"> |
| 198 |
|
<span class="method-result">int</span> |
| 199 |
|
<a href="#get_searchby_value" title="details" class="method-name">get_searchby_value</a> |
| 200 |
|
() |
| 201 |
|
</div> |
| 202 |
|
|
| 203 |
|
<div class="method-definition"> |
| 204 |
|
<span class="method-result">string</span> |
| 205 |
|
<a href="#get_search_type" title="details" class="method-name">get_search_type</a> |
| 206 |
|
() |
| 207 |
|
</div> |
| 208 |
|
|
| 209 |
|
<div class="method-definition"> |
| 210 |
|
<span class="method-result">array</span> |
| 211 |
|
<a href="#get_secondary_orderby" title="details" class="method-name">get_secondary_orderby</a> |
| 212 |
|
() |
| 213 |
|
</div> |
| 214 |
|
|
| 215 |
|
<div class="method-definition"> |
| 216 |
|
<span class="method-result">int</span> |
| 217 |
|
<a href="#get_simplesearch_modifier" title="details" class="method-name">get_simplesearch_modifier</a> |
| 218 |
|
() |
| 219 |
|
</div> |
| 220 |
|
|
| 221 |
|
<div class="method-definition"> |
| 222 |
|
<span class="method-result">int</span> |
| 223 |
|
<a href="#get_total_rows" title="details" class="method-name">get_total_rows</a> |
| 224 |
|
() |
| 225 |
|
</div> |
| 226 |
|
|
| 227 |
|
<div class="method-definition"> |
| 228 |
|
<span class="method-result">void</span> |
| 229 |
|
<a href="#query" title="details" class="method-name">query</a> |
| 230 |
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
| 231 |
|
</div> |
| 232 |
|
|
| 233 |
|
<div class="method-definition"> |
| 234 |
|
<span class="method-result">boolean</span> |
| 235 |
|
<a href="#row_filter" title="details" class="method-name">row_filter</a> |
| 236 |
|
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 237 |
|
</div> |
| 238 |
|
|
| 239 |
|
<div class="method-definition"> |
| 240 |
|
<span class="method-result">void</span> |
| 241 |
|
<a href="#set_limit" title="details" class="method-name">set_limit</a> |
| 242 |
|
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
| 243 |
|
</div> |
| 244 |
|
|
| 245 |
|
<div class="method-definition"> |
| 246 |
|
<span class="method-result">void</span> |
| 247 |
|
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
| 248 |
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 249 |
|
</div> |
| 250 |
|
|
| 251 |
|
<div class="method-definition"> |
| 252 |
|
<span class="method-result">void</span> |
| 253 |
|
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
| 254 |
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
| 255 |
|
</div> |
| 256 |
|
|
| 257 |
|
<div class="method-definition"> |
| 258 |
|
<span class="method-result">void</span> |
| 259 |
|
<a href="#set_orderby" title="details" class="method-name">set_orderby</a> |
| 260 |
|
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
| 261 |
|
</div> |
| 262 |
|
|
| 263 |
|
<div class="method-definition"> |
| 264 |
|
<span class="method-result">void</span> |
| 265 |
|
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
| 266 |
|
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
| 267 |
|
</div> |
| 268 |
|
|
| 269 |
|
<div class="method-definition"> |
| 270 |
|
<span class="method-result">void</span> |
| 271 |
|
<a href="#set_searchby" title="details" class="method-name">set_searchby</a> |
| 272 |
|
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
| 273 |
|
</div> |
| 274 |
|
|
| 275 |
|
<div class="method-definition"> |
| 276 |
|
<span class="method-result">void</span> |
| 277 |
|
<a href="#set_searchby_value" title="details" class="method-name">set_searchby_value</a> |
| 278 |
|
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
| 279 |
|
</div> |
| 280 |
|
|
| 281 |
|
<div class="method-definition"> |
| 282 |
|
<span class="method-result">void</span> |
| 283 |
|
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
| 284 |
|
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
| 285 |
|
</div> |
| 286 |
|
|
| 287 |
|
<div class="method-definition"> |
| 288 |
|
<span class="method-result">void</span> |
| 289 |
|
<a href="#set_secondary_orderby" title="details" class="method-name">set_secondary_orderby</a> |
| 290 |
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 291 |
|
</div> |
| 292 |
|
|
| 293 |
|
<div class="method-definition"> |
| 294 |
|
<span class="method-result">void</span> |
| 295 |
|
<a href="#set_simplesearch_modifier" title="details" class="method-name">set_simplesearch_modifier</a> |
| 296 |
|
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
| 297 |
|
</div> |
| 298 |
|
|
| 299 |
|
<div class="method-definition"> |
| 300 |
|
<span class="method-result">void</span> |
| 301 |
|
<a href="#set_total_rows" title="details" class="method-name">set_total_rows</a> |
| 302 |
|
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
| 303 |
|
</div> |
| 304 |
|
|
| 305 |
|
<div class="method-definition"> |
| 306 |
|
<span class="method-result">void</span> |
| 307 |
|
<a href="#sort" title="details" class="method-name">sort</a> |
| 308 |
|
() |
| 309 |
|
</div> |
| 310 |
|
|
| 311 |
|
<div class="method-definition"> |
| 312 |
|
<span class="method-result">boolean</span> |
| 313 |
|
<a href="#_is_column_sortable" title="details" class="method-name">_is_column_sortable</a> |
| 314 |
|
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
| 315 |
|
</div> |
| 316 |
|
</div> |
| 317 |
|
</div> |
| 318 |
|
</div> |
| 319 |
|
|
| 320 |
|
<a name="sec-vars"></a> |
| 321 |
|
<div class="info-box"> |
| 322 |
|
<div class="info-box-title">Variables</div> |
| 323 |
|
<div class="nav-bar"> |
| 324 |
|
<a href="#sec-description">Description</a> | |
| 325 |
|
<a href="#sec-descendents">Descendents</a> | |
| 326 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 327 |
|
|
| 328 |
|
|
| 329 |
|
| |
| 330 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 331 |
|
|
| 332 |
|
</div> |
| 333 |
|
<div class="info-box-body"> |
| 334 |
|
<a name="var$_columns" id="$_columns"><!-- --></A> |
| 335 |
|
<div class="oddrow"> |
| 336 |
|
|
| 337 |
|
<div class="var-header"> |
| 338 |
|
<span class="var-title"> |
| 339 |
|
<span class="var-type">array</span> |
| 340 |
|
<span class="var-name">$_columns</span> |
| 341 |
|
= <span class="var-default">array()</span> (line <span class="line-number">39</span>) |
| 342 |
|
</span> |
| 343 |
|
</div> |
| 344 |
|
|
| 345 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 346 |
|
<p class="short-description">The column descriptions for the data we are working on</p> |
| 347 |
|
|
| 348 |
|
|
| 349 |
|
|
| 350 |
|
|
| 351 |
|
|
| 352 |
|
</div> |
| 353 |
|
<a name="var$_data" id="$_data"><!-- --></A> |
| 354 |
|
<div class="evenrow"> |
| 355 |
|
|
| 356 |
|
<div class="var-header"> |
| 357 |
|
<span class="var-title"> |
| 358 |
|
<span class="var-type">mixed</span> |
| 359 |
|
<span class="var-name">$_data</span> |
| 360 |
|
= <span class="var-default">array()</span> (line <span class="line-number">80</span>) |
| 361 |
|
</span> |
| 362 |
|
</div> |
| 363 |
|
|
| 364 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 365 |
|
<p class="short-description">A placeholder for data that is read/built and stored locally. Not all data sources have to use this.</p> |
| 366 |
|
<p class="description"><p>Each entry in the array corresponds to 1 row of data.</p></p> |
| 367 |
|
|
| 368 |
|
|
| 369 |
|
|
| 370 |
|
|
| 371 |
|
|
| 372 |
|
</div> |
| 373 |
|
<a name="var$_data_index" id="$_data_index"><!-- --></A> |
| 374 |
|
<div class="oddrow"> |
| 375 |
|
|
| 376 |
|
<div class="var-header"> |
| 377 |
|
<span class="var-title"> |
| 378 |
|
<span class="var-type">mixed</span> |
| 379 |
|
<span class="var-name">$_data_index</span> |
| 380 |
|
= <span class="var-default"> 0</span> (line <span class="line-number">71</span>) |
| 381 |
|
</span> |
| 382 |
|
</div> |
| 383 |
|
|
| 384 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 385 |
|
<p class="short-description">Holds the index into the array of data</p> |
| 386 |
|
<p class="description"><p>so we can keep track of where we are when we are walking the array (only usefull for non DB children)</p></p> |
| 387 |
|
|
| 388 |
|
|
| 389 |
|
|
| 390 |
|
|
| 391 |
|
|
| 392 |
|
</div> |
| 393 |
|
<a name="var$_not_found_message" id="$_not_found_message"><!-- --></A> |
| 394 |
|
<div class="evenrow"> |
| 395 |
|
|
| 396 |
|
<div class="var-header"> |
| 397 |
|
<span class="var-title"> |
| 398 |
|
<span class="var-type">mixed</span> |
| 399 |
|
<span class="var-name">$_not_found_message</span> |
| 400 |
|
= <span class="var-default"> "No data was found"</span> (line <span class="line-number">45</span>) |
| 401 |
|
</span> |
| 402 |
|
</div> |
| 403 |
|
|
| 404 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 405 |
|
<p class="short-description">This is the message displayed when no data</p> |
| 406 |
|
<p class="description"><p>was retrieved from the database</p></p> |
| 407 |
|
|
| 408 |
|
|
| 409 |
|
|
| 410 |
|
|
| 411 |
|
|
| 412 |
|
</div> |
| 413 |
|
<a name="var$_query_params" id="$_query_params"><!-- --></A> |
| 414 |
|
<div class="oddrow"> |
| 415 |
|
|
| 416 |
|
<div class="var-header"> |
| 417 |
|
<span class="var-title"> |
| 418 |
|
<span class="var-type">mixed</span> |
| 419 |
|
<span class="var-name">$_query_params</span> |
| 420 |
|
= <span class="var-default">array("num_total_rows" => 0,<br /> "offset" => 0,<br /> "limit" => -1,<br /> "orderby" => '',<br /> "secondaryorderby" => array(),"reverseorder"=>'',"searchby"=>'',"searchvalue"=>'',"searchmodifier"=>'',"searchtype"=>'simple')</span> (line <span class="line-number">53</span>) |
| 421 |
|
</span> |
| 422 |
|
</div> |
| 423 |
|
|
| 424 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 425 |
|
<p class="short-description">This holds various parameters relating</p> |
| 426 |
|
<p class="description"><p>to the query of the data</p></p> |
| 427 |
|
|
| 428 |
|
|
| 429 |
|
|
| 430 |
|
|
| 431 |
|
|
| 432 |
|
</div> |
| 433 |
|
|
| 434 |
|
</div> |
| 435 |
|
</div> |
| 436 |
|
|
| 437 |
|
<a name="sec-methods"></a> |
| 438 |
|
<div class="info-box"> |
| 439 |
|
<div class="info-box-title">Methods</div> |
| 440 |
|
<div class="nav-bar"> |
| 441 |
|
<a href="#sec-description">Description</a> | |
| 442 |
|
<a href="#sec-descendents">Descendents</a> | |
| 443 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 444 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 445 |
|
|
| 446 |
|
</div> |
| 447 |
|
<div class="info-box-body"> |
| 448 |
|
<A NAME='method_detail'></A> |
| 449 |
|
<a name="methodDataListSource" id="DataListSource"><!-- --></a> |
| 450 |
|
<div class="evenrow"> |
| 451 |
|
|
| 452 |
|
<div class="method-header"> |
| 453 |
|
<span class="method-title">Constructor DataListSource</span> (line <span class="line-number">86</span>) |
| 454 |
|
</div> |
| 455 |
|
|
| 456 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 457 |
|
<p class="short-description">The constructor</p> |
| 458 |
|
|
| 459 |
|
<div class="method-signature"> |
| 460 |
|
<span class="method-result">DataListSource</span> |
| 461 |
|
<span class="method-name"> |
| 462 |
|
DataListSource |
| 463 |
|
</span> |
| 464 |
|
() |
| 465 |
|
</div> |
| 466 |
|
|
| 467 |
|
|
| 468 |
|
|
| 469 |
|
</div> |
| 470 |
|
<a name="methodadd_column" id="add_column"><!-- --></a> |
| 471 |
|
<div class="oddrow"> |
| 472 |
|
|
| 473 |
|
<div class="method-header"> |
| 474 |
|
<span class="method-title">add_column</span> (line <span class="line-number">109</span>) |
| 475 |
|
</div> |
| 476 |
|
|
| 477 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 478 |
|
<p class="short-description">Add a column of data to manage</p> |
| 479 |
|
|
| 480 |
|
<div class="method-signature"> |
| 481 |
|
<span class="method-result">void</span> |
| 482 |
|
<span class="method-name"> |
| 483 |
|
add_column |
| 484 |
|
</span> |
| 485 |
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
| 486 |
|
</div> |
| 487 |
|
|
| 488 |
|
<ul class="parameters"> |
| 489 |
|
<li> |
| 490 |
|
<span class="var-type">string</span> |
| 491 |
|
<span class="var-name">$title</span><span class="var-description">: - the title of the column</span> </li> |
| 492 |
|
<li> |
| 493 |
|
<span class="var-type">string</span> |
| 494 |
|
<span class="var-name">$data_name</span><span class="var-description">: - the data value name</span> </li> |
| 495 |
|
<li> |
| 496 |
|
<span class="var-type">boolean</span> |
| 497 |
|
<span class="var-name">$sortable</span><span class="var-description">: - is the column sortable? default: FALSE</span> </li> |
| 498 |
|
<li> |
| 499 |
|
<span class="var-type">boolean</span> |
| 500 |
|
<span class="var-name">$searchable</span><span class="var-description">: - is the column searchable default: FALSE</span> </li> |
| 501 |
|
<li> |
| 502 |
|
<span class="var-type">string</span> |
| 503 |
|
<span class="var-name">$sortorder</span><span class="var-description">: - the sort order (ASC, DESC) default: ASC</span> </li> |
| 504 |
|
</ul> |
| 505 |
|
|
| 506 |
|
|
| 507 |
|
</div> |
| 508 |
|
<a name="methoddo_prequery" id="do_prequery"><!-- --></a> |
| 509 |
|
<div class="evenrow"> |
| 510 |
|
|
| 511 |
|
<div class="method-header"> |
| 512 |
|
<span class="method-title">do_prequery</span> (line <span class="line-number">198</span>) |
| 513 |
|
</div> |
| 514 |
|
|
| 515 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 516 |
|
<p class="short-description">This is a method that should be defined by the child class to do any pre-query type of things.</p> |
| 517 |
|
<p class="description"><p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p></p> |
| 518 |
|
|
| 519 |
|
<div class="method-signature"> |
| 520 |
|
<span class="method-result">void</span> |
| 521 |
|
<span class="method-name"> |
| 522 |
|
do_prequery |
| 523 |
|
</span> |
| 524 |
|
() |
| 525 |
|
</div> |
| 526 |
|
|
| 527 |
|
|
| 528 |
|
|
| 529 |
|
<hr class="separator" /> |
| 530 |
|
<div class="notes">Redefined in descendants as:</div> |
| 531 |
|
<ul class="redefinitions"> |
| 532 |
|
<li> |
| 533 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_prequery">ArrayDataListSource::do_prequery()</a> |
| 534 |
|
: This is a method that should be defined by the child class to do any pre-query type of things. |
| 535 |
|
</li> |
| 536 |
|
<li> |
| 537 |
|
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a> |
| 538 |
|
: The prequery. We use this to read the file |
| 539 |
|
</li> |
| 540 |
|
<li> |
| 541 |
|
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a> |
| 542 |
|
</li> |
| 543 |
|
</ul> |
| 544 |
|
</div> |
| 545 |
|
<a name="methoddo_query" id="do_query"><!-- --></a> |
| 546 |
|
<div class="oddrow"> |
| 547 |
|
|
| 548 |
|
<div class="method-header"> |
| 549 |
|
<span class="method-title">do_query</span> (line <span class="line-number">213</span>) |
| 550 |
|
</div> |
| 551 |
|
|
| 552 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 553 |
|
<p class="short-description">This is the function that does the data fetching, and sorting if needed.</p> |
| 554 |
|
<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> |
| 555 |
|
<ul class="tags"> |
| 556 |
|
<li><span class="field">return:</span> - the query passed/failed.</li> |
| 557 |
|
</ul> |
| 558 |
|
|
| 559 |
|
<div class="method-signature"> |
| 560 |
|
<span class="method-result">boolean</span> |
| 561 |
|
<span class="method-name"> |
| 562 |
|
do_query |
| 563 |
|
</span> |
| 564 |
|
() |
| 565 |
|
</div> |
| 566 |
|
|
| 567 |
|
|
| 568 |
|
|
| 569 |
|
<hr class="separator" /> |
| 570 |
|
<div class="notes">Redefined in descendants as:</div> |
| 571 |
|
<ul class="redefinitions"> |
| 572 |
|
<li> |
| 573 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_query">ArrayDataListSource::do_query()</a> |
| 574 |
|
: This function does the query |
| 575 |
|
</li> |
| 576 |
|
<li> |
| 577 |
|
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a> |
| 578 |
|
: This function does the query |
| 579 |
|
</li> |
| 580 |
|
<li> |
| 581 |
|
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a> |
| 582 |
|
: Do the query to the DB and pull in all of the records locally. |
| 583 |
|
</li> |
| 584 |
|
<li> |
| 585 |
|
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methoddo_query">ADODBSQLDataListSource::do_query()</a> |
| 586 |
|
: This is the function that does the data fetching, and sorting if needed. |
| 587 |
|
</li> |
| 588 |
|
<li> |
| 589 |
|
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query">PEARSQLDataListSource::do_query()</a> |
| 590 |
|
: This is the function that does the data fetching, and sorting if needed. |
| 591 |
|
</li> |
| 592 |
|
<li> |
| 593 |
|
<a href="../phpHtmlLib/PGSQLDataListSource.html#methoddo_query">PGSQLDataListSource::do_query()</a> |
| 594 |
|
</li> |
| 595 |
|
</ul> |
| 596 |
|
</div> |
| 597 |
|
<a name="methodget_data_index" id="get_data_index"><!-- --></a> |
| 598 |
|
<div class="evenrow"> |
| 599 |
|
|
| 600 |
|
<div class="method-header"> |
| 601 |
|
<span class="method-title">get_data_index</span> (line <span class="line-number">464</span>) |
| 602 |
|
</div> |
| 603 |
|
|
| 604 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 605 |
|
<p class="short-description">This function returns the data_index value and increments it</p> |
| 606 |
|
|
| 607 |
|
<div class="method-signature"> |
| 608 |
|
<span class="method-result">int</span> |
| 609 |
|
<span class="method-name"> |
| 610 |
|
get_data_index |
| 611 |
|
</span> |
| 612 |
|
() |
| 613 |
|
</div> |
| 614 |
|
|
| 615 |
|
|
| 616 |
|
|
| 617 |
|
<hr class="separator" /> |
| 618 |
|
<div class="notes">Redefined in descendants as:</div> |
| 619 |
|
<ul class="redefinitions"> |
| 620 |
|
<li> |
| 621 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_data_index">ArrayDataListSource::get_data_index()</a> |
| 622 |
|
: This function returns the data_index value and increments it |
| 623 |
|
</li> |
| 624 |
|
</ul> |
| 625 |
|
</div> |
| 626 |
|
<a name="methodget_limit" id="get_limit"><!-- --></a> |
| 627 |
|
<div class="oddrow"> |
| 628 |
|
|
| 629 |
|
<div class="method-header"> |
| 630 |
|
<span class="method-title">get_limit</span> (line <span class="line-number">412</span>) |
| 631 |
|
</div> |
| 632 |
|
|
| 633 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 634 |
|
<p class="short-description">This function gets the current value of the limit value</p> |
| 635 |
|
|
| 636 |
|
<div class="method-signature"> |
| 637 |
|
<span class="method-result">int</span> |
| 638 |
|
<span class="method-name"> |
| 639 |
|
get_limit |
| 640 |
|
</span> |
| 641 |
|
() |
| 642 |
|
</div> |
| 643 |
|
|
| 644 |
|
|
| 645 |
|
|
| 646 |
|
</div> |
| 647 |
|
<a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a> |
| 648 |
|
<div class="evenrow"> |
| 649 |
|
|
| 650 |
|
<div class="method-header"> |
| 651 |
|
<span class="method-title">get_next_data_row</span> (line <span class="line-number">174</span>) |
| 652 |
|
</div> |
| 653 |
|
|
| 654 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 655 |
|
<p class="short-description">This function gets the next data row from the query()</p> |
| 656 |
|
|
| 657 |
|
<div class="method-signature"> |
| 658 |
|
<span class="method-result">array()</span> |
| 659 |
|
<span class="method-name"> |
| 660 |
|
get_next_data_row |
| 661 |
|
</span> |
| 662 |
|
() |
| 663 |
|
</div> |
| 664 |
|
|
| 665 |
|
|
| 666 |
|
|
| 667 |
|
<hr class="separator" /> |
| 668 |
|
<div class="notes">Redefined in descendants as:</div> |
| 669 |
|
<ul class="redefinitions"> |
| 670 |
|
<li> |
| 671 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_next_data_row">ArrayDataListSource::get_next_data_row()</a> |
| 672 |
|
: This function returns the next row of valid data. |
| 673 |
|
</li> |
| 674 |
|
<li> |
| 675 |
|
<a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a> |
| 676 |
|
: This function gets the next data row from the query() |
| 677 |
|
</li> |
| 678 |
|
<li> |
| 679 |
|
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodget_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a> |
| 680 |
|
: This function gets the next data row from the query() |
| 681 |
|
</li> |
| 682 |
|
<li> |
| 683 |
|
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row">PEARSQLDataListSource::get_next_data_row()</a> |
| 684 |
|
: This function gets the next data row from the query() |
| 685 |
|
</li> |
| 686 |
|
<li> |
| 687 |
|
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodget_next_data_row">PGSQLDataListSource::get_next_data_row()</a> |
| 688 |
|
: This function gets the next data row from the query() |
| 689 |
|
</li> |
| 690 |
|
</ul> |
| 691 |
|
</div> |
| 692 |
|
<a name="methodget_not_found_message" id="get_not_found_message"><!-- --></a> |
| 693 |
|
<div class="oddrow"> |
| 694 |
|
|
| 695 |
|
<div class="method-header"> |
| 696 |
|
<span class="method-title">get_not_found_message</span> (line <span class="line-number">246</span>) |
| 697 |
|
</div> |
| 698 |
|
|
| 699 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 700 |
|
<p class="short-description">This function is used to get the message displayed when no data is found</p> |
| 701 |
|
|
| 702 |
|
<div class="method-signature"> |
| 703 |
|
<span class="method-result">string</span> |
| 704 |
|
<span class="method-name"> |
| 705 |
|
get_not_found_message |
| 706 |
|
</span> |
| 707 |
|
() |
| 708 |
|
</div> |
| 709 |
|
|
| 710 |
|
|
| 711 |
|
|
| 712 |
|
</div> |
| 713 |
|
<a name="methodget_offset" id="get_offset"><!-- --></a> |
| 714 |
|
<div class="evenrow"> |
| 715 |
|
|
| 716 |
|
<div class="method-header"> |
| 717 |
|
<span class="method-title">get_offset</span> (line <span class="line-number">289</span>) |
| 718 |
|
</div> |
| 719 |
|
|
| 720 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 721 |
|
<p class="short-description">This function returns the value of the offset</p> |
| 722 |
|
|
| 723 |
|
<div class="method-signature"> |
| 724 |
|
<span class="method-result">int</span> |
| 725 |
|
<span class="method-name"> |
| 726 |
|
get_offset |
| 727 |
|
</span> |
| 728 |
|
() |
| 729 |
|
</div> |
| 730 |
|
|
| 731 |
|
|
| 732 |
|
|
| 733 |
|
</div> |
| 734 |
|
<a name="methodget_orderby" id="get_orderby"><!-- --></a> |
| 735 |
|
<div class="oddrow"> |
| 736 |
|
|
| 737 |
|
<div class="method-header"> |
| 738 |
|
<span class="method-title">get_orderby</span> (line <span class="line-number">311</span>) |
| 739 |
|
</div> |
| 740 |
|
|
| 741 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 742 |
|
<p class="short-description">This function returns the value of the orderby</p> |
| 743 |
|
|
| 744 |
|
<div class="method-signature"> |
| 745 |
|
<span class="method-result">int</span> |
| 746 |
|
<span class="method-name"> |
| 747 |
|
get_orderby |
| 748 |
|
</span> |
| 749 |
|
() |
| 750 |
|
</div> |
| 751 |
|
|
| 752 |
|
|
| 753 |
|
|
| 754 |
|
</div> |
| 755 |
|
<a name="methodget_reverseorder" id="get_reverseorder"><!-- --></a> |
| 756 |
|
<div class="evenrow"> |
| 757 |
|
|
| 758 |
|
<div class="method-header"> |
| 759 |
|
<span class="method-title">get_reverseorder</span> (line <span class="line-number">332</span>) |
| 760 |
|
</div> |
| 761 |
|
|
| 762 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 763 |
|
<p class="short-description">This function returns the value of the reverseorder</p> |
| 764 |
|
|
| 765 |
|
<div class="method-signature"> |
| 766 |
|
<span class="method-result">int</span> |
| 767 |
|
<span class="method-name"> |
| 768 |
|
get_reverseorder |
| 769 |
|
</span> |
| 770 |
|
() |
| 771 |
|
</div> |
| 772 |
|
|
| 773 |
|
|
| 774 |
|
|
| 775 |
|
</div> |
| 776 |
|
<a name="methodget_searchby" id="get_searchby"><!-- --></a> |
| 777 |
|
<div class="oddrow"> |
| 778 |
|
|
| 779 |
|
<div class="method-header"> |
| 780 |
|
<span class="method-title">get_searchby</span> (line <span class="line-number">352</span>) |
| 781 |
|
</div> |
| 782 |
|
|
| 783 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 784 |
|
<p class="short-description">This function returns the value of the searchby</p> |
| 785 |
|
|
| 786 |
|
<div class="method-signature"> |
| 787 |
|
<span class="method-result">int</span> |
| 788 |
|
<span class="method-name"> |
| 789 |
|
get_searchby |
| 790 |
|
</span> |
| 791 |
|
() |
| 792 |
|
</div> |
| 793 |
|
|
| 794 |
|
|
| 795 |
|
|
| 796 |
|
</div> |
| 797 |
|
<a name="methodget_searchby_value" id="get_searchby_value"><!-- --></a> |
| 798 |
|
<div class="evenrow"> |
| 799 |
|
|
| 800 |
|
<div class="method-header"> |
| 801 |
|
<span class="method-title">get_searchby_value</span> (line <span class="line-number">372</span>) |
| 802 |
|
</div> |
| 803 |
|
|
| 804 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 805 |
|
<p class="short-description">This function returns the value of the search value</p> |
| 806 |
|
|
| 807 |
|
<div class="method-signature"> |
| 808 |
|
<span class="method-result">int</span> |
| 809 |
|
<span class="method-name"> |
| 810 |
|
get_searchby_value |
| 811 |
|
</span> |
| 812 |
|
() |
| 813 |
|
</div> |
| 814 |
|
|
| 815 |
|
|
| 816 |
|
|
| 817 |
|
</div> |
| 818 |
|
<a name="methodget_search_type" id="get_search_type"><!-- --></a> |
| 819 |
|
<div class="oddrow"> |
| 820 |
|
|
| 821 |
|
<div class="method-header"> |
| 822 |
|
<span class="method-title">get_search_type</span> (line <span class="line-number">433</span>) |
| 823 |
|
</div> |
| 824 |
|
|
| 825 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 826 |
|
<p class="short-description">this function returns the current search type for the DataList query</p> |
| 827 |
|
|
| 828 |
|
<div class="method-signature"> |
| 829 |
|
<span class="method-result">string</span> |
| 830 |
|
<span class="method-name"> |
| 831 |
|
get_search_type |
| 832 |
|
</span> |
| 833 |
|
() |
| 834 |
|
</div> |
| 835 |
|
|
| 836 |
|
|
| 837 |
|
|
| 838 |
|
</div> |
| 839 |
|
<a name="methodget_secondary_orderby" id="get_secondary_orderby"><!-- --></a> |
| 840 |
|
<div class="evenrow"> |
| 841 |
|
|
| 842 |
|
<div class="method-header"> |
| 843 |
|
<span class="method-title">get_secondary_orderby</span> (line <span class="line-number">454</span>) |
| 844 |
|
</div> |
| 845 |
|
|
| 846 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 847 |
|
<p class="short-description">This gets the list of secondary order by columns.</p> |
| 848 |
|
|
| 849 |
|
<div class="method-signature"> |
| 850 |
|
<span class="method-result">array</span> |
| 851 |
|
<span class="method-name"> |
| 852 |
|
get_secondary_orderby |
| 853 |
|
</span> |
| 854 |
|
() |
| 855 |
|
</div> |
| 856 |
|
|
| 857 |
|
|
| 858 |
|
|
| 859 |
|
</div> |
| 860 |
|
<a name="methodget_simplesearch_modifier" id="get_simplesearch_modifier"><!-- --></a> |
| 861 |
|
<div class="oddrow"> |
| 862 |
|
|
| 863 |
|
<div class="method-header"> |
| 864 |
|
<span class="method-title">get_simplesearch_modifier</span> (line <span class="line-number">392</span>) |
| 865 |
|
</div> |
| 866 |
|
|
| 867 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 868 |
|
<p class="short-description">This function returns the value of the search value</p> |
| 869 |
|
|
| 870 |
|
<div class="method-signature"> |
| 871 |
|
<span class="method-result">int</span> |
| 872 |
|
<span class="method-name"> |
| 873 |
|
get_simplesearch_modifier |
| 874 |
|
</span> |
| 875 |
|
() |
| 876 |
|
</div> |
| 877 |
|
|
| 878 |
|
|
| 879 |
|
|
| 880 |
|
</div> |
| 881 |
|
<a name="methodget_total_rows" id="get_total_rows"><!-- --></a> |
| 882 |
|
<div class="evenrow"> |
| 883 |
|
|
| 884 |
|
<div class="method-header"> |
| 885 |
|
<span class="method-title">get_total_rows</span> (line <span class="line-number">256</span>) |
| 886 |
|
</div> |
| 887 |
|
|
| 888 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 889 |
|
<p class="short-description">This returns the total number of rows in our entire data set</p> |
| 890 |
|
|
| 891 |
|
<div class="method-signature"> |
| 892 |
|
<span class="method-result">int</span> |
| 893 |
|
<span class="method-name"> |
| 894 |
|
get_total_rows |
| 895 |
|
</span> |
| 896 |
|
() |
| 897 |
|
</div> |
| 898 |
|
|
| 899 |
|
|
| 900 |
|
|
| 901 |
|
</div> |
| 902 |
|
<a name="methodquery" id="query"><!-- --></a> |
| 903 |
|
<div class="oddrow"> |
| 904 |
|
|
| 905 |
|
<div class="method-header"> |
| 906 |
|
<span class="method-title">query</span> (line <span class="line-number">140</span>) |
| 907 |
|
</div> |
| 908 |
|
|
| 909 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 910 |
|
<p class="short-description">The main Query function.</p> |
| 911 |
|
<p class="description"><p>This function is responsible for doing any data prefetching from a db,file and doing any sorting and searching on it depending on the values passed in from the DataList object</p></p> |
| 912 |
|
|
| 913 |
|
<div class="method-signature"> |
| 914 |
|
<span class="method-result">void</span> |
| 915 |
|
<span class="method-name"> |
| 916 |
|
query |
| 917 |
|
</span> |
| 918 |
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
| 919 |
|
</div> |
| 920 |
|
|
| 921 |
|
<ul class="parameters"> |
| 922 |
|
<li> |
| 923 |
|
<span class="var-type">int</span> |
| 924 |
|
<span class="var-name">$offset</span><span class="var-description">: - the offset into the data set</span> </li> |
| 925 |
|
<li> |
| 926 |
|
<span class="var-type">int</span> |
| 927 |
|
<span class="var-name">$limit</span><span class="var-description">: - the # of rows to get</span> </li> |
| 928 |
|
<li> |
| 929 |
|
<span class="var-type">string</span> |
| 930 |
|
<span class="var-name">$orderby</span><span class="var-description">: - the column to order the data by</span> </li> |
| 931 |
|
<li> |
| 932 |
|
<span class="var-type">string</span> |
| 933 |
|
<span class="var-name">$reverseorder</span><span class="var-description">: - order in asc or reverse?</span> </li> |
| 934 |
|
<li> |
| 935 |
|
<span class="var-type">string</span> |
| 936 |
|
<span class="var-name">$searchby</span><span class="var-description">: - the column in the dataset to search by</span> </li> |
| 937 |
|
<li> |
| 938 |
|
<span class="var-type">string</span> |
| 939 |
|
<span class="var-name">$searchby_value</span><span class="var-description">: - the value to look for</span> </li> |
| 940 |
|
<li> |
| 941 |
|
<span class="var-type">string</span> |
| 942 |
|
<span class="var-name">$simplesearch_modifier</span><span class="var-description">: - the simple search modifier.</span> </li> |
| 943 |
|
</ul> |
| 944 |
|
|
| 945 |
|
|
| 946 |
|
</div> |
| 947 |
|
<a name="methodrow_filter" id="row_filter"><!-- --></a> |
| 948 |
|
<div class="evenrow"> |
| 949 |
|
|
| 950 |
|
<div class="method-header"> |
| 951 |
|
<span class="method-title">row_filter</span> (line <span class="line-number">185</span>) |
| 952 |
|
</div> |
| 953 |
|
|
| 954 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 955 |
|
<p class="short-description">This is called by the DataList object to allow us a chance to run the next row through a filter</p> |
| 956 |
|
<ul class="tags"> |
| 957 |
|
<li><span class="field">return:</span> - TRUE = allow the row. FALSE = drop it.</li> |
| 958 |
|
</ul> |
| 959 |
|
|
| 960 |
|
<div class="method-signature"> |
| 961 |
|
<span class="method-result">boolean</span> |
| 962 |
|
<span class="method-name"> |
| 963 |
|
row_filter |
| 964 |
|
</span> |
| 965 |
|
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 966 |
|
</div> |
| 967 |
|
|
| 968 |
|
<ul class="parameters"> |
| 969 |
|
<li> |
| 970 |
|
<span class="var-type">array</span> |
| 971 |
|
<span class="var-name">&$row_data</span><span class="var-description">: - the row to run through the filter</span> </li> |
| 972 |
|
</ul> |
| 973 |
|
|
| 974 |
|
|
| 975 |
|
</div> |
| 976 |
|
<a name="methodset_limit" id="set_limit"><!-- --></a> |
| 977 |
|
<div class="oddrow"> |
| 978 |
|
|
| 979 |
|
<div class="method-header"> |
| 980 |
|
<span class="method-title">set_limit</span> (line <span class="line-number">402</span>) |
| 981 |
|
</div> |
| 982 |
|
|
| 983 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 984 |
|
<p class="short-description">This function is used to set</p> |
| 985 |
|
<p class="description"><p>the limit value, which limits the # of rows of data to allow to return</p></p> |
| 986 |
|
|
| 987 |
|
<div class="method-signature"> |
| 988 |
|
<span class="method-result">void</span> |
| 989 |
|
<span class="method-name"> |
| 990 |
|
set_limit |
| 991 |
|
</span> |
| 992 |
|
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
| 993 |
|
</div> |
| 994 |
|
|
| 995 |
|
|
| 996 |
|
|
| 997 |
|
</div> |
| 998 |
|
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
| 999 |
|
<div class="evenrow"> |
| 1000 |
|
|
| 1001 |
|
<div class="method-header"> |
| 1002 |
|
<span class="method-title">set_not_found_message</span> (line <span class="line-number">236</span>) |
| 1003 |
|
</div> |
| 1004 |
|
|
| 1005 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1006 |
|
<p class="short-description">This function is used to set the message displayed when no data is found</p> |
| 1007 |
|
|
| 1008 |
|
<div class="method-signature"> |
| 1009 |
|
<span class="method-result">void</span> |
| 1010 |
|
<span class="method-name"> |
| 1011 |
|
set_not_found_message |
| 1012 |
|
</span> |
| 1013 |
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 1014 |
|
</div> |
| 1015 |
|
|
| 1016 |
|
<ul class="parameters"> |
| 1017 |
|
<li> |
| 1018 |
|
<span class="var-type">string</span> |
| 1019 |
|
<span class="var-name">$mesg</span> </li> |
| 1020 |
|
</ul> |
| 1021 |
|
|
| 1022 |
|
|
| 1023 |
|
</div> |
| 1024 |
|
<a name="methodset_offset" id="set_offset"><!-- --></a> |
| 1025 |
|
<div class="oddrow"> |
| 1026 |
|
|
| 1027 |
|
<div class="method-header"> |
| 1028 |
|
<span class="method-title">set_offset</span> (line <span class="line-number">278</span>) |
| 1029 |
|
</div> |
| 1030 |
|
|
| 1031 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1032 |
|
<p class="short-description">This sets the offset value and resets the index into the data array (in non DB children)</p> |
| 1033 |
|
|
| 1034 |
|
<div class="method-signature"> |
| 1035 |
|
<span class="method-result">void</span> |
| 1036 |
|
<span class="method-name"> |
| 1037 |
|
set_offset |
| 1038 |
|
</span> |
| 1039 |
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
| 1040 |
|
</div> |
| 1041 |
|
|
| 1042 |
|
<ul class="parameters"> |
| 1043 |
|
<li> |
| 1044 |
|
<span class="var-type">int</span> |
| 1045 |
|
<span class="var-name">$offset</span><span class="var-description">: offset</span> </li> |
| 1046 |
|
</ul> |
| 1047 |
|
|
| 1048 |
|
|
| 1049 |
|
</div> |
| 1050 |
|
<a name="methodset_orderby" id="set_orderby"><!-- --></a> |
| 1051 |
|
<div class="evenrow"> |
| 1052 |
|
|
| 1053 |
|
<div class="method-header"> |
| 1054 |
|
<span class="method-title">set_orderby</span> (line <span class="line-number">301</span>) |
| 1055 |
|
</div> |
| 1056 |
|
|
| 1057 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1058 |
|
<p class="short-description">This sets the orderby column name.</p> |
| 1059 |
|
<p class="description"><p>This corresponds to the column that wants to be sorted/ordered, but not the actual direction (asc, desc)</p></p> |
| 1060 |
|
|
| 1061 |
|
<div class="method-signature"> |
| 1062 |
|
<span class="method-result">void</span> |
| 1063 |
|
<span class="method-name"> |
| 1064 |
|
set_orderby |
| 1065 |
|
</span> |
| 1066 |
|
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
| 1067 |
|
</div> |
| 1068 |
|
|
| 1069 |
|
<ul class="parameters"> |
| 1070 |
|
<li> |
| 1071 |
|
<span class="var-type">int</span> |
| 1072 |
|
<span class="var-name">$orderby</span><span class="var-description">: offset</span> </li> |
| 1073 |
|
</ul> |
| 1074 |
|
|
| 1075 |
|
|
| 1076 |
|
</div> |
| 1077 |
|
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
| 1078 |
|
<div class="oddrow"> |
| 1079 |
|
|
| 1080 |
|
<div class="method-header"> |
| 1081 |
|
<span class="method-title">set_reverseorder</span> (line <span class="line-number">322</span>) |
| 1082 |
|
</div> |
| 1083 |
|
|
| 1084 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1085 |
|
<p class="short-description">This sets the flag that tells us the direction in which to order the orderby column.</p> |
| 1086 |
|
|
| 1087 |
|
<div class="method-signature"> |
| 1088 |
|
<span class="method-result">void</span> |
| 1089 |
|
<span class="method-name"> |
| 1090 |
|
set_reverseorder |
| 1091 |
|
</span> |
| 1092 |
|
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
| 1093 |
|
</div> |
| 1094 |
|
|
| 1095 |
|
<ul class="parameters"> |
| 1096 |
|
<li> |
| 1097 |
|
<span class="var-type">int</span> |
| 1098 |
|
<span class="var-name">$order</span><span class="var-description">: offset</span> </li> |
| 1099 |
|
</ul> |
| 1100 |
|
|
| 1101 |
|
|
| 1102 |
|
</div> |
| 1103 |
|
<a name="methodset_searchby" id="set_searchby"><!-- --></a> |
| 1104 |
|
<div class="evenrow"> |
| 1105 |
|
|
| 1106 |
|
<div class="method-header"> |
| 1107 |
|
<span class="method-title">set_searchby</span> (line <span class="line-number">342</span>) |
| 1108 |
|
</div> |
| 1109 |
|
|
| 1110 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1111 |
|
<p class="short-description">This sets the column that we want to search from.</p> |
| 1112 |
|
|
| 1113 |
|
<div class="method-signature"> |
| 1114 |
|
<span class="method-result">void</span> |
| 1115 |
|
<span class="method-name"> |
| 1116 |
|
set_searchby |
| 1117 |
|
</span> |
| 1118 |
|
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
| 1119 |
|
</div> |
| 1120 |
|
|
| 1121 |
|
<ul class="parameters"> |
| 1122 |
|
<li> |
| 1123 |
|
<span class="var-type">int</span> |
| 1124 |
|
<span class="var-name">$search_col</span><span class="var-description">: offset</span> </li> |
| 1125 |
|
</ul> |
| 1126 |
|
|
| 1127 |
|
|
| 1128 |
|
</div> |
| 1129 |
|
<a name="methodset_searchby_value" id="set_searchby_value"><!-- --></a> |
| 1130 |
|
<div class="oddrow"> |
| 1131 |
|
|
| 1132 |
|
<div class="method-header"> |
| 1133 |
|
<span class="method-title">set_searchby_value</span> (line <span class="line-number">362</span>) |
| 1134 |
|
</div> |
| 1135 |
|
|
| 1136 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1137 |
|
<p class="short-description">This sets the data that we want to search for.</p> |
| 1138 |
|
|
| 1139 |
|
<div class="method-signature"> |
| 1140 |
|
<span class="method-result">void</span> |
| 1141 |
|
<span class="method-name"> |
| 1142 |
|
set_searchby_value |
| 1143 |
|
</span> |
| 1144 |
|
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
| 1145 |
|
</div> |
| 1146 |
|
|
| 1147 |
|
<ul class="parameters"> |
| 1148 |
|
<li> |
| 1149 |
|
<span class="var-type">int</span> |
| 1150 |
|
<span class="var-name">$search_value</span><span class="var-description">: offset</span> </li> |
| 1151 |
|
</ul> |
| 1152 |
|
|
| 1153 |
|
|
| 1154 |
|
</div> |
| 1155 |
|
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
| 1156 |
|
<div class="evenrow"> |
| 1157 |
|
|
| 1158 |
|
<div class="method-header"> |
| 1159 |
|
<span class="method-title">set_search_type</span> (line <span class="line-number">423</span>) |
| 1160 |
|
</div> |
| 1161 |
|
|
| 1162 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1163 |
|
<p class="short-description">This function sets the search type (simple or advanced)</p> |
| 1164 |
|
|
| 1165 |
|
<div class="method-signature"> |
| 1166 |
|
<span class="method-result">void</span> |
| 1167 |
|
<span class="method-name"> |
| 1168 |
|
set_search_type |
| 1169 |
|
</span> |
| 1170 |
|
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
| 1171 |
|
</div> |
| 1172 |
|
|
| 1173 |
|
<ul class="parameters"> |
| 1174 |
|
<li> |
| 1175 |
|
<span class="var-type">string</span> |
| 1176 |
|
<span class="var-name">$search_type</span> </li> |
| 1177 |
|
</ul> |
| 1178 |
|
|
| 1179 |
|
|
| 1180 |
|
</div> |
| 1181 |
|
<a name="methodset_secondary_orderby" id="set_secondary_orderby"><!-- --></a> |
| 1182 |
|
<div class="oddrow"> |
| 1183 |
|
|
| 1184 |
|
<div class="method-header"> |
| 1185 |
|
<span class="method-title">set_secondary_orderby</span> (line <span class="line-number">444</span>) |
| 1186 |
|
</div> |
| 1187 |
|
|
| 1188 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1189 |
|
<p class="short-description">This method is used to set a secondary list of columns to order/sort by.</p> |
| 1190 |
|
|
| 1191 |
|
<div class="method-signature"> |
| 1192 |
|
<span class="method-result">void</span> |
| 1193 |
|
<span class="method-name"> |
| 1194 |
|
set_secondary_orderby |
| 1195 |
|
</span> |
| 1196 |
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 1197 |
|
</div> |
| 1198 |
|
|
| 1199 |
|
<ul class="parameters"> |
| 1200 |
|
<li> |
| 1201 |
|
<span class="var-type">mixed</span> |
| 1202 |
|
<span class="var-name">0</span><span class="var-description">: - n numbers of column names to order by</span> </li> |
| 1203 |
|
</ul> |
| 1204 |
|
|
| 1205 |
|
|
| 1206 |
|
</div> |
| 1207 |
|
<a name="methodset_simplesearch_modifier" id="set_simplesearch_modifier"><!-- --></a> |
| 1208 |
|
<div class="evenrow"> |
| 1209 |
|
|
| 1210 |
|
<div class="method-header"> |
| 1211 |
|
<span class="method-title">set_simplesearch_modifier</span> (line <span class="line-number">382</span>) |
| 1212 |
|
</div> |
| 1213 |
|
|
| 1214 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1215 |
|
<p class="short-description">This sets the simple search modifier</p> |
| 1216 |
|
|
| 1217 |
|
<div class="method-signature"> |
| 1218 |
|
<span class="method-result">void</span> |
| 1219 |
|
<span class="method-name"> |
| 1220 |
|
set_simplesearch_modifier |
| 1221 |
|
</span> |
| 1222 |
|
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
| 1223 |
|
</div> |
| 1224 |
|
|
| 1225 |
|
<ul class="parameters"> |
| 1226 |
|
<li> |
| 1227 |
|
<span class="var-type">int</span> |
| 1228 |
|
<span class="var-name">$search_modifier</span><span class="var-description">: offset</span> </li> |
| 1229 |
|
</ul> |
| 1230 |
|
|
| 1231 |
|
|
| 1232 |
|
</div> |
| 1233 |
|
<a name="methodset_total_rows" id="set_total_rows"><!-- --></a> |
| 1234 |
|
<div class="oddrow"> |
| 1235 |
|
|
| 1236 |
|
<div class="method-header"> |
| 1237 |
|
<span class="method-title">set_total_rows</span> (line <span class="line-number">266</span>) |
| 1238 |
|
</div> |
| 1239 |
|
|
| 1240 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1241 |
|
<p class="short-description">This is used to set the total # of rows we have in our data set</p> |
| 1242 |
|
|
| 1243 |
|
<div class="method-signature"> |
| 1244 |
|
<span class="method-result">void</span> |
| 1245 |
|
<span class="method-name"> |
| 1246 |
|
set_total_rows |
| 1247 |
|
</span> |
| 1248 |
|
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
| 1249 |
|
</div> |
| 1250 |
|
|
| 1251 |
|
<ul class="parameters"> |
| 1252 |
|
<li> |
| 1253 |
|
<span class="var-type">int</span> |
| 1254 |
|
<span class="var-name">$num</span> </li> |
| 1255 |
|
</ul> |
| 1256 |
|
|
| 1257 |
|
|
| 1258 |
|
</div> |
| 1259 |
|
<a name="methodsort" id="sort"><!-- --></a> |
| 1260 |
|
<div class="evenrow"> |
| 1261 |
|
|
| 1262 |
|
<div class="method-header"> |
| 1263 |
|
<span class="method-title">sort</span> (line <span class="line-number">226</span>) |
| 1264 |
|
</div> |
| 1265 |
|
|
| 1266 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1267 |
|
<p class="short-description">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.</p> |
| 1268 |
|
<p class="description"><p>It should operate on the $this->_data array</p></p> |
| 1269 |
|
|
| 1270 |
|
<div class="method-signature"> |
| 1271 |
|
<span class="method-result">void</span> |
| 1272 |
|
<span class="method-name"> |
| 1273 |
|
sort |
| 1274 |
|
</span> |
| 1275 |
|
() |
| 1276 |
|
</div> |
| 1277 |
|
|
| 1278 |
|
|
| 1279 |
|
|
| 1280 |
|
<hr class="separator" /> |
| 1281 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1282 |
|
<ul class="redefinitions"> |
| 1283 |
|
<li> |
| 1284 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methodsort">ArrayDataListSource::sort()</a> |
| 1285 |
|
: This method sorts our data array by the requested column order by. This could be expensive for HUGE arrays. |
| 1286 |
|
</li> |
| 1287 |
|
</ul> |
| 1288 |
|
</div> |
| 1289 |
|
<a name="method_is_column_sortable" id="_is_column_sortable"><!-- --></a> |
| 1290 |
|
<div class="oddrow"> |
| 1291 |
|
|
| 1292 |
|
<div class="method-header"> |
| 1293 |
|
<span class="method-title">_is_column_sortable</span> (line <span class="line-number">478</span>) |
| 1294 |
|
</div> |
| 1295 |
|
|
| 1296 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1297 |
|
<p class="short-description">This function determines if the column associated w/ a data_name is sortable or not</p> |
| 1298 |
|
<ul class="tags"> |
| 1299 |
|
<li><span class="field">return:</span> - is that column sortable?</li> |
| 1300 |
|
</ul> |
| 1301 |
|
|
| 1302 |
|
<div class="method-signature"> |
| 1303 |
|
<span class="method-result">boolean</span> |
| 1304 |
|
<span class="method-name"> |
| 1305 |
|
_is_column_sortable |
| 1306 |
|
</span> |
| 1307 |
|
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
| 1308 |
|
</div> |
| 1309 |
|
|
| 1310 |
|
<ul class="parameters"> |
| 1311 |
|
<li> |
| 1312 |
|
<span class="var-type">string</span> |
| 1313 |
|
<span class="var-name">$data_name</span><span class="var-description">: - the data_name filed in the _columns array to look for</span> </li> |
| 1314 |
|
</ul> |
| 1315 |
|
|
| 1316 |
|
|
| 1317 |
|
</div> |
| 1318 |
|
|
| 1319 |
|
</div> |
| 1320 |
|
</div> |
| 1321 |
|
|
| 1322 |
|
|
| 1323 |
|
<p class="notes" id="credit"> |
| 1324 |
|
Documentation generated on Thu, 1 Apr 2004 09:38:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 1325 |
|
</p> |
| 1326 |
|
</div></body> |
| 1327 |
|
</html> |
Parent Directory
| 
Revision Log
| 
Patch
