1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!--NewPage--> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<HTML> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<HEAD> |
<head> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class DataList</TITLE> |
<title>Docs For Class DataList</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
</HEAD> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
</head> |
10 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
<!-- Links --> |
<h2 class="class-name">Class DataList</h2> |
13 |
<a NAME="top"></A> |
|
14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
15 |
<TR> |
<div class="info-box"> |
16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
17 |
Links: |
<div class="nav-bar"> |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from DataList">Child Classes</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-descendents">Descendents</a> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
21 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
22 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
|
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
</div> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<div class="info-box-body"> |
25 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
26 |
</TR> |
<p class="short-description">This object is the base class that can be</p> |
27 |
</TABLE> |
<p class="description"><p>used to build a widget that shows lists of data from any source via the DataListSource object. It fetches/builds/gets its data from the DataListSource object, which can be written to support any data source (MySQL, Oracle, comma delimited file, xml, etc.)</p><p>This base class MUST be extended by a child to actually render the list. The job of the DataList class is to provide the basic API and abstraction mechanism to handling searching, showing, sorting lists of data.</p><p>Each column of data is associated with a title and a name. The title is what is shown to the user for that column. The name is the mapping between the column and the DataListSource. Each column can be marked as sortable and searchable. If a column is sortable, the title is a link that can be clicked on to sort. The sorting is done in the DataListSource object ( via the sql query, or sort() functions depending on the data source itself)</p><p>The DataList object will build the title, the search block (if any), the datalist controls (the links/imges for first, prev, next, last, all). Then the data columns/labels. Then it will fetch each of the rows of data to display from the DataListSource.</p><p>The logic of the output calls follows in the order:</p><p>title search table/block datalist controls (first, prev, next, last, all) data columns/labels data rows x through y</p><p>REQUIREMENTS: You must use/define a DataListSource object. You MUST override/extend the following methods:</p><p>* get_data_source() - used to set the DataListSource by this class. * user_setup() - used to set the columns to show and any options used by the DataList class and DataListSource object.</p><p>UI ABSTRACTION METHODS These methods allow for some level of abstraction for the layout/look/feel of the actual list of data.</p><p>* gui_init() - the function gives the child class a chance to do any building of the objects that will hold the search area, column headers and the rows of data.</p><p>* child_build_column_header() - This method is responsible for building and inserting the column header title into the UI object.</p><p>* child_add_row_cell() - This function is responsible for adding the cell in the current row. The method is responsible for keeping track of the location in its UI object for the current row.</p><p>* child_get_gui() - This method returns the entire UI in 1 object or container. At this point the entire UI has been constructed, the entire list of data has been walked and inserted.</p></p> |
28 |
<BR> |
<ul class="tags"> |
29 |
|
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
30 |
<!-- Start of Class Data --> |
</ul> |
31 |
<H2> |
<p class="notes"> |
32 |
Class DataList |
Located in <a class="field" href="_widgets_data_list_DataList_inc.html">Program_Root/widgets/data_list/DataList.inc</a> (line <span class="field">108</span>) |
33 |
</H2> |
</p> |
34 |
|
|
35 |
<pre> |
|
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
| |
38 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
39 |
| |
| |
40 |
--DataList</pre> |
--DataList</pre> |
41 |
</pre> |
|
42 |
|
</div> |
43 |
|
</div> |
44 |
|
|
45 |
<A NAME="children_summary"</A> |
<a name="sec-descendents"></a> |
46 |
<H3> |
<div class="info-box"> |
47 |
Classes extended from DataList: <A HREF="#top" CLASS="links">^TOP</A> |
<div class="info-box-title">Direct descendents</div> |
48 |
</H3> |
<div class="nav-bar"> |
49 |
<a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a> |
<a href="#sec-description">Description</a> | |
50 |
<p> |
<span class="disabled">Descendents</span> |
51 |
<b><i>Located in File: Program_Root/widgets/data_list/DataList.inc</i></b><br> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
52 |
</p> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
53 |
<hr> |
|
54 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
55 |
This object is the base class that can be |
<div class="info-box-body"> |
56 |
<BR> |
<table cellpadding="2" cellspacing="0" class="class-table"> |
|
used to build a widget that shows lists of |
|
|
data from any source via the DataListSource |
|
|
object. It fetches/builds/gets its data |
|
|
from the DataListSource object, which can |
|
|
be written to support any data source |
|
|
(MySQL, Oracle, comma delimited file, xml, etc.) |
|
|
|
|
|
This base class MUST be extended by a child to |
|
|
actually render the list. The job of the DataList |
|
|
class is to provide the basic API and abstraction |
|
|
mechanism to handling searching, showing, sorting |
|
|
lists of data. |
|
|
|
|
|
Each column of data is associated with a title and a |
|
|
name. The title is what is shown to the user for that |
|
|
column. The name is the mapping between the column and |
|
|
the DataListSource. Each column can be marked |
|
|
as sortable and searchable. If a column is sortable, |
|
|
the title is a link that can be clicked on to sort. |
|
|
The sorting is done in the DataListSource object ( |
|
|
via the sql query, or sort() functions depending on the |
|
|
data source itself) |
|
|
|
|
|
The DataList object will build the title, the search block |
|
|
(if any), the datalist controls (the links/imges for |
|
|
first, prev, next, last, all). Then the data columns/labels. |
|
|
Then it will fetch each of the rows of data to display |
|
|
from the DataListSource. |
|
|
|
|
|
The logic of the output calls follows in the order: |
|
|
|
|
|
title |
|
|
search table/block |
|
|
datalist controls (first, prev, next, last, all) |
|
|
data columns/labels |
|
|
data rows x through y |
|
|
|
|
|
|
|
|
REQUIREMENTS: |
|
|
You must use/define a DataListSource object. |
|
|
You MUST override/extend the following methods: |
|
|
|
|
|
* get_data_source() - used to set the DataListSource |
|
|
by this class. |
|
|
* user_setup() - used to set the columns to show and any |
|
|
options used by the DataList class and |
|
|
DataListSource object. |
|
|
|
|
|
|
|
|
UI ABSTRACTION METHODS |
|
|
These methods allow for some level of abstraction for |
|
|
the layout/look/feel of the actual list of data. |
|
|
|
|
|
|
|
|
* gui_init() - the function gives the child class a chance |
|
|
to do any building of the objects that will |
|
|
hold the search area, column headers and the |
|
|
rows of data. |
|
|
|
|
|
* child_build_column_header() - This method is responsible |
|
|
for building and inserting |
|
|
the column header title into |
|
|
the UI object. |
|
|
|
|
|
* child_add_row_cell() - This function is responsible for adding |
|
|
the cell in the current row. The method |
|
|
is responsible for keeping track of the |
|
|
location in its UI object for the current |
|
|
row. |
|
|
|
|
|
* child_get_gui() - This method returns the entire UI in 1 object |
|
|
or container. At this point the entire UI |
|
|
has been constructed, the entire list of data |
|
|
has been walked and inserted. |
|
|
|
|
|
<UL> |
|
|
|
|
|
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
|
|
|
|
|
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">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='DataList.html#$alternating_row_colors'>$alternating_row_colors</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Do we want to alternate the row colors? |
|
|
This helps to see each row easier. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_advanced_search_flag'>$_advanced_search_flag</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Flag to let us know that |
|
|
advanced search is enabled </blockquote> |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_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='DataList.html#$_datasource'>$_datasource</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds our reference/copy of the </blockquote> |
|
|
<blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_default_orderby'>$_default_orderby</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds the db column name that |
|
|
we want to order by default. </blockquote> |
|
|
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_default_reverseorder'>$_default_reverseorder</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds a flag to let us know to </blockquote> |
|
|
<blockquote> Default Value: <CODE>->false<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_default_rows_per_page'>$_default_rows_per_page</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The number of rows of data |
|
|
to show per "page". </blockquote> |
|
|
<blockquote> Default Value: <CODE>->10<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_form_attributes'>$_form_attributes</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This holds the form attributes </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array("method" => "GET", |
|
|
"target" => "", |
|
|
"action" => "", |
|
|
"name" => "")<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_form_render_flag'>$_form_render_flag</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Build everything inside a form? </blockquote> |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_global_prefix'>$_global_prefix</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> prefix for all list variable |
|
|
names, so we can potentially |
|
|
have more then 1 list per page. </blockquote> |
|
|
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_image_path'>$_image_path</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This stores the base path to where the |
|
|
tool link images live. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->/phphtmllib/images/widgets<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_max_rows'>$_max_rows</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The max number of rows to |
|
|
show when the user does the |
|
|
"EXPAND" command. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->200<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_numrowsVar'>$_numrowsVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The number of rows variable name </blockquote> |
|
|
<blockquote> Default Value: <CODE>->numrows<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_num_columns'>$_num_columns</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Keeps track of the # of columns we have </blockquote> |
|
|
<blockquote> Default Value: <CODE>->0<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_num_pages'>$_num_pages</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This value holds the number |
|
|
of pages of data we have |
|
|
to display. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->1<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_offsetVar'>$_offsetVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The offset variable name </blockquote> |
|
|
<blockquote> Default Value: <CODE>->offset<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_orderbyVar'>$_orderbyVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The order by variable name </blockquote> |
|
|
<blockquote> Default Value: <CODE>->orderby<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_reverseorderVar'>$_reverseorderVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The reverseorder variable name </blockquote> |
|
|
<blockquote> Default Value: <CODE>->reverseorder<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_save_vars'>$_save_vars</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This holds a list of </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_search_fieldVar'>$_search_fieldVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The search field variable </blockquote> |
|
|
<blockquote> Default Value: <CODE>->search_field<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_search_flag'>$_search_flag</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Flag to let us know that search |
|
|
is enabled. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_search_table'>$_search_table</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds the object block that is the </blockquote> |
|
|
<blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_search_typeVar'>$_search_typeVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The type of search </blockquote> |
|
|
<blockquote> Default Value: <CODE>->search_type<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_search_valueVar'>$_search_valueVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The search value </blockquote> |
|
|
<blockquote> Default Value: <CODE>->search_value<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_showallVar'>$_showallVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This var to tell us to show all |
|
|
data or not. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->showall<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_show_results_flag'>$_show_results_flag</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> flag to let us know if we want to show |
|
|
the results or not. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_simple_search_modifier'>$_simple_search_modifier</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Flag to enable simple search modifyer. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='DataList.html#$_simple_search_modifierVar'>$_simple_search_modifierVar</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The simple search modifier |
|
|
var name. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->simple_search_modifier<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
|
|
<td CLASS="font10">The title of the table.</td> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td> |
|
|
<td CLASS="font10">the width of the widget</td> |
|
|
</tr> |
|
|
|
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
|
|
<td CLASS="font10">Flag for pretty (indented) output</td> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
|
|
<td CLASS="font10">Do we render a newline after the |
|
|
contents has been rendered?</td> |
|
|
</tr> |
|
|
|
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
|
|
<A NAME='functions_inherited'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td> |
|
|
<td CLASS="font10">This gets the alignment value |
|
|
for the outer table</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td> |
|
|
<td CLASS="font10">This function provides the</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td> |
|
|
<td CLASS="font10">Function for returning the raw javascript |
|
|
that is required for this widget.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td> |
|
|
<td CLASS="font10">Function for accessing the |
|
|
title of this widget</td> |
|
|
|
|
57 |
<tr> |
<tr> |
58 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td> |
<th class="class-table-header">Class</th> |
59 |
<td CLASS="font10">Function for getting the current |
<th class="class-table-header">Description</th> |
|
widget width setting.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td> |
|
|
<td CLASS="font10">This function sets the align attribute |
|
|
for the outer table.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td> |
|
|
<td CLASS="font10">Set the title for the widget.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td> |
|
|
<td CLASS="font10">Set the width for the widget.</td> |
|
|
|
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
60 |
</tr> |
</tr> |
61 |
|
<tr> |
62 |
<tr> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a></td> |
63 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td> |
<td> |
64 |
<td CLASS="font10">The constructor.</td> |
This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList. |
65 |
|
</td> |
66 |
<tr> |
</tr> |
67 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
<tr> |
68 |
<td CLASS="font10">add content onto content stack</td> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/SimpleGUIDataList.html">SimpleGUIDataList</a></td> |
69 |
|
<td> |
70 |
<tr> |
This object is the base class that can be |
71 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> |
</td> |
72 |
<td CLASS="font10">Add content onto content stack |
</tr> |
73 |
so you can change the item later.</td> |
<tr> |
74 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ListAction.html">ListAction</a></td> |
75 |
<tr> |
<td> |
76 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td> |
A class for showing a list of items to preform an action on |
77 |
<td CLASS="font10">counts the number of content objects</td> |
</td> |
78 |
|
</tr> |
79 |
<tr> |
</table> |
80 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td> |
</div> |
81 |
<td CLASS="font10">This flag gets the current value |
</div> |
82 |
of the indent flag</td> |
|
83 |
|
<a name="sec-var-summary"></a> |
84 |
<tr> |
<div class="info-box"> |
85 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td> |
<div class="info-box-title">Variable Summary</span></div> |
86 |
<td CLASS="font10">Same as add().</td> |
<div class="nav-bar"> |
87 |
|
<a href="#sec-description">Description</a> | |
88 |
<tr> |
<a href="#sec-descendents">Descendents</a> | |
89 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
90 |
<td CLASS="font10">Same as add_reference |
| |
91 |
NOTE : only exists for compatibility with 1.1.x</td> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
92 |
|
|
93 |
<tr> |
</div> |
94 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> |
<div class="info-box-body"> |
95 |
<td CLASS="font10">This function is compatible with the |
<div class="var-summary"> |
96 |
rest of the phpHtmllib API spec.</td> |
<div class="var-title"> |
97 |
|
<span class="var-type">mixed</span> |
98 |
<tr> |
<a href="#$alternating_row_colors" title="details" class="var-name">$alternating_row_colors</a> |
99 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td> |
</div> |
100 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
<div class="var-title"> |
101 |
|
<span class="var-type">mixed</span> |
102 |
<tr> |
<a href="#$_advanced_search_flag" title="details" class="var-name">$_advanced_search_flag</a> |
103 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
</div> |
104 |
<td CLASS="font10">This function turns on the collapse flag</td> |
<div class="var-title"> |
105 |
|
<span class="var-type">array</span> |
106 |
<tr> |
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
107 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
</div> |
108 |
<td CLASS="font10">function to set the indent flag</td> |
<div class="var-title"> |
109 |
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
110 |
</table> |
<a href="#$_datasource" title="details" class="var-name">$_datasource</a> |
111 |
<br> |
</div> |
112 |
</TD> |
<div class="var-title"> |
113 |
</TR> |
<span class="var-type">mixed</span> |
114 |
|
<a href="#$_default_orderby" title="details" class="var-name">$_default_orderby</a> |
115 |
</TABLE> |
</div> |
116 |
|
<div class="var-title"> |
117 |
<hr> |
<span class="var-type">mixed</span> |
118 |
<!-- should have constructor at some point --> |
<a href="#$_default_reverseorder" title="details" class="var-name">$_default_reverseorder</a> |
119 |
<!-- =========== Method SUMMARY =========== --> |
</div> |
120 |
<A NAME='Method_summary'><!-- --></A> |
<div class="var-title"> |
121 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
<span class="var-type">mixed</span> |
122 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a> |
123 |
<TD> |
</div> |
124 |
<span class="font12bold">Method Summary</span> |
<div class="var-title"> |
125 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="var-type">mixed</span> |
126 |
</TD> |
<a href="#$_form_attributes" title="details" class="var-name">$_form_attributes</a> |
127 |
</TR> |
</div> |
128 |
|
<div class="var-title"> |
129 |
|
<span class="var-type">mixed</span> |
130 |
<!-- =========== Summary =========== --> |
<a href="#$_form_render_flag" title="details" class="var-name">$_form_render_flag</a> |
131 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
132 |
<TD> |
<div class="var-title"> |
133 |
<CODE><B><A HREF='DataList.html#constructor DataList'>void constructor DataList ( $title, [$width = "100%"], [$default_orderby = ''], [$default_reverseorder = FALSE] )</A></B></CODE> |
<span class="var-type">mixed</span> |
134 |
<BR> |
<a href="#$_global_prefix" title="details" class="var-name">$_global_prefix</a> |
135 |
<blockquote> The constructor </blockquote> |
</div> |
136 |
</TD> |
<div class="var-title"> |
137 |
</TR> |
<span class="var-type">mixed</span> |
138 |
|
<a href="#$_image_path" title="details" class="var-name">$_image_path</a> |
139 |
<!-- =========== Summary =========== --> |
</div> |
140 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-title"> |
141 |
<TD> |
<span class="var-type">mixed</span> |
142 |
<CODE><B><A HREF='DataList.html#add_header_item'>array add_header_item ( $label, [$size = 100], [$data_name = NULL], [$sortable = FALSE], [$searchable = FALSE], [$align = "left"], $sortorder, [$max_text_length = ""NULL] )</A></B></CODE> |
<a href="#$_max_rows" title="details" class="var-name">$_max_rows</a> |
143 |
<BR> |
</div> |
144 |
<blockquote> This function adds a header item to the column headers |
<div class="var-title"> |
145 |
from a list of parameters. </blockquote> |
<span class="var-type">mixed</span> |
146 |
</TD> |
<a href="#$_num_columns" title="details" class="var-name">$_num_columns</a> |
147 |
</TR> |
</div> |
148 |
|
<div class="var-title"> |
149 |
<!-- =========== Summary =========== --> |
<span class="var-type">mixed</span> |
150 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#$_num_pages" title="details" class="var-name">$_num_pages</a> |
151 |
<TD> |
</div> |
152 |
<CODE><B><A HREF='DataList.html#advanced_search_disable'>void advanced_search_disable ( )</A></B></CODE> |
<div class="var-title"> |
153 |
<BR> |
<span class="var-type">mixed</span> |
154 |
<blockquote> Disable the advanced search |
<a href="#$_save_vars" title="details" class="var-name">$_save_vars</a> |
155 |
capability </blockquote> |
</div> |
156 |
</TD> |
<div class="var-title"> |
157 |
</TR> |
<span class="var-type">mixed</span> |
158 |
|
<a href="#$_search_flag" title="details" class="var-name">$_search_flag</a> |
159 |
<!-- =========== Summary =========== --> |
</div> |
160 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-title"> |
161 |
<TD> |
<span class="var-type">mixed</span> |
162 |
<CODE><B><A HREF='DataList.html#advanced_search_enable'>void advanced_search_enable ( )</A></B></CODE> |
<a href="#$_search_table" title="details" class="var-name">$_search_table</a> |
163 |
<BR> |
</div> |
164 |
<blockquote> Enable the advanced search </blockquote> |
<div class="var-title"> |
165 |
</TD> |
<span class="var-type">mixed</span> |
166 |
</TR> |
<a href="#$_show_results_flag" title="details" class="var-name">$_show_results_flag</a> |
167 |
|
</div> |
168 |
<!-- =========== Summary =========== --> |
<div class="var-title"> |
169 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
170 |
<TD> |
<a href="#$_simple_search_modifier" title="details" class="var-name">$_simple_search_modifier</a> |
171 |
<CODE><B><A HREF='DataList.html#build_base_url'>string build_base_url ( )</A></B></CODE> |
</div> |
172 |
<BR> |
<div class="var-title"> |
173 |
<blockquote> This builds the base url used |
<span class="var-type">mixed</span> |
174 |
by the column headers as well |
<a href="#$_vars" title="details" class="var-name">$_vars</a> |
175 |
as the page tool links. </blockquote> |
</div> |
176 |
</TD> |
</div> |
177 |
</TR> |
</div> |
178 |
|
</div> |
179 |
<!-- =========== Summary =========== --> |
|
180 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="sec-method-summary"></a> |
181 |
<TD> |
<div class="info-box"> |
182 |
<CODE><B><A HREF='DataList.html#build_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE> |
<div class="info-box-title">Method Summary</span></div> |
183 |
<BR> |
<div class="nav-bar"> |
184 |
<blockquote> This is the basic function for letting us |
<a href="#sec-description">Description</a> | |
185 |
do a mapping between the column name in |
<a href="#sec-descendents">Descendents</a> | |
186 |
the header, to the value found in the DB. </blockquote> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
187 |
</TD> |
|
188 |
</TR> |
| |
189 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
190 |
<!-- =========== Summary =========== --> |
</div> |
191 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="info-box-body"> |
192 |
<TD> |
<div class="method-summary"> |
193 |
<CODE><B><A HREF='DataList.html#build_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE> |
|
194 |
<BR> |
<div class="method-definition"> |
195 |
<blockquote> This is the basic function for letting us |
<span class="method-result">void</span> |
196 |
do a mapping between the column name in |
<a href="#DataList" title="details" class="method-name">DataList</a> |
197 |
the header, to the value found in the DB. </blockquote> |
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$default_orderby</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span> <span class="var-name">$default_reverseorder</span> = <span class="var-default">FALSE</span>]) |
198 |
</TD> |
</div> |
199 |
</TR> |
|
200 |
|
<div class="method-definition"> |
201 |
<!-- =========== Summary =========== --> |
<span class="method-result">array</span> |
202 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#add_header_item" title="details" class="method-name">add_header_item</a> |
203 |
<TD> |
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">100</span>], [<span class="var-type">string</span> <span class="var-name">$data_name</span> = <span class="var-default">NULL</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">$align</span> = <span class="var-default">"left"</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$max_text_length</span> = <span class="var-default">NULL</span>]) |
204 |
<CODE><B><A HREF='DataList.html#build_column_url'><a href="../phpHtmlLib/Atag.html">Atag</a> build_column_url ( $col_name )</A></B></CODE> |
</div> |
205 |
<BR> |
|
206 |
<blockquote> This builds a url for a particular |
<div class="method-definition"> |
207 |
column header. </blockquote> |
<span class="method-result">void</span> |
208 |
</TD> |
<a href="#advanced_search_disable" title="details" class="method-name">advanced_search_disable</a> |
209 |
</TR> |
() |
210 |
|
</div> |
211 |
<!-- =========== Summary =========== --> |
|
212 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
213 |
<TD> |
<span class="method-result">void</span> |
214 |
<CODE><B><A HREF='DataList.html#build_gui'>Container build_gui ( )</A></B></CODE> |
<a href="#advanced_search_enable" title="details" class="method-name">advanced_search_enable</a> |
215 |
<BR> |
() |
216 |
<blockquote> This function is responsible for calling the child </blockquote> |
</div> |
217 |
</TD> |
|
218 |
</TR> |
<div class="method-definition"> |
219 |
|
<span class="method-result">string</span> |
220 |
<!-- =========== Summary =========== --> |
<a href="#build_base_url" title="details" class="method-name">build_base_url</a> |
221 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
222 |
<TD> |
</div> |
223 |
<CODE><B><A HREF='DataList.html#build_orderby_querystring'>string build_orderby_querystring ( )</A></B></CODE> |
|
224 |
<BR> |
<div class="method-definition"> |
225 |
<blockquote> This builds a query string var for the |
<span class="method-result">mixed</span> |
226 |
orderby value. </blockquote> |
<a href="#build_column_item" title="details" class="method-name">build_column_item</a> |
227 |
</TD> |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
228 |
</TR> |
</div> |
229 |
|
|
230 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
231 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span> |
232 |
<TD> |
<a href="#build_column_url" title="details" class="method-name">build_column_url</a> |
233 |
<CODE><B><A HREF='DataList.html#build_reverseorder_querystring'>string build_reverseorder_querystring ( )</A></B></CODE> |
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
234 |
<BR> |
</div> |
235 |
<blockquote> This builds a query string var for the |
|
236 |
reverseorder value. </blockquote> |
<div class="method-definition"> |
237 |
</TD> |
<span class="method-result">Container</span> |
238 |
</TR> |
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
239 |
|
() |
240 |
<!-- =========== Summary =========== --> |
</div> |
241 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
242 |
<TD> |
<div class="method-definition"> |
243 |
<CODE><B><A HREF='DataList.html#build_searchfield_querystring'>string build_searchfield_querystring ( )</A></B></CODE> |
<span class="method-result">string</span> |
244 |
<BR> |
<a href="#build_orderby_querystring" title="details" class="method-name">build_orderby_querystring</a> |
245 |
<blockquote> This builds a query string var for the |
() |
246 |
searchfield value. </blockquote> |
</div> |
247 |
</TD> |
|
248 |
</TR> |
<div class="method-definition"> |
249 |
|
<span class="method-result">string</span> |
250 |
<!-- =========== Summary =========== --> |
<a href="#build_reverseorder_querystring" title="details" class="method-name">build_reverseorder_querystring</a> |
251 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
252 |
<TD> |
</div> |
253 |
<CODE><B><A HREF='DataList.html#build_searchvalue_querystring'>string build_searchvalue_querystring ( )</A></B></CODE> |
|
254 |
<BR> |
<div class="method-definition"> |
255 |
<blockquote> This builds a query string var for the |
<span class="method-result">string</span> |
256 |
searchfield value. </blockquote> |
<a href="#build_searchfield_querystring" title="details" class="method-name">build_searchfield_querystring</a> |
257 |
</TD> |
() |
258 |
</TR> |
</div> |
259 |
|
|
260 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
261 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
262 |
<TD> |
<a href="#build_searchvalue_querystring" title="details" class="method-name">build_searchvalue_querystring</a> |
263 |
<CODE><B><A HREF='DataList.html#build_state_vars_query_string'>string build_state_vars_query_string ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></B></CODE> |
() |
264 |
<BR> |
</div> |
265 |
<blockquote> this function is used to build a sub query string |
|
266 |
of all of the query string vars to save the |
<div class="method-definition"> |
267 |
state of the DBItemList. </blockquote> |
<span class="method-result">string</span> |
268 |
</TD> |
<a href="#build_state_vars_query_string" title="details" class="method-name">build_state_vars_query_string</a> |
269 |
</TR> |
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, [<span class="var-type">mixed</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span> <span class="var-name">$showall_value</span>) |
270 |
|
</div> |
271 |
<!-- =========== Summary =========== --> |
|
272 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
273 |
<TD> |
<span class="method-result">Object</span> |
274 |
<CODE><B><A HREF='DataList.html#build_tool_link'>Object build_tool_link ( $which )</A></B></CODE> |
<a href="#build_tool_link" title="details" class="method-name">build_tool_link</a> |
275 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
276 |
<blockquote> This function builds the 'tool' images that |
</div> |
277 |
allow you to walk through the data list itself. </blockquote> |
|
278 |
</TD> |
<div class="method-definition"> |
279 |
</TR> |
<span class="method-result">void</span> |
280 |
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
281 |
<!-- =========== Summary =========== --> |
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>, <span class="var-type">boolean</span> <span class="var-name">$last_in_row_flag</span>) |
282 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
283 |
<TD> |
|
284 |
<CODE><B><A HREF='DataList.html#child_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</A></B></CODE> |
<div class="method-definition"> |
285 |
<BR> |
<span class="method-result">void</span> |
286 |
<blockquote> This method is supposed to be written by </blockquote> |
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
287 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">array</span> <span class="var-name">$col_data</span>, <span class="var-type">int</span> <span class="var-name">$col_count</span>) |
288 |
</TR> |
</div> |
289 |
|
|
290 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
291 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">Container</span> |
292 |
<TD> |
<a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a> |
293 |
<CODE><B><A HREF='DataList.html#child_build_column_header'>void child_build_column_header ( $title, $col_data, $col_count )</A></B></CODE> |
() |
294 |
<BR> |
</div> |
295 |
<blockquote> This method is supposed to be written by </blockquote> |
|
296 |
</TD> |
<div class="method-definition"> |
297 |
</TR> |
<span class="method-result">Container</span> |
298 |
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
299 |
<!-- =========== Summary =========== --> |
() |
300 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
301 |
<TD> |
|
302 |
<CODE><B><A HREF='DataList.html#child_build_search_table'>Container child_build_search_table ( )</A></B></CODE> |
<div class="method-definition"> |
303 |
<BR> |
<span class="method-result">void</span> |
304 |
<blockquote> This function builds the search |
<a href="#data_prefetch" title="details" class="method-name">data_prefetch</a> |
305 |
block that lives above the results </blockquote> |
() |
306 |
</TD> |
</div> |
307 |
</TR> |
|
308 |
|
<div class="method-definition"> |
309 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
310 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#do_action" title="details" class="method-name">do_action</a> |
311 |
<TD> |
() |
312 |
<CODE><B><A HREF='DataList.html#child_get_gui'>Container child_get_gui ( )</A></B></CODE> |
</div> |
313 |
<BR> |
|
314 |
<blockquote> This function is called after all of the data has |
<div class="method-definition"> |
315 |
been added to the UI object. </blockquote> |
<span class="method-result">string</span> |
316 |
</TD> |
<a href="#filter_column_string" title="details" class="method-name">filter_column_string</a> |
317 |
</TR> |
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
318 |
|
</div> |
319 |
<!-- =========== Summary =========== --> |
|
320 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
321 |
<TD> |
<span class="method-result">int</span> |
322 |
<CODE><B><A HREF='DataList.html#data_prefetch'>void data_prefetch ( )</A></B></CODE> |
<a href="#get_current_page" title="details" class="method-name">get_current_page</a> |
323 |
<BR> |
() |
324 |
<blockquote> This function is used to set up any </blockquote> |
</div> |
325 |
</TD> |
|
326 |
</TR> |
<div class="method-definition"> |
327 |
|
<span class="method-result">void</span> |
328 |
<!-- =========== Summary =========== --> |
<a href="#get_data_source" title="details" class="method-name">get_data_source</a> |
329 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
330 |
<TD> |
</div> |
331 |
<CODE><B><A HREF='DataList.html#filter_column_string'>string filter_column_string ( $data )</A></B></CODE> |
|
332 |
<BR> |
<div class="method-definition"> |
333 |
<blockquote> This does some magic filtering on the data |
<span class="method-result">int</span> |
334 |
that we display in a column. </blockquote> |
<a href="#get_default_num_rows" title="details" class="method-name">get_default_num_rows</a> |
335 |
</TD> |
() |
336 |
</TR> |
</div> |
337 |
|
|
338 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
339 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
340 |
<TD> |
<a href="#get_form_action" title="details" class="method-name">get_form_action</a> |
341 |
<CODE><B><A HREF='DataList.html#get_current_page'>int get_current_page ( )</A></B></CODE> |
() |
342 |
<BR> |
</div> |
343 |
<blockquote> This function returns the current |
|
344 |
page that the item list is on. </blockquote> |
<div class="method-definition"> |
345 |
</TD> |
<span class="method-result">string</span> |
346 |
</TR> |
<a href="#get_form_method" title="details" class="method-name">get_form_method</a> |
347 |
|
() |
348 |
<!-- =========== Summary =========== --> |
</div> |
349 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
350 |
<TD> |
<div class="method-definition"> |
351 |
<CODE><B><A HREF='DataList.html#get_data_source'>void get_data_source ( )</A></B></CODE> |
<span class="method-result">string</span> |
352 |
<BR> |
<a href="#get_form_name" title="details" class="method-name">get_form_name</a> |
353 |
<blockquote> This function is called automatically by |
() |
354 |
the DataList constructor. </blockquote> |
</div> |
355 |
</TD> |
|
356 |
</TR> |
<div class="method-definition"> |
357 |
|
<span class="method-result">bool</span> |
358 |
<!-- =========== Summary =========== --> |
<a href="#get_form_render" title="details" class="method-name">get_form_render</a> |
359 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
360 |
<TD> |
</div> |
361 |
<CODE><B><A HREF='DataList.html#get_default_num_rows'>int get_default_num_rows ( )</A></B></CODE> |
|
362 |
<BR> |
<div class="method-definition"> |
363 |
<blockquote> This function gets the current default |
<span class="method-result">string</span> |
364 |
number of rows to display setting. </blockquote> |
<a href="#get_form_target" title="details" class="method-name">get_form_target</a> |
365 |
</TD> |
() |
366 |
</TR> |
</div> |
367 |
|
|
368 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
369 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
370 |
<TD> |
<a href="#get_global_prefix" title="details" class="method-name">get_global_prefix</a> |
371 |
<CODE><B><A HREF='DataList.html#get_form_action'>string get_form_action ( )</A></B></CODE> |
() |
372 |
<BR> |
</div> |
373 |
<blockquote> This function is used to get |
|
374 |
the form action </blockquote> |
<div class="method-definition"> |
375 |
</TD> |
<span class="method-result">string</span> |
376 |
</TR> |
<a href="#get_image_path" title="details" class="method-name">get_image_path</a> |
377 |
|
() |
378 |
<!-- =========== Summary =========== --> |
</div> |
379 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
380 |
<TD> |
<div class="method-definition"> |
381 |
<CODE><B><A HREF='DataList.html#get_form_method'>string get_form_method ( )</A></B></CODE> |
<span class="method-result">int</span> |
382 |
<BR> |
<a href="#get_last_page" title="details" class="method-name">get_last_page</a> |
383 |
<blockquote> This function is used to get |
() |
384 |
the form method </blockquote> |
</div> |
385 |
</TD> |
|
386 |
</TR> |
<div class="method-definition"> |
387 |
|
<span class="method-result">int</span> |
388 |
<!-- =========== Summary =========== --> |
<a href="#get_max_rows" title="details" class="method-name">get_max_rows</a> |
389 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
390 |
<TD> |
</div> |
391 |
<CODE><B><A HREF='DataList.html#get_form_name'>string get_form_name ( )</A></B></CODE> |
|
392 |
<BR> |
<div class="method-definition"> |
393 |
<blockquote> This function is used to get |
<span class="method-result">int</span> |
394 |
the form name </blockquote> |
<a href="#get_num_pages" title="details" class="method-name">get_num_pages</a> |
395 |
</TD> |
() |
396 |
</TR> |
</div> |
397 |
|
|
398 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
399 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
400 |
<TD> |
<a href="#get_page_info" title="details" class="method-name">get_page_info</a> |
401 |
<CODE><B><A HREF='DataList.html#get_form_render'>bool get_form_render ( )</A></B></CODE> |
() |
402 |
<BR> |
</div> |
403 |
<blockquote> Return the state of the form render </blockquote> |
|
404 |
</TD> |
<div class="method-definition"> |
405 |
</TR> |
<span class="method-result">void</span> |
406 |
|
<a href="#get_simple_search_modifier" title="details" class="method-name">get_simple_search_modifier</a> |
407 |
<!-- =========== Summary =========== --> |
() |
408 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
409 |
<TD> |
|
410 |
<CODE><B><A HREF='DataList.html#get_form_target'>string get_form_target ( )</A></B></CODE> |
<div class="method-definition"> |
411 |
<BR> |
<span class="method-result">void</span> |
412 |
<blockquote> This function is used to get |
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
413 |
the form target </blockquote> |
() |
414 |
</TD> |
</div> |
415 |
</TR> |
|
416 |
|
<div class="method-definition"> |
417 |
<!-- =========== Summary =========== --> |
<span class="method-result">boolean</span> |
418 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#is_advanced_search_enabled" title="details" class="method-name">is_advanced_search_enabled</a> |
419 |
<TD> |
() |
420 |
<CODE><B><A HREF='DataList.html#get_global_prefix'>string get_global_prefix ( )</A></B></CODE> |
</div> |
421 |
<BR> |
|
422 |
<blockquote> returns the current variable prefix |
<div class="method-definition"> |
423 |
string being used. </blockquote> |
<span class="method-result">boolean</span> |
424 |
</TD> |
<a href="#is_search_enabled" title="details" class="method-name">is_search_enabled</a> |
425 |
</TR> |
() |
426 |
|
</div> |
427 |
<!-- =========== Summary =========== --> |
|
428 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
429 |
<TD> |
<span class="method-result">int</span> |
430 |
<CODE><B><A HREF='DataList.html#get_image_path'>string get_image_path ( )</A></B></CODE> |
<a href="#numrows" title="details" class="method-name">numrows</a> |
431 |
<BR> |
() |
432 |
<blockquote> This function returns the path to the |
</div> |
433 |
images used in this class </blockquote> |
|
434 |
</TD> |
<div class="method-definition"> |
435 |
</TR> |
<span class="method-result">int</span> |
436 |
|
<a href="#offset" title="details" class="method-name">offset</a> |
437 |
<!-- =========== Summary =========== --> |
() |
438 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
439 |
<TD> |
|
440 |
<CODE><B><A HREF='DataList.html#get_last_page'>int get_last_page ( )</A></B></CODE> |
<div class="method-definition"> |
441 |
<BR> |
<span class="method-result">string.</span> |
442 |
<blockquote> This calculates the last page # |
<a href="#orderby" title="details" class="method-name">orderby</a> |
443 |
for this list of items </blockquote> |
() |
444 |
</TD> |
</div> |
445 |
</TR> |
|
446 |
|
<div class="method-definition"> |
447 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
448 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#render" title="details" class="method-name">render</a> |
449 |
<TD> |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
450 |
<CODE><B><A HREF='DataList.html#get_max_rows'>int get_max_rows ( )</A></B></CODE> |
</div> |
451 |
<BR> |
|
452 |
<blockquote> This returns the Maximum # of rows to |
<div class="method-definition"> |
453 |
display when in expand mode </blockquote> |
<span class="method-result">string.</span> |
454 |
</TD> |
<a href="#reverseorder" title="details" class="method-name">reverseorder</a> |
455 |
</TR> |
() |
456 |
|
</div> |
457 |
<!-- =========== Summary =========== --> |
|
458 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
459 |
<TD> |
<span class="method-result">void</span> |
460 |
<CODE><B><A HREF='DataList.html#get_num_pages'>int get_num_pages ( )</A></B></CODE> |
<a href="#search_disable" title="details" class="method-name">search_disable</a> |
461 |
<BR> |
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
462 |
<blockquote> This function returns the # |
</div> |
463 |
of pages that are available |
|
464 |
for this list of items. </blockquote> |
<div class="method-definition"> |
465 |
</TD> |
<span class="method-result">void</span> |
466 |
</TR> |
<a href="#search_enable" title="details" class="method-name">search_enable</a> |
467 |
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
468 |
<!-- =========== Summary =========== --> |
</div> |
469 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
470 |
<TD> |
<div class="method-definition"> |
471 |
<CODE><B><A HREF='DataList.html#get_page_info'>string get_page_info ( )</A></B></CODE> |
<span class="method-result">string</span> |
472 |
<BR> |
<a href="#search_field" title="details" class="method-name">search_field</a> |
473 |
<blockquote> This function builds the string </blockquote> |
() |
474 |
</TD> |
</div> |
475 |
</TR> |
|
476 |
|
<div class="method-definition"> |
477 |
<!-- =========== Summary =========== --> |
<span class="method-result">string</span> |
478 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#search_type" title="details" class="method-name">search_type</a> |
479 |
<TD> |
() |
480 |
<CODE><B><A HREF='DataList.html#get_simple_search_modifier'>void get_simple_search_modifier ( )</A></B></CODE> |
</div> |
481 |
<BR> |
|
482 |
<blockquote> gets the value of the search modifier |
<div class="method-definition"> |
483 |
flag. </blockquote> |
<span class="method-result">string</span> |
484 |
</TD> |
<a href="#search_value" title="details" class="method-name">search_value</a> |
485 |
</TR> |
() |
486 |
|
</div> |
487 |
<!-- =========== Summary =========== --> |
|
488 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
489 |
<TD> |
<span class="method-result">string</span> |
490 |
<CODE><B><A HREF='DataList.html#gui_init'>void gui_init ( )</A></B></CODE> |
<a href="#search_value_filter" title="details" class="method-name">search_value_filter</a> |
491 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
492 |
<blockquote> A subclass can override this function |
</div> |
493 |
to setup the class variables after |
|
494 |
the constructor. </blockquote> |
<div class="method-definition"> |
495 |
</TD> |
<span class="method-result">void</span> |
496 |
</TR> |
<a href="#setup_columns" title="details" class="method-name">setup_columns</a> |
497 |
|
() |
498 |
<!-- =========== Summary =========== --> |
</div> |
499 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
500 |
<TD> |
<div class="method-definition"> |
501 |
<CODE><B><A HREF='DataList.html#is_advanced_search_enabled'>boolean is_advanced_search_enabled ( )</A></B></CODE> |
<span class="method-result">void</span> |
502 |
<BR> |
<a href="#set_data_source" title="details" class="method-name">set_data_source</a> |
503 |
<blockquote> This returns the status of the |
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
504 |
advanced search flag. </blockquote> |
</div> |
505 |
</TD> |
|
506 |
</TR> |
<div class="method-definition"> |
507 |
|
<span class="method-result">void</span> |
508 |
<!-- =========== Summary =========== --> |
<a href="#set_default_num_rows" title="details" class="method-name">set_default_num_rows</a> |
509 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
510 |
<TD> |
</div> |
511 |
<CODE><B><A HREF='DataList.html#is_search_enabled'>boolean is_search_enabled ( )</A></B></CODE> |
|
512 |
<BR> |
<div class="method-definition"> |
513 |
<blockquote> get the status of the search |
<span class="method-result">void</span> |
514 |
ability. </blockquote> |
<a href="#set_form_action" title="details" class="method-name">set_form_action</a> |
515 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
516 |
</TR> |
</div> |
517 |
|
|
518 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
519 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">void</span> |
520 |
<TD> |
<a href="#set_form_method" title="details" class="method-name">set_form_method</a> |
521 |
<CODE><B><A HREF='DataList.html#numrows'>int numrows ( )</A></B></CODE> |
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
522 |
<BR> |
</div> |
523 |
<blockquote> This function returns the number of rows |
|
524 |
that the query found. </blockquote> |
<div class="method-definition"> |
525 |
</TD> |
<span class="method-result">void</span> |
526 |
</TR> |
<a href="#set_form_name" title="details" class="method-name">set_form_name</a> |
527 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
528 |
<!-- =========== Summary =========== --> |
</div> |
529 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
530 |
<TD> |
<div class="method-definition"> |
531 |
<CODE><B><A HREF='DataList.html#offset'>int offset ( )</A></B></CODE> |
<span class="method-result">void</span> |
532 |
<BR> |
<a href="#set_form_render" title="details" class="method-name">set_form_render</a> |
533 |
<blockquote> This function returns the current value |
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
534 |
of the offset variable. </blockquote> |
</div> |
535 |
</TD> |
|
536 |
</TR> |
<div class="method-definition"> |
537 |
|
<span class="method-result">void</span> |
538 |
<!-- =========== Summary =========== --> |
<a href="#set_form_target" title="details" class="method-name">set_form_target</a> |
539 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
(<span class="var-type">string</span> <span class="var-name">$target</span>) |
540 |
<TD> |
</div> |
541 |
<CODE><B><A HREF='DataList.html#orderby'>string. orderby ( )</A></B></CODE> |
|
542 |
<BR> |
<div class="method-definition"> |
543 |
<blockquote> This function returns the value of the |
<span class="method-result">void</span> |
544 |
current orderby variable. </blockquote> |
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
545 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
546 |
</TR> |
</div> |
547 |
|
|
548 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
549 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
550 |
<TD> |
<a href="#set_image_path" title="details" class="method-name">set_image_path</a> |
551 |
<CODE><B><A HREF='DataList.html#render'>void render ( $indent_level, $output_debug )</A></B></CODE> |
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
552 |
<BR> |
</div> |
553 |
<blockquote> This function renders the final |
|
554 |
widget </blockquote> |
<div class="method-definition"> |
555 |
</TD> |
<span class="method-result">void</span> |
556 |
</TR> |
<a href="#set_max_rows" title="details" class="method-name">set_max_rows</a> |
557 |
|
(<span class="var-type">int</span> <span class="var-name">$max</span>) |
558 |
<!-- =========== Summary =========== --> |
</div> |
559 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
560 |
<TD> |
<div class="method-definition"> |
561 |
<CODE><B><A HREF='DataList.html#reverseorder'>string. reverseorder ( )</A></B></CODE> |
<span class="method-result">void</span> |
562 |
<BR> |
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
563 |
<blockquote> This function returns the current value of |
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
564 |
the reverse order member variable. </blockquote> |
</div> |
565 |
</TD> |
|
566 |
</TR> |
<div class="method-definition"> |
567 |
|
<span class="method-result">void</span> |
568 |
<!-- =========== Summary =========== --> |
<a href="#set_numrows" title="details" class="method-name">set_numrows</a> |
569 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
570 |
<TD> |
</div> |
571 |
<CODE><B><A HREF='DataList.html#search_disable'>void search_disable ( )</A></B></CODE> |
|
572 |
<BR> |
<div class="method-definition"> |
573 |
<blockquote> Disable the search ability. </blockquote> |
<span class="method-result">void</span> |
574 |
</TD> |
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
575 |
</TR> |
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
576 |
|
</div> |
577 |
<!-- =========== Summary =========== --> |
|
578 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
579 |
<TD> |
<span class="method-result">void</span> |
580 |
<CODE><B><A HREF='DataList.html#search_enable'>void search_enable ( )</A></B></CODE> |
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
581 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
582 |
<blockquote> Enable the search ability. </blockquote> |
</div> |
583 |
</TD> |
|
584 |
</TR> |
<div class="method-definition"> |
585 |
|
<span class="method-result">void</span> |
586 |
<!-- =========== Summary =========== --> |
<a href="#set_save_vars" title="details" class="method-name">set_save_vars</a> |
587 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
588 |
<TD> |
</div> |
589 |
<CODE><B><A HREF='DataList.html#search_field'>string search_field ( )</A></B></CODE> |
|
590 |
<BR> |
<div class="method-definition"> |
591 |
<blockquote> returns the current value of |
<span class="method-result">void</span> |
592 |
the search field name </blockquote> |
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
593 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
594 |
</TR> |
</div> |
595 |
|
|
596 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
597 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">void</span> |
598 |
<TD> |
<a href="#set_show_results" title="details" class="method-name">set_show_results</a> |
599 |
<CODE><B><A HREF='DataList.html#search_type'>string search_type ( )</A></B></CODE> |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
600 |
<BR> |
</div> |
601 |
<blockquote> returns the type of search being used </blockquote> |
|
602 |
</TD> |
<div class="method-definition"> |
603 |
</TR> |
<span class="method-result">void</span> |
604 |
|
<a href="#set_simple_search_modifier" title="details" class="method-name">set_simple_search_modifier</a> |
605 |
<!-- =========== Summary =========== --> |
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
606 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
607 |
<TD> |
|
608 |
<CODE><B><A HREF='DataList.html#search_value'>string search_value ( )</A></B></CODE> |
<div class="method-definition"> |
609 |
<BR> |
<span class="method-result">string</span> |
610 |
<blockquote> returns the current value of |
<a href="#showall" title="details" class="method-name">showall</a> |
611 |
te search field value. </blockquote> |
() |
612 |
</TD> |
</div> |
613 |
</TR> |
|
614 |
|
<div class="method-definition"> |
615 |
<!-- =========== Summary =========== --> |
<span class="method-result">string</span> |
616 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#simple_search_modifier_value" title="details" class="method-name">simple_search_modifier_value</a> |
617 |
<TD> |
() |
618 |
<CODE><B><A HREF='DataList.html#search_value_filter'>string search_value_filter ( $value )</A></B></CODE> |
</div> |
619 |
<BR> |
|
620 |
<blockquote> This function is used to make safe |
<div class="method-definition"> |
621 |
any query string value that is used </blockquote> |
<span class="method-result">void</span> |
622 |
</TD> |
<a href="#user_setup" title="details" class="method-name">user_setup</a> |
623 |
</TR> |
() |
624 |
|
</div> |
625 |
<!-- =========== Summary =========== --> |
|
626 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
627 |
<TD> |
<span class="method-result">Container</span> |
628 |
<CODE><B><A HREF='DataList.html#setup_columns'>void setup_columns ( )</A></B></CODE> |
<a href="#_build_default_vars" title="details" class="method-name">_build_default_vars</a> |
629 |
<BR> |
() |
630 |
<blockquote> </blockquote> |
</div> |
631 |
</TD> |
|
632 |
</TR> |
<div class="method-definition"> |
633 |
|
<span class="method-result">mixed</span> |
634 |
<!-- =========== Summary =========== --> |
<a href="#_build_save_vars" title="details" class="method-name">_build_save_vars</a> |
635 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
636 |
<TD> |
</div> |
637 |
<CODE><B><A HREF='DataList.html#set_data_source'>void set_data_source ( $datasource )</A></B></CODE> |
|
638 |
<BR> |
<div class="method-definition"> |
639 |
<blockquote> This function is used to set the |
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
640 |
DataListSource object for this instance </blockquote> |
<a href="#_build_simple_search_modifier" title="details" class="method-name">_build_simple_search_modifier</a> |
641 |
</TD> |
() |
642 |
</TR> |
</div> |
643 |
|
|
644 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
645 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">string</span> |
646 |
<TD> |
<a href="#_build_tool_url" title="details" class="method-name">_build_tool_url</a> |
647 |
<CODE><B><A HREF='DataList.html#set_default_num_rows'>void set_default_num_rows ( $num_rows )</A></B></CODE> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, [<span class="var-type">boolean</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$showall_value</span>) |
648 |
<BR> |
</div> |
649 |
<blockquote> This function sets the default # of rows |
|
650 |
per page to display. </blockquote> |
<div class="method-definition"> |
651 |
</TD> |
<span class="method-result">void</span> |
652 |
</TR> |
<a href="#_check_datasource" title="details" class="method-name">_check_datasource</a> |
653 |
|
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
654 |
<!-- =========== Summary =========== --> |
</div> |
655 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
656 |
<TD> |
<div class="method-definition"> |
657 |
<CODE><B><A HREF='DataList.html#set_form_action'>void set_form_action ( $action )</A></B></CODE> |
<span class="method-result">mixed</span> |
658 |
<BR> |
<a href="#_clean_string" title="details" class="method-name">_clean_string</a> |
659 |
<blockquote> Sets the form action </blockquote> |
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
660 |
</TD> |
</div> |
661 |
</TR> |
|
662 |
|
<div class="method-definition"> |
663 |
<!-- =========== Summary =========== --> |
<span class="method-result">string</span> |
664 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#_filter_column_string" title="details" class="method-name">_filter_column_string</a> |
665 |
<TD> |
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
666 |
<CODE><B><A HREF='DataList.html#set_form_method'>void set_form_method ( $method )</A></B></CODE> |
</div> |
667 |
<BR> |
|
668 |
<blockquote> This function is used to set the |
<div class="method-definition"> |
669 |
form method </blockquote> |
<span class="method-result">the</span> |
670 |
</TD> |
<a href="#_get" title="details" class="method-name">_get</a> |
671 |
</TR> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$default_value</span> = <span class="var-default">NULL</span>]) |
672 |
|
</div> |
673 |
<!-- =========== Summary =========== --> |
|
674 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
675 |
<TD> |
<span class="method-result">array</span> |
676 |
<CODE><B><A HREF='DataList.html#set_form_name'>void set_form_name ( $name )</A></B></CODE> |
<a href="#_get_searchable_fields" title="details" class="method-name">_get_searchable_fields</a> |
677 |
<BR> |
() |
678 |
<blockquote> This function is used to set the |
</div> |
679 |
form name </blockquote> |
|
680 |
</TD> |
<div class="method-definition"> |
681 |
</TR> |
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
682 |
|
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
683 |
<!-- =========== Summary =========== --> |
() |
684 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
685 |
<TD> |
|
686 |
<CODE><B><A HREF='DataList.html#set_form_render'>void set_form_render ( $flag )</A></B></CODE> |
<div class="method-definition"> |
687 |
<BR> |
<span class="method-result">void</span> |
688 |
<blockquote> Sets whether to the output into a form </blockquote> |
<a href="#_save_mozilla_nav_link" title="details" class="method-name">_save_mozilla_nav_link</a> |
689 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$which</span>, <span class="var-type">string</span> <span class="var-name">$url</span>) |
690 |
</TR> |
</div> |
691 |
|
|
692 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
693 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">void</span> |
694 |
<TD> |
<a href="#_set" title="details" class="method-name">_set</a> |
695 |
<CODE><B><A HREF='DataList.html#set_form_target'>void set_form_target ( $target )</A></B></CODE> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
696 |
<BR> |
</div> |
697 |
<blockquote> This function is used to set the |
|
698 |
form target </blockquote> |
<div class="method-definition"> |
699 |
</TD> |
<span class="method-result">boolean</span> |
700 |
</TR> |
<a href="#_show_results" title="details" class="method-name">_show_results</a> |
701 |
|
() |
702 |
<!-- =========== Summary =========== --> |
</div> |
703 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
704 |
<TD> |
</div> |
705 |
<CODE><B><A HREF='DataList.html#set_global_prefix'>void set_global_prefix ( $prefix )</A></B></CODE> |
</div> |
706 |
<BR> |
|
707 |
<blockquote> This function sets a prefix for all |
<a name="sec-vars"></a> |
708 |
variables that are used in the item list |
<div class="info-box"> |
709 |
table on a page. </blockquote> |
<div class="info-box-title">Variables</div> |
710 |
</TD> |
<div class="nav-bar"> |
711 |
</TR> |
<a href="#sec-description">Description</a> | |
712 |
|
<a href="#sec-descendents">Descendents</a> | |
713 |
<!-- =========== Summary =========== --> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
714 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
715 |
<TD> |
|
716 |
<CODE><B><A HREF='DataList.html#set_image_path'>string set_image_path ( $path )</A></B></CODE> |
| |
717 |
<BR> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
718 |
<blockquote> This function returns the path to the |
|
719 |
images used in this class </blockquote> |
</div> |
720 |
</TD> |
<div class="info-box-body"> |
721 |
</TR> |
<a name="var$alternating_row_colors" id="$alternating_row_colors"><!-- --></A> |
722 |
|
<div class="oddrow"> |
723 |
<!-- =========== Summary =========== --> |
|
724 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-header"> |
725 |
<TD> |
<span class="var-title"> |
726 |
<CODE><B><A HREF='DataList.html#set_max_rows'>void set_max_rows ( $max )</A></B></CODE> |
<span class="var-type">mixed</span> |
727 |
<BR> |
<span class="var-name">$alternating_row_colors</span> |
728 |
<blockquote> This sets the maximum # of rows to |
= <span class="var-default"> TRUE</span> (line <span class="line-number">138</span>) |
729 |
display when in expand mode </blockquote> |
</span> |
730 |
</TD> |
</div> |
731 |
</TR> |
|
732 |
|
<!-- ========== Info from phpDoc block ========= --> |
733 |
<!-- =========== Summary =========== --> |
<p class="short-description">Do we want to alternate the row colors? This helps to see each row easier.</p> |
734 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
735 |
<TD> |
|
736 |
<CODE><B><A HREF='DataList.html#set_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE> |
|
737 |
<BR> |
|
738 |
<blockquote> This function is used to set the |
|
739 |
message displayed when no data is found </blockquote> |
</div> |
740 |
</TD> |
<a name="var$_advanced_search_flag" id="$_advanced_search_flag"><!-- --></A> |
741 |
</TR> |
<div class="evenrow"> |
742 |
|
|
743 |
<!-- =========== Summary =========== --> |
<div class="var-header"> |
744 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-title"> |
745 |
<TD> |
<span class="var-type">mixed</span> |
746 |
<CODE><B><A HREF='DataList.html#set_numrows'>void set_numrows ( $new_numrows )</A></B></CODE> |
<span class="var-name">$_advanced_search_flag</span> |
747 |
<BR> |
= <span class="var-default"> FALSE</span> (line <span class="line-number">187</span>) |
748 |
<blockquote> This function sets the # of rows to display |
</span> |
749 |
per page. </blockquote> |
</div> |
750 |
</TD> |
|
751 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
752 |
|
<p class="short-description">Flag to let us know that</p> |
753 |
<!-- =========== Summary =========== --> |
<p class="description"><p>advanced search is enabled</p></p> |
754 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
755 |
<TD> |
|
756 |
<CODE><B><A HREF='DataList.html#set_offset'>void set_offset ( $new_offset )</A></B></CODE> |
|
757 |
<BR> |
|
758 |
<blockquote> This function is used to set/change |
|
759 |
the offset for this list. </blockquote> |
</div> |
760 |
</TD> |
<a name="var$_columns" id="$_columns"><!-- --></A> |
761 |
</TR> |
<div class="oddrow"> |
762 |
|
|
763 |
<!-- =========== Summary =========== --> |
<div class="var-header"> |
764 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-title"> |
765 |
<TD> |
<span class="var-type">array</span> |
766 |
<CODE><B><A HREF='DataList.html#set_reverseorder'>void set_reverseorder ( $new_value )</A></B></CODE> |
<span class="var-name">$_columns</span> |
767 |
<BR> |
= <span class="var-default">array()</span> (line <span class="line-number">220</span>) |
768 |
<blockquote> This function sets the reverse order flag |
</span> |
769 |
to a new value. </blockquote> |
</div> |
770 |
</TD> |
|
771 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
772 |
|
<p class="short-description">The column descriptions for the data we are working on</p> |
773 |
<!-- =========== Summary =========== --> |
|
774 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
775 |
<TD> |
|
776 |
<CODE><B><A HREF='DataList.html#set_save_vars'>void set_save_vars ( $vars )</A></B></CODE> |
|
777 |
<BR> |
|
778 |
<blockquote> This function sets the save variables </blockquote> |
</div> |
779 |
</TD> |
<a name="var$_datasource" id="$_datasource"><!-- --></A> |
780 |
</TR> |
<div class="evenrow"> |
781 |
|
|
782 |
<!-- =========== Summary =========== --> |
<div class="var-header"> |
783 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-title"> |
784 |
<TD> |
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
785 |
<CODE><B><A HREF='DataList.html#set_save_vars'>void set_save_vars ( $vars )</A></B></CODE> |
<span class="var-name">$_datasource</span> |
786 |
<BR> |
= <span class="var-default"> NULL</span> (line <span class="line-number">258</span>) |
787 |
<blockquote> This function sets the save variables </blockquote> |
</span> |
788 |
</TD> |
</div> |
789 |
</TR> |
|
790 |
|
<!-- ========== Info from phpDoc block ========= --> |
791 |
<!-- =========== Summary =========== --> |
<p class="short-description">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</p> |
792 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="tags"> |
793 |
<TD> |
<li><span class="field">var:</span> <p>object</p></li> |
794 |
<CODE><B><A HREF='DataList.html#set_search_type'>void set_search_type ( $type )</A></B></CODE> |
</ul> |
795 |
<BR> |
|
796 |
<blockquote> This function sets the search type </blockquote> |
|
797 |
</TD> |
|
798 |
</TR> |
|
799 |
|
|
800 |
<!-- =========== Summary =========== --> |
</div> |
801 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="var$_default_orderby" id="$_default_orderby"><!-- --></A> |
802 |
<TD> |
<div class="oddrow"> |
803 |
<CODE><B><A HREF='DataList.html#set_show_results'>void set_show_results ( [$flag = TRUE] )</A></B></CODE> |
|
804 |
<BR> |
<div class="var-header"> |
805 |
<blockquote> This function is used to set the value |
<span class="var-title"> |
806 |
of the _show_results_flag </blockquote> |
<span class="var-type">mixed</span> |
807 |
</TD> |
<span class="var-name">$_default_orderby</span> |
808 |
</TR> |
= <span class="var-default"> ''</span> (line <span class="line-number">167</span>) |
809 |
|
</span> |
810 |
<!-- =========== Summary =========== --> |
</div> |
811 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
812 |
<TD> |
<!-- ========== Info from phpDoc block ========= --> |
813 |
<CODE><B><A HREF='DataList.html#set_simple_search_modifier'>void set_simple_search_modifier ( [$modifier = SEARCH_ALL] )</A></B></CODE> |
<p class="short-description">Holds the db column name that we want to order by default.</p> |
814 |
<BR> |
|
815 |
<blockquote> Set the simple search modifyer </blockquote> |
|
816 |
</TD> |
|
817 |
</TR> |
|
818 |
|
|
819 |
<!-- =========== Summary =========== --> |
</div> |
820 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="var$_default_reverseorder" id="$_default_reverseorder"><!-- --></A> |
821 |
<TD> |
<div class="evenrow"> |
822 |
<CODE><B><A HREF='DataList.html#showall'>string showall ( )</A></B></CODE> |
|
823 |
<BR> |
<div class="var-header"> |
824 |
<blockquote> returns the current value of the showall |
<span class="var-title"> |
825 |
flag. </blockquote> |
<span class="var-type">mixed</span> |
826 |
</TD> |
<span class="var-name">$_default_reverseorder</span> |
827 |
</TR> |
= <span class="var-default"> "false"</span> (line <span class="line-number">173</span>) |
828 |
|
</span> |
829 |
<!-- =========== Summary =========== --> |
</div> |
830 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
831 |
<TD> |
<!-- ========== Info from phpDoc block ========= --> |
832 |
<CODE><B><A HREF='DataList.html#simple_search_modifier_value'>string simple_search_modifier_value ( )</A></B></CODE> |
<p class="short-description">Holds a flag to let us know to</p> |
833 |
<BR> |
<p class="description"><p>reverse order the column by default</p></p> |
834 |
<blockquote> returns the current value of the |
|
835 |
simple search modifier </blockquote> |
|
836 |
</TD> |
|
837 |
</TR> |
|
838 |
|
|
839 |
<!-- =========== Summary =========== --> |
</div> |
840 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A> |
841 |
<TD> |
<div class="oddrow"> |
842 |
<CODE><B><A HREF='DataList.html#user_setup'>void user_setup ( )</A></B></CODE> |
|
843 |
<BR> |
<div class="var-header"> |
844 |
<blockquote> A subclass can override this function |
<span class="var-title"> |
845 |
to setup the class variables after |
<span class="var-type">mixed</span> |
846 |
the constructor. </blockquote> |
<span class="var-name">$_default_rows_per_page</span> |
847 |
</TD> |
= <span class="var-default"> 10</span> (line <span class="line-number">124</span>) |
848 |
</TR> |
</span> |
849 |
|
</div> |
850 |
<!-- =========== Summary =========== --> |
|
851 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
852 |
<TD> |
<p class="short-description">The number of rows of data to show per "page".</p> |
853 |
<CODE><B><A HREF='DataList.html#_build_save_vars'><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> _build_save_vars ( )</A></B></CODE> |
<p class="description"><p>The default is 20.</p></p> |
854 |
<BR> |
|
855 |
<blockquote> this method builds some hidden |
|
856 |
form fields to automatically |
|
857 |
be placed inside the form. </blockquote> |
|
858 |
</TD> |
|
859 |
</TR> |
</div> |
860 |
|
<a name="var$_form_attributes" id="$_form_attributes"><!-- --></A> |
861 |
<!-- =========== Summary =========== --> |
<div class="evenrow"> |
862 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
863 |
<TD> |
<div class="var-header"> |
864 |
<CODE><B><A HREF='DataList.html#_build_simple_search_modifier'><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a> _build_simple_search_modifier ( )</A></B></CODE> |
<span class="var-title"> |
865 |
<BR> |
<span class="var-type">mixed</span> |
866 |
<blockquote> This builds the simple search modifier |
<span class="var-name">$_form_attributes</span> |
867 |
select box. </blockquote> |
= <span class="var-default">array("method" => "GET",<br /> "target" => "",<br /> "action" => "",<br /> "name" => "datalist")</span> (line <span class="line-number">232</span>) |
868 |
</TD> |
</span> |
869 |
</TR> |
</div> |
870 |
|
|
871 |
<!-- =========== Summary =========== --> |
<!-- ========== Info from phpDoc block ========= --> |
872 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<p class="short-description">This holds the form attributes</p> |
873 |
<TD> |
|
874 |
<CODE><B><A HREF='DataList.html#_build_tool_url'>string _build_tool_url ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></B></CODE> |
|
875 |
<BR> |
|
876 |
<blockquote> This function is used to build the url |
|
877 |
for a tool link. </blockquote> |
|
878 |
</TD> |
</div> |
879 |
</TR> |
<a name="var$_form_render_flag" id="$_form_render_flag"><!-- --></A> |
880 |
|
<div class="oddrow"> |
881 |
<!-- =========== Summary =========== --> |
|
882 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-header"> |
883 |
<TD> |
<span class="var-title"> |
884 |
<CODE><B><A HREF='DataList.html#_check_datasource'>void _check_datasource ( $function_name )</A></B></CODE> |
<span class="var-type">mixed</span> |
885 |
<BR> |
<span class="var-name">$_form_render_flag</span> |
886 |
<blockquote> general DataListSource object checker. </blockquote> |
= <span class="var-default"> FALSE</span> (line <span class="line-number">241</span>) |
887 |
</TD> |
</span> |
888 |
</TR> |
</div> |
889 |
|
|
890 |
<!-- =========== Summary =========== --> |
<!-- ========== Info from phpDoc block ========= --> |
891 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<p class="short-description">Build everything inside a form?</p> |
892 |
<TD> |
|
893 |
<CODE><B><A HREF='DataList.html#_clean_string'>mixed _clean_string ( $obj, $col_name )</A></B></CODE> |
|
894 |
<BR> |
|
895 |
<blockquote> This function is used to make sure that the string we are |
|
896 |
placing in a cell has been "cleaned" </blockquote> |
|
897 |
</TD> |
</div> |
898 |
</TR> |
<a name="var$_global_prefix" id="$_global_prefix"><!-- --></A> |
899 |
|
<div class="evenrow"> |
900 |
<!-- =========== Summary =========== --> |
|
901 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-header"> |
902 |
<TD> |
<span class="var-title"> |
903 |
<CODE><B><A HREF='DataList.html#_filter_column_string'>string _filter_column_string ( $data )</A></B></CODE> |
<span class="var-type">mixed</span> |
904 |
<BR> |
<span class="var-name">$_global_prefix</span> |
905 |
<blockquote> This does some magic filtering on the data |
= <span class="var-default"> ''</span> (line <span class="line-number">145</span>) |
906 |
that we display in a column. </blockquote> |
</span> |
907 |
</TD> |
</div> |
908 |
</TR> |
|
909 |
|
<!-- ========== Info from phpDoc block ========= --> |
910 |
<!-- =========== Summary =========== --> |
<p class="short-description">prefix for all list variable names, so we can potentially have more then 1 list per page.</p> |
911 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
912 |
<TD> |
|
913 |
<CODE><B><A HREF='DataList.html#_get_searchable_fields'>array _get_searchable_fields ( )</A></B></CODE> |
|
914 |
<BR> |
|
915 |
<blockquote> This method gets the array of |
|
916 |
searchable header fields (columns) </blockquote> |
</div> |
917 |
</TD> |
<a name="var$_image_path" id="$_image_path"><!-- --></A> |
918 |
</TR> |
<div class="oddrow"> |
919 |
|
|
920 |
<!-- =========== Summary =========== --> |
<div class="var-header"> |
921 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-title"> |
922 |
<TD> |
<span class="var-type">mixed</span> |
923 |
<CODE><B><A HREF='DataList.html#_javascript'><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a> _javascript ( )</A></B></CODE> |
<span class="var-name">$_image_path</span> |
924 |
<BR> |
= <span class="var-default"> "/phphtmllib/images/widgets"</span> (line <span class="line-number">266</span>) |
925 |
<blockquote> This function provides a way to automatically |
</span> |
926 |
add javascript to this object. </blockquote> |
</div> |
927 |
</TD> |
|
928 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
929 |
|
<p class="short-description">This stores the base path to where the tool link images live. This lets you specify a new path to where your images live.</p> |
930 |
<!-- =========== Summary =========== --> |
|
931 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
932 |
<TD> |
|
933 |
<CODE><B><A HREF='DataList.html#_save_mozilla_nav_link'>void _save_mozilla_nav_link ( $which, $url )</A></B></CODE> |
|
934 |
<BR> |
|
935 |
<blockquote> This function stores the url for each of the tool |
</div> |
936 |
urls, so we can push these out for mozilla. </blockquote> |
<a name="var$_max_rows" id="$_max_rows"><!-- --></A> |
937 |
</TD> |
<div class="evenrow"> |
938 |
</TR> |
|
939 |
|
<div class="var-header"> |
940 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
941 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
942 |
<TD> |
<span class="var-name">$_max_rows</span> |
943 |
<CODE><B><A HREF='DataList.html#_show_results'>boolean _show_results ( )</A></B></CODE> |
= <span class="var-default"> 200</span> (line <span class="line-number">131</span>) |
944 |
<BR> |
</span> |
945 |
<blockquote> This function is used to let render() know |
</div> |
946 |
that we should show the results or not. </blockquote> |
|
947 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
948 |
</TR> |
<p class="short-description">The max number of rows to show when the user does the "EXPAND" command.</p> |
949 |
|
|
950 |
</TABLE> |
|
951 |
|
|
952 |
<hr> |
|
953 |
<!-- ============ VARIABLE DETAIL =========== --> |
|
954 |
|
</div> |
955 |
<A NAME='variable_detail'></A> |
<a name="var$_num_columns" id="$_num_columns"><!-- --></A> |
956 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="oddrow"> |
957 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
958 |
<TD> |
<div class="var-header"> |
959 |
<span CLASS="font12bold">Variable Detail</span> |
<span class="var-title"> |
960 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="var-type">mixed</span> |
961 |
</TD> |
<span class="var-name">$_num_columns</span> |
962 |
</TR> |
= <span class="var-default"> 0</span> (line <span class="line-number">225</span>) |
963 |
</TABLE> |
</span> |
964 |
|
</div> |
965 |
|
|
966 |
<A NAME='$alternating_row_colors'><!-- --></A><H3>$alternating_row_colors</H3> |
<!-- ========== Info from phpDoc block ========= --> |
967 |
<b>Data type:</b> mixed<br> |
<p class="short-description">Keeps track of the # of columns we have</p> |
968 |
<!-- ========== Info from phpDoc block ========= --> |
|
969 |
Do we want to alternate the row colors? |
|
970 |
This helps to see each row easier. |
|
971 |
<BR> |
|
972 |
|
|
973 |
|
</div> |
974 |
<UL> |
<a name="var$_num_pages" id="$_num_pages"><!-- --></A> |
975 |
|
<div class="evenrow"> |
976 |
</UL> |
|
977 |
|
<div class="var-header"> |
978 |
<HR> |
<span class="var-title"> |
979 |
|
<span class="var-type">mixed</span> |
980 |
<A NAME='$_advanced_search_flag'><!-- --></A><H3>$_advanced_search_flag</H3> |
<span class="var-name">$_num_pages</span> |
981 |
<b>Data type:</b> mixed<br> |
= <span class="var-default">1</span> (line <span class="line-number">116</span>) |
982 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
983 |
Flag to let us know that |
</div> |
984 |
advanced search is enabled |
|
985 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
986 |
|
<p class="short-description">This value holds the number of pages of data we have to display.</p> |
987 |
|
|
988 |
<UL> |
|
989 |
|
|
990 |
</UL> |
|
991 |
|
|
992 |
<HR> |
</div> |
993 |
|
<a name="var$_save_vars" id="$_save_vars"><!-- --></A> |
994 |
<A NAME='$_columns'><!-- --></A><H3>$_columns</H3> |
<div class="oddrow"> |
995 |
<b>Data type:</b> array<br> |
|
996 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="var-header"> |
997 |
The column descriptions |
<span class="var-title"> |
998 |
for the data we are working on |
<span class="var-type">mixed</span> |
999 |
<BR> |
<span class="var-name">$_save_vars</span> |
1000 |
|
= <span class="var-default">array()</span> (line <span class="line-number">211</span>) |
1001 |
|
</span> |
1002 |
<UL> |
</div> |
1003 |
|
|
1004 |
</UL> |
<!-- ========== Info from phpDoc block ========= --> |
1005 |
|
<p class="short-description">This holds a list of name=>value vars that the caller/child wants to propogate automatically.</p> |
1006 |
<HR> |
|
1007 |
|
|
1008 |
<A NAME='$_datasource'><!-- --></A><H3>$_datasource</H3> |
|
1009 |
<b>Data type:</b> <a href="../phpHtmlLib/DataListSource.html">DataListSource</a><br> |
|
1010 |
<!-- ========== Info from phpDoc block ========= --> |
|
1011 |
Holds our reference/copy of the |
</div> |
1012 |
<BR> |
<a name="var$_search_flag" id="$_search_flag"><!-- --></A> |
1013 |
DataListSource object which is used to |
<div class="evenrow"> |
1014 |
access the data that this object uses |
|
1015 |
|
<div class="var-header"> |
1016 |
<UL> |
<span class="var-title"> |
1017 |
|
<span class="var-type">mixed</span> |
1018 |
<LI><b>Var</b> - <CODE>object</CODE></LI> |
<span class="var-name">$_search_flag</span> |
1019 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">180</span>) |
1020 |
</UL> |
</span> |
1021 |
|
</div> |
1022 |
<HR> |
|
1023 |
|
<!-- ========== Info from phpDoc block ========= --> |
1024 |
<A NAME='$_default_orderby'><!-- --></A><H3>$_default_orderby</H3> |
<p class="short-description">Flag to let us know that search is enabled.</p> |
1025 |
<b>Data type:</b> mixed<br> |
|
1026 |
<!-- ========== Info from phpDoc block ========= --> |
|
1027 |
Holds the db column name that |
|
1028 |
we want to order by default. |
|
1029 |
<BR> |
|
1030 |
|
</div> |
1031 |
|
<a name="var$_search_table" id="$_search_table"><!-- --></A> |
1032 |
<UL> |
<div class="oddrow"> |
1033 |
|
|
1034 |
</UL> |
<div class="var-header"> |
1035 |
|
<span class="var-title"> |
1036 |
<HR> |
<span class="var-type">mixed</span> |
1037 |
|
<span class="var-name">$_search_table</span> |
1038 |
<A NAME='$_default_reverseorder'><!-- --></A><H3>$_default_reverseorder</H3> |
= <span class="var-default"> NULL</span> (line <span class="line-number">202</span>) |
1039 |
<b>Data type:</b> mixed<br> |
</span> |
1040 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1041 |
Holds a flag to let us know to |
|
1042 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1043 |
reverse order the column by default |
<p class="short-description">Holds the object block that is the</p> |
1044 |
|
<p class="description"><p>search UI</p></p> |
1045 |
<UL> |
|
1046 |
|
|
1047 |
</UL> |
|
1048 |
|
|
1049 |
<HR> |
|
1050 |
|
</div> |
1051 |
<A NAME='$_default_rows_per_page'><!-- --></A><H3>$_default_rows_per_page</H3> |
<a name="var$_show_results_flag" id="$_show_results_flag"><!-- --></A> |
1052 |
<b>Data type:</b> mixed<br> |
<div class="evenrow"> |
1053 |
<!-- ========== Info from phpDoc block ========= --> |
|
1054 |
The number of rows of data |
<div class="var-header"> |
1055 |
to show per "page". |
<span class="var-title"> |
1056 |
<BR> |
<span class="var-type">mixed</span> |
1057 |
The default is 20. |
<span class="var-name">$_show_results_flag</span> |
1058 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">248</span>) |
1059 |
<UL> |
</span> |
1060 |
|
</div> |
1061 |
</UL> |
|
1062 |
|
<!-- ========== Info from phpDoc block ========= --> |
1063 |
<HR> |
<p class="short-description">flag to let us know if we want to show the results or not.</p> |
1064 |
|
|
1065 |
<A NAME='$_form_attributes'><!-- --></A><H3>$_form_attributes</H3> |
|
1066 |
<b>Data type:</b> mixed<br> |
|
1067 |
<!-- ========== Info from phpDoc block ========= --> |
|
1068 |
This holds the form attributes |
|
1069 |
<BR> |
</div> |
1070 |
|
<a name="var$_simple_search_modifier" id="$_simple_search_modifier"><!-- --></A> |
1071 |
|
<div class="oddrow"> |
1072 |
<UL> |
|
1073 |
|
<div class="var-header"> |
1074 |
</UL> |
<span class="var-title"> |
1075 |
|
<span class="var-type">mixed</span> |
1076 |
<HR> |
<span class="var-name">$_simple_search_modifier</span> |
1077 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">195</span>) |
1078 |
<A NAME='$_form_render_flag'><!-- --></A><H3>$_form_render_flag</H3> |
</span> |
1079 |
<b>Data type:</b> mixed<br> |
</div> |
1080 |
<!-- ========== Info from phpDoc block ========= --> |
|
1081 |
Build everything inside a form? |
<!-- ========== Info from phpDoc block ========= --> |
1082 |
<BR> |
<p class="short-description">Flag to enable simple search modifyer.</p> |
1083 |
|
<p class="description"><p>IF enabled it will add a select that adds the "beings with", "contains" options for a simple search.</p></p> |
1084 |
|
|
1085 |
<UL> |
|
1086 |
|
|
1087 |
</UL> |
|
1088 |
|
|
1089 |
<HR> |
</div> |
1090 |
|
<a name="var$_vars" id="$_vars"><!-- --></A> |
1091 |
<A NAME='$_global_prefix'><!-- --></A><H3>$_global_prefix</H3> |
<div class="evenrow"> |
1092 |
<b>Data type:</b> mixed<br> |
|
1093 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="var-header"> |
1094 |
prefix for all list variable |
<span class="var-title"> |
1095 |
names, so we can potentially |
<span class="var-type">mixed</span> |
1096 |
have more then 1 list per page. |
<span class="var-name">$_vars</span> |
1097 |
<BR> |
= <span class="var-default">array("offsetVar" => "offset",<br /> "orderbyVar" => "orderby",<br /> "reverseorderVar" => "reverseorder",<br /> "numrowsVar" => "numrows",<br /> "showallVar" => "showall",<br /> "search_fieldVar" => "search_field",<br /> "search_valueVar" => "search_value",<br /> "search_typeVar" => "search_type",<br /> "simple_search_modifierVar" => "simple_search_modifier")</span> (line <span class="line-number">153</span>) |
1098 |
|
</span> |
1099 |
|
</div> |
1100 |
<UL> |
|
1101 |
|
<!-- ========== Info from phpDoc block ========= --> |
1102 |
</UL> |
<p class="short-description">Holds an array of all the form vars we need for this class to work.</p> |
1103 |
|
|
1104 |
<HR> |
|
1105 |
|
|
1106 |
<A NAME='$_image_path'><!-- --></A><H3>$_image_path</H3> |
|
1107 |
<b>Data type:</b> mixed<br> |
|
1108 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1109 |
This stores the base path to where the |
<h4>Inherited Variables</h4> |
1110 |
tool link images live. |
<A NAME='inherited_vars'><!-- --></A> |
1111 |
<BR> |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
1112 |
This lets you |
<blockquote> |
1113 |
specify a new path to where your images |
<span class="var-title"> |
1114 |
live. |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
1115 |
|
</span> |
1116 |
<UL> |
<span class="var-title"> |
1117 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
1118 |
</UL> |
</span> |
1119 |
|
</blockquote> |
1120 |
<HR> |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
1121 |
|
<blockquote> |
1122 |
<A NAME='$_max_rows'><!-- --></A><H3>$_max_rows</H3> |
<span class="var-title"> |
1123 |
<b>Data type:</b> mixed<br> |
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
1124 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
1125 |
The max number of rows to |
</blockquote> |
1126 |
show when the user does the |
|
1127 |
"EXPAND" command. |
</div> |
1128 |
<BR> |
</div> |
1129 |
|
|
1130 |
|
<a name="sec-methods"></a> |
1131 |
<UL> |
<div class="info-box"> |
1132 |
|
<div class="info-box-title">Methods</div> |
1133 |
</UL> |
<div class="nav-bar"> |
1134 |
|
<a href="#sec-description">Description</a> | |
1135 |
<HR> |
<a href="#sec-descendents">Descendents</a> | |
1136 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
1137 |
<A NAME='$_numrowsVar'><!-- --></A><H3>$_numrowsVar</H3> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
1138 |
<b>Data type:</b> mixed<br> |
|
1139 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1140 |
The number of rows variable name |
<div class="info-box-body"> |
1141 |
<BR> |
<A NAME='method_detail'></A> |
1142 |
|
<a name="methodDataList" id="DataList"><!-- --></a> |
1143 |
|
<div class="oddrow"> |
1144 |
<UL> |
|
1145 |
|
<div class="method-header"> |
1146 |
</UL> |
<span class="method-title">Constructor DataList</span> (line <span class="line-number">277</span>) |
1147 |
|
</div> |
1148 |
<HR> |
|
1149 |
|
<!-- ========== Info from phpDoc block ========= --> |
1150 |
<A NAME='$_num_columns'><!-- --></A><H3>$_num_columns</H3> |
<p class="short-description">The constructor</p> |
1151 |
<b>Data type:</b> mixed<br> |
|
1152 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
1153 |
Keeps track of the # of columns we have |
<span class="method-result">void</span> |
1154 |
<BR> |
<span class="method-name"> |
1155 |
|
DataList |
1156 |
|
</span> |
1157 |
<UL> |
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$default_orderby</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span> <span class="var-name">$default_reverseorder</span> = <span class="var-default">FALSE</span>]) |
1158 |
|
</div> |
1159 |
</UL> |
|
1160 |
|
<ul class="parameters"> |
1161 |
<HR> |
<li> |
1162 |
|
<span class="var-type">string</span> |
1163 |
<A NAME='$_num_pages'><!-- --></A><H3>$_num_pages</H3> |
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the data list</p></span> </li> |
1164 |
<b>Data type:</b> mixed<br> |
<li> |
1165 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">string</span> |
1166 |
This value holds the number |
<span class="var-name">$width</span><span class="var-description">: <p>- the overall width</p></span> </li> |
1167 |
of pages of data we have |
<li> |
1168 |
to display. |
<span class="var-type">string</span> |
1169 |
<BR> |
<span class="var-name">$default_orderby</span><span class="var-description">: <p>- the column to use as the default sorting order</p></span> </li> |
1170 |
|
<li> |
1171 |
|
<span class="var-type">boolean</span> |
1172 |
<UL> |
<span class="var-name">$default_reverseorder</span><span class="var-description">: <p>- sort the default column in reverse order?</p></span> </li> |
1173 |
|
</ul> |
1174 |
</UL> |
|
1175 |
|
|
1176 |
<HR> |
</div> |
1177 |
|
<a name="methodadd_header_item" id="add_header_item"><!-- --></a> |
1178 |
<A NAME='$_offsetVar'><!-- --></A><H3>$_offsetVar</H3> |
<div class="evenrow"> |
1179 |
<b>Data type:</b> mixed<br> |
|
1180 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
1181 |
The offset variable name |
<span class="method-title">add_header_item</span> (line <span class="line-number">592</span>) |
1182 |
<BR> |
</div> |
1183 |
|
|
1184 |
|
<!-- ========== Info from phpDoc block ========= --> |
1185 |
<UL> |
<p class="short-description">This function adds a header item to the column headers from a list of parameters.</p> |
1186 |
|
<ul class="tags"> |
1187 |
</UL> |
<li><span class="field">return:</span> <p>a single header array</p></li> |
1188 |
|
</ul> |
1189 |
<HR> |
|
1190 |
|
<div class="method-signature"> |
1191 |
<A NAME='$_orderbyVar'><!-- --></A><H3>$_orderbyVar</H3> |
<span class="method-result">array</span> |
1192 |
<b>Data type:</b> mixed<br> |
<span class="method-name"> |
1193 |
<!-- ========== Info from phpDoc block ========= --> |
add_header_item |
1194 |
The order by variable name |
</span> |
1195 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">100</span>], [<span class="var-type">string</span> <span class="var-name">$data_name</span> = <span class="var-default">NULL</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">$align</span> = <span class="var-default">"left"</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$max_text_length</span> = <span class="var-default">NULL</span>]) |
1196 |
|
</div> |
1197 |
|
|
1198 |
<UL> |
<ul class="parameters"> |
1199 |
|
<li> |
1200 |
</UL> |
<span class="var-type">string</span> |
1201 |
|
<span class="var-name">$label</span><span class="var-description">: <p>- $label - the label to use for the column header.</p></span> </li> |
1202 |
<HR> |
<li> |
1203 |
|
<span class="var-type">int</span> |
1204 |
<A NAME='$_reverseorderVar'><!-- --></A><H3>$_reverseorderVar</H3> |
<span class="var-name">$size</span><span class="var-description">: <p>- $size - the size for the table column.</p></span> </li> |
1205 |
<b>Data type:</b> mixed<br> |
<li> |
1206 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">string</span> |
1207 |
The reverseorder variable name |
<span class="var-name">$data_name</span><span class="var-description">: <p>- $dbfield - the db field associated with this label from the query.</p></span> </li> |
1208 |
<BR> |
<li> |
1209 |
|
<span class="var-type">boolean</span> |
1210 |
|
<span class="var-name">$sortable</span><span class="var-description">: <p>- $sortable - flag to make this column sortable.</p></span> </li> |
1211 |
<UL> |
<li> |
1212 |
|
<span class="var-type">boolean</span> |
1213 |
</UL> |
<span class="var-name">$searchable</span><span class="var-description">: <p>- $searchable - flag to make this column searchable.</p></span> </li> |
1214 |
|
<li> |
1215 |
<HR> |
<span class="var-type">string</span> |
1216 |
|
<span class="var-name">$align</span><span class="var-description">: <p>- header align value.</p></span> </li> |
1217 |
<A NAME='$_save_vars'><!-- --></A><H3>$_save_vars</H3> |
<li> |
1218 |
<b>Data type:</b> mixed<br> |
<span class="var-type">string</span> |
1219 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$sortorder</span><span class="var-description">: <p>- the sort order</p></span> </li> |
1220 |
This holds a list of |
<li> |
1221 |
<BR> |
<span class="var-type">string</span> |
1222 |
name=>value vars that the |
<span class="var-name">$max_text_length</span><span class="var-description">: <p>- the maximum # of characters to allow in the cell.</p></span> </li> |
1223 |
caller/child wants to propogate |
</ul> |
1224 |
automatically. |
|
1225 |
|
|
1226 |
<UL> |
</div> |
1227 |
|
<a name="methodadvanced_search_disable" id="advanced_search_disable"><!-- --></a> |
1228 |
</UL> |
<div class="oddrow"> |
1229 |
|
|
1230 |
<HR> |
<div class="method-header"> |
1231 |
|
<span class="method-title">advanced_search_disable</span> (line <span class="line-number">700</span>) |
1232 |
<A NAME='$_search_fieldVar'><!-- --></A><H3>$_search_fieldVar</H3> |
</div> |
1233 |
<b>Data type:</b> mixed<br> |
|
1234 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1235 |
The search field variable |
<p class="short-description">Disable the advanced search</p> |
1236 |
<BR> |
<p class="description"><p>capability</p></p> |
1237 |
|
|
1238 |
|
<div class="method-signature"> |
1239 |
<UL> |
<span class="method-result">void</span> |
1240 |
|
<span class="method-name"> |
1241 |
</UL> |
advanced_search_disable |
1242 |
|
</span> |
1243 |
<HR> |
() |
1244 |
|
</div> |
1245 |
<A NAME='$_search_flag'><!-- --></A><H3>$_search_flag</H3> |
|
1246 |
<b>Data type:</b> mixed<br> |
|
1247 |
<!-- ========== Info from phpDoc block ========= --> |
|
1248 |
Flag to let us know that search |
</div> |
1249 |
is enabled. |
<a name="methodadvanced_search_enable" id="advanced_search_enable"><!-- --></a> |
1250 |
<BR> |
<div class="evenrow"> |
1251 |
|
|
1252 |
|
<div class="method-header"> |
1253 |
<UL> |
<span class="method-title">advanced_search_enable</span> (line <span class="line-number">688</span>) |
1254 |
|
</div> |
1255 |
</UL> |
|
1256 |
|
<!-- ========== Info from phpDoc block ========= --> |
1257 |
<HR> |
<p class="short-description">Enable the advanced search</p> |
1258 |
|
<p class="description"><p>capability NOTE: Child class MUST extend the _build_advanced_search_table</p></p> |
1259 |
<A NAME='$_search_table'><!-- --></A><H3>$_search_table</H3> |
|
1260 |
<b>Data type:</b> mixed<br> |
<div class="method-signature"> |
1261 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-result">void</span> |
1262 |
Holds the object block that is the |
<span class="method-name"> |
1263 |
<BR> |
advanced_search_enable |
1264 |
search UI |
</span> |
1265 |
|
() |
1266 |
<UL> |
</div> |
1267 |
|
|
1268 |
</UL> |
|
1269 |
|
|
1270 |
<HR> |
</div> |
1271 |
|
<a name="methodbuild_base_url" id="build_base_url"><!-- --></a> |
1272 |
<A NAME='$_search_typeVar'><!-- --></A><H3>$_search_typeVar</H3> |
<div class="oddrow"> |
1273 |
<b>Data type:</b> mixed<br> |
|
1274 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
1275 |
The type of search |
<span class="method-title">build_base_url</span> (line <span class="line-number">1303</span>) |
1276 |
<BR> |
</div> |
1277 |
advanced/simple |
|
1278 |
|
<!-- ========== Info from phpDoc block ========= --> |
1279 |
<UL> |
<p class="short-description">This builds the base url used by the column headers as well as the page tool links.</p> |
1280 |
|
<p class="description"><p>it basically builds: $_SELF?$_GET</p></p> |
1281 |
</UL> |
|
1282 |
|
<div class="method-signature"> |
1283 |
<HR> |
<span class="method-result">string</span> |
1284 |
|
<span class="method-name"> |
1285 |
<A NAME='$_search_valueVar'><!-- --></A><H3>$_search_valueVar</H3> |
build_base_url |
1286 |
<b>Data type:</b> mixed<br> |
</span> |
1287 |
<!-- ========== Info from phpDoc block ========= --> |
() |
1288 |
The search value |
</div> |
1289 |
<BR> |
|
1290 |
|
|
1291 |
|
|
1292 |
<UL> |
</div> |
1293 |
|
<a name="methodbuild_column_item" id="build_column_item"><!-- --></a> |
1294 |
</UL> |
<div class="evenrow"> |
1295 |
|
|
1296 |
<HR> |
<div class="method-header"> |
1297 |
|
<span class="method-title">build_column_item</span> (line <span class="line-number">1079</span>) |
1298 |
<A NAME='$_showallVar'><!-- --></A><H3>$_showallVar</H3> |
</div> |
1299 |
<b>Data type:</b> mixed<br> |
|
1300 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1301 |
This var to tell us to show all |
<p class="short-description">This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DB.</p> |
1302 |
data or not. |
<p class="description"><p>NOTE: this function is meant to be overridden so that you can push whatever you want.</p></p> |
1303 |
<BR> |
<ul class="tags"> |
1304 |
|
<li><span class="field">return:</span> <p>- either a HTMLTag object, or raw text.</p></li> |
1305 |
|
</ul> |
1306 |
<UL> |
|
1307 |
|
<div class="method-signature"> |
1308 |
</UL> |
<span class="method-result">mixed</span> |
1309 |
|
<span class="method-name"> |
1310 |
<HR> |
build_column_item |
1311 |
|
</span> |
1312 |
<A NAME='$_show_results_flag'><!-- --></A><H3>$_show_results_flag</H3> |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
1313 |
<b>Data type:</b> mixed<br> |
</div> |
1314 |
<!-- ========== Info from phpDoc block ========= --> |
|
1315 |
flag to let us know if we want to show |
<ul class="parameters"> |
1316 |
the results or not. |
<li> |
1317 |
<BR> |
<span class="var-type">array</span> |
1318 |
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- $row_data - the entire data for the row</p></span> </li> |
1319 |
|
<li> |
1320 |
<UL> |
<span class="var-type">string</span> |
1321 |
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name - the name of the column header for this row to render.</p></span> </li> |
1322 |
</UL> |
</ul> |
1323 |
|
|
1324 |
<HR> |
|
1325 |
|
</div> |
1326 |
<A NAME='$_simple_search_modifier'><!-- --></A><H3>$_simple_search_modifier</H3> |
<a name="methodbuild_column_url" id="build_column_url"><!-- --></a> |
1327 |
<b>Data type:</b> mixed<br> |
<div class="oddrow"> |
1328 |
<!-- ========== Info from phpDoc block ========= --> |
|
1329 |
Flag to enable simple search modifyer. |
<div class="method-header"> |
1330 |
<BR> |
<span class="method-title">build_column_url</span> (line <span class="line-number">1610</span>) |
1331 |
IF enabled it will add a select that adds |
</div> |
1332 |
the "beings with", "contains" options for |
|
1333 |
a simple search. |
<!-- ========== Info from phpDoc block ========= --> |
1334 |
|
<p class="short-description">This builds a url for a particular column header.</p> |
1335 |
<UL> |
<ul class="tags"> |
1336 |
|
<li><span class="field">return:</span> <p>object;</p></li> |
1337 |
</UL> |
</ul> |
1338 |
|
|
1339 |
<HR> |
<div class="method-signature"> |
1340 |
|
<span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span> |
1341 |
<A NAME='$_simple_search_modifierVar'><!-- --></A><H3>$_simple_search_modifierVar</H3> |
<span class="method-name"> |
1342 |
<b>Data type:</b> mixed<br> |
build_column_url |
1343 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
1344 |
The simple search modifier |
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
1345 |
var name. |
</div> |
1346 |
<BR> |
|
1347 |
|
<ul class="parameters"> |
1348 |
|
<li> |
1349 |
<UL> |
<span class="var-type">string</span> |
1350 |
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name</p></span> </li> |
1351 |
</UL> |
</ul> |
1352 |
|
|
1353 |
<HR> |
|
1354 |
|
</div> |
1355 |
|
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
1356 |
<hr> |
<div class="evenrow"> |
1357 |
<!-- ============ FUNCTION DETAIL =========== --> |
|
1358 |
|
<div class="method-header"> |
1359 |
<A NAME='function_detail'></A> |
<span class="method-title">build_gui</span> (line <span class="line-number">399</span>) |
1360 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</div> |
1361 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
1362 |
<TD> |
<!-- ========== Info from phpDoc block ========= --> |
1363 |
<span class="font12bold">Method Detail</span> |
<p class="short-description">This function is responsible for calling the child class's methods for building the GUI container.</p> |
1364 |
<A HREF="#top" CLASS="links">^TOP</A> |
<p class="description"><p>This function builds the search area, the title, page controls, the column headers, and walks the rows of data and adds them</p><p>A child class can override this method to move the placement of the search box relative to the data list. By default the search area comes above the table for the data list and page controls</p></p> |
1365 |
</TD> |
|
1366 |
</TR> |
<div class="method-signature"> |
1367 |
</TABLE> |
<span class="method-result">Container</span> |
1368 |
<BR> |
<span class="method-name"> |
1369 |
|
build_gui |
1370 |
<DIV CLASS="function"> |
</span> |
1371 |
<A NAME='constructor DataList'><!-- --></A> |
() |
1372 |
<SPAN CLASS="font12bold">constructor DataList</SPAN> |
</div> |
1373 |
<BR> |
|
1374 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1375 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1376 |
<span class="font10bold" style="color: #0000FF">constructor DataList ( $title, [$width = "100%"], [$default_orderby = ''], [$default_reverseorder = FALSE] )</SPAN> |
<hr class="separator" /> |
1377 |
<BR> |
<div class="notes">Redefined in descendants as:</div> |
1378 |
|
<ul class="redefinitions"> |
1379 |
<BR> |
<li> |
1380 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodbuild_gui">DefaultGUIDatalist::build_gui()</a> |
1381 |
<!-- ========== Info from phpDoc block ========= --> |
: Override the parent's method so we can wrap everything in a div to hold it all together when we change the alignment |
1382 |
The constructor |
</li> |
1383 |
<BR> |
</ul> |
1384 |
|
</div> |
1385 |
<DL> |
<a name="methodbuild_orderby_querystring" id="build_orderby_querystring"><!-- --></a> |
1386 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="oddrow"> |
1387 |
|
|
1388 |
<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 data list</DD> |
<div class="method-header"> |
1389 |
|
<span class="method-title">build_orderby_querystring</span> (line <span class="line-number">926</span>) |
1390 |
<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">$width</SPAN></SPAN> - the overall width</DD> |
</div> |
1391 |
|
|
1392 |
<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">$default_orderby</SPAN></SPAN> - the column to use as the default sorting order</DD> |
<!-- ========== Info from phpDoc block ========= --> |
1393 |
|
<p class="short-description">This builds a query string var for the orderby value.</p> |
1394 |
<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">$default_reverseorder</SPAN></SPAN> - sort the default column in reverse order?</DD> |
<ul class="tags"> |
1395 |
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
1396 |
|
</ul> |
1397 |
<DT class="font10bold">Function Info:</DT> |
|
1398 |
|
<div class="method-signature"> |
1399 |
</DL> |
<span class="method-result">string</span> |
1400 |
|
<span class="method-name"> |
1401 |
</DIV> |
build_orderby_querystring |
1402 |
<BR> |
</span> |
1403 |
|
() |
1404 |
<DIV CLASS="function"> |
</div> |
1405 |
<A NAME='add_header_item'><!-- --></A> |
|
1406 |
<SPAN CLASS="font12bold">add_header_item</SPAN> |
|
1407 |
<BR> |
|
1408 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
1409 |
<span class="font10bold" style="color: #FF0000">array</SPAN> |
<a name="methodbuild_reverseorder_querystring" id="build_reverseorder_querystring"><!-- --></a> |
1410 |
<span class="font10bold" style="color: #0000FF">add_header_item ( $label, [$size = 100], [$data_name = NULL], [$sortable = FALSE], [$searchable = FALSE], [$align = "left"], $sortorder, [$max_text_length = ""NULL] )</SPAN> |
<div class="evenrow"> |
1411 |
<BR> |
|
1412 |
|
<div class="method-header"> |
1413 |
<BR> |
<span class="method-title">build_reverseorder_querystring</span> (line <span class="line-number">957</span>) |
1414 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1415 |
<!-- ========== Info from phpDoc block ========= --> |
|
1416 |
This function adds a header item to the column headers |
<!-- ========== Info from phpDoc block ========= --> |
1417 |
from a list of parameters. |
<p class="short-description">This builds a query string var for the reverseorder value.</p> |
1418 |
<BR> |
<ul class="tags"> |
1419 |
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
1420 |
<DL> |
</ul> |
1421 |
<DT class="font10bold">Function Parameters:</DT> |
|
1422 |
|
<div class="method-signature"> |
1423 |
<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">$label</SPAN></SPAN> - header align value.</DD> |
<span class="method-result">string</span> |
1424 |
|
<span class="method-name"> |
1425 |
<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">$size</SPAN></SPAN> - the maximum # of characters to allow in the cell.</DD> |
build_reverseorder_querystring |
1426 |
|
</span> |
1427 |
<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">$dbfield</SPAN></SPAN> - - the db field associated |
() |
1428 |
with this label from the query.</DD> |
</div> |
1429 |
|
|
1430 |
<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> - - flag to make this column sortable.</DD> |
|
1431 |
|
|
1432 |
<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> - - flag to make this column searchable.</DD> |
</div> |
1433 |
|
<a name="methodbuild_searchfield_querystring" id="build_searchfield_querystring"><!-- --></a> |
1434 |
|
<div class="oddrow"> |
1435 |
<DT class="font10bold">Function Info:</DT> |
|
1436 |
|
<div class="method-header"> |
1437 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - a single header array</DD> |
<span class="method-title">build_searchfield_querystring</span> (line <span class="line-number">998</span>) |
1438 |
|
</div> |
1439 |
</DL> |
|
1440 |
|
<!-- ========== Info from phpDoc block ========= --> |
1441 |
</DIV> |
<p class="short-description">This builds a query string var for the searchfield value.</p> |
1442 |
<BR> |
<ul class="tags"> |
1443 |
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
1444 |
<DIV CLASS="function"> |
</ul> |
1445 |
<A NAME='advanced_search_disable'><!-- --></A> |
|
1446 |
<SPAN CLASS="font12bold">advanced_search_disable</SPAN> |
<div class="method-signature"> |
1447 |
<BR> |
<span class="method-result">string</span> |
1448 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"> |
1449 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
build_searchfield_querystring |
1450 |
<span class="font10bold" style="color: #0000FF">advanced_search_disable ( )</SPAN> |
</span> |
1451 |
<BR> |
() |
1452 |
|
</div> |
1453 |
<BR> |
|
1454 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1455 |
<!-- ========== Info from phpDoc block ========= --> |
|
1456 |
Disable the advanced search |
</div> |
1457 |
capability |
<a name="methodbuild_searchvalue_querystring" id="build_searchvalue_querystring"><!-- --></a> |
1458 |
<BR> |
<div class="evenrow"> |
1459 |
|
|
1460 |
<DL> |
<div class="method-header"> |
1461 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-title">build_searchvalue_querystring</span> (line <span class="line-number">1019</span>) |
1462 |
|
</div> |
1463 |
|
|
1464 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
1465 |
|
<p class="short-description">This builds a query string var for the searchfield value.</p> |
1466 |
</DL> |
<ul class="tags"> |
1467 |
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
1468 |
</DIV> |
</ul> |
1469 |
<BR> |
|
1470 |
|
<div class="method-signature"> |
1471 |
<DIV CLASS="function"> |
<span class="method-result">string</span> |
1472 |
<A NAME='advanced_search_enable'><!-- --></A> |
<span class="method-name"> |
1473 |
<SPAN CLASS="font12bold">advanced_search_enable</SPAN> |
build_searchvalue_querystring |
1474 |
<BR> |
</span> |
1475 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
() |
1476 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
1477 |
<span class="font10bold" style="color: #0000FF">advanced_search_enable ( )</SPAN> |
|
1478 |
<BR> |
|
1479 |
|
|
1480 |
<BR> |
</div> |
1481 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a name="methodbuild_state_vars_query_string" id="build_state_vars_query_string"><!-- --></a> |
1482 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="oddrow"> |
1483 |
Enable the advanced search |
|
1484 |
<BR> |
<div class="method-header"> |
1485 |
capability |
<span class="method-title">build_state_vars_query_string</span> (line <span class="line-number">1480</span>) |
1486 |
NOTE: Child class MUST |
</div> |
1487 |
extend the |
|
1488 |
_build_advanced_search_table |
<!-- ========== Info from phpDoc block ========= --> |
1489 |
<DL> |
<p class="short-description">this function is used to build a sub query string</p> |
1490 |
<DT class="font10bold">Function Parameters:</DT> |
<p class="description"><p>of all of the query string vars to save the state of the DBItemList. This is used for pages that want to come back to the list at the same state</p></p> |
1491 |
|
<ul class="tags"> |
1492 |
|
<li><span class="field">return:</span> <p>- name=value& pairs</p></li> |
1493 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
1494 |
|
|
1495 |
</DL> |
<div class="method-signature"> |
1496 |
|
<span class="method-result">string</span> |
1497 |
</DIV> |
<span class="method-name"> |
1498 |
<BR> |
build_state_vars_query_string |
1499 |
|
</span> |
1500 |
<DIV CLASS="function"> |
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, [<span class="var-type">mixed</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span> <span class="var-name">$showall_value</span>) |
1501 |
<A NAME='build_base_url'><!-- --></A> |
</div> |
1502 |
<SPAN CLASS="font12bold">build_base_url</SPAN> |
|
1503 |
<BR> |
|
1504 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1505 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</div> |
1506 |
<span class="font10bold" style="color: #0000FF">build_base_url ( )</SPAN> |
<a name="methodbuild_tool_link" id="build_tool_link"><!-- --></a> |
1507 |
<BR> |
<div class="evenrow"> |
1508 |
|
|
1509 |
<BR> |
<div class="method-header"> |
1510 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-title">build_tool_link</span> (line <span class="line-number">1349</span>) |
1511 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1512 |
This builds the base url used |
|
1513 |
by the column headers as well |
<!-- ========== Info from phpDoc block ========= --> |
1514 |
as the page tool links. |
<p class="short-description">This function builds the 'tool' images that allow you to walk through the data list itself.</p> |
1515 |
<BR> |
<p class="description"><p>It provides image links for first - go to the first page in the data list prev - go to the previous page in the data list next - go to the next page in the data list last - go to the last page in the data list all - show the rest of the list from the current offset</p></p> |
1516 |
it basically builds: |
|
1517 |
$_SELF?$_GET |
<div class="method-signature"> |
1518 |
<DL> |
<span class="method-result">Object</span> |
1519 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
1520 |
|
build_tool_link |
1521 |
|
</span> |
1522 |
<DT class="font10bold">Function Info:</DT> |
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
1523 |
|
</div> |
1524 |
</DL> |
|
1525 |
|
<ul class="parameters"> |
1526 |
</DIV> |
<li> |
1527 |
<BR> |
<span class="var-type">string</span> |
1528 |
|
<span class="var-name">$which</span><span class="var-description">: <p>- which tool image to build</p></span> </li> |
1529 |
<DIV CLASS="function"> |
</ul> |
1530 |
<A NAME='build_column_item'><!-- --></A> |
|
1531 |
<SPAN CLASS="font12bold">build_column_item</SPAN> |
|
1532 |
<BR> |
</div> |
1533 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
1534 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<div class="oddrow"> |
1535 |
<span class="font10bold" style="color: #0000FF">build_column_item ( $row_data, $col_name )</SPAN> |
|
1536 |
<BR> |
<div class="method-header"> |
1537 |
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">530</span>) |
1538 |
<BR> |
</div> |
1539 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1540 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1541 |
This is the basic function for letting us |
<p class="short-description">This method is supposed to be written by the child class to add the cell data to the current row in the UI</p> |
1542 |
do a mapping between the column name in |
|
1543 |
the header, to the value found in the DB. |
<div class="method-signature"> |
1544 |
<BR> |
<span class="method-result">void</span> |
1545 |
NOTE: this function is meant to be overridden |
<span class="method-name"> |
1546 |
so that you can push whatever you want. |
child_add_row_cell |
1547 |
<DL> |
</span> |
1548 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>, <span class="var-type">boolean</span> <span class="var-name">$last_in_row_flag</span>) |
1549 |
|
</div> |
1550 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$row_data</SPAN></SPAN> - - the entire data for the row</DD> |
|
1551 |
|
<ul class="parameters"> |
1552 |
<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">$col_name</SPAN></SPAN> - - the name of the column header |
<li> |
1553 |
for this row to render.</DD> |
<span class="var-type">mixed</span> |
1554 |
|
<span class="var-name">$obj</span><span class="var-description">: <p>- the object/string/entity that should get put into the column row cell.</p></span> </li> |
1555 |
|
<li> |
1556 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">string</span> |
1557 |
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- the name/title of the column that the object will live in</p></span> </li> |
1558 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either a HTMLTag object, or raw text.</DD> |
<li> |
1559 |
|
<span class="var-type">boolean</span> |
1560 |
</DL> |
<span class="var-name">$last_in_row_flag</span><span class="var-description">: <p>- flag that tells the function if this is is the last cell for the current row.</p></span> </li> |
1561 |
|
</ul> |
1562 |
</DIV> |
|
1563 |
<BR> |
|
1564 |
|
<hr class="separator" /> |
1565 |
<DIV CLASS="function"> |
<div class="notes">Redefined in descendants as:</div> |
1566 |
<A NAME='build_column_item'><!-- --></A> |
<ul class="redefinitions"> |
1567 |
<SPAN CLASS="font12bold">build_column_item</SPAN> |
<li> |
1568 |
<BR> |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a> |
1569 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</li> |
1570 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<li> |
1571 |
<span class="font10bold" style="color: #0000FF">build_column_item ( $row_data, $col_name )</SPAN> |
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_add_row_cell">SimpleGUIDataList::child_add_row_cell()</a> |
1572 |
<BR> |
</li> |
1573 |
|
<li> |
1574 |
<BR> |
<a href="../phpHtmlLib/ListAction.html#methodchild_add_row_cell">ListAction::child_add_row_cell()</a> |
1575 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</li> |
1576 |
<!-- ========== Info from phpDoc block ========= --> |
</ul> |
1577 |
This is the basic function for letting us |
</div> |
1578 |
do a mapping between the column name in |
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
1579 |
the header, to the value found in the DB. |
<div class="evenrow"> |
1580 |
<BR> |
|
1581 |
NOTE: this function is meant to be overridden |
<div class="method-header"> |
1582 |
so that you can push whatever you want. |
<span class="method-title">child_build_column_header</span> (line <span class="line-number">510</span>) |
1583 |
<DL> |
</div> |
1584 |
<DT class="font10bold">Function Parameters:</DT> |
|
1585 |
|
<!-- ========== Info from phpDoc block ========= --> |
1586 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$row_data</SPAN></SPAN> - - the entire data for the row</DD> |
<p class="short-description">This method is supposed to be written by the child class to build and add the column title to the UI</p> |
1587 |
|
|
1588 |
<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">$col_name</SPAN></SPAN> - - the name of the column header |
<div class="method-signature"> |
1589 |
for this row to render.</DD> |
<span class="method-result">void</span> |
1590 |
|
<span class="method-name"> |
1591 |
|
child_build_column_header |
1592 |
<DT class="font10bold">Function Info:</DT> |
</span> |
1593 |
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">array</span> <span class="var-name">$col_data</span>, <span class="var-type">int</span> <span class="var-name">$col_count</span>) |
1594 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either a HTMLTag object, or raw text.</DD> |
</div> |
1595 |
|
|
1596 |
</DL> |
<ul class="parameters"> |
1597 |
|
<li> |
1598 |
</DIV> |
<span class="var-type">string</span> |
1599 |
<BR> |
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the column</p></span> </li> |
1600 |
|
<li> |
1601 |
<DIV CLASS="function"> |
<span class="var-type">array</span> |
1602 |
<A NAME='build_column_url'><!-- --></A> |
<span class="var-name">$col_data</span><span class="var-description">: <p>- the column data ( from $this->_columns )</p></span> </li> |
1603 |
<SPAN CLASS="font12bold">build_column_url</SPAN> |
<li> |
1604 |
<BR> |
<span class="var-type">int</span> |
1605 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-name">$col_count</span><span class="var-description">: <p>- the column #</p></span> </li> |
1606 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/Atag.html">Atag</a></SPAN> |
</ul> |
1607 |
<span class="font10bold" style="color: #0000FF">build_column_url ( $col_name )</SPAN> |
|
1608 |
<BR> |
|
1609 |
|
<hr class="separator" /> |
1610 |
<BR> |
<div class="notes">Redefined in descendants as:</div> |
1611 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<ul class="redefinitions"> |
1612 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
1613 |
This builds a url for a particular |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_column_header">DefaultGUIDatalist::child_build_column_header()</a> |
1614 |
column header. |
</li> |
1615 |
<BR> |
<li> |
1616 |
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_build_column_header">SimpleGUIDataList::child_build_column_header()</a> |
1617 |
<DL> |
</li> |
1618 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
1619 |
|
<a href="../phpHtmlLib/ListAction.html#methodchild_build_column_header">ListAction::child_build_column_header()</a> |
1620 |
<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">$col_name</SPAN></SPAN> -</DD> |
</li> |
1621 |
|
</ul> |
1622 |
|
</div> |
1623 |
<DT class="font10bold">Function Info:</DT> |
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
1624 |
|
<div class="oddrow"> |
1625 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object;</DD> |
|
1626 |
|
<div class="method-header"> |
1627 |
</DL> |
<span class="method-title">child_build_search_table</span> (line <span class="line-number">557</span>) |
1628 |
|
</div> |
1629 |
</DIV> |
|
1630 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1631 |
|
<p class="short-description">This function builds the search block that lives above the results</p> |
1632 |
<DIV CLASS="function"> |
|
1633 |
<A NAME='build_gui'><!-- --></A> |
<div class="method-signature"> |
1634 |
<SPAN CLASS="font12bold">build_gui</SPAN> |
<span class="method-result">Container</span> |
1635 |
<BR> |
<span class="method-name"> |
1636 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
child_build_search_table |
1637 |
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
</span> |
1638 |
<span class="font10bold" style="color: #0000FF">build_gui ( )</SPAN> |
() |
1639 |
<BR> |
</div> |
1640 |
|
|
1641 |
<BR> |
|
1642 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1643 |
<!-- ========== Info from phpDoc block ========= --> |
<hr class="separator" /> |
1644 |
This function is responsible for calling the child |
<div class="notes">Redefined in descendants as:</div> |
1645 |
<BR> |
<ul class="redefinitions"> |
1646 |
class's methods for building the GUI container. |
<li> |
1647 |
This function builds the search area, the |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_search_table">DefaultGUIDatalist::child_build_search_table()</a> |
1648 |
title, page controls, the column headers, |
: This builds the table that holds the search capability. |
1649 |
and walks the rows of data and adds them |
</li> |
1650 |
|
</ul> |
1651 |
A child class can override this method to |
</div> |
1652 |
move the placement of the search box |
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
1653 |
relative to the data list. By default |
<div class="evenrow"> |
1654 |
the search area comes above the table |
|
1655 |
for the data list and page controls |
<div class="method-header"> |
1656 |
<DL> |
<span class="method-title">child_get_gui</span> (line <span class="line-number">544</span>) |
1657 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
1658 |
|
|
1659 |
|
<!-- ========== Info from phpDoc block ========= --> |
1660 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList</p> |
1661 |
|
|
1662 |
</DL> |
<div class="method-signature"> |
1663 |
|
<span class="method-result">Container</span> |
1664 |
</DIV> |
<span class="method-name"> |
1665 |
<BR> |
child_get_gui |
1666 |
|
</span> |
1667 |
<DIV CLASS="function"> |
() |
1668 |
<A NAME='build_orderby_querystring'><!-- --></A> |
</div> |
1669 |
<SPAN CLASS="font12bold">build_orderby_querystring</SPAN> |
|
1670 |
<BR> |
|
1671 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1672 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<hr class="separator" /> |
1673 |
<span class="font10bold" style="color: #0000FF">build_orderby_querystring ( )</SPAN> |
<div class="notes">Redefined in descendants as:</div> |
1674 |
<BR> |
<ul class="redefinitions"> |
1675 |
|
<li> |
1676 |
<BR> |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_get_gui">DefaultGUIDatalist::child_get_gui()</a> |
1677 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</li> |
1678 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
1679 |
This builds a query string var for the |
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_get_gui">SimpleGUIDataList::child_get_gui()</a> |
1680 |
orderby value. |
</li> |
1681 |
<BR> |
<li> |
1682 |
|
<a href="../phpHtmlLib/ListAction.html#methodchild_get_gui">ListAction::child_get_gui()</a> |
1683 |
<DL> |
</li> |
1684 |
<DT class="font10bold">Function Parameters:</DT> |
</ul> |
1685 |
|
</div> |
1686 |
|
<a name="methoddata_prefetch" id="data_prefetch"><!-- --></a> |
1687 |
<DT class="font10bold">Function Info:</DT> |
<div class="oddrow"> |
1688 |
|
|
1689 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - "orderby=(thevalue)"</DD> |
<div class="method-header"> |
1690 |
|
<span class="method-title">data_prefetch</span> (line <span class="line-number">805</span>) |
1691 |
</DL> |
</div> |
1692 |
|
|
1693 |
</DIV> |
<!-- ========== Info from phpDoc block ========= --> |
1694 |
<BR> |
<p class="short-description">This function is used to set up any</p> |
1695 |
|
<p class="description"><p>data that needs to be munged before the data is fetched from the DataListSource</p></p> |
1696 |
<DIV CLASS="function"> |
|
1697 |
<A NAME='build_reverseorder_querystring'><!-- --></A> |
<div class="method-signature"> |
1698 |
<SPAN CLASS="font12bold">build_reverseorder_querystring</SPAN> |
<span class="method-result">void</span> |
1699 |
<BR> |
<span class="method-name"> |
1700 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
data_prefetch |
1701 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</span> |
1702 |
<span class="font10bold" style="color: #0000FF">build_reverseorder_querystring ( )</SPAN> |
() |
1703 |
<BR> |
</div> |
1704 |
|
|
1705 |
<BR> |
|
1706 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1707 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1708 |
This builds a query string var for the |
<a name="methoddo_action" id="do_action"><!-- --></a> |
1709 |
reverseorder value. |
<div class="evenrow"> |
1710 |
<BR> |
|
1711 |
|
<div class="method-header"> |
1712 |
<DL> |
<span class="method-title">do_action</span> (line <span class="line-number">453</span>) |
1713 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
1714 |
|
|
1715 |
|
<!-- ========== Info from phpDoc block ========= --> |
1716 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This method is called prior to get_data_source and user_setup() to allow you to do some generic action on data. By default this does nothing.</p> |
1717 |
|
|
1718 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - "orderby=(thevalue)"</DD> |
<div class="method-signature"> |
1719 |
|
<span class="method-result">void</span> |
1720 |
</DL> |
<span class="method-name"> |
1721 |
|
do_action |
1722 |
</DIV> |
</span> |
1723 |
<BR> |
() |
1724 |
|
</div> |
1725 |
<DIV CLASS="function"> |
|
1726 |
<A NAME='build_searchfield_querystring'><!-- --></A> |
|
1727 |
<SPAN CLASS="font12bold">build_searchfield_querystring</SPAN> |
|
1728 |
<BR> |
</div> |
1729 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodfilter_column_string" id="filter_column_string"><!-- --></a> |
1730 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="oddrow"> |
1731 |
<span class="font10bold" style="color: #0000FF">build_searchfield_querystring ( )</SPAN> |
|
1732 |
<BR> |
<div class="method-header"> |
1733 |
|
<span class="method-title">filter_column_string</span> (line <span class="line-number">1664</span>) |
1734 |
<BR> |
</div> |
1735 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1736 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1737 |
This builds a query string var for the |
<p class="short-description">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</p> |
1738 |
searchfield value. |
<ul class="tags"> |
1739 |
<BR> |
<li><span class="field">return:</span> <p>the cleaned/filtered data</p></li> |
1740 |
|
</ul> |
1741 |
<DL> |
|
1742 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-signature"> |
1743 |
|
<span class="method-result">string</span> |
1744 |
|
<span class="method-name"> |
1745 |
<DT class="font10bold">Function Info:</DT> |
filter_column_string |
1746 |
|
</span> |
1747 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - "orderby=(thevalue)"</DD> |
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
1748 |
|
</div> |
1749 |
</DL> |
|
1750 |
|
<ul class="parameters"> |
1751 |
</DIV> |
<li> |
1752 |
<BR> |
<span class="var-type">string</span> |
1753 |
|
<span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li> |
1754 |
<DIV CLASS="function"> |
</ul> |
1755 |
<A NAME='build_searchvalue_querystring'><!-- --></A> |
|
1756 |
<SPAN CLASS="font12bold">build_searchvalue_querystring</SPAN> |
|
1757 |
<BR> |
</div> |
1758 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodget_current_page" id="get_current_page"><!-- --></a> |
1759 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="evenrow"> |
1760 |
<span class="font10bold" style="color: #0000FF">build_searchvalue_querystring ( )</SPAN> |
|
1761 |
<BR> |
<div class="method-header"> |
1762 |
|
<span class="method-title">get_current_page</span> (line <span class="line-number">1538</span>) |
1763 |
<BR> |
</div> |
1764 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1765 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1766 |
This builds a query string var for the |
<p class="short-description">This function returns the current page that the item list is on.</p> |
1767 |
searchfield value. |
|
1768 |
<BR> |
<div class="method-signature"> |
1769 |
|
<span class="method-result">int</span> |
1770 |
<DL> |
<span class="method-name"> |
1771 |
<DT class="font10bold">Function Parameters:</DT> |
get_current_page |
1772 |
|
</span> |
1773 |
|
() |
1774 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1775 |
|
|
1776 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - "orderby=(thevalue)"</DD> |
|
1777 |
|
|
1778 |
</DL> |
</div> |
1779 |
|
<a name="methodget_data_source" id="get_data_source"><!-- --></a> |
1780 |
</DIV> |
<div class="oddrow"> |
1781 |
<BR> |
|
1782 |
|
<div class="method-header"> |
1783 |
<DIV CLASS="function"> |
<span class="method-title">get_data_source</span> (line <span class="line-number">465</span>) |
1784 |
<A NAME='build_state_vars_query_string'><!-- --></A> |
</div> |
1785 |
<SPAN CLASS="font12bold">build_state_vars_query_string</SPAN> |
|
1786 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1787 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<p class="short-description">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</p> |
1788 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
1789 |
<span class="font10bold" style="color: #0000FF">build_state_vars_query_string ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</SPAN> |
<div class="method-signature"> |
1790 |
<BR> |
<span class="method-result">void</span> |
1791 |
|
<span class="method-name"> |
1792 |
<BR> |
get_data_source |
1793 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</span> |
1794 |
<!-- ========== Info from phpDoc block ========= --> |
() |
1795 |
this function is used to build a sub query string |
</div> |
1796 |
of all of the query string vars to save the |
|
1797 |
state of the DBItemList. |
|
1798 |
<BR> |
|
1799 |
This is used for pages |
</div> |
1800 |
that want to come back to the list at the same state |
<a name="methodget_default_num_rows" id="get_default_num_rows"><!-- --></a> |
1801 |
<DL> |
<div class="evenrow"> |
1802 |
<DT class="font10bold">Function Parameters:</DT> |
|
1803 |
|
<div class="method-header"> |
1804 |
|
<span class="method-title">get_default_num_rows</span> (line <span class="line-number">771</span>) |
1805 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1806 |
|
|
1807 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - name=value& pairs</DD> |
<!-- ========== Info from phpDoc block ========= --> |
1808 |
|
<p class="short-description">This function gets the current default number of rows to display setting.</p> |
1809 |
</DL> |
|
1810 |
|
<div class="method-signature"> |
1811 |
</DIV> |
<span class="method-result">int</span> |
1812 |
<BR> |
<span class="method-name"> |
1813 |
|
get_default_num_rows |
1814 |
<DIV CLASS="function"> |
</span> |
1815 |
<A NAME='build_tool_link'><!-- --></A> |
() |
1816 |
<SPAN CLASS="font12bold">build_tool_link</SPAN> |
</div> |
1817 |
<BR> |
|
1818 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1819 |
<span class="font10bold" style="color: #FF0000">Object</SPAN> |
|
1820 |
<span class="font10bold" style="color: #0000FF">build_tool_link ( $which )</SPAN> |
</div> |
1821 |
<BR> |
<a name="methodget_form_action" id="get_form_action"><!-- --></a> |
1822 |
|
<div class="oddrow"> |
1823 |
<BR> |
|
1824 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-header"> |
1825 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-title">get_form_action</span> (line <span class="line-number">1187</span>) |
1826 |
This function builds the 'tool' images that |
</div> |
1827 |
allow you to walk through the data list itself. |
|
1828 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1829 |
It provides image links for |
<p class="short-description">This function is used to get the form action</p> |
1830 |
first - go to the first page in the data list |
<ul class="tags"> |
1831 |
prev - go to the previous page in the data list |
<li><span class="field">return:</span> <p>(POST or GET)</p></li> |
1832 |
next - go to the next page in the data list |
</ul> |
1833 |
last - go to the last page in the data list |
|
1834 |
all - show the rest of the list from the current offset |
<div class="method-signature"> |
1835 |
<DL> |
<span class="method-result">string</span> |
1836 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
1837 |
|
get_form_action |
1838 |
<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">$which</SPAN></SPAN> - which tool image to build</DD> |
</span> |
1839 |
|
() |
1840 |
|
</div> |
1841 |
<DT class="font10bold">Function Info:</DT> |
|
1842 |
|
|
1843 |
</DL> |
|
1844 |
|
</div> |
1845 |
</DIV> |
<a name="methodget_form_method" id="get_form_method"><!-- --></a> |
1846 |
<BR> |
<div class="evenrow"> |
1847 |
|
|
1848 |
<DIV CLASS="function"> |
<div class="method-header"> |
1849 |
<A NAME='child_add_row_cell'><!-- --></A> |
<span class="method-title">get_form_method</span> (line <span class="line-number">1168</span>) |
1850 |
<SPAN CLASS="font12bold">child_add_row_cell</SPAN> |
</div> |
1851 |
<BR> |
|
1852 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
1853 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<p class="short-description">This function is used to get the form method</p> |
1854 |
<span class="font10bold" style="color: #0000FF">child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</SPAN> |
<ul class="tags"> |
1855 |
<BR> |
<li><span class="field">return:</span> <p>(POST or GET)</p></li> |
1856 |
Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a><br> |
</ul> |
1857 |
<BR> |
|
1858 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-signature"> |
1859 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-result">string</span> |
1860 |
This method is supposed to be written by |
<span class="method-name"> |
1861 |
<BR> |
get_form_method |
1862 |
the child class to add the cell data to the |
</span> |
1863 |
current row in the UI |
() |
1864 |
<DL> |
</div> |
1865 |
<DT class="font10bold">Function Parameters:</DT> |
|
1866 |
|
|
1867 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$obj</SPAN></SPAN> - the object/string/entity that |
|
1868 |
should get put into the column row cell.</DD> |
</div> |
1869 |
|
<a name="methodget_form_name" id="get_form_name"><!-- --></a> |
1870 |
<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">$col_name</SPAN></SPAN> - the name/title of the column that the |
<div class="oddrow"> |
1871 |
object will live in</DD> |
|
1872 |
|
<div class="method-header"> |
1873 |
<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">$last_in_row_flag</SPAN></SPAN> - flag that tells the function if this is |
<span class="method-title">get_form_name</span> (line <span class="line-number">1124</span>) |
1874 |
is the last cell for the current row.</DD> |
</div> |
1875 |
|
|
1876 |
|
<!-- ========== Info from phpDoc block ========= --> |
1877 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This function is used to get the form name</p> |
1878 |
|
|
1879 |
</DL> |
<div class="method-signature"> |
1880 |
|
<span class="method-result">string</span> |
1881 |
</DIV> |
<span class="method-name"> |
1882 |
<BR> |
get_form_name |
1883 |
|
</span> |
1884 |
<DIV CLASS="function"> |
() |
1885 |
<A NAME='child_build_column_header'><!-- --></A> |
</div> |
1886 |
<SPAN CLASS="font12bold">child_build_column_header</SPAN> |
|
1887 |
<BR> |
|
1888 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1889 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
1890 |
<span class="font10bold" style="color: #0000FF">child_build_column_header ( $title, $col_data, $col_count )</SPAN> |
<a name="methodget_form_render" id="get_form_render"><!-- --></a> |
1891 |
<BR> |
<div class="evenrow"> |
1892 |
Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_build_column_header">DefaultGUIDatalist::child_build_column_header()</a><br> |
|
1893 |
<BR> |
<div class="method-header"> |
1894 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-title">get_form_render</span> (line <span class="line-number">1205</span>) |
1895 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1896 |
This method is supposed to be written by |
|
1897 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1898 |
the child class to build and add the column |
<p class="short-description">Return the state of the form render</p> |
1899 |
title to the UI |
|
1900 |
<DL> |
<div class="method-signature"> |
1901 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">bool</span> |
1902 |
|
<span class="method-name"> |
1903 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$this-</SPAN></SPAN> - the column data ( from >_columns )</DD> |
get_form_render |
1904 |
|
</span> |
1905 |
<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> |
() |
1906 |
|
</div> |
1907 |
<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">$col_data</SPAN></SPAN> - the column #</DD> |
|
1908 |
|
|
1909 |
|
|
1910 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1911 |
|
<a name="methodget_form_target" id="get_form_target"><!-- --></a> |
1912 |
</DL> |
<div class="oddrow"> |
1913 |
|
|
1914 |
</DIV> |
<div class="method-header"> |
1915 |
<BR> |
<span class="method-title">get_form_target</span> (line <span class="line-number">1144</span>) |
1916 |
|
</div> |
1917 |
<DIV CLASS="function"> |
|
1918 |
<A NAME='child_build_search_table'><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
1919 |
<SPAN CLASS="font12bold">child_build_search_table</SPAN> |
<p class="short-description">This function is used to get the form target</p> |
1920 |
<BR> |
|
1921 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="method-signature"> |
1922 |
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
<span class="method-result">string</span> |
1923 |
<span class="font10bold" style="color: #0000FF">child_build_search_table ( )</SPAN> |
<span class="method-name"> |
1924 |
<BR> |
get_form_target |
1925 |
Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_build_search_table">DefaultGUIDatalist::child_build_search_table()</a><br> |
</span> |
1926 |
<BR> |
() |
1927 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1928 |
<!-- ========== Info from phpDoc block ========= --> |
|
1929 |
This function builds the search |
|
1930 |
block that lives above the results |
|
1931 |
<BR> |
</div> |
1932 |
|
<a name="methodget_global_prefix" id="get_global_prefix"><!-- --></a> |
1933 |
<DL> |
<div class="evenrow"> |
1934 |
<DT class="font10bold">Function Parameters:</DT> |
|
1935 |
|
<div class="method-header"> |
1936 |
|
<span class="method-title">get_global_prefix</span> (line <span class="line-number">635</span>) |
1937 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1938 |
|
|
1939 |
</DL> |
<!-- ========== Info from phpDoc block ========= --> |
1940 |
|
<p class="short-description">returns the current variable prefix string being used.</p> |
1941 |
</DIV> |
<ul class="tags"> |
1942 |
<BR> |
<li><span class="field">return:</span> <p>- current global prefix</p></li> |
1943 |
|
</ul> |
1944 |
<DIV CLASS="function"> |
|
1945 |
<A NAME='child_get_gui'><!-- --></A> |
<div class="method-signature"> |
1946 |
<SPAN CLASS="font12bold">child_get_gui</SPAN> |
<span class="method-result">string</span> |
1947 |
<BR> |
<span class="method-name"> |
1948 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
get_global_prefix |
1949 |
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
</span> |
1950 |
<span class="font10bold" style="color: #0000FF">child_get_gui ( )</SPAN> |
() |
1951 |
<BR> |
</div> |
1952 |
Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#child_get_gui">DefaultGUIDatalist::child_get_gui()</a><br> |
|
1953 |
<BR> |
|
1954 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1955 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
1956 |
This function is called after all of the data has |
<a name="methodget_image_path" id="get_image_path"><!-- --></a> |
1957 |
been added to the UI object. |
<div class="oddrow"> |
1958 |
<BR> |
|
1959 |
It just returns the |
<div class="method-header"> |
1960 |
container that is the entire UI for the DataList |
<span class="method-title">get_image_path</span> (line <span class="line-number">1518</span>) |
1961 |
<DL> |
</div> |
1962 |
<DT class="font10bold">Function Parameters:</DT> |
|
1963 |
|
<!-- ========== Info from phpDoc block ========= --> |
1964 |
|
<p class="short-description">This function returns the path to the images used in this class</p> |
1965 |
<DT class="font10bold">Function Info:</DT> |
|
1966 |
|
<div class="method-signature"> |
1967 |
</DL> |
<span class="method-result">string</span> |
1968 |
|
<span class="method-name"> |
1969 |
</DIV> |
get_image_path |
1970 |
<BR> |
</span> |
1971 |
|
() |
1972 |
<DIV CLASS="function"> |
</div> |
1973 |
<A NAME='data_prefetch'><!-- --></A> |
|
1974 |
<SPAN CLASS="font12bold">data_prefetch</SPAN> |
|
1975 |
<BR> |
|
1976 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
1977 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<a name="methodget_last_page" id="get_last_page"><!-- --></a> |
1978 |
<span class="font10bold" style="color: #0000FF">data_prefetch ( )</SPAN> |
<div class="evenrow"> |
1979 |
<BR> |
|
1980 |
|
<div class="method-header"> |
1981 |
<BR> |
<span class="method-title">get_last_page</span> (line <span class="line-number">1566</span>) |
1982 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1983 |
<!-- ========== Info from phpDoc block ========= --> |
|
1984 |
This function is used to set up any |
<!-- ========== Info from phpDoc block ========= --> |
1985 |
<BR> |
<p class="short-description">This calculates the last page # for this list of items</p> |
1986 |
data that needs to be munged before the |
|
1987 |
data is fetched from the DataListSource |
<div class="method-signature"> |
1988 |
<DL> |
<span class="method-result">int</span> |
1989 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
1990 |
|
get_last_page |
1991 |
|
</span> |
1992 |
<DT class="font10bold">Function Info:</DT> |
() |
1993 |
|
</div> |
1994 |
</DL> |
|
1995 |
|
|
1996 |
</DIV> |
|
1997 |
<BR> |
</div> |
1998 |
|
<a name="methodget_max_rows" id="get_max_rows"><!-- --></a> |
1999 |
<DIV CLASS="function"> |
<div class="oddrow"> |
2000 |
<A NAME='filter_column_string'><!-- --></A> |
|
2001 |
<SPAN CLASS="font12bold">filter_column_string</SPAN> |
<div class="method-header"> |
2002 |
<BR> |
<span class="method-title">get_max_rows</span> (line <span class="line-number">781</span>) |
2003 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2004 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
2005 |
<span class="font10bold" style="color: #0000FF">filter_column_string ( $data )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2006 |
<BR> |
<p class="short-description">This returns the Maximum # of rows to display when in expand mode</p> |
2007 |
|
|
2008 |
<BR> |
<div class="method-signature"> |
2009 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">int</span> |
2010 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
2011 |
This does some magic filtering on the data |
get_max_rows |
2012 |
that we display in a column. |
</span> |
2013 |
<BR> |
() |
2014 |
This helps |
</div> |
2015 |
to prevent nast data that may have html |
|
2016 |
tags in it. |
|
2017 |
<DL> |
|
2018 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2019 |
|
<a name="methodget_num_pages" id="get_num_pages"><!-- --></a> |
2020 |
<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</SPAN></SPAN> - the column data u want to filter</DD> |
<div class="evenrow"> |
2021 |
|
|
2022 |
|
<div class="method-header"> |
2023 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-title">get_num_pages</span> (line <span class="line-number">1549</span>) |
2024 |
|
</div> |
2025 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the cleaned/filtered data</DD> |
|
2026 |
|
<!-- ========== Info from phpDoc block ========= --> |
2027 |
</DL> |
<p class="short-description">This function returns the # of pages that are available for this list of items.</p> |
2028 |
|
|
2029 |
</DIV> |
<div class="method-signature"> |
2030 |
<BR> |
<span class="method-result">int</span> |
2031 |
|
<span class="method-name"> |
2032 |
<DIV CLASS="function"> |
get_num_pages |
2033 |
<A NAME='get_current_page'><!-- --></A> |
</span> |
2034 |
<SPAN CLASS="font12bold">get_current_page</SPAN> |
() |
2035 |
<BR> |
</div> |
2036 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2037 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
2038 |
<span class="font10bold" style="color: #0000FF">get_current_page ( )</SPAN> |
|
2039 |
<BR> |
</div> |
2040 |
|
<a name="methodget_page_info" id="get_page_info"><!-- --></a> |
2041 |
<BR> |
<div class="oddrow"> |
2042 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2043 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
2044 |
This function returns the current |
<span class="method-title">get_page_info</span> (line <span class="line-number">1577</span>) |
2045 |
page that the item list is on. |
</div> |
2046 |
<BR> |
|
2047 |
|
<!-- ========== Info from phpDoc block ========= --> |
2048 |
<DL> |
<p class="short-description">This function builds the string that describes the current page out of n pages the list is showing</p> |
2049 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="tags"> |
2050 |
|
<li><span class="field">return:</span> <p>(ie. 1 to 10 of 25)</p></li> |
2051 |
|
</ul> |
2052 |
<DT class="font10bold">Function Info:</DT> |
|
2053 |
|
<div class="method-signature"> |
2054 |
</DL> |
<span class="method-result">string</span> |
2055 |
|
<span class="method-name"> |
2056 |
</DIV> |
get_page_info |
2057 |
<BR> |
</span> |
2058 |
|
() |
2059 |
<DIV CLASS="function"> |
</div> |
2060 |
<A NAME='get_data_source'><!-- --></A> |
|
2061 |
<SPAN CLASS="font12bold">get_data_source</SPAN> |
|
2062 |
<BR> |
|
2063 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2064 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<a name="methodget_simple_search_modifier" id="get_simple_search_modifier"><!-- --></a> |
2065 |
<span class="font10bold" style="color: #0000FF">get_data_source ( )</SPAN> |
<div class="evenrow"> |
2066 |
<BR> |
|
2067 |
|
<div class="method-header"> |
2068 |
<BR> |
<span class="method-title">get_simple_search_modifier</span> (line <span class="line-number">750</span>) |
2069 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
2070 |
<!-- ========== Info from phpDoc block ========= --> |
|
2071 |
This function is called automatically by |
<!-- ========== Info from phpDoc block ========= --> |
2072 |
the DataList constructor. |
<p class="short-description">gets the value of the search modifier flag.</p> |
2073 |
<BR> |
|
2074 |
It must be |
<div class="method-signature"> |
2075 |
extended by the child class to actually |
<span class="method-result">void</span> |
2076 |
set the DataListSource object. |
<span class="method-name"> |
2077 |
<DL> |
get_simple_search_modifier |
2078 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
2079 |
|
() |
2080 |
|
</div> |
2081 |
<DT class="font10bold">Function Info:</DT> |
|
2082 |
|
|
2083 |
</DL> |
|
2084 |
|
</div> |
2085 |
</DIV> |
<a name="methodgui_init" id="gui_init"><!-- --></a> |
2086 |
<BR> |
<div class="oddrow"> |
2087 |
|
|
2088 |
<DIV CLASS="function"> |
<div class="method-header"> |
2089 |
<A NAME='get_default_num_rows'><!-- --></A> |
<span class="method-title">gui_init</span> (line <span class="line-number">492</span>) |
2090 |
<SPAN CLASS="font12bold">get_default_num_rows</SPAN> |
</div> |
2091 |
<BR> |
|
2092 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2093 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<p class="short-description">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</p> |
2094 |
<span class="font10bold" style="color: #0000FF">get_default_num_rows ( )</SPAN> |
|
2095 |
<BR> |
<div class="method-signature"> |
2096 |
|
<span class="method-result">void</span> |
2097 |
<BR> |
<span class="method-name"> |
2098 |
<SPAN CLASS="font10bold">Description : </SPAN> |
gui_init |
2099 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
2100 |
This function gets the current default |
() |
2101 |
number of rows to display setting. |
</div> |
2102 |
<BR> |
|
2103 |
|
|
2104 |
<DL> |
|
2105 |
<DT class="font10bold">Function Parameters:</DT> |
<hr class="separator" /> |
2106 |
|
<div class="notes">Redefined in descendants as:</div> |
2107 |
|
<ul class="redefinitions"> |
2108 |
<DT class="font10bold">Function Info:</DT> |
<li> |
2109 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodgui_init">DefaultGUIDatalist::gui_init()</a> |
2110 |
</DL> |
</li> |
2111 |
|
<li> |
2112 |
</DIV> |
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodgui_init">SimpleGUIDataList::gui_init()</a> |
2113 |
<BR> |
: Initialize the gui layout |
2114 |
|
</li> |
2115 |
<DIV CLASS="function"> |
<li> |
2116 |
<A NAME='get_form_action'><!-- --></A> |
<a href="../phpHtmlLib/ListAction.html#methodgui_init">ListAction::gui_init()</a> |
2117 |
<SPAN CLASS="font12bold">get_form_action</SPAN> |
: Initialize the gui layout |
2118 |
<BR> |
</li> |
2119 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</ul> |
2120 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</div> |
2121 |
<span class="font10bold" style="color: #0000FF">get_form_action ( )</SPAN> |
<a name="methodis_advanced_search_enabled" id="is_advanced_search_enabled"><!-- --></a> |
2122 |
<BR> |
<div class="evenrow"> |
2123 |
|
|
2124 |
<BR> |
<div class="method-header"> |
2125 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-title">is_advanced_search_enabled</span> (line <span class="line-number">710</span>) |
2126 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2127 |
This function is used to get |
|
2128 |
the form action |
<!-- ========== Info from phpDoc block ========= --> |
2129 |
<BR> |
<p class="short-description">This returns the status of the advanced search flag.</p> |
2130 |
|
|
2131 |
<DL> |
<div class="method-signature"> |
2132 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">boolean</span> |
2133 |
|
<span class="method-name"> |
2134 |
|
is_advanced_search_enabled |
2135 |
<DT class="font10bold">Function Info:</DT> |
</span> |
2136 |
|
() |
2137 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (POST or GET)</DD> |
</div> |
2138 |
|
|
2139 |
</DL> |
|
2140 |
|
|
2141 |
</DIV> |
</div> |
2142 |
<BR> |
<a name="methodis_search_enabled" id="is_search_enabled"><!-- --></a> |
2143 |
|
<div class="oddrow"> |
2144 |
<DIV CLASS="function"> |
|
2145 |
<A NAME='get_form_method'><!-- --></A> |
<div class="method-header"> |
2146 |
<SPAN CLASS="font12bold">get_form_method</SPAN> |
<span class="method-title">is_search_enabled</span> (line <span class="line-number">676</span>) |
2147 |
<BR> |
</div> |
2148 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2149 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2150 |
<span class="font10bold" style="color: #0000FF">get_form_method ( )</SPAN> |
<p class="short-description">get the status of the search ability.</p> |
2151 |
<BR> |
|
2152 |
|
<div class="method-signature"> |
2153 |
<BR> |
<span class="method-result">boolean</span> |
2154 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-name"> |
2155 |
<!-- ========== Info from phpDoc block ========= --> |
is_search_enabled |
2156 |
This function is used to get |
</span> |
2157 |
the form method |
() |
2158 |
<BR> |
</div> |
2159 |
|
|
2160 |
<DL> |
|
2161 |
<DT class="font10bold">Function Parameters:</DT> |
|
2162 |
|
</div> |
2163 |
|
<a name="methodnumrows" id="numrows"><!-- --></a> |
2164 |
<DT class="font10bold">Function Info:</DT> |
<div class="evenrow"> |
2165 |
|
|
2166 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (POST or GET)</DD> |
<div class="method-header"> |
2167 |
|
<span class="method-title">numrows</span> (line <span class="line-number">968</span>) |
2168 |
</DL> |
</div> |
2169 |
|
|
2170 |
</DIV> |
<!-- ========== Info from phpDoc block ========= --> |
2171 |
<BR> |
<p class="short-description">This function returns the number of rows that the query found.</p> |
2172 |
|
<ul class="tags"> |
2173 |
<DIV CLASS="function"> |
<li><span class="field">return:</span> <p>- the number of rows</p></li> |
2174 |
<A NAME='get_form_name'><!-- --></A> |
</ul> |
2175 |
<SPAN CLASS="font12bold">get_form_name</SPAN> |
|
2176 |
<BR> |
<div class="method-signature"> |
2177 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-result">int</span> |
2178 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="method-name"> |
2179 |
<span class="font10bold" style="color: #0000FF">get_form_name ( )</SPAN> |
numrows |
2180 |
<BR> |
</span> |
2181 |
|
() |
2182 |
<BR> |
</div> |
2183 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2184 |
<!-- ========== Info from phpDoc block ========= --> |
|
2185 |
This function is used to get |
|
2186 |
the form name |
</div> |
2187 |
<BR> |
<a name="methodoffset" id="offset"><!-- --></a> |
2188 |
|
<div class="oddrow"> |
2189 |
<DL> |
|
2190 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-header"> |
2191 |
|
<span class="method-title">offset</span> (line <span class="line-number">896</span>) |
2192 |
|
</div> |
2193 |
<DT class="font10bold">Function Info:</DT> |
|
2194 |
|
<!-- ========== Info from phpDoc block ========= --> |
2195 |
</DL> |
<p class="short-description">This function returns the current value of the offset variable. This is an offset into the query return data set.</p> |
2196 |
|
<ul class="tags"> |
2197 |
</DIV> |
<li><span class="field">return:</span> <p>- the current value.</p></li> |
2198 |
<BR> |
</ul> |
2199 |
|
|
2200 |
<DIV CLASS="function"> |
<div class="method-signature"> |
2201 |
<A NAME='get_form_render'><!-- --></A> |
<span class="method-result">int</span> |
2202 |
<SPAN CLASS="font12bold">get_form_render</SPAN> |
<span class="method-name"> |
2203 |
<BR> |
offset |
2204 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
2205 |
<span class="font10bold" style="color: #FF0000">bool</SPAN> |
() |
2206 |
<span class="font10bold" style="color: #0000FF">get_form_render ( )</SPAN> |
</div> |
2207 |
<BR> |
|
2208 |
|
|
2209 |
<BR> |
|
2210 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
2211 |
<!-- ========== Info from phpDoc block ========= --> |
<a name="methodorderby" id="orderby"><!-- --></a> |
2212 |
Return the state of the form render |
<div class="evenrow"> |
2213 |
<BR> |
|
2214 |
|
<div class="method-header"> |
2215 |
<DL> |
<span class="method-title">orderby</span> (line <span class="line-number">916</span>) |
2216 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2217 |
|
|
2218 |
|
<!-- ========== Info from phpDoc block ========= --> |
2219 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This function returns the value of the current orderby variable.</p> |
2220 |
|
|
2221 |
</DL> |
<div class="method-signature"> |
2222 |
|
<span class="method-result">string.</span> |
2223 |
</DIV> |
<span class="method-name"> |
2224 |
<BR> |
orderby |
2225 |
|
</span> |
2226 |
<DIV CLASS="function"> |
() |
2227 |
<A NAME='get_form_target'><!-- --></A> |
</div> |
2228 |
<SPAN CLASS="font12bold">get_form_target</SPAN> |
|
2229 |
<BR> |
|
2230 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2231 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</div> |
2232 |
<span class="font10bold" style="color: #0000FF">get_form_target ( )</SPAN> |
<a name="methodrender" id="render"><!-- --></a> |
2233 |
<BR> |
<div class="oddrow"> |
2234 |
|
|
2235 |
<BR> |
<div class="method-header"> |
2236 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-title">render</span> (line <span class="line-number">321</span>) |
2237 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2238 |
This function is used to get |
|
2239 |
the form target |
<!-- ========== Info from phpDoc block ========= --> |
2240 |
<BR> |
<p class="short-description">This function renders the final</p> |
2241 |
|
<p class="description"><p>widget</p></p> |
2242 |
<DL> |
|
2243 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-signature"> |
2244 |
|
<span class="method-result">void</span> |
2245 |
|
<span class="method-name"> |
2246 |
<DT class="font10bold">Function Info:</DT> |
render |
2247 |
|
</span> |
2248 |
</DL> |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
2249 |
|
</div> |
2250 |
</DIV> |
|
2251 |
<BR> |
|
2252 |
|
<hr class="separator" /> |
2253 |
<DIV CLASS="function"> |
<div class="notes">Redefinition of:</div> |
2254 |
<A NAME='get_global_prefix'><!-- --></A> |
<dl> |
2255 |
<SPAN CLASS="font12bold">get_global_prefix</SPAN> |
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
2256 |
<BR> |
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
2257 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</dl> |
2258 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
2259 |
<span class="font10bold" style="color: #0000FF">get_global_prefix ( )</SPAN> |
</div> |
2260 |
<BR> |
<a name="methodreverseorder" id="reverseorder"><!-- --></a> |
2261 |
|
<div class="evenrow"> |
2262 |
<BR> |
|
2263 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-header"> |
2264 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-title">reverseorder</span> (line <span class="line-number">937</span>) |
2265 |
returns the current variable prefix |
</div> |
2266 |
string being used. |
|
2267 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
2268 |
|
<p class="short-description">This function returns the current value of the reverse order member variable.</p> |
2269 |
<DL> |
|
2270 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-signature"> |
2271 |
|
<span class="method-result">string.</span> |
2272 |
|
<span class="method-name"> |
2273 |
<DT class="font10bold">Function Info:</DT> |
reverseorder |
2274 |
|
</span> |
2275 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - current global prefix</DD> |
() |
2276 |
|
</div> |
2277 |
</DL> |
|
2278 |
|
|
2279 |
</DIV> |
|
2280 |
<BR> |
</div> |
2281 |
|
<a name="methodsearch_disable" id="search_disable"><!-- --></a> |
2282 |
<DIV CLASS="function"> |
<div class="oddrow"> |
2283 |
<A NAME='get_image_path'><!-- --></A> |
|
2284 |
<SPAN CLASS="font12bold">get_image_path</SPAN> |
<div class="method-header"> |
2285 |
<BR> |
<span class="method-title">search_disable</span> (line <span class="line-number">666</span>) |
2286 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2287 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
2288 |
<span class="font10bold" style="color: #0000FF">get_image_path ( )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2289 |
<BR> |
<p class="short-description">Disable the search ability.</p> |
2290 |
|
|
2291 |
<BR> |
<div class="method-signature"> |
2292 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">void</span> |
2293 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
2294 |
This function returns the path to the |
search_disable |
2295 |
images used in this class |
</span> |
2296 |
<BR> |
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
2297 |
|
</div> |
2298 |
<DL> |
|
2299 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="parameters"> |
2300 |
|
<li> |
2301 |
|
<span class="var-type">boolean</span> |
2302 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-name">0</span> </li> |
2303 |
|
</ul> |
2304 |
</DL> |
|
2305 |
|
|
2306 |
</DIV> |
</div> |
2307 |
<BR> |
<a name="methodsearch_enable" id="search_enable"><!-- --></a> |
2308 |
|
<div class="evenrow"> |
2309 |
<DIV CLASS="function"> |
|
2310 |
<A NAME='get_last_page'><!-- --></A> |
<div class="method-header"> |
2311 |
<SPAN CLASS="font12bold">get_last_page</SPAN> |
<span class="method-title">search_enable</span> (line <span class="line-number">654</span>) |
2312 |
<BR> |
</div> |
2313 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2314 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2315 |
<span class="font10bold" style="color: #0000FF">get_last_page ( )</SPAN> |
<p class="short-description">Enable the search ability.</p> |
2316 |
<BR> |
|
2317 |
|
<div class="method-signature"> |
2318 |
<BR> |
<span class="method-result">void</span> |
2319 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-name"> |
2320 |
<!-- ========== Info from phpDoc block ========= --> |
search_enable |
2321 |
This calculates the last page # |
</span> |
2322 |
for this list of items |
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
2323 |
<BR> |
</div> |
2324 |
|
|
2325 |
<DL> |
<ul class="parameters"> |
2326 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
2327 |
|
<span class="var-type">boolean</span> |
2328 |
|
<span class="var-name">0</span> </li> |
2329 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
2330 |
|
|
2331 |
</DL> |
|
2332 |
|
</div> |
2333 |
</DIV> |
<a name="methodsearch_field" id="search_field"><!-- --></a> |
2334 |
<BR> |
<div class="oddrow"> |
2335 |
|
|
2336 |
<DIV CLASS="function"> |
<div class="method-header"> |
2337 |
<A NAME='get_max_rows'><!-- --></A> |
<span class="method-title">search_field</span> (line <span class="line-number">988</span>) |
2338 |
<SPAN CLASS="font12bold">get_max_rows</SPAN> |
</div> |
2339 |
<BR> |
|
2340 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2341 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<p class="short-description">returns the current value of the search field name</p> |
2342 |
<span class="font10bold" style="color: #0000FF">get_max_rows ( )</SPAN> |
|
2343 |
<BR> |
<div class="method-signature"> |
2344 |
|
<span class="method-result">string</span> |
2345 |
<BR> |
<span class="method-name"> |
2346 |
<SPAN CLASS="font10bold">Description : </SPAN> |
search_field |
2347 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
2348 |
This returns the Maximum # of rows to |
() |
2349 |
display when in expand mode |
</div> |
2350 |
<BR> |
|
2351 |
|
|
2352 |
<DL> |
|
2353 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2354 |
|
<a name="methodsearch_type" id="search_type"><!-- --></a> |
2355 |
|
<div class="evenrow"> |
2356 |
<DT class="font10bold">Function Info:</DT> |
|
2357 |
|
<div class="method-header"> |
2358 |
</DL> |
<span class="method-title">search_type</span> (line <span class="line-number">1040</span>) |
2359 |
|
</div> |
2360 |
</DIV> |
|
2361 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
2362 |
|
<p class="short-description">returns the type of search being used</p> |
2363 |
<DIV CLASS="function"> |
|
2364 |
<A NAME='get_num_pages'><!-- --></A> |
<div class="method-signature"> |
2365 |
<SPAN CLASS="font12bold">get_num_pages</SPAN> |
<span class="method-result">string</span> |
2366 |
<BR> |
<span class="method-name"> |
2367 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
search_type |
2368 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
</span> |
2369 |
<span class="font10bold" style="color: #0000FF">get_num_pages ( )</SPAN> |
() |
2370 |
<BR> |
</div> |
2371 |
|
|
2372 |
<BR> |
|
2373 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2374 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2375 |
This function returns the # |
<a name="methodsearch_value" id="search_value"><!-- --></a> |
2376 |
of pages that are available |
<div class="oddrow"> |
2377 |
for this list of items. |
|
2378 |
<BR> |
<div class="method-header"> |
2379 |
|
<span class="method-title">search_value</span> (line <span class="line-number">1009</span>) |
2380 |
<DL> |
</div> |
2381 |
<DT class="font10bold">Function Parameters:</DT> |
|
2382 |
|
<!-- ========== Info from phpDoc block ========= --> |
2383 |
|
<p class="short-description">returns the current value of te search field value.</p> |
2384 |
<DT class="font10bold">Function Info:</DT> |
|
2385 |
|
<div class="method-signature"> |
2386 |
</DL> |
<span class="method-result">string</span> |
2387 |
|
<span class="method-name"> |
2388 |
</DIV> |
search_value |
2389 |
<BR> |
</span> |
2390 |
|
() |
2391 |
<DIV CLASS="function"> |
</div> |
2392 |
<A NAME='get_page_info'><!-- --></A> |
|
2393 |
<SPAN CLASS="font12bold">get_page_info</SPAN> |
|
2394 |
<BR> |
|
2395 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2396 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a> |
2397 |
<span class="font10bold" style="color: #0000FF">get_page_info ( )</SPAN> |
<div class="evenrow"> |
2398 |
<BR> |
|
2399 |
|
<div class="method-header"> |
2400 |
<BR> |
<span class="method-title">search_value_filter</span> (line <span class="line-number">1756</span>) |
2401 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
2402 |
<!-- ========== Info from phpDoc block ========= --> |
|
2403 |
This function builds the string |
<!-- ========== Info from phpDoc block ========= --> |
2404 |
<BR> |
<p class="short-description">This function is used to make safe any query string value that is used</p> |
2405 |
that describes the current page |
|
2406 |
out of n pages the list is showing |
<div class="method-signature"> |
2407 |
<DL> |
<span class="method-result">string</span> |
2408 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
2409 |
|
search_value_filter |
2410 |
|
</span> |
2411 |
<DT class="font10bold">Function Info:</DT> |
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
2412 |
|
</div> |
2413 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - (ie. 1 to 10 of 25)</DD> |
|
2414 |
|
<ul class="parameters"> |
2415 |
</DL> |
<li> |
2416 |
|
<span class="var-type">string</span> |
2417 |
</DIV> |
<span class="var-name">$value</span> </li> |
2418 |
<BR> |
</ul> |
2419 |
|
|
2420 |
<DIV CLASS="function"> |
|
2421 |
<A NAME='get_simple_search_modifier'><!-- --></A> |
</div> |
2422 |
<SPAN CLASS="font12bold">get_simple_search_modifier</SPAN> |
<a name="methodsetup_columns" id="setup_columns"><!-- --></a> |
2423 |
<BR> |
<div class="oddrow"> |
2424 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2425 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-header"> |
2426 |
<span class="font10bold" style="color: #0000FF">get_simple_search_modifier ( )</SPAN> |
<span class="method-title">setup_columns</span> (line <span class="line-number">827</span>) |
2427 |
<BR> |
</div> |
2428 |
|
|
2429 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
2430 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2431 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
2432 |
gets the value of the search modifier |
<span class="method-result">void</span> |
2433 |
flag. |
<span class="method-name"> |
2434 |
<BR> |
setup_columns |
2435 |
|
</span> |
2436 |
<DL> |
() |
2437 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2438 |
|
|
2439 |
|
|
2440 |
<DT class="font10bold">Function Info:</DT> |
|
2441 |
|
</div> |
2442 |
</DL> |
<a name="methodset_data_source" id="set_data_source"><!-- --></a> |
2443 |
|
<div class="evenrow"> |
2444 |
</DIV> |
|
2445 |
<BR> |
<div class="method-header"> |
2446 |
|
<span class="method-title">set_data_source</span> (line <span class="line-number">645</span>) |
2447 |
<DIV CLASS="function"> |
</div> |
2448 |
<A NAME='gui_init'><!-- --></A> |
|
2449 |
<SPAN CLASS="font12bold">gui_init</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2450 |
<BR> |
<p class="short-description">This function is used to set the DataListSource object for this instance</p> |
2451 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2452 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-signature"> |
2453 |
<span class="font10bold" style="color: #0000FF">gui_init ( )</SPAN> |
<span class="method-result">void</span> |
2454 |
<BR> |
<span class="method-name"> |
2455 |
Overridden in child class(es) as: <a href="../phpHtmlLib/DefaultGUIDatalist.html#gui_init">DefaultGUIDatalist::gui_init()</a><br> |
set_data_source |
2456 |
<BR> |
</span> |
2457 |
<SPAN CLASS="font10bold">Description : </SPAN> |
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
2458 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2459 |
A subclass can override this function |
|
2460 |
to setup the class variables after |
<ul class="parameters"> |
2461 |
the constructor. |
<li> |
2462 |
<BR> |
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
2463 |
The constructor |
<span class="var-name">$datasource</span><span class="var-description">: <p>object</p></span> </li> |
2464 |
automatically calls this function. |
</ul> |
2465 |
<DL> |
|
2466 |
<DT class="font10bold">Function Parameters:</DT> |
|
2467 |
|
</div> |
2468 |
|
<a name="methodset_default_num_rows" id="set_default_num_rows"><!-- --></a> |
2469 |
<DT class="font10bold">Function Info:</DT> |
<div class="oddrow"> |
2470 |
|
|
2471 |
</DL> |
<div class="method-header"> |
2472 |
|
<span class="method-title">set_default_num_rows</span> (line <span class="line-number">761</span>) |
2473 |
</DIV> |
</div> |
2474 |
<BR> |
|
2475 |
|
<!-- ========== Info from phpDoc block ========= --> |
2476 |
<DIV CLASS="function"> |
<p class="short-description">This function sets the default # of rows per page to display. By default its 10.</p> |
2477 |
<A NAME='is_advanced_search_enabled'><!-- --></A> |
<p class="description"><p>This lets the user override this value.</p></p> |
2478 |
<SPAN CLASS="font12bold">is_advanced_search_enabled</SPAN> |
|
2479 |
<BR> |
<div class="method-signature"> |
2480 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-result">void</span> |
2481 |
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
<span class="method-name"> |
2482 |
<span class="font10bold" style="color: #0000FF">is_advanced_search_enabled ( )</SPAN> |
set_default_num_rows |
2483 |
<BR> |
</span> |
2484 |
|
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
2485 |
<BR> |
</div> |
2486 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2487 |
<!-- ========== Info from phpDoc block ========= --> |
<ul class="parameters"> |
2488 |
This returns the status of the |
<li> |
2489 |
advanced search flag. |
<span class="var-type">int</span> |
2490 |
<BR> |
<span class="var-name">$num_rows</span><span class="var-description">: <p>- the # of rows to use.</p></span> </li> |
2491 |
|
</ul> |
2492 |
<DL> |
|
2493 |
<DT class="font10bold">Function Parameters:</DT> |
|
2494 |
|
</div> |
2495 |
|
<a name="methodset_form_action" id="set_form_action"><!-- --></a> |
2496 |
<DT class="font10bold">Function Info:</DT> |
<div class="evenrow"> |
2497 |
|
|
2498 |
</DL> |
<div class="method-header"> |
2499 |
|
<span class="method-title">set_form_action</span> (line <span class="line-number">1177</span>) |
2500 |
</DIV> |
</div> |
2501 |
<BR> |
|
2502 |
|
<!-- ========== Info from phpDoc block ========= --> |
2503 |
<DIV CLASS="function"> |
<p class="short-description">Sets the form action</p> |
2504 |
<A NAME='is_search_enabled'><!-- --></A> |
|
2505 |
<SPAN CLASS="font12bold">is_search_enabled</SPAN> |
<div class="method-signature"> |
2506 |
<BR> |
<span class="method-result">void</span> |
2507 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"> |
2508 |
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
set_form_action |
2509 |
<span class="font10bold" style="color: #0000FF">is_search_enabled ( )</SPAN> |
</span> |
2510 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
2511 |
|
</div> |
2512 |
<BR> |
|
2513 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<ul class="parameters"> |
2514 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
2515 |
get the status of the search |
<span class="var-type">string</span> |
2516 |
ability. |
<span class="var-name">$action</span> </li> |
2517 |
<BR> |
</ul> |
2518 |
|
|
2519 |
<DL> |
|
2520 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2521 |
|
<a name="methodset_form_method" id="set_form_method"><!-- --></a> |
2522 |
|
<div class="oddrow"> |
2523 |
<DT class="font10bold">Function Info:</DT> |
|
2524 |
|
<div class="method-header"> |
2525 |
</DL> |
<span class="method-title">set_form_method</span> (line <span class="line-number">1154</span>) |
2526 |
|
</div> |
2527 |
</DIV> |
|
2528 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
2529 |
|
<p class="short-description">This function is used to set the form method</p> |
2530 |
<DIV CLASS="function"> |
|
2531 |
<A NAME='numrows'><!-- --></A> |
<div class="method-signature"> |
2532 |
<SPAN CLASS="font12bold">numrows</SPAN> |
<span class="method-result">void</span> |
2533 |
<BR> |
<span class="method-name"> |
2534 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
set_form_method |
2535 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
</span> |
2536 |
<span class="font10bold" style="color: #0000FF">numrows ( )</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
2537 |
<BR> |
</div> |
2538 |
|
|
2539 |
<BR> |
<ul class="parameters"> |
2540 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
2541 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">string</span> |
2542 |
This function returns the number of rows |
<span class="var-name">$method</span><span class="var-description">: <p>(POST or GET)</p></span> </li> |
2543 |
that the query found. |
</ul> |
2544 |
<BR> |
|
2545 |
|
|
2546 |
<DL> |
</div> |
2547 |
<DT class="font10bold">Function Parameters:</DT> |
<a name="methodset_form_name" id="set_form_name"><!-- --></a> |
2548 |
|
<div class="evenrow"> |
2549 |
|
|
2550 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-header"> |
2551 |
|
<span class="method-title">set_form_name</span> (line <span class="line-number">1114</span>) |
2552 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the number of rows</DD> |
</div> |
2553 |
|
|
2554 |
</DL> |
<!-- ========== Info from phpDoc block ========= --> |
2555 |
|
<p class="short-description">This function is used to set the form name</p> |
2556 |
</DIV> |
|
2557 |
<BR> |
<div class="method-signature"> |
2558 |
|
<span class="method-result">void</span> |
2559 |
<DIV CLASS="function"> |
<span class="method-name"> |
2560 |
<A NAME='offset'><!-- --></A> |
set_form_name |
2561 |
<SPAN CLASS="font12bold">offset</SPAN> |
</span> |
2562 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
2563 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2564 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
2565 |
<span class="font10bold" style="color: #0000FF">offset ( )</SPAN> |
<ul class="parameters"> |
2566 |
<BR> |
<li> |
2567 |
|
<span class="var-type">string</span> |
2568 |
<BR> |
<span class="var-name">$name</span> </li> |
2569 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</ul> |
2570 |
<!-- ========== Info from phpDoc block ========= --> |
|
2571 |
This function returns the current value |
|
2572 |
of the offset variable. |
</div> |
2573 |
<BR> |
<a name="methodset_form_render" id="set_form_render"><!-- --></a> |
2574 |
This is an offset |
<div class="oddrow"> |
2575 |
into the query return data set. |
|
2576 |
<DL> |
<div class="method-header"> |
2577 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-title">set_form_render</span> (line <span class="line-number">1196</span>) |
2578 |
|
</div> |
2579 |
|
|
2580 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
2581 |
|
<p class="short-description">Sets whether to the output into a form</p> |
2582 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current value.</DD> |
|
2583 |
|
<div class="method-signature"> |
2584 |
</DL> |
<span class="method-result">void</span> |
2585 |
|
<span class="method-name"> |
2586 |
</DIV> |
set_form_render |
2587 |
<BR> |
</span> |
2588 |
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
2589 |
<DIV CLASS="function"> |
</div> |
2590 |
<A NAME='orderby'><!-- --></A> |
|
2591 |
<SPAN CLASS="font12bold">orderby</SPAN> |
<ul class="parameters"> |
2592 |
<BR> |
<li> |
2593 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-type">bool</span> |
2594 |
<span class="font10bold" style="color: #FF0000">string.</SPAN> |
<span class="var-name">$flag</span> </li> |
2595 |
<span class="font10bold" style="color: #0000FF">orderby ( )</SPAN> |
</ul> |
2596 |
<BR> |
|
2597 |
|
|
2598 |
<BR> |
</div> |
2599 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a name="methodset_form_target" id="set_form_target"><!-- --></a> |
2600 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="evenrow"> |
2601 |
This function returns the value of the |
|
2602 |
current orderby variable. |
<div class="method-header"> |
2603 |
<BR> |
<span class="method-title">set_form_target</span> (line <span class="line-number">1134</span>) |
2604 |
|
</div> |
2605 |
<DL> |
|
2606 |
<DT class="font10bold">Function Parameters:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
2607 |
|
<p class="short-description">This function is used to set the form target</p> |
2608 |
|
|
2609 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-signature"> |
2610 |
|
<span class="method-result">void</span> |
2611 |
</DL> |
<span class="method-name"> |
2612 |
|
set_form_target |
2613 |
</DIV> |
</span> |
2614 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$target</span>) |
2615 |
|
</div> |
2616 |
<DIV CLASS="function"> |
|
2617 |
<A NAME='render'><!-- --></A> |
<ul class="parameters"> |
2618 |
<SPAN CLASS="font12bold">render</SPAN> |
<li> |
2619 |
<BR> |
<span class="var-type">string</span> |
2620 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-name">$target</span> </li> |
2621 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</ul> |
2622 |
<span class="font10bold" style="color: #0000FF">render ( $indent_level, $output_debug )</SPAN> |
|
2623 |
<BR> |
|
2624 |
|
</div> |
2625 |
<BR> |
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
2626 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="oddrow"> |
2627 |
<!-- ========== Info from phpDoc block ========= --> |
|
2628 |
This function renders the final |
<div class="method-header"> |
2629 |
widget |
<span class="method-title">set_global_prefix</span> (line <span class="line-number">621</span>) |
2630 |
<BR> |
</div> |
2631 |
|
|
2632 |
<DL> |
<!-- ========== Info from phpDoc block ========= --> |
2633 |
<DT class="font10bold">Function Parameters:</DT> |
<p class="short-description">This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.</p> |
2634 |
|
|
2635 |
|
<div class="method-signature"> |
2636 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-result">void</span> |
2637 |
|
<span class="method-name"> |
2638 |
</DL> |
set_global_prefix |
2639 |
|
</span> |
2640 |
</DIV> |
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
2641 |
<BR> |
</div> |
2642 |
|
|
2643 |
<DIV CLASS="function"> |
<ul class="parameters"> |
2644 |
<A NAME='reverseorder'><!-- --></A> |
<li> |
2645 |
<SPAN CLASS="font12bold">reverseorder</SPAN> |
<span class="var-type">string</span> |
2646 |
<BR> |
<span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for all vars.</p></span> </li> |
2647 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</ul> |
2648 |
<span class="font10bold" style="color: #FF0000">string.</SPAN> |
|
2649 |
<span class="font10bold" style="color: #0000FF">reverseorder ( )</SPAN> |
|
2650 |
<BR> |
<hr class="separator" /> |
2651 |
|
<div class="notes">Redefined in descendants as:</div> |
2652 |
<BR> |
<ul class="redefinitions"> |
2653 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
2654 |
<!-- ========== Info from phpDoc block ========= --> |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_global_prefix">DefaultGUIDatalist::set_global_prefix()</a> |
2655 |
This function returns the current value of |
: This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page. |
2656 |
the reverse order member variable. |
</li> |
2657 |
<BR> |
</ul> |
2658 |
|
</div> |
2659 |
<DL> |
<a name="methodset_image_path" id="set_image_path"><!-- --></a> |
2660 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="evenrow"> |
2661 |
|
|
2662 |
|
<div class="method-header"> |
2663 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-title">set_image_path</span> (line <span class="line-number">1528</span>) |
2664 |
|
</div> |
2665 |
</DL> |
|
2666 |
|
<!-- ========== Info from phpDoc block ========= --> |
2667 |
</DIV> |
<p class="short-description">This function returns the path to the images used in this class</p> |
2668 |
<BR> |
|
2669 |
|
<div class="method-signature"> |
2670 |
<DIV CLASS="function"> |
<span class="method-result">string</span> |
2671 |
<A NAME='search_disable'><!-- --></A> |
<span class="method-name"> |
2672 |
<SPAN CLASS="font12bold">search_disable</SPAN> |
set_image_path |
2673 |
<BR> |
</span> |
2674 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
2675 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
2676 |
<span class="font10bold" style="color: #0000FF">search_disable ( )</SPAN> |
|
2677 |
<BR> |
|
2678 |
|
|
2679 |
<BR> |
</div> |
2680 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a name="methodset_max_rows" id="set_max_rows"><!-- --></a> |
2681 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="oddrow"> |
2682 |
Disable the search ability. |
|
2683 |
<BR> |
<div class="method-header"> |
2684 |
|
<span class="method-title">set_max_rows</span> (line <span class="line-number">793</span>) |
2685 |
<DL> |
</div> |
2686 |
<DT class="font10bold">Function Parameters:</DT> |
|
2687 |
|
<!-- ========== Info from phpDoc block ========= --> |
2688 |
<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">0</SPAN></SPAN> </DD> |
<p class="short-description">This sets the maximum # of rows to display when in expand mode</p> |
2689 |
|
|
2690 |
|
<div class="method-signature"> |
2691 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-result">void</span> |
2692 |
|
<span class="method-name"> |
2693 |
</DL> |
set_max_rows |
2694 |
|
</span> |
2695 |
</DIV> |
(<span class="var-type">int</span> <span class="var-name">$max</span>) |
2696 |
<BR> |
</div> |
2697 |
|
|
2698 |
<DIV CLASS="function"> |
<ul class="parameters"> |
2699 |
<A NAME='search_enable'><!-- --></A> |
<li> |
2700 |
<SPAN CLASS="font12bold">search_enable</SPAN> |
<span class="var-type">int</span> |
2701 |
<BR> |
<span class="var-name">$max</span><span class="var-description">: <p>- new # of maximum rows to display when in 'expand' mode</p></span> </li> |
2702 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</ul> |
2703 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
2704 |
<span class="font10bold" style="color: #0000FF">search_enable ( )</SPAN> |
|
2705 |
<BR> |
</div> |
2706 |
|
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
2707 |
<BR> |
<div class="evenrow"> |
2708 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2709 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
2710 |
Enable the search ability. |
<span class="method-title">set_not_found_message</span> (line <span class="line-number">1215</span>) |
2711 |
<BR> |
</div> |
2712 |
|
|
2713 |
<DL> |
<!-- ========== Info from phpDoc block ========= --> |
2714 |
<DT class="font10bold">Function Parameters:</DT> |
<p class="short-description">This function is used to set the message displayed when no data is found</p> |
2715 |
|
|
2716 |
<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">0</SPAN></SPAN> </DD> |
<div class="method-signature"> |
2717 |
|
<span class="method-result">void</span> |
2718 |
|
<span class="method-name"> |
2719 |
<DT class="font10bold">Function Info:</DT> |
set_not_found_message |
2720 |
|
</span> |
2721 |
</DL> |
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
2722 |
|
</div> |
2723 |
</DIV> |
|
2724 |
<BR> |
<ul class="parameters"> |
2725 |
|
<li> |
2726 |
<DIV CLASS="function"> |
<span class="var-type">string</span> |
2727 |
<A NAME='search_field'><!-- --></A> |
<span class="var-name">$mesg</span> </li> |
2728 |
<SPAN CLASS="font12bold">search_field</SPAN> |
</ul> |
2729 |
<BR> |
|
2730 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2731 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</div> |
2732 |
<span class="font10bold" style="color: #0000FF">search_field ( )</SPAN> |
<a name="methodset_numrows" id="set_numrows"><!-- --></a> |
2733 |
<BR> |
<div class="oddrow"> |
2734 |
|
|
2735 |
<BR> |
<div class="method-header"> |
2736 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-title">set_numrows</span> (line <span class="line-number">978</span>) |
2737 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2738 |
returns the current value of |
|
2739 |
the search field name |
<!-- ========== Info from phpDoc block ========= --> |
2740 |
<BR> |
<p class="short-description">This function sets the # of rows to display per page.</p> |
2741 |
|
|
2742 |
<DL> |
<div class="method-signature"> |
2743 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">void</span> |
2744 |
|
<span class="method-name"> |
2745 |
|
set_numrows |
2746 |
<DT class="font10bold">Function Info:</DT> |
</span> |
2747 |
|
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
2748 |
</DL> |
</div> |
2749 |
|
|
2750 |
</DIV> |
<ul class="parameters"> |
2751 |
<BR> |
<li> |
2752 |
|
<span class="var-type">int</span> |
2753 |
<DIV CLASS="function"> |
<span class="var-name">$new_numrows</span><span class="var-description">: <p>- the # of rows</p></span> </li> |
2754 |
<A NAME='search_type'><!-- --></A> |
</ul> |
2755 |
<SPAN CLASS="font12bold">search_type</SPAN> |
|
2756 |
<BR> |
|
2757 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2758 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodset_offset" id="set_offset"><!-- --></a> |
2759 |
<span class="font10bold" style="color: #0000FF">search_type ( )</SPAN> |
<div class="evenrow"> |
2760 |
<BR> |
|
2761 |
|
<div class="method-header"> |
2762 |
<BR> |
<span class="method-title">set_offset</span> (line <span class="line-number">906</span>) |
2763 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
2764 |
<!-- ========== Info from phpDoc block ========= --> |
|
2765 |
returns the type of search being used |
<!-- ========== Info from phpDoc block ========= --> |
2766 |
<BR> |
<p class="short-description">This function is used to set/change the offset for this list.</p> |
2767 |
|
|
2768 |
<DL> |
<div class="method-signature"> |
2769 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">void</span> |
2770 |
|
<span class="method-name"> |
2771 |
|
set_offset |
2772 |
<DT class="font10bold">Function Info:</DT> |
</span> |
2773 |
|
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
2774 |
</DL> |
</div> |
2775 |
|
|
2776 |
</DIV> |
<ul class="parameters"> |
2777 |
<BR> |
<li> |
2778 |
|
<span class="var-type">int</span> |
2779 |
<DIV CLASS="function"> |
<span class="var-name">$new_offset</span><span class="var-description">: <p>- the new offset.</p></span> </li> |
2780 |
<A NAME='search_value'><!-- --></A> |
</ul> |
2781 |
<SPAN CLASS="font12bold">search_value</SPAN> |
|
2782 |
<BR> |
|
2783 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
2784 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
2785 |
<span class="font10bold" style="color: #0000FF">search_value ( )</SPAN> |
<div class="oddrow"> |
2786 |
<BR> |
|
2787 |
|
<div class="method-header"> |
2788 |
<BR> |
<span class="method-title">set_reverseorder</span> (line <span class="line-number">947</span>) |
2789 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
2790 |
<!-- ========== Info from phpDoc block ========= --> |
|
2791 |
returns the current value of |
<!-- ========== Info from phpDoc block ========= --> |
2792 |
te search field value. |
<p class="short-description">This function sets the reverse order flag to a new value.</p> |
2793 |
<BR> |
|
2794 |
|
<div class="method-signature"> |
2795 |
<DL> |
<span class="method-result">void</span> |
2796 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
2797 |
|
set_reverseorder |
2798 |
|
</span> |
2799 |
<DT class="font10bold">Function Info:</DT> |
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
2800 |
|
</div> |
2801 |
</DL> |
|
2802 |
|
<ul class="parameters"> |
2803 |
</DIV> |
<li> |
2804 |
<BR> |
<span class="var-type">string</span> |
2805 |
|
<span class="var-name">$new_value</span><span class="var-description">: <p>- the new value.</p></span> </li> |
2806 |
<DIV CLASS="function"> |
</ul> |
2807 |
<A NAME='search_value_filter'><!-- --></A> |
|
2808 |
<SPAN CLASS="font12bold">search_value_filter</SPAN> |
|
2809 |
<BR> |
</div> |
2810 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodset_save_vars" id="set_save_vars"><!-- --></a> |
2811 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="evenrow"> |
2812 |
<span class="font10bold" style="color: #0000FF">search_value_filter ( $value )</SPAN> |
|
2813 |
<BR> |
<div class="method-header"> |
2814 |
|
<span class="method-title">set_save_vars</span> (line <span class="line-number">1270</span>) |
2815 |
<BR> |
</div> |
2816 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2817 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
2818 |
This function is used to make safe |
<p class="short-description">This function sets the save variables that the user/child wants to automatically propogate</p> |
2819 |
any query string value that is used |
|
2820 |
<BR> |
<div class="method-signature"> |
2821 |
|
<span class="method-result">void</span> |
2822 |
<DL> |
<span class="method-name"> |
2823 |
<DT class="font10bold">Function Parameters:</DT> |
set_save_vars |
2824 |
|
</span> |
2825 |
<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">$value</SPAN></SPAN> </DD> |
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
2826 |
|
</div> |
2827 |
|
|
2828 |
<DT class="font10bold">Function Info:</DT> |
<ul class="parameters"> |
2829 |
|
<li> |
2830 |
</DL> |
<span class="var-type">array</span> |
2831 |
|
<span class="var-name">$vars</span><span class="var-description">: <p>- name=>value pairs of the data that they want to propogate</p></span> </li> |
2832 |
</DIV> |
</ul> |
2833 |
<BR> |
|
2834 |
|
|
2835 |
<DIV CLASS="function"> |
</div> |
2836 |
<A NAME='setup_columns'><!-- --></A> |
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
2837 |
<SPAN CLASS="font12bold">setup_columns</SPAN> |
<div class="oddrow"> |
2838 |
<BR> |
|
2839 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="method-header"> |
2840 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="method-title">set_search_type</span> (line <span class="line-number">1050</span>) |
2841 |
<span class="font10bold" style="color: #0000FF">setup_columns ( )</SPAN> |
</div> |
2842 |
<BR> |
|
2843 |
|
<!-- ========== Info from phpDoc block ========= --> |
2844 |
<BR> |
<p class="short-description">This function sets the search type</p> |
2845 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2846 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
2847 |
|
<span class="method-result">void</span> |
2848 |
<BR> |
<span class="method-name"> |
2849 |
|
set_search_type |
2850 |
<DL> |
</span> |
2851 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
2852 |
|
</div> |
2853 |
|
|
2854 |
<DT class="font10bold">Function Info:</DT> |
<ul class="parameters"> |
2855 |
|
<li> |
2856 |
</DL> |
<span class="var-type">string</span> |
2857 |
|
<span class="var-name">$type</span><span class="var-description">: <p>- the search type "simple" or "advanced"</p></span> </li> |
2858 |
</DIV> |
</ul> |
2859 |
<BR> |
|
2860 |
|
|
2861 |
<DIV CLASS="function"> |
</div> |
2862 |
<A NAME='set_data_source'><!-- --></A> |
<a name="methodset_show_results" id="set_show_results"><!-- --></a> |
2863 |
<SPAN CLASS="font12bold">set_data_source</SPAN> |
<div class="evenrow"> |
2864 |
<BR> |
|
2865 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="method-header"> |
2866 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="method-title">set_show_results</span> (line <span class="line-number">1227</span>) |
2867 |
<span class="font10bold" style="color: #0000FF">set_data_source ( $datasource )</SPAN> |
</div> |
2868 |
<BR> |
|
2869 |
|
<!-- ========== Info from phpDoc block ========= --> |
2870 |
<BR> |
<p class="short-description">This function is used to set the value of the _show_results_flag</p> |
2871 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2872 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
2873 |
This function is used to set the |
<span class="method-result">void</span> |
2874 |
DataListSource object for this instance |
<span class="method-name"> |
2875 |
<BR> |
set_show_results |
2876 |
|
</span> |
2877 |
<DL> |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
2878 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2879 |
|
|
2880 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></SPAN> <span style="color: #0000FF;font-weight:bold">$datasource</SPAN></SPAN> object</DD> |
<ul class="parameters"> |
2881 |
|
<li> |
2882 |
|
<span class="var-type">boolean</span> |
2883 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-name">$flag</span><span class="var-description">: <p>- TRUE to show the results</p></span> </li> |
2884 |
|
</ul> |
2885 |
</DL> |
|
2886 |
|
|
2887 |
</DIV> |
</div> |
2888 |
<BR> |
<a name="methodset_simple_search_modifier" id="set_simple_search_modifier"><!-- --></a> |
2889 |
|
<div class="oddrow"> |
2890 |
<DIV CLASS="function"> |
|
2891 |
<A NAME='set_default_num_rows'><!-- --></A> |
<div class="method-header"> |
2892 |
<SPAN CLASS="font12bold">set_default_num_rows</SPAN> |
<span class="method-title">set_simple_search_modifier</span> (line <span class="line-number">735</span>) |
2893 |
<BR> |
</div> |
2894 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
2895 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2896 |
<span class="font10bold" style="color: #0000FF">set_default_num_rows ( $num_rows )</SPAN> |
<p class="short-description">Set the simple search modifyer flag.</p> |
2897 |
<BR> |
<p class="description"><p>NOTE: by default all the modifiers are enabled. You can limit the modifiers by passing in the string of defines of which ones you want enabled.</p><p>MODIFIERS: SEARCH_BEGINS_WITH SEARCH_CONTAINS SEARCH_EXACT SEARCH_ENDS_WITH</p><p>ie. SEARCH_BEGINS_WITH.SEARCH_EXACT will enable ONLY the "begins with" and "exact" modifiers.</p></p> |
2898 |
|
|
2899 |
<BR> |
<div class="method-signature"> |
2900 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">void</span> |
2901 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
2902 |
This function sets the default # of rows |
set_simple_search_modifier |
2903 |
per page to display. |
</span> |
2904 |
<BR> |
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
2905 |
By default its 10. |
</div> |
2906 |
This lets the user override this value. |
|
2907 |
<DL> |
<ul class="parameters"> |
2908 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
2909 |
|
<span class="var-type">string</span> |
2910 |
<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_rows</SPAN></SPAN> - the # of rows to use.</DD> |
<span class="var-name">$modifier</span> </li> |
2911 |
|
</ul> |
2912 |
|
|
2913 |
<DT class="font10bold">Function Info:</DT> |
|
2914 |
|
</div> |
2915 |
</DL> |
<a name="methodshowall" id="showall"><!-- --></a> |
2916 |
|
<div class="evenrow"> |
2917 |
</DIV> |
|
2918 |
<BR> |
<div class="method-header"> |
2919 |
|
<span class="method-title">showall</span> (line <span class="line-number">1062</span>) |
2920 |
<DIV CLASS="function"> |
</div> |
2921 |
<A NAME='set_form_action'><!-- --></A> |
|
2922 |
<SPAN CLASS="font12bold">set_form_action</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
2923 |
<BR> |
<p class="short-description">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</p> |
2924 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<ul class="tags"> |
2925 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li><span class="field">return:</span> <p>- the current value</p></li> |
2926 |
<span class="font10bold" style="color: #0000FF">set_form_action ( $action )</SPAN> |
</ul> |
2927 |
<BR> |
|
2928 |
|
<div class="method-signature"> |
2929 |
<BR> |
<span class="method-result">string</span> |
2930 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-name"> |
2931 |
<!-- ========== Info from phpDoc block ========= --> |
showall |
2932 |
Sets the form action |
</span> |
2933 |
<BR> |
() |
2934 |
|
</div> |
2935 |
<DL> |
|
2936 |
<DT class="font10bold">Function Parameters:</DT> |
|
2937 |
|
|
2938 |
<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">$action</SPAN></SPAN> </DD> |
</div> |
2939 |
|
<a name="methodsimple_search_modifier_value" id="simple_search_modifier_value"><!-- --></a> |
2940 |
|
<div class="oddrow"> |
2941 |
<DT class="font10bold">Function Info:</DT> |
|
2942 |
|
<div class="method-header"> |
2943 |
</DL> |
<span class="method-title">simple_search_modifier_value</span> (line <span class="line-number">1030</span>) |
2944 |
|
</div> |
2945 |
</DIV> |
|
2946 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
2947 |
|
<p class="short-description">returns the current value of the simple search modifier</p> |
2948 |
<DIV CLASS="function"> |
|
2949 |
<A NAME='set_form_method'><!-- --></A> |
<div class="method-signature"> |
2950 |
<SPAN CLASS="font12bold">set_form_method</SPAN> |
<span class="method-result">string</span> |
2951 |
<BR> |
<span class="method-name"> |
2952 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
simple_search_modifier_value |
2953 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</span> |
2954 |
<span class="font10bold" style="color: #0000FF">set_form_method ( $method )</SPAN> |
() |
2955 |
<BR> |
</div> |
2956 |
|
|
2957 |
<BR> |
|
2958 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2959 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
2960 |
This function is used to set the |
<a name="methoduser_setup" id="user_setup"><!-- --></a> |
2961 |
form method |
<div class="evenrow"> |
2962 |
<BR> |
|
2963 |
|
<div class="method-header"> |
2964 |
<DL> |
<span class="method-title">user_setup</span> (line <span class="line-number">478</span>) |
2965 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
2966 |
|
|
2967 |
<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">$method</SPAN></SPAN> (POST or GET)</DD> |
<!-- ========== Info from phpDoc block ========= --> |
2968 |
|
<p class="short-description">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</p> |
2969 |
|
|
2970 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-signature"> |
2971 |
|
<span class="method-result">void</span> |
2972 |
</DL> |
<span class="method-name"> |
2973 |
|
user_setup |
2974 |
</DIV> |
</span> |
2975 |
<BR> |
() |
2976 |
|
</div> |
2977 |
<DIV CLASS="function"> |
|
2978 |
<A NAME='set_form_name'><!-- --></A> |
|
2979 |
<SPAN CLASS="font12bold">set_form_name</SPAN> |
|
2980 |
<BR> |
</div> |
2981 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="method_build_default_vars" id="_build_default_vars"><!-- --></a> |
2982 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="oddrow"> |
2983 |
<span class="font10bold" style="color: #0000FF">set_form_name ( $name )</SPAN> |
|
2984 |
<BR> |
<div class="method-header"> |
2985 |
|
<span class="method-title">_build_default_vars</span> (line <span class="line-number">1282</span>) |
2986 |
<BR> |
</div> |
2987 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
2988 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
2989 |
This function is used to set the |
<p class="short-description">This function builds the list of</p> |
2990 |
form name |
<p class="description"><p>default hidden form vars for when the datalist is being rendered as a POST</p></p> |
2991 |
<BR> |
|
2992 |
|
<div class="method-signature"> |
2993 |
<DL> |
<span class="method-result">Container</span> |
2994 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
2995 |
|
_build_default_vars |
2996 |
<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">$name</SPAN></SPAN> </DD> |
</span> |
2997 |
|
() |
2998 |
|
</div> |
2999 |
<DT class="font10bold">Function Info:</DT> |
|
3000 |
|
|
3001 |
</DL> |
|
3002 |
|
</div> |
3003 |
</DIV> |
<a name="method_build_save_vars" id="_build_save_vars"><!-- --></a> |
3004 |
<BR> |
<div class="evenrow"> |
3005 |
|
|
3006 |
<DIV CLASS="function"> |
<div class="method-header"> |
3007 |
<A NAME='set_form_render'><!-- --></A> |
<span class="method-title">_build_save_vars</span> (line <span class="line-number">1254</span>) |
3008 |
<SPAN CLASS="font12bold">set_form_render</SPAN> |
</div> |
3009 |
<BR> |
|
3010 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
3011 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<p class="short-description">this method builds some hidden form fields to automatically be placed inside the form.</p> |
3012 |
<span class="font10bold" style="color: #0000FF">set_form_render ( $flag )</SPAN> |
<p class="description"><p>This method returns a list of hidden form fields if we are a POST. It returns a portion of a query string If we are a GET.</p></p> |
3013 |
<BR> |
<ul class="tags"> |
3014 |
|
<li><span class="field">return:</span> <p>depending on form method</p></li> |
3015 |
<BR> |
</ul> |
3016 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
3017 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
3018 |
Sets whether to the output into a form |
<span class="method-result">mixed</span> |
3019 |
<BR> |
<span class="method-name"> |
3020 |
|
_build_save_vars |
3021 |
<DL> |
</span> |
3022 |
<DT class="font10bold">Function Parameters:</DT> |
() |
3023 |
|
</div> |
3024 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">bool</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD> |
|
3025 |
|
|
3026 |
|
|
3027 |
<DT class="font10bold">Function Info:</DT> |
</div> |
3028 |
|
<a name="method_build_simple_search_modifier" id="_build_simple_search_modifier"><!-- --></a> |
3029 |
</DL> |
<div class="oddrow"> |
3030 |
|
|
3031 |
</DIV> |
<div class="method-header"> |
3032 |
<BR> |
<span class="method-title">_build_simple_search_modifier</span> (line <span class="line-number">1721</span>) |
3033 |
|
</div> |
3034 |
<DIV CLASS="function"> |
|
3035 |
<A NAME='set_form_target'><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
3036 |
<SPAN CLASS="font12bold">set_form_target</SPAN> |
<p class="short-description">This builds the simple search modifier select box.</p> |
3037 |
<BR> |
<ul class="tags"> |
3038 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li><span class="field">return:</span> <p>object.</p></li> |
3039 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</ul> |
3040 |
<span class="font10bold" style="color: #0000FF">set_form_target ( $target )</SPAN> |
|
3041 |
<BR> |
<div class="method-signature"> |
3042 |
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
3043 |
<BR> |
<span class="method-name"> |
3044 |
<SPAN CLASS="font10bold">Description : </SPAN> |
_build_simple_search_modifier |
3045 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
3046 |
This function is used to set the |
() |
3047 |
form target |
</div> |
3048 |
<BR> |
|
3049 |
|
|
3050 |
<DL> |
|
3051 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
3052 |
|
<a name="method_build_tool_url" id="_build_tool_url"><!-- --></a> |
3053 |
<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">$target</SPAN></SPAN> </DD> |
<div class="evenrow"> |
3054 |
|
|
3055 |
|
<div class="method-header"> |
3056 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-title">_build_tool_url</span> (line <span class="line-number">1450</span>) |
3057 |
|
</div> |
3058 |
</DL> |
|
3059 |
|
<!-- ========== Info from phpDoc block ========= --> |
3060 |
</DIV> |
<p class="short-description">This function is used to build the url for a tool link.</p> |
3061 |
<BR> |
<p class="description"><p>(first, prev, next, last, all)</p></p> |
3062 |
|
|
3063 |
<DIV CLASS="function"> |
<div class="method-signature"> |
3064 |
<A NAME='set_global_prefix'><!-- --></A> |
<span class="method-result">string</span> |
3065 |
<SPAN CLASS="font12bold">set_global_prefix</SPAN> |
<span class="method-name"> |
3066 |
<BR> |
_build_tool_url |
3067 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
3068 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, [<span class="var-type">boolean</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$showall_value</span>) |
3069 |
<span class="font10bold" style="color: #0000FF">set_global_prefix ( $prefix )</SPAN> |
</div> |
3070 |
<BR> |
|
3071 |
|
<ul class="parameters"> |
3072 |
<BR> |
<li> |
3073 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">int</span> |
3074 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$offset</span><span class="var-description">: <p>- the offset for the link</p></span> </li> |
3075 |
This function sets a prefix for all |
<li> |
3076 |
variables that are used in the item list |
<span class="var-type">boolean</span> |
3077 |
table on a page. |
<span class="var-name">$showall_flag</span><span class="var-description">: <p>- add the showall value to the url</p></span> </li> |
3078 |
<BR> |
<li> |
3079 |
This allows you to have |
<span class="var-type">int</span> |
3080 |
multiple itemlists on a single html page. |
<span class="var-name">$showall_value</span><span class="var-description">: <p>- the showall value to use if the flag is on</p></span> </li> |
3081 |
<DL> |
</ul> |
3082 |
<DT class="font10bold">Function Parameters:</DT> |
|
3083 |
|
|
3084 |
<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">$prefix</SPAN></SPAN> - the prefix for all vars.</DD> |
</div> |
3085 |
|
<a name="method_check_datasource" id="_check_datasource"><!-- --></a> |
3086 |
|
<div class="oddrow"> |
3087 |
<DT class="font10bold">Function Info:</DT> |
|
3088 |
|
<div class="method-header"> |
3089 |
</DL> |
<span class="method-title">_check_datasource</span> (line <span class="line-number">847</span>) |
3090 |
|
</div> |
3091 |
</DIV> |
|
3092 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
3093 |
|
<p class="short-description">general DataListSource object checker.</p> |
3094 |
<DIV CLASS="function"> |
|
3095 |
<A NAME='set_image_path'><!-- --></A> |
<div class="method-signature"> |
3096 |
<SPAN CLASS="font12bold">set_image_path</SPAN> |
<span class="method-result">void</span> |
3097 |
<BR> |
<span class="method-name"> |
3098 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
_check_datasource |
3099 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</span> |
3100 |
<span class="font10bold" style="color: #0000FF">set_image_path ( $path )</SPAN> |
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
3101 |
<BR> |
</div> |
3102 |
|
|
3103 |
<BR> |
|
3104 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
3105 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
3106 |
This function returns the path to the |
<a name="method_clean_string" id="_clean_string"><!-- --></a> |
3107 |
images used in this class |
<div class="evenrow"> |
3108 |
<BR> |
|
3109 |
|
<div class="method-header"> |
3110 |
<DL> |
<span class="method-title">_clean_string</span> (line <span class="line-number">1680</span>) |
3111 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
3112 |
|
|
3113 |
|
<!-- ========== Info from phpDoc block ========= --> |
3114 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This function is used to make sure that the string we are placing in a cell has been "cleaned"</p> |
3115 |
|
<ul class="tags"> |
3116 |
</DL> |
<li><span class="field">return:</span> <p>- the cleaned string or object</p></li> |
3117 |
|
</ul> |
3118 |
</DIV> |
|
3119 |
<BR> |
<div class="method-signature"> |
3120 |
|
<span class="method-result">mixed</span> |
3121 |
<DIV CLASS="function"> |
<span class="method-name"> |
3122 |
<A NAME='set_max_rows'><!-- --></A> |
_clean_string |
3123 |
<SPAN CLASS="font12bold">set_max_rows</SPAN> |
</span> |
3124 |
<BR> |
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
3125 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
3126 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
3127 |
<span class="font10bold" style="color: #0000FF">set_max_rows ( $max )</SPAN> |
<ul class="parameters"> |
3128 |
<BR> |
<li> |
3129 |
|
<span class="var-type">mixed</span> |
3130 |
<BR> |
<span class="var-name">$obj</span><span class="var-description">: <p>- the cell object. It can be a string.</p></span> </li> |
3131 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
3132 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">string</span> |
3133 |
This sets the maximum # of rows to |
<span class="var-name">$col_name</span><span class="var-description">: <p>- the name of the column this object/string will live</p></span> </li> |
3134 |
display when in expand mode |
</ul> |
3135 |
<BR> |
|
3136 |
|
|
3137 |
<DL> |
</div> |
3138 |
<DT class="font10bold">Function Parameters:</DT> |
<a name="method_filter_column_string" id="_filter_column_string"><!-- --></a> |
3139 |
|
<div class="oddrow"> |
3140 |
<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">$max</SPAN></SPAN> - new # of maximum rows |
|
3141 |
to display when in 'expand' mode</DD> |
<div class="method-header"> |
3142 |
|
<span class="method-title">_filter_column_string</span> (line <span class="line-number">1099</span>) |
3143 |
|
</div> |
3144 |
<DT class="font10bold">Function Info:</DT> |
|
3145 |
|
<!-- ========== Info from phpDoc block ========= --> |
3146 |
</DL> |
<p class="short-description">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</p> |
3147 |
|
<ul class="tags"> |
3148 |
</DIV> |
<li><span class="field">return:</span> <p>the cleaned/filtered data</p></li> |
3149 |
<BR> |
</ul> |
3150 |
|
|
3151 |
<DIV CLASS="function"> |
<div class="method-signature"> |
3152 |
<A NAME='set_not_found_message'><!-- --></A> |
<span class="method-result">string</span> |
3153 |
<SPAN CLASS="font12bold">set_not_found_message</SPAN> |
<span class="method-name"> |
3154 |
<BR> |
_filter_column_string |
3155 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
3156 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
3157 |
<span class="font10bold" style="color: #0000FF">set_not_found_message ( $mesg )</SPAN> |
</div> |
3158 |
<BR> |
|
3159 |
|
<ul class="parameters"> |
3160 |
<BR> |
<li> |
3161 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
3162 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li> |
3163 |
This function is used to set the |
</ul> |
3164 |
message displayed when no data is found |
|
3165 |
<BR> |
|
3166 |
|
</div> |
3167 |
<DL> |
<a name="method_get" id="_get"><!-- --></a> |
3168 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="evenrow"> |
3169 |
|
|
3170 |
<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> |
<div class="method-header"> |
3171 |
|
<span class="method-title">_get</span> (line <span class="line-number">870</span>) |
3172 |
|
</div> |
3173 |
<DT class="font10bold">Function Info:</DT> |
|
3174 |
|
<!-- ========== Info from phpDoc block ========= --> |
3175 |
</DL> |
<p class="short-description">Function used to get the current value of one of the control vars for this class</p> |
3176 |
|
<ul class="tags"> |
3177 |
</DIV> |
<li><span class="field">return:</span> <p>current value or default if not set</p></li> |
3178 |
<BR> |
</ul> |
3179 |
|
|
3180 |
<DIV CLASS="function"> |
<div class="method-signature"> |
3181 |
<A NAME='set_numrows'><!-- --></A> |
<span class="method-result">the</span> |
3182 |
<SPAN CLASS="font12bold">set_numrows</SPAN> |
<span class="method-name"> |
3183 |
<BR> |
_get |
3184 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
3185 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$default_value</span> = <span class="var-default">NULL</span>]) |
3186 |
<span class="font10bold" style="color: #0000FF">set_numrows ( $new_numrows )</SPAN> |
</div> |
3187 |
<BR> |
|
3188 |
|
<ul class="parameters"> |
3189 |
<BR> |
<li> |
3190 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
3191 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li> |
3192 |
This function sets the # of rows to display |
<li> |
3193 |
per page. |
<span class="var-type">mixed</span> |
3194 |
<BR> |
<span class="var-name">$default_value</span><span class="var-description">: <p>- the default value if not set</p></span> </li> |
3195 |
|
</ul> |
3196 |
<DL> |
|
3197 |
<DT class="font10bold">Function Parameters:</DT> |
|
3198 |
|
</div> |
3199 |
<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">$new_numrows</SPAN></SPAN> - the # of rows</DD> |
<a name="method_get_searchable_fields" id="_get_searchable_fields"><!-- --></a> |
3200 |
|
<div class="oddrow"> |
3201 |
|
|
3202 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-header"> |
3203 |
|
<span class="method-title">_get_searchable_fields</span> (line <span class="line-number">1705</span>) |
3204 |
</DL> |
</div> |
3205 |
|
|
3206 |
</DIV> |
<!-- ========== Info from phpDoc block ========= --> |
3207 |
<BR> |
<p class="short-description">This method gets the array of searchable header fields (columns)</p> |
3208 |
|
|
3209 |
<DIV CLASS="function"> |
<div class="method-signature"> |
3210 |
<A NAME='set_offset'><!-- --></A> |
<span class="method-result">array</span> |
3211 |
<SPAN CLASS="font12bold">set_offset</SPAN> |
<span class="method-name"> |
3212 |
<BR> |
_get_searchable_fields |
3213 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
3214 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
() |
3215 |
<span class="font10bold" style="color: #0000FF">set_offset ( $new_offset )</SPAN> |
</div> |
3216 |
<BR> |
|
3217 |
|
|
3218 |
<BR> |
|
3219 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
3220 |
<!-- ========== Info from phpDoc block ========= --> |
<a name="method_javascript" id="_javascript"><!-- --></a> |
3221 |
This function is used to set/change |
<div class="evenrow"> |
3222 |
the offset for this list. |
|
3223 |
<BR> |
<div class="method-header"> |
3224 |
|
<span class="method-title">_javascript</span> (line <span class="line-number">571</span>) |
3225 |
<DL> |
</div> |
3226 |
<DT class="font10bold">Function Parameters:</DT> |
|
3227 |
|
<!-- ========== Info from phpDoc block ========= --> |
3228 |
<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">$new_offset</SPAN></SPAN> - the new offset.</DD> |
<p class="short-description">This function provides a way to automatically add javascript to this object.</p> |
3229 |
|
<p class="description"><p>This function is meant to be extended by the child class.</p></p> |
3230 |
|
<ul class="tags"> |
3231 |
<DT class="font10bold">Function Info:</DT> |
<li><span class="field">return:</span> <p>object</p></li> |
3232 |
|
</ul> |
3233 |
</DL> |
|
3234 |
|
<div class="method-signature"> |
3235 |
</DIV> |
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
3236 |
<BR> |
<span class="method-name"> |
3237 |
|
_javascript |
3238 |
<DIV CLASS="function"> |
</span> |
3239 |
<A NAME='set_reverseorder'><!-- --></A> |
() |
3240 |
<SPAN CLASS="font12bold">set_reverseorder</SPAN> |
</div> |
3241 |
<BR> |
|
3242 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
3243 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
3244 |
<span class="font10bold" style="color: #0000FF">set_reverseorder ( $new_value )</SPAN> |
<hr class="separator" /> |
3245 |
<BR> |
<div class="notes">Redefined in descendants as:</div> |
3246 |
|
<ul class="redefinitions"> |
3247 |
<BR> |
<li> |
3248 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a href="../phpHtmlLib/DefaultGUIDatalist.html#method_javascript">DefaultGUIDatalist::_javascript()</a> |
3249 |
<!-- ========== Info from phpDoc block ========= --> |
: This function returns any Javascript required for this widget |
3250 |
This function sets the reverse order flag |
</li> |
3251 |
to a new value. |
</ul> |
3252 |
<BR> |
</div> |
3253 |
|
<a name="method_save_mozilla_nav_link" id="_save_mozilla_nav_link"><!-- --></a> |
3254 |
<DL> |
<div class="oddrow"> |
3255 |
<DT class="font10bold">Function Parameters:</DT> |
|
3256 |
|
<div class="method-header"> |
3257 |
<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">$new_value</SPAN></SPAN> - the new value.</DD> |
<span class="method-title">_save_mozilla_nav_link</span> (line <span class="line-number">1507</span>) |
3258 |
|
</div> |
3259 |
|
|
3260 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
3261 |
|
<p class="short-description">This function stores the url for each of the tool urls, so we can push these out for mozilla.</p> |
3262 |
</DL> |
<p class="description"><p>Mozilla has a nice navigation bar feature that lets you program first, prev, next, last links</p></p> |
3263 |
|
|
3264 |
</DIV> |
<div class="method-signature"> |
3265 |
<BR> |
<span class="method-result">void</span> |
3266 |
|
<span class="method-name"> |
3267 |
<DIV CLASS="function"> |
_save_mozilla_nav_link |
3268 |
<A NAME='set_save_vars'><!-- --></A> |
</span> |
3269 |
<SPAN CLASS="font12bold">set_save_vars</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$which</span>, <span class="var-type">string</span> <span class="var-name">$url</span>) |
3270 |
<BR> |
</div> |
3271 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
3272 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<ul class="parameters"> |
3273 |
<span class="font10bold" style="color: #0000FF">set_save_vars ( $vars )</SPAN> |
<li> |
3274 |
<BR> |
<span class="var-type">string</span> |
3275 |
|
<span class="var-name">$which</span><span class="var-description">: <p>- which tool link</p></span> </li> |
3276 |
<BR> |
<li> |
3277 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
3278 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$url</span><span class="var-description">: <p>- the url for that link</p></span> </li> |
3279 |
This function sets the save variables |
</ul> |
3280 |
<BR> |
|
3281 |
that the user/child wants to automatically |
|
3282 |
propogate |
</div> |
3283 |
<DL> |
<a name="method_set" id="_set"><!-- --></a> |
3284 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="evenrow"> |
3285 |
|
|
3286 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$vars</SPAN></SPAN> - name=>value pairs of the data |
<div class="method-header"> |
3287 |
that they want to propogate</DD> |
<span class="method-title">_set</span> (line <span class="line-number">885</span>) |
3288 |
|
</div> |
3289 |
|
|
3290 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
3291 |
|
<p class="short-description">This function is used to set the value of the control var</p> |
3292 |
</DL> |
|
3293 |
|
<div class="method-signature"> |
3294 |
</DIV> |
<span class="method-result">void</span> |
3295 |
<BR> |
<span class="method-name"> |
3296 |
|
_set |
3297 |
<DIV CLASS="function"> |
</span> |
3298 |
<A NAME='set_save_vars'><!-- --></A> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
3299 |
<SPAN CLASS="font12bold">set_save_vars</SPAN> |
</div> |
3300 |
<BR> |
|
3301 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<ul class="parameters"> |
3302 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li> |
3303 |
<span class="font10bold" style="color: #0000FF">set_save_vars ( $vars )</SPAN> |
<span class="var-type">string</span> |
3304 |
<BR> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li> |
3305 |
|
<li> |
3306 |
<BR> |
<span class="var-type">mixed</span> |
3307 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-name">$value</span><span class="var-description">: <p>- the new value for it.</p></span> </li> |
3308 |
<!-- ========== Info from phpDoc block ========= --> |
</ul> |
3309 |
This function sets the save variables |
|
3310 |
<BR> |
|
3311 |
that the user/child wants to automatically |
</div> |
3312 |
propogate |
<a name="method_show_results" id="_show_results"><!-- --></a> |
3313 |
<DL> |
<div class="oddrow"> |
3314 |
<DT class="font10bold">Function Parameters:</DT> |
|
3315 |
|
<div class="method-header"> |
3316 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$vars</SPAN></SPAN> - name=>value pairs of the data |
<span class="method-title">_show_results</span> (line <span class="line-number">1238</span>) |
3317 |
that they want to propogate</DD> |
</div> |
3318 |
|
|
3319 |
|
<!-- ========== Info from phpDoc block ========= --> |
3320 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">This function is used to let render() know that we should show the results or not.</p> |
3321 |
|
|
3322 |
</DL> |
<div class="method-signature"> |
3323 |
|
<span class="method-result">boolean</span> |
3324 |
</DIV> |
<span class="method-name"> |
3325 |
<BR> |
_show_results |
3326 |
|
</span> |
3327 |
<DIV CLASS="function"> |
() |
3328 |
<A NAME='set_search_type'><!-- --></A> |
</div> |
3329 |
<SPAN CLASS="font12bold">set_search_type</SPAN> |
|
3330 |
<BR> |
|
3331 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
3332 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
3333 |
<span class="font10bold" style="color: #0000FF">set_search_type ( $type )</SPAN> |
<h4>Inherited Methods</h4> |
3334 |
<BR> |
<a name='inherited_methods'><!-- --></a> |
3335 |
|
<!-- =========== Summary =========== --> |
3336 |
<BR> |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
3337 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<blockquote> |
3338 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
3339 |
This function sets the search type |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
3340 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
3341 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
3342 |
<DL> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
3343 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
3344 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
3345 |
<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">$type</SPAN></SPAN> - the search type |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
3346 |
"simple" or "advanced"</DD> |
</blockquote> |
3347 |
|
<!-- =========== Summary =========== --> |
3348 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
3349 |
<DT class="font10bold">Function Info:</DT> |
<blockquote> |
3350 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
3351 |
</DL> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
3352 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
3353 |
</DIV> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
3354 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
3355 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
3356 |
<DIV CLASS="function"> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
3357 |
<A NAME='set_show_results'><!-- --></A> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
3358 |
<SPAN CLASS="font12bold">set_show_results</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
3359 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
3360 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
3361 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
3362 |
<span class="font10bold" style="color: #0000FF">set_show_results ( [$flag = TRUE] )</SPAN> |
</blockquote> |
3363 |
<BR> |
|
3364 |
|
</div> |
3365 |
<BR> |
</div> |
3366 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
3367 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="notes" id="credit"> |
3368 |
This function is used to set the value |
Documention generated on Thu, 31 Jul 2003 18:32:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
3369 |
of the _show_results_flag |
</p> |
3370 |
<BR> |
</div></body> |
3371 |
|
</html> |
|
<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;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> - TRUE to show the results</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_simple_search_modifier'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_simple_search_modifier</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_simple_search_modifier ( [$modifier = SEARCH_ALL] )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Set the simple search modifyer |
|
|
<BR> |
|
|
flag. |
|
|
NOTE: by default all the modifiers |
|
|
are enabled. You can limit the |
|
|
modifiers by passing in the |
|
|
string of defines of which ones |
|
|
you want enabled. |
|
|
|
|
|
MODIFIERS: |
|
|
SEARCH_BEGINS_WITH |
|
|
SEARCH_CONTAINS |
|
|
SEARCH_EXACT |
|
|
SEARCH_ENDS_WITH |
|
|
|
|
|
ie. SEARCH_BEGINS_WITH.SEARCH_EXACT |
|
|
will enable ONLY the |
|
|
"begins with" and "exact" modifiers. |
|
|
<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">$modifier</SPAN></SPAN> </DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='showall'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">showall</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">showall ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
returns the current value of the showall |
|
|
flag. |
|
|
<BR> |
|
|
This tells us if they want the entire |
|
|
list of data back from the DB. |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current value</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='simple_search_modifier_value'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">simple_search_modifier_value</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">simple_search_modifier_value ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
returns the current value of the |
|
|
simple search modifier |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='user_setup'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">user_setup</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">user_setup ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
A subclass can override this function |
|
|
to setup the class variables after |
|
|
the constructor. |
|
|
<BR> |
|
|
The constructor |
|
|
automatically calls this function. |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_save_vars'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_save_vars</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_save_vars ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
this method builds some hidden |
|
|
form fields to automatically |
|
|
be placed inside the form. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_simple_search_modifier'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_simple_search_modifier</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_simple_search_modifier ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This builds the simple search modifier |
|
|
select box. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_tool_url'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_tool_url</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_tool_url ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function is used to build the url |
|
|
for a tool link. |
|
|
<BR> |
|
|
(first, prev, next, last, all) |
|
|
<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 for the link</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">$showall_flag</SPAN></SPAN> - add the showall value to the url</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">$showall_value</SPAN></SPAN> - the showall value to use if the flag is on</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_check_datasource'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_check_datasource</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_check_datasource ( $function_name )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
general DataListSource object checker. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_clean_string'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_clean_string</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_clean_string ( $obj, $col_name )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function is used to make sure that the string we are |
|
|
placing in a cell has been "cleaned" |
|
|
<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;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$obj</SPAN></SPAN> - the cell object. It can be a string.</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">$col_name</SPAN></SPAN> - the name of the column this object/string |
|
|
will live</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the cleaned string or object</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_filter_column_string'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_filter_column_string</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_filter_column_string ( $data )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This does some magic filtering on the data |
|
|
that we display in a column. |
|
|
<BR> |
|
|
This helps |
|
|
to prevent nast data that may have html |
|
|
tags in it. |
|
|
<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</SPAN></SPAN> - the column data u want to filter</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the cleaned/filtered data</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_get_searchable_fields'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_get_searchable_fields</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">array</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_get_searchable_fields ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This method gets the array of |
|
|
searchable header fields (columns) |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_javascript'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_javascript</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_javascript ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function provides a way to automatically |
|
|
add javascript to this object. |
|
|
<BR> |
|
|
This function is meant to be extended by the |
|
|
child class. |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_save_mozilla_nav_link'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_save_mozilla_nav_link</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_save_mozilla_nav_link ( $which, $url )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function stores the url for each of the tool |
|
|
urls, so we can push these out for mozilla. |
|
|
<BR> |
|
|
Mozilla has a nice navigation bar feature that |
|
|
lets you program first, prev, next, last links |
|
|
<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">$which</SPAN></SPAN> - which tool link</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">$url</SPAN></SPAN> - the url for that link</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_show_results'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_show_results</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_show_results ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function is used to let render() know |
|
|
that we should show the results or not. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
|
|
|
<hr> |
|
|
</HTML> |
|