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