| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Docs For Class DataList</title> |
<title>Docs For Class DataList</title> |
| 7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
</head> |
| 10 |
<body> |
<body> |
| 11 |
<div class="page-body"> |
<div class="page-body"> |
| 12 |
<h2 class="class-name">Class DataList</h2> |
<h2 class="class-name">Class DataList</h2> |
| 13 |
|
|
| 14 |
<a name="sec-description"></a> |
<a name="sec-description"></a> |
| 15 |
<div class="info-box"> |
<div class="info-box"> |
| 16 |
<div class="info-box-title">Description</div> |
<div class="info-box-title">Description</div> |
| 17 |
<div class="nav-bar"> |
<div class="nav-bar"> |
| 18 |
<span class="disabled">Description</span> | |
<span class="disabled">Description</span> | |
| 19 |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-descendents">Descendents</a> |
| 20 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 21 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 22 |
|
|
| 23 |
</div> |
</div> |
| 24 |
<div class="info-box-body"> |
<div class="info-box-body"> |
| 25 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
| 26 |
<p class="short-description">This object is the base class that can be</p> |
<p class="short-description">This object is the base class that can be</p> |
| 27 |
<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> |
<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 |
<ul class="tags"> |
<ul class="tags"> |
| 29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 30 |
</ul> |
</ul> |
| 31 |
<p class="notes"> |
<p class="notes"> |
| 32 |
Located in <a class="field" href="_widgets_data_list_DataList_inc.html">Program_Root/widgets/data_list/DataList.inc</a> (line <span class="field">108</span>) |
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 |
</p> |
</p> |
| 34 |
|
|
| 35 |
|
|
| 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 |
| |
| |
|
--DataList</pre> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-descendents"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Direct descendents</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<span class="disabled">Descendents</span> |
|
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
|
|
<tr> |
|
|
<th class="class-table-header">Class</th> |
|
|
<th class="class-table-header">Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a></td> |
|
|
<td> |
|
|
This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList. |
|
|
</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SimpleGUIDataList.html">SimpleGUIDataList</a></td> |
|
|
<td> |
|
|
This object is the base class that can be |
|
|
</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ListAction.html">ListAction</a></td> |
|
|
<td> |
|
|
A class for showing a list of items to preform an action on |
|
|
</td> |
|
|
</tr> |
|
|
</table> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-var-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Variable Summary</span></div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-descendents">Descendents</a> | |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
|
|
| |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<div class="var-summary"> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$alternating_row_colors" title="details" class="var-name">$alternating_row_colors</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_advanced_search_flag" title="details" class="var-name">$_advanced_search_flag</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">array</span> |
|
|
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
|
|
<a href="#$_datasource" title="details" class="var-name">$_datasource</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_default_orderby" title="details" class="var-name">$_default_orderby</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_default_reverseorder" title="details" class="var-name">$_default_reverseorder</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_form_attributes" title="details" class="var-name">$_form_attributes</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_form_render_flag" title="details" class="var-name">$_form_render_flag</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_global_prefix" title="details" class="var-name">$_global_prefix</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_image_path" title="details" class="var-name">$_image_path</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_max_rows" title="details" class="var-name">$_max_rows</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_num_columns" title="details" class="var-name">$_num_columns</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_num_pages" title="details" class="var-name">$_num_pages</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_save_vars" title="details" class="var-name">$_save_vars</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_search_flag" title="details" class="var-name">$_search_flag</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_search_table" title="details" class="var-name">$_search_table</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_show_results_flag" title="details" class="var-name">$_show_results_flag</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_simple_search_modifier" title="details" class="var-name">$_simple_search_modifier</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_vars" title="details" class="var-name">$_vars</a> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-method-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Method Summary</span></div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-descendents">Descendents</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
|
|
|
| |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<div class="method-summary"> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#DataList" title="details" class="method-name">DataList</a> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">array</span> |
|
|
<a href="#add_header_item" title="details" class="method-name">add_header_item</a> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#advanced_search_disable" title="details" class="method-name">advanced_search_disable</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#advanced_search_enable" title="details" class="method-name">advanced_search_enable</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_base_url" title="details" class="method-name">build_base_url</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">mixed</span> |
|
|
<a href="#build_column_item" title="details" class="method-name">build_column_item</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span> |
|
|
<a href="#build_column_url" title="details" class="method-name">build_column_url</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">Container</span> |
|
|
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_orderby_querystring" title="details" class="method-name">build_orderby_querystring</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_reverseorder_querystring" title="details" class="method-name">build_reverseorder_querystring</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_searchfield_querystring" title="details" class="method-name">build_searchfield_querystring</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_searchvalue_querystring" title="details" class="method-name">build_searchvalue_querystring</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#build_state_vars_query_string" title="details" class="method-name">build_state_vars_query_string</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, [<span class="var-type">mixed</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span> <span class="var-name">$showall_value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">Object</span> |
|
|
<a href="#build_tool_link" title="details" class="method-name">build_tool_link</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">Container</span> |
|
|
<a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">Container</span> |
|
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#data_prefetch" title="details" class="method-name">data_prefetch</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#do_action" title="details" class="method-name">do_action</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#filter_column_string" title="details" class="method-name">filter_column_string</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#get_current_page" title="details" class="method-name">get_current_page</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#get_data_source" title="details" class="method-name">get_data_source</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#get_default_num_rows" title="details" class="method-name">get_default_num_rows</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_form_action" title="details" class="method-name">get_form_action</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_form_method" title="details" class="method-name">get_form_method</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_form_name" title="details" class="method-name">get_form_name</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">bool</span> |
|
|
<a href="#get_form_render" title="details" class="method-name">get_form_render</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_form_target" title="details" class="method-name">get_form_target</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_global_prefix" title="details" class="method-name">get_global_prefix</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_image_path" title="details" class="method-name">get_image_path</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#get_last_page" title="details" class="method-name">get_last_page</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#get_max_rows" title="details" class="method-name">get_max_rows</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#get_num_pages" title="details" class="method-name">get_num_pages</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_page_info" title="details" class="method-name">get_page_info</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#get_simple_search_modifier" title="details" class="method-name">get_simple_search_modifier</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#is_advanced_search_enabled" title="details" class="method-name">is_advanced_search_enabled</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#is_search_enabled" title="details" class="method-name">is_search_enabled</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#numrows" title="details" class="method-name">numrows</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">int</span> |
|
|
<a href="#offset" title="details" class="method-name">offset</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string.</span> |
|
|
<a href="#orderby" title="details" class="method-name">orderby</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#render" title="details" class="method-name">render</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string.</span> |
|
|
<a href="#reverseorder" title="details" class="method-name">reverseorder</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#search_disable" title="details" class="method-name">search_disable</a> |
|
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#search_enable" title="details" class="method-name">search_enable</a> |
|
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#search_field" title="details" class="method-name">search_field</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#search_type" title="details" class="method-name">search_type</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#search_value" title="details" class="method-name">search_value</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#search_value_filter" title="details" class="method-name">search_value_filter</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#setup_columns" title="details" class="method-name">setup_columns</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_data_source" title="details" class="method-name">set_data_source</a> |
|
|
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_default_num_rows" title="details" class="method-name">set_default_num_rows</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_form_action" title="details" class="method-name">set_form_action</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_form_method" title="details" class="method-name">set_form_method</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_form_name" title="details" class="method-name">set_form_name</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_form_render" title="details" class="method-name">set_form_render</a> |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_form_target" title="details" class="method-name">set_form_target</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$target</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#set_image_path" title="details" class="method-name">set_image_path</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_max_rows" title="details" class="method-name">set_max_rows</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$max</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_numrows" title="details" class="method-name">set_numrows</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_save_vars" title="details" class="method-name">set_save_vars</a> |
|
|
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_show_results" title="details" class="method-name">set_show_results</a> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_simple_search_modifier" title="details" class="method-name">set_simple_search_modifier</a> |
|
|
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#showall" title="details" class="method-name">showall</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#simple_search_modifier_value" title="details" class="method-name">simple_search_modifier_value</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#user_setup" title="details" class="method-name">user_setup</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">Container</span> |
|
|
<a href="#_build_default_vars" title="details" class="method-name">_build_default_vars</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">mixed</span> |
|
|
<a href="#_build_save_vars" title="details" class="method-name">_build_save_vars</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
|
|
<a href="#_build_simple_search_modifier" title="details" class="method-name">_build_simple_search_modifier</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#_build_tool_url" title="details" class="method-name">_build_tool_url</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>, [<span class="var-type">boolean</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$showall_value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_check_datasource" title="details" class="method-name">_check_datasource</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">mixed</span> |
|
|
<a href="#_clean_string" title="details" class="method-name">_clean_string</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#_filter_column_string" title="details" class="method-name">_filter_column_string</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">the</span> |
|
|
<a href="#_get" title="details" class="method-name">_get</a> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">array</span> |
|
|
<a href="#_get_searchable_fields" title="details" class="method-name">_get_searchable_fields</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
|
|
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_save_mozilla_nav_link" title="details" class="method-name">_save_mozilla_nav_link</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$which</span>, <span class="var-type">string</span> <span class="var-name">$url</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_set" title="details" class="method-name">_set</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#_show_results" title="details" class="method-name">_show_results</a> |
|
|
() |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-vars"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Variables</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-descendents">Descendents</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|
|
|
|
|
|
|
|
| |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<a name="var$alternating_row_colors" id="$alternating_row_colors"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$alternating_row_colors</span> |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">138</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Do we want to alternate the row colors? This helps to see each row easier.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_advanced_search_flag" id="$_advanced_search_flag"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_advanced_search_flag</span> |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">187</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Flag to let us know that</p> |
|
|
<p class="description"><p>advanced search is enabled</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_columns" id="$_columns"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$_columns</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">220</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The column descriptions for the data we are working on</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_datasource" id="$_datasource"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
|
|
<span class="var-name">$_datasource</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">258</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">var:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_default_orderby" id="$_default_orderby"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_default_orderby</span> |
|
|
= <span class="var-default"> ''</span> (line <span class="line-number">167</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds the db column name that we want to order by default.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_default_reverseorder" id="$_default_reverseorder"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_default_reverseorder</span> |
|
|
= <span class="var-default"> "false"</span> (line <span class="line-number">173</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds a flag to let us know to</p> |
|
|
<p class="description"><p>reverse order the column by default</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_default_rows_per_page</span> |
|
|
= <span class="var-default"> 10</span> (line <span class="line-number">124</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The number of rows of data to show per "page".</p> |
|
|
<p class="description"><p>The default is 20.</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_form_attributes" id="$_form_attributes"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_form_attributes</span> |
|
|
= <span class="var-default">array("method" => "GET",<br /> "target" => "",<br /> "action" => "",<br /> "name" => "datalist")</span> (line <span class="line-number">232</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This holds the form attributes</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_form_render_flag" id="$_form_render_flag"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_form_render_flag</span> |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">241</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Build everything inside a form?</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_global_prefix" id="$_global_prefix"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_global_prefix</span> |
|
|
= <span class="var-default"> ''</span> (line <span class="line-number">145</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">prefix for all list variable names, so we can potentially have more then 1 list per page.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_image_path" id="$_image_path"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_image_path</span> |
|
|
= <span class="var-default"> "/phphtmllib/images/widgets"</span> (line <span class="line-number">266</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_max_rows" id="$_max_rows"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_max_rows</span> |
|
|
= <span class="var-default"> 200</span> (line <span class="line-number">131</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The max number of rows to show when the user does the "EXPAND" command.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_num_columns" id="$_num_columns"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_num_columns</span> |
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">225</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Keeps track of the # of columns we have</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_num_pages" id="$_num_pages"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_num_pages</span> |
|
|
= <span class="var-default">1</span> (line <span class="line-number">116</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This value holds the number of pages of data we have to display.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_save_vars" id="$_save_vars"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_save_vars</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">211</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This holds a list of name=>value vars that the caller/child wants to propogate automatically.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_search_flag" id="$_search_flag"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_search_flag</span> |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">180</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Flag to let us know that search is enabled.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_search_table" id="$_search_table"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_search_table</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">202</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds the object block that is the</p> |
|
|
<p class="description"><p>search UI</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_show_results_flag" id="$_show_results_flag"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_show_results_flag</span> |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">248</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">flag to let us know if we want to show the results or not.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_simple_search_modifier" id="$_simple_search_modifier"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_simple_search_modifier</span> |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">195</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Flag to enable simple search modifyer.</p> |
|
|
<p class="description"><p>IF enabled it will add a select that adds the "beings with", "contains" options for a simple search.</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_vars" id="$_vars"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_vars</span> |
|
|
= <span class="var-default">array("offsetVar" => "offset",<br /> "orderbyVar" => "orderby",<br /> "reverseorderVar" => "reverseorder",<br /> "numrowsVar" => "numrows",<br /> "showallVar" => "showall",<br /> "search_fieldVar" => "search_field",<br /> "search_valueVar" => "search_value",<br /> "search_typeVar" => "search_type",<br /> "simple_search_modifierVar" => "simple_search_modifier")</span> (line <span class="line-number">153</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds an array of all the form vars we need for this class to work.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Variables</h4> |
|
|
<A NAME='inherited_vars'><!-- --></A> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
|
|
</span> |
|
|
</blockquote> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
|
|
</span> |
|
|
</blockquote> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-methods"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Methods</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-descendents">Descendents</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<A NAME='method_detail'></A> |
|
|
<a name="methodDataList" id="DataList"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">Constructor DataList</span> (line <span class="line-number">277</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The constructor</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
DataList |
|
|
</span> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the data list</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$width</span><span class="var-description">: <p>- the overall width</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$default_orderby</span><span class="var-description">: <p>- the column to use as the default sorting order</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$default_reverseorder</span><span class="var-description">: <p>- sort the default column in reverse order?</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodadd_header_item" id="add_header_item"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">add_header_item</span> (line <span class="line-number">592</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function adds a header item to the column headers from a list of parameters.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>a single header array</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">array</span> |
|
|
<span class="method-name"> |
|
|
add_header_item |
|
|
</span> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$label</span><span class="var-description">: <p>- $label - the label to use for the column header.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$size</span><span class="var-description">: <p>- $size - the size for the table column.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$data_name</span><span class="var-description">: <p>- $dbfield - the db field associated with this label from the query.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$sortable</span><span class="var-description">: <p>- $sortable - flag to make this column sortable.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$searchable</span><span class="var-description">: <p>- $searchable - flag to make this column searchable.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$align</span><span class="var-description">: <p>- header align value.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$sortorder</span><span class="var-description">: <p>- the sort order</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$max_text_length</span><span class="var-description">: <p>- the maximum # of characters to allow in the cell.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodadvanced_search_disable" id="advanced_search_disable"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">advanced_search_disable</span> (line <span class="line-number">700</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Disable the advanced search</p> |
|
|
<p class="description"><p>capability</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
advanced_search_disable |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodadvanced_search_enable" id="advanced_search_enable"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">advanced_search_enable</span> (line <span class="line-number">688</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Enable the advanced search</p> |
|
|
<p class="description"><p>capability NOTE: Child class MUST extend the _build_advanced_search_table</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
advanced_search_enable |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_base_url" id="build_base_url"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_base_url</span> (line <span class="line-number">1303</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds the base url used by the column headers as well as the page tool links.</p> |
|
|
<p class="description"><p>it basically builds: $_SELF?$_GET</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_base_url |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_column_item" id="build_column_item"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_column_item</span> (line <span class="line-number">1079</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<p class="description"><p>NOTE: this function is meant to be overridden so that you can push whatever you want.</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- either a HTMLTag object, or raw text.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">mixed</span> |
|
|
<span class="method-name"> |
|
|
build_column_item |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- $row_data - the entire data for the row</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name - the name of the column header for this row to render.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_column_url" id="build_column_url"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_column_url</span> (line <span class="line-number">1610</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds a url for a particular column header.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object;</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span> |
|
|
<span class="method-name"> |
|
|
build_column_url |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_gui</span> (line <span class="line-number">399</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is responsible for calling the child class's methods for building the GUI container.</p> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">Container</span> |
|
|
<span class="method-name"> |
|
|
build_gui |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodbuild_gui">DefaultGUIDatalist::build_gui()</a> |
|
|
: Override the parent's method so we can wrap everything in a div to hold it all together when we change the alignment |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodbuild_orderby_querystring" id="build_orderby_querystring"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_orderby_querystring</span> (line <span class="line-number">926</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds a query string var for the orderby value.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_orderby_querystring |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_reverseorder_querystring" id="build_reverseorder_querystring"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_reverseorder_querystring</span> (line <span class="line-number">957</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds a query string var for the reverseorder value.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_reverseorder_querystring |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_searchfield_querystring" id="build_searchfield_querystring"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_searchfield_querystring</span> (line <span class="line-number">998</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds a query string var for the searchfield value.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_searchfield_querystring |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_searchvalue_querystring" id="build_searchvalue_querystring"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_searchvalue_querystring</span> (line <span class="line-number">1019</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds a query string var for the searchfield value.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- "orderby=(thevalue)"</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_searchvalue_querystring |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_state_vars_query_string" id="build_state_vars_query_string"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_state_vars_query_string</span> (line <span class="line-number">1480</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this function is used to build a sub query string</p> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- name=value& pairs</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
build_state_vars_query_string |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, [<span class="var-type">mixed</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">mixed</span> <span class="var-name">$showall_value</span>) |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_tool_link" id="build_tool_link"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_tool_link</span> (line <span class="line-number">1349</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the 'tool' images that allow you to walk through the data list itself.</p> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">Object</span> |
|
|
<span class="method-name"> |
|
|
build_tool_link |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$which</span><span class="var-description">: <p>- which tool image to build</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">530</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
child_add_row_cell |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$obj</span><span class="var-description">: <p>- the object/string/entity that should get put into the column row cell.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- the name/title of the column that the object will live in</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$last_in_row_flag</span><span class="var-description">: <p>- flag that tells the function if this is is the last cell for the current row.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_add_row_cell">SimpleGUIDataList::child_add_row_cell()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/ListAction.html#methodchild_add_row_cell">ListAction::child_add_row_cell()</a> |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_build_column_header</span> (line <span class="line-number">510</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
child_build_column_header |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the column</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$col_data</span><span class="var-description">: <p>- the column data ( from $this->_columns )</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$col_count</span><span class="var-description">: <p>- the column #</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_column_header">DefaultGUIDatalist::child_build_column_header()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_build_column_header">SimpleGUIDataList::child_build_column_header()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/ListAction.html#methodchild_build_column_header">ListAction::child_build_column_header()</a> |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_build_search_table</span> (line <span class="line-number">557</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the search block that lives above the results</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">Container</span> |
|
|
<span class="method-name"> |
|
|
child_build_search_table |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_search_table">DefaultGUIDatalist::child_build_search_table()</a> |
|
|
: This builds the table that holds the search capability. |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_get_gui</span> (line <span class="line-number">544</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">Container</span> |
|
|
<span class="method-name"> |
|
|
child_get_gui |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_get_gui">DefaultGUIDatalist::child_get_gui()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_get_gui">SimpleGUIDataList::child_get_gui()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/ListAction.html#methodchild_get_gui">ListAction::child_get_gui()</a> |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methoddata_prefetch" id="data_prefetch"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">data_prefetch</span> (line <span class="line-number">805</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set up any</p> |
|
|
<p class="description"><p>data that needs to be munged before the data is fetched from the DataListSource</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
data_prefetch |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methoddo_action" id="do_action"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">do_action</span> (line <span class="line-number">453</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
do_action |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodfilter_column_string" id="filter_column_string"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">filter_column_string</span> (line <span class="line-number">1664</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>the cleaned/filtered data</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
filter_column_string |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_current_page" id="get_current_page"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_current_page</span> (line <span class="line-number">1538</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the current page that the item list is on.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
get_current_page |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_data_source" id="get_data_source"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_data_source</span> (line <span class="line-number">465</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
get_data_source |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_default_num_rows" id="get_default_num_rows"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_default_num_rows</span> (line <span class="line-number">771</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function gets the current default number of rows to display setting.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
get_default_num_rows |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_form_action" id="get_form_action"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_form_action</span> (line <span class="line-number">1187</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to get the form action</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>(POST or GET)</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_form_action |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_form_method" id="get_form_method"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_form_method</span> (line <span class="line-number">1168</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to get the form method</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>(POST or GET)</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_form_method |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_form_name" id="get_form_name"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_form_name</span> (line <span class="line-number">1124</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to get the form name</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_form_name |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_form_render" id="get_form_render"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_form_render</span> (line <span class="line-number">1205</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Return the state of the form render</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">bool</span> |
|
|
<span class="method-name"> |
|
|
get_form_render |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_form_target" id="get_form_target"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_form_target</span> (line <span class="line-number">1144</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to get the form target</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_form_target |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_global_prefix" id="get_global_prefix"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_global_prefix</span> (line <span class="line-number">635</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the current variable prefix string being used.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- current global prefix</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_global_prefix |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_image_path" id="get_image_path"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_image_path</span> (line <span class="line-number">1518</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the path to the images used in this class</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_image_path |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_last_page" id="get_last_page"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_last_page</span> (line <span class="line-number">1566</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This calculates the last page # for this list of items</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
get_last_page |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_max_rows" id="get_max_rows"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_max_rows</span> (line <span class="line-number">781</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This returns the Maximum # of rows to display when in expand mode</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
get_max_rows |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_num_pages" id="get_num_pages"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_num_pages</span> (line <span class="line-number">1549</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the # of pages that are available for this list of items.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
get_num_pages |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_page_info" id="get_page_info"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_page_info</span> (line <span class="line-number">1577</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the string that describes the current page out of n pages the list is showing</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>(ie. 1 to 10 of 25)</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_page_info |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_simple_search_modifier" id="get_simple_search_modifier"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_simple_search_modifier</span> (line <span class="line-number">750</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">gets the value of the search modifier flag.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
get_simple_search_modifier |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodgui_init" id="gui_init"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">gui_init</span> (line <span class="line-number">492</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
gui_init |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodgui_init">DefaultGUIDatalist::gui_init()</a> |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodgui_init">SimpleGUIDataList::gui_init()</a> |
|
|
: Initialize the gui layout |
|
|
</li> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/ListAction.html#methodgui_init">ListAction::gui_init()</a> |
|
|
: Initialize the gui layout |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodis_advanced_search_enabled" id="is_advanced_search_enabled"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">is_advanced_search_enabled</span> (line <span class="line-number">710</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This returns the status of the advanced search flag.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
is_advanced_search_enabled |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodis_search_enabled" id="is_search_enabled"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">is_search_enabled</span> (line <span class="line-number">676</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">get the status of the search ability.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
is_search_enabled |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodnumrows" id="numrows"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">numrows</span> (line <span class="line-number">968</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the number of rows that the query found.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the number of rows</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
numrows |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodoffset" id="offset"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">offset</span> (line <span class="line-number">896</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the current value.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">int</span> |
|
|
<span class="method-name"> |
|
|
offset |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodorderby" id="orderby"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">orderby</span> (line <span class="line-number">916</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the value of the current orderby variable.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string.</span> |
|
|
<span class="method-name"> |
|
|
orderby |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodrender" id="render"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">render</span> (line <span class="line-number">321</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function renders the final</p> |
|
|
<p class="description"><p>widget</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
render |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
|
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodreverseorder" id="reverseorder"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">reverseorder</span> (line <span class="line-number">937</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the current value of the reverse order member variable.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string.</span> |
|
|
<span class="method-name"> |
|
|
reverseorder |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_disable" id="search_disable"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_disable</span> (line <span class="line-number">666</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Disable the search ability.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
search_disable |
|
|
</span> |
|
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">0</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_enable" id="search_enable"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_enable</span> (line <span class="line-number">654</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Enable the search ability.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
search_enable |
|
|
</span> |
|
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">0</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_field" id="search_field"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_field</span> (line <span class="line-number">988</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the current value of the search field name</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
search_field |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_type" id="search_type"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_type</span> (line <span class="line-number">1040</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the type of search being used</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
search_type |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_value" id="search_value"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_value</span> (line <span class="line-number">1009</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the current value of te search field value.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
search_value |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">search_value_filter</span> (line <span class="line-number">1756</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to make safe any query string value that is used</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
search_value_filter |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$value</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsetup_columns" id="setup_columns"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">setup_columns</span> (line <span class="line-number">827</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
setup_columns |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_data_source" id="set_data_source"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_data_source</span> (line <span class="line-number">645</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the DataListSource object for this instance</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_data_source |
|
|
</span> |
|
|
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
|
|
<span class="var-name">$datasource</span><span class="var-description">: <p>object</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_default_num_rows" id="set_default_num_rows"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_default_num_rows</span> (line <span class="line-number">761</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function sets the default # of rows per page to display. By default its 10.</p> |
|
|
<p class="description"><p>This lets the user override this value.</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_default_num_rows |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$num_rows</span><span class="var-description">: <p>- the # of rows to use.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_form_action" id="set_form_action"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_form_action</span> (line <span class="line-number">1177</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Sets the form action</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_form_action |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$action</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_form_method" id="set_form_method"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_form_method</span> (line <span class="line-number">1154</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the form method</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_form_method |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$method</span><span class="var-description">: <p>(POST or GET)</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_form_name" id="set_form_name"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_form_name</span> (line <span class="line-number">1114</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the form name</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_form_name |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_form_render" id="set_form_render"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_form_render</span> (line <span class="line-number">1196</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Sets whether to the output into a form</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_form_render |
|
|
</span> |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">bool</span> |
|
|
<span class="var-name">$flag</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_form_target" id="set_form_target"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_form_target</span> (line <span class="line-number">1134</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the form target</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_form_target |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$target</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$target</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_global_prefix</span> (line <span class="line-number">621</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_global_prefix |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for all vars.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_global_prefix">DefaultGUIDatalist::set_global_prefix()</a> |
|
|
: 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. |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="methodset_image_path" id="set_image_path"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_image_path</span> (line <span class="line-number">1528</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the path to the images used in this class</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
set_image_path |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_max_rows" id="set_max_rows"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_max_rows</span> (line <span class="line-number">793</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This sets the maximum # of rows to display when in expand mode</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_max_rows |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$max</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$max</span><span class="var-description">: <p>- new # of maximum rows to display when in 'expand' mode</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_not_found_message</span> (line <span class="line-number">1215</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the message displayed when no data is found</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_not_found_message |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$mesg</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_numrows" id="set_numrows"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_numrows</span> (line <span class="line-number">978</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function sets the # of rows to display per page.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_numrows |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$new_numrows</span><span class="var-description">: <p>- the # of rows</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_offset" id="set_offset"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_offset</span> (line <span class="line-number">906</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set/change the offset for this list.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_offset |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$new_offset</span><span class="var-description">: <p>- the new offset.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_reverseorder</span> (line <span class="line-number">947</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function sets the reverse order flag to a new value.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_reverseorder |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$new_value</span><span class="var-description">: <p>- the new value.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_save_vars" id="set_save_vars"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_save_vars</span> (line <span class="line-number">1270</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function sets the save variables that the user/child wants to automatically propogate</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_save_vars |
|
|
</span> |
|
|
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$vars</span><span class="var-description">: <p>- name=>value pairs of the data that they want to propogate</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_search_type</span> (line <span class="line-number">1050</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function sets the search type</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_search_type |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$type</span><span class="var-description">: <p>- the search type "simple" or "advanced"</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_show_results" id="set_show_results"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_show_results</span> (line <span class="line-number">1227</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the value of the _show_results_flag</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_show_results |
|
|
</span> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$flag</span><span class="var-description">: <p>- TRUE to show the results</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_simple_search_modifier" id="set_simple_search_modifier"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_simple_search_modifier</span> (line <span class="line-number">735</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Set the simple search modifyer flag.</p> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_simple_search_modifier |
|
|
</span> |
|
|
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$modifier</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodshowall" id="showall"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">showall</span> (line <span class="line-number">1062</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the current value</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
showall |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsimple_search_modifier_value" id="simple_search_modifier_value"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">simple_search_modifier_value</span> (line <span class="line-number">1030</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">returns the current value of the simple search modifier</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
simple_search_modifier_value |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methoduser_setup" id="user_setup"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">user_setup</span> (line <span class="line-number">478</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
user_setup |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_default_vars" id="_build_default_vars"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_default_vars</span> (line <span class="line-number">1282</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the list of</p> |
|
|
<p class="description"><p>default hidden form vars for when the datalist is being rendered as a POST</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">Container</span> |
|
|
<span class="method-name"> |
|
|
_build_default_vars |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_save_vars" id="_build_save_vars"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_save_vars</span> (line <span class="line-number">1254</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this method builds some hidden form fields to automatically be placed inside the form.</p> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>depending on form method</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">mixed</span> |
|
|
<span class="method-name"> |
|
|
_build_save_vars |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_simple_search_modifier" id="_build_simple_search_modifier"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_simple_search_modifier</span> (line <span class="line-number">1721</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds the simple search modifier select box.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
|
|
<span class="method-name"> |
|
|
_build_simple_search_modifier |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_tool_url" id="_build_tool_url"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_tool_url</span> (line <span class="line-number">1450</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to build the url for a tool link.</p> |
|
|
<p class="description"><p>(first, prev, next, last, all)</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
_build_tool_url |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$offset</span>, [<span class="var-type">boolean</span> <span class="var-name">$showall_flag</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$showall_value</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$offset</span><span class="var-description">: <p>- the offset for the link</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$showall_flag</span><span class="var-description">: <p>- add the showall value to the url</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$showall_value</span><span class="var-description">: <p>- the showall value to use if the flag is on</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_check_datasource" id="_check_datasource"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_check_datasource</span> (line <span class="line-number">847</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">general DataListSource object checker.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_check_datasource |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_clean_string" id="_clean_string"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_clean_string</span> (line <span class="line-number">1680</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to make sure that the string we are placing in a cell has been "cleaned"</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the cleaned string or object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">mixed</span> |
|
|
<span class="method-name"> |
|
|
_clean_string |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$obj</span><span class="var-description">: <p>- the cell object. It can be a string.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- the name of the column this object/string will live</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_filter_column_string" id="_filter_column_string"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_filter_column_string</span> (line <span class="line-number">1099</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>the cleaned/filtered data</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
_filter_column_string |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$data</span><span class="var-description">: <p>- the column data u want to filter</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_get" id="_get"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_get</span> (line <span class="line-number">870</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Function used to get the current value of one of the control vars for this class</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>current value or default if not set</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">the</span> |
|
|
<span class="method-name"> |
|
|
_get |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$default_value</span> = <span class="var-default">NULL</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$default_value</span><span class="var-description">: <p>- the default value if not set</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_get_searchable_fields" id="_get_searchable_fields"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_get_searchable_fields</span> (line <span class="line-number">1705</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This method gets the array of searchable header fields (columns)</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">array</span> |
|
|
<span class="method-name"> |
|
|
_get_searchable_fields |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_javascript" id="_javascript"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_javascript</span> (line <span class="line-number">571</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function provides a way to automatically add javascript to this object.</p> |
|
|
<p class="description"><p>This function is meant to be extended by the child class.</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
|
|
<span class="method-name"> |
|
|
_javascript |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefined in descendants as:</div> |
|
|
<ul class="redefinitions"> |
|
|
<li> |
|
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#method_javascript">DefaultGUIDatalist::_javascript()</a> |
|
|
: This function returns any Javascript required for this widget |
|
|
</li> |
|
|
</ul> |
|
|
</div> |
|
|
<a name="method_save_mozilla_nav_link" id="_save_mozilla_nav_link"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_save_mozilla_nav_link</span> (line <span class="line-number">1507</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function stores the url for each of the tool urls, so we can push these out for mozilla.</p> |
|
|
<p class="description"><p>Mozilla has a nice navigation bar feature that lets you program first, prev, next, last links</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_save_mozilla_nav_link |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$which</span><span class="var-description">: <p>- which tool link</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$url</span><span class="var-description">: <p>- the url for that link</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_set" id="_set"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_set</span> (line <span class="line-number">885</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the value of the control var</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_set |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the name we want to get</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$value</span><span class="var-description">: <p>- the new value for it.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_show_results" id="_show_results"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_show_results</span> (line <span class="line-number">1238</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to let render() know that we should show the results or not.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
_show_results |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Methods</h4> |
|
|
<a name='inherited_methods'><!-- --></a> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
|
|
</blockquote> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
|
|
</blockquote> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<p class="notes" id="credit"> |
|
|
Documention generated on Thu, 31 Jul 2003 18:32:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
|
|
</p> |
|
|
</div></body> |
|
|
</html> |
|
| 40 |
|
--DataList</pre> |
| 41 |
|
|
| 42 |
|
</div> |
| 43 |
|
</div> |
| 44 |
|
|
| 45 |
|
<a name="sec-descendents"></a> |
| 46 |
|
<div class="info-box"> |
| 47 |
|
<div class="info-box-title">Direct descendents</div> |
| 48 |
|
<div class="nav-bar"> |
| 49 |
|
<a href="#sec-description">Description</a> | |
| 50 |
|
<span class="disabled">Descendents</span> |
| 51 |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 52 |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 53 |
|
|
| 54 |
|
</div> |
| 55 |
|
<div class="info-box-body"> |
| 56 |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 57 |
|
<tr> |
| 58 |
|
<th class="class-table-header">Class</th> |
| 59 |
|
<th class="class-table-header">Description</th> |
| 60 |
|
</tr> |
| 61 |
|
<tr> |
| 62 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDatalist.html">DefaultGUIDatalist</a></td> |
| 63 |
|
<td> |
| 64 |
|
This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList. |
| 65 |
|
</td> |
| 66 |
|
</tr> |
| 67 |
|
<tr> |
| 68 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ListAction.html">ListAction</a></td> |
| 69 |
|
<td> |
| 70 |
|
A class for showing a list of items to preform an action on |
| 71 |
|
</td> |
| 72 |
|
</tr> |
| 73 |
|
<tr> |
| 74 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SimpleGUIDataList.html">SimpleGUIDataList</a></td> |
| 75 |
|
<td> |
| 76 |
|
This object is the base class that can be |
| 77 |
|
</td> |
| 78 |
|
</tr> |
| 79 |
|
</table> |
| 80 |
|
</div> |
| 81 |
|
</div> |
| 82 |
|
|
| 83 |
|
|
| 84 |
|
<a name="sec-var-summary"></a> |
| 85 |
|
<div class="info-box"> |
| 86 |
|
<div class="info-box-title">Variable Summary</span></div> |
| 87 |
|
<div class="nav-bar"> |
| 88 |
|
<a href="#sec-description">Description</a> | |
| 89 |
|
<a href="#sec-descendents">Descendents</a> | |
| 90 |
|
<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 |
|
|
| 94 |
|
</div> |
| 95 |
|
<div class="info-box-body"> |
| 96 |
|
<div class="var-summary"> |
| 97 |
|
<div class="var-title"> |
| 98 |
|
<span class="var-type">mixed</span> |
| 99 |
|
<a href="#$alternating_row_colors" title="details" class="var-name">$alternating_row_colors</a> |
| 100 |
|
</div> |
| 101 |
|
<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 |
|
</div> |
| 105 |
|
<div class="var-title"> |
| 106 |
|
<span class="var-type">array</span> |
| 107 |
|
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
| 108 |
|
</div> |
| 109 |
|
<div class="var-title"> |
| 110 |
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
| 111 |
|
<a href="#$_datasource" title="details" class="var-name">$_datasource</a> |
| 112 |
|
</div> |
| 113 |
|
<div class="var-title"> |
| 114 |
|
<span class="var-type">mixed</span> |
| 115 |
|
<a href="#$_default_orderby" title="details" class="var-name">$_default_orderby</a> |
| 116 |
|
</div> |
| 117 |
|
<div class="var-title"> |
| 118 |
|
<span class="var-type">mixed</span> |
| 119 |
|
<a href="#$_default_reverseorder" title="details" class="var-name">$_default_reverseorder</a> |
| 120 |
|
</div> |
| 121 |
|
<div class="var-title"> |
| 122 |
|
<span class="var-type">mixed</span> |
| 123 |
|
<a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a> |
| 124 |
|
</div> |
| 125 |
|
<div class="var-title"> |
| 126 |
|
<span class="var-type">mixed</span> |
| 127 |
|
<a href="#$_form_attributes" title="details" class="var-name">$_form_attributes</a> |
| 128 |
|
</div> |
| 129 |
|
<div class="var-title"> |
| 130 |
|
<span class="var-type">mixed</span> |
| 131 |
|
<a href="#$_form_render_flag" title="details" class="var-name">$_form_render_flag</a> |
| 132 |
|
</div> |
| 133 |
|
<div class="var-title"> |
| 134 |
|
<span class="var-type">mixed</span> |
| 135 |
|
<a href="#$_global_prefix" title="details" class="var-name">$_global_prefix</a> |
| 136 |
|
</div> |
| 137 |
|
<div class="var-title"> |
| 138 |
|
<span class="var-type">mixed</span> |
| 139 |
|
<a href="#$_image_path" title="details" class="var-name">$_image_path</a> |
| 140 |
|
</div> |
| 141 |
|
<div class="var-title"> |
| 142 |
|
<span class="var-type">mixed</span> |
| 143 |
|
<a href="#$_max_rows" title="details" class="var-name">$_max_rows</a> |
| 144 |
|
</div> |
| 145 |
|
<div class="var-title"> |
| 146 |
|
<span class="var-type">mixed</span> |
| 147 |
|
<a href="#$_num_columns" title="details" class="var-name">$_num_columns</a> |
| 148 |
|
</div> |
| 149 |
|
<div class="var-title"> |
| 150 |
|
<span class="var-type">mixed</span> |
| 151 |
|
<a href="#$_num_pages" title="details" class="var-name">$_num_pages</a> |
| 152 |
|
</div> |
| 153 |
|
<div class="var-title"> |
| 154 |
|
<span class="var-type">mixed</span> |
| 155 |
|
<a href="#$_save_vars" title="details" class="var-name">$_save_vars</a> |
| 156 |
|
</div> |
| 157 |
|
<div class="var-title"> |
| 158 |
|
<span class="var-type">mixed</span> |
| 159 |
|
<a href="#$_search_flag" title="details" class="var-name">$_search_flag</a> |
| 160 |
|
</div> |
| 161 |
|
<div class="var-title"> |
| 162 |
|
<span class="var-type">mixed</span> |
| 163 |
|
<a href="#$_search_table" title="details" class="var-name">$_search_table</a> |
| 164 |
|
</div> |
| 165 |
|
<div class="var-title"> |
| 166 |
|
<span class="var-type">mixed</span> |
| 167 |
|
<a href="#$_show_all_rows" title="details" class="var-name">$_show_all_rows</a> |
| 168 |
|
</div> |
| 169 |
|
<div class="var-title"> |
| 170 |
|
<span class="var-type">mixed</span> |
| 171 |
|
<a href="#$_show_results_flag" title="details" class="var-name">$_show_results_flag</a> |
| 172 |
|
</div> |
| 173 |
|
<div class="var-title"> |
| 174 |
|
<span class="var-type">mixed</span> |
| 175 |
|
<a href="#$_simple_search_modifier" title="details" class="var-name">$_simple_search_modifier</a> |
| 176 |
|
</div> |
| 177 |
|
<div class="var-title"> |
| 178 |
|
<span class="var-type">mixed</span> |
| 179 |
|
<a href="#$_vars" title="details" class="var-name">$_vars</a> |
| 180 |
|
</div> |
| 181 |
|
</div> |
| 182 |
|
</div> |
| 183 |
|
</div> |
| 184 |
|
|
| 185 |
|
<a name="sec-method-summary"></a> |
| 186 |
|
<div class="info-box"> |
| 187 |
|
<div class="info-box-title">Method Summary</span></div> |
| 188 |
|
<div class="nav-bar"> |
| 189 |
|
<a href="#sec-description">Description</a> | |
| 190 |
|
<a href="#sec-descendents">Descendents</a> | |
| 191 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 192 |
|
|
| 193 |
|
| |
| 194 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 195 |
|
</div> |
| 196 |
|
<div class="info-box-body"> |
| 197 |
|
<div class="method-summary"> |
| 198 |
|
|
| 199 |
|
<div class="method-definition"> |
| 200 |
|
<span class="method-result">DataList</span> |
| 201 |
|
<a href="#DataList" title="details" class="method-name">DataList</a> |
| 202 |
|
(<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 |
|
|
| 205 |
|
<div class="method-definition"> |
| 206 |
|
<span class="method-result">array</span> |
| 207 |
|
<a href="#add_header_item" title="details" class="method-name">add_header_item</a> |
| 208 |
|
(<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 |
|
</div> |
| 210 |
|
|
| 211 |
|
<div class="method-definition"> |
| 212 |
|
<span class="method-result">void</span> |
| 213 |
|
<a href="#advanced_search_disable" title="details" class="method-name">advanced_search_disable</a> |
| 214 |
|
() |
| 215 |
|
</div> |
| 216 |
|
|
| 217 |
|
<div class="method-definition"> |
| 218 |
|
<span class="method-result">void</span> |
| 219 |
|
<a href="#advanced_search_enable" title="details" class="method-name">advanced_search_enable</a> |
| 220 |
|
() |
| 221 |
|
</div> |
| 222 |
|
|
| 223 |
|
<div class="method-definition"> |
| 224 |
|
<span class="method-result">string</span> |
| 225 |
|
<a href="#build_base_url" title="details" class="method-name">build_base_url</a> |
| 226 |
|
() |
| 227 |
|
</div> |
| 228 |
|
|
| 229 |
|
<div class="method-definition"> |
| 230 |
|
<span class="method-result">mixed</span> |
| 231 |
|
<a href="#build_column_item" title="details" class="method-name">build_column_item</a> |
| 232 |
|
(<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 |
|
</div> |
| 234 |
|
|
| 235 |
|
<div class="method-definition"> |
| 236 |
|
<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 |
|
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
| 239 |
|
</div> |
| 240 |
|
|
| 241 |
|
<div class="method-definition"> |
| 242 |
|
<span class="method-result">Container</span> |
| 243 |
|
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
| 244 |
|
() |
| 245 |
|
</div> |
| 246 |
|
|
| 247 |
|
<div class="method-definition"> |
| 248 |
|
<span class="method-result">string</span> |
| 249 |
|
<a href="#build_orderby_querystring" title="details" class="method-name">build_orderby_querystring</a> |
| 250 |
|
() |
| 251 |
|
</div> |
| 252 |
|
|
| 253 |
|
<div class="method-definition"> |
| 254 |
|
<span class="method-result">string</span> |
| 255 |
|
<a href="#build_reverseorder_querystring" title="details" class="method-name">build_reverseorder_querystring</a> |
| 256 |
|
() |
| 257 |
|
</div> |
| 258 |
|
|
| 259 |
|
<div class="method-definition"> |
| 260 |
|
<span class="method-result">string</span> |
| 261 |
|
<a href="#build_searchfield_querystring" title="details" class="method-name">build_searchfield_querystring</a> |
| 262 |
|
() |
| 263 |
|
</div> |
| 264 |
|
|
| 265 |
|
<div class="method-definition"> |
| 266 |
|
<span class="method-result">string</span> |
| 267 |
|
<a href="#build_searchvalue_querystring" title="details" class="method-name">build_searchvalue_querystring</a> |
| 268 |
|
() |
| 269 |
|
</div> |
| 270 |
|
|
| 271 |
|
<div class="method-definition"> |
| 272 |
|
<span class="method-result">string</span> |
| 273 |
|
<a href="#build_state_vars_query_string" title="details" class="method-name">build_state_vars_query_string</a> |
| 274 |
|
(<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 |
|
</div> |
| 276 |
|
|
| 277 |
|
<div class="method-definition"> |
| 278 |
|
<span class="method-result">Object</span> |
| 279 |
|
<a href="#build_tool_link" title="details" class="method-name">build_tool_link</a> |
| 280 |
|
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
| 281 |
|
</div> |
| 282 |
|
|
| 283 |
|
<div class="method-definition"> |
| 284 |
|
<span class="method-result">void</span> |
| 285 |
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
| 286 |
|
(<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 |
|
</div> |
| 288 |
|
|
| 289 |
|
<div class="method-definition"> |
| 290 |
|
<span class="method-result">void</span> |
| 291 |
|
<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 |
|
</div> |
| 294 |
|
|
| 295 |
|
<div class="method-definition"> |
| 296 |
|
<span class="method-result">Container</span> |
| 297 |
|
<a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a> |
| 298 |
|
() |
| 299 |
|
</div> |
| 300 |
|
|
| 301 |
|
<div class="method-definition"> |
| 302 |
|
<span class="method-result">Container</span> |
| 303 |
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
| 304 |
|
() |
| 305 |
|
</div> |
| 306 |
|
|
| 307 |
|
<div class="method-definition"> |
| 308 |
|
<span class="method-result">void</span> |
| 309 |
|
<a href="#data_prefetch" title="details" class="method-name">data_prefetch</a> |
| 310 |
|
() |
| 311 |
|
</div> |
| 312 |
|
|
| 313 |
|
<div class="method-definition"> |
| 314 |
|
<span class="method-result">void</span> |
| 315 |
|
<a href="#do_action" title="details" class="method-name">do_action</a> |
| 316 |
|
() |
| 317 |
|
</div> |
| 318 |
|
|
| 319 |
|
<div class="method-definition"> |
| 320 |
|
<span class="method-result">string</span> |
| 321 |
|
<a href="#expandrows" title="details" class="method-name">expandrows</a> |
| 322 |
|
() |
| 323 |
|
</div> |
| 324 |
|
|
| 325 |
|
<div class="method-definition"> |
| 326 |
|
<span class="method-result">string</span> |
| 327 |
|
<a href="#filter_column_string" title="details" class="method-name">filter_column_string</a> |
| 328 |
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
| 329 |
|
</div> |
| 330 |
|
|
| 331 |
|
<div class="method-definition"> |
| 332 |
|
<span class="method-result">int</span> |
| 333 |
|
<a href="#get_current_page" title="details" class="method-name">get_current_page</a> |
| 334 |
|
() |
| 335 |
|
</div> |
| 336 |
|
|
| 337 |
|
<div class="method-definition"> |
| 338 |
|
<span class="method-result">void</span> |
| 339 |
|
<a href="#get_data_source" title="details" class="method-name">get_data_source</a> |
| 340 |
|
() |
| 341 |
|
</div> |
| 342 |
|
|
| 343 |
|
<div class="method-definition"> |
| 344 |
|
<span class="method-result">int</span> |
| 345 |
|
<a href="#get_default_num_rows" title="details" class="method-name">get_default_num_rows</a> |
| 346 |
|
() |
| 347 |
|
</div> |
| 348 |
|
|
| 349 |
|
<div class="method-definition"> |
| 350 |
|
<span class="method-result">string</span> |
| 351 |
|
<a href="#get_form_action" title="details" class="method-name">get_form_action</a> |
| 352 |
|
() |
| 353 |
|
</div> |
| 354 |
|
|
| 355 |
|
<div class="method-definition"> |
| 356 |
|
<span class="method-result">string</span> |
| 357 |
|
<a href="#get_form_method" title="details" class="method-name">get_form_method</a> |
| 358 |
|
() |
| 359 |
|
</div> |
| 360 |
|
|
| 361 |
|
<div class="method-definition"> |
| 362 |
|
<span class="method-result">string</span> |
| 363 |
|
<a href="#get_form_name" title="details" class="method-name">get_form_name</a> |
| 364 |
|
() |
| 365 |
|
</div> |
| 366 |
|
|
| 367 |
|
<div class="method-definition"> |
| 368 |
|
<span class="method-result">bool</span> |
| 369 |
|
<a href="#get_form_render" title="details" class="method-name">get_form_render</a> |
| 370 |
|
() |
| 371 |
|
</div> |
| 372 |
|
|
| 373 |
|
<div class="method-definition"> |
| 374 |
|
<span class="method-result">string</span> |
| 375 |
|
<a href="#get_form_target" title="details" class="method-name">get_form_target</a> |
| 376 |
|
() |
| 377 |
|
</div> |
| 378 |
|
|
| 379 |
|
<div class="method-definition"> |
| 380 |
|
<span class="method-result">string</span> |
| 381 |
|
<a href="#get_global_prefix" title="details" class="method-name">get_global_prefix</a> |
| 382 |
|
() |
| 383 |
|
</div> |
| 384 |
|
|
| 385 |
|
<div class="method-definition"> |
| 386 |
|
<span class="method-result">string</span> |
| 387 |
|
<a href="#get_image_path" title="details" class="method-name">get_image_path</a> |
| 388 |
|
() |
| 389 |
|
</div> |
| 390 |
|
|
| 391 |
|
<div class="method-definition"> |
| 392 |
|
<span class="method-result">int</span> |
| 393 |
|
<a href="#get_last_page" title="details" class="method-name">get_last_page</a> |
| 394 |
|
() |
| 395 |
|
</div> |
| 396 |
|
|
| 397 |
|
<div class="method-definition"> |
| 398 |
|
<span class="method-result">int</span> |
| 399 |
|
<a href="#get_max_rows" title="details" class="method-name">get_max_rows</a> |
| 400 |
|
() |
| 401 |
|
</div> |
| 402 |
|
|
| 403 |
|
<div class="method-definition"> |
| 404 |
|
<span class="method-result">int</span> |
| 405 |
|
<a href="#get_num_pages" title="details" class="method-name">get_num_pages</a> |
| 406 |
|
() |
| 407 |
|
</div> |
| 408 |
|
|
| 409 |
|
<div class="method-definition"> |
| 410 |
|
<span class="method-result">string</span> |
| 411 |
|
<a href="#get_page_info" title="details" class="method-name">get_page_info</a> |
| 412 |
|
() |
| 413 |
|
</div> |
| 414 |
|
|
| 415 |
|
<div class="method-definition"> |
| 416 |
|
<span class="method-result">boolean</span> |
| 417 |
|
<a href="#get_showall" title="details" class="method-name">get_showall</a> |
| 418 |
|
() |
| 419 |
|
</div> |
| 420 |
|
|
| 421 |
|
<div class="method-definition"> |
| 422 |
|
<span class="method-result">void</span> |
| 423 |
|
<a href="#get_simple_search_modifier" title="details" class="method-name">get_simple_search_modifier</a> |
| 424 |
|
() |
| 425 |
|
</div> |
| 426 |
|
|
| 427 |
|
<div class="method-definition"> |
| 428 |
|
<span class="method-result">void</span> |
| 429 |
|
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
| 430 |
|
() |
| 431 |
|
</div> |
| 432 |
|
|
| 433 |
|
<div class="method-definition"> |
| 434 |
|
<span class="method-result">boolean</span> |
| 435 |
|
<a href="#is_advanced_search_enabled" title="details" class="method-name">is_advanced_search_enabled</a> |
| 436 |
|
() |
| 437 |
|
</div> |
| 438 |
|
|
| 439 |
|
<div class="method-definition"> |
| 440 |
|
<span class="method-result">boolean</span> |
| 441 |
|
<a href="#is_search_enabled" title="details" class="method-name">is_search_enabled</a> |
| 442 |
|
() |
| 443 |
|
</div> |
| 444 |
|
|
| 445 |
|
<div class="method-definition"> |
| 446 |
|
<span class="method-result">int</span> |
| 447 |
|
<a href="#numrows" title="details" class="method-name">numrows</a> |
| 448 |
|
() |
| 449 |
|
</div> |
| 450 |
|
|
| 451 |
|
<div class="method-definition"> |
| 452 |
|
<span class="method-result">int</span> |
| 453 |
|
<a href="#offset" title="details" class="method-name">offset</a> |
| 454 |
|
() |
| 455 |
|
</div> |
| 456 |
|
|
| 457 |
|
<div class="method-definition"> |
| 458 |
|
<span class="method-result">string.</span> |
| 459 |
|
<a href="#orderby" title="details" class="method-name">orderby</a> |
| 460 |
|
() |
| 461 |
|
</div> |
| 462 |
|
|
| 463 |
|
<div class="method-definition"> |
| 464 |
|
<span class="method-result">void</span> |
| 465 |
|
<a href="#render" title="details" class="method-name">render</a> |
| 466 |
|
(<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 |
|
</div> |
| 468 |
|
|
| 469 |
|
<div class="method-definition"> |
| 470 |
|
<span class="method-result">string.</span> |
| 471 |
|
<a href="#reverseorder" title="details" class="method-name">reverseorder</a> |
| 472 |
|
() |
| 473 |
|
</div> |
| 474 |
|
|
| 475 |
|
<div class="method-definition"> |
| 476 |
|
<span class="method-result">void</span> |
| 477 |
|
<a href="#search_disable" title="details" class="method-name">search_disable</a> |
| 478 |
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
| 479 |
|
</div> |
| 480 |
|
|
| 481 |
|
<div class="method-definition"> |
| 482 |
|
<span class="method-result">void</span> |
| 483 |
|
<a href="#search_enable" title="details" class="method-name">search_enable</a> |
| 484 |
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
| 485 |
|
</div> |
| 486 |
|
|
| 487 |
|
<div class="method-definition"> |
| 488 |
|
<span class="method-result">string</span> |
| 489 |
|
<a href="#search_field" title="details" class="method-name">search_field</a> |
| 490 |
|
() |
| 491 |
|
</div> |
| 492 |
|
|
| 493 |
|
<div class="method-definition"> |
| 494 |
|
<span class="method-result">string</span> |
| 495 |
|
<a href="#search_type" title="details" class="method-name">search_type</a> |
| 496 |
|
() |
| 497 |
|
</div> |
| 498 |
|
|
| 499 |
|
<div class="method-definition"> |
| 500 |
|
<span class="method-result">string</span> |
| 501 |
|
<a href="#search_value" title="details" class="method-name">search_value</a> |
| 502 |
|
() |
| 503 |
|
</div> |
| 504 |
|
|
| 505 |
|
<div class="method-definition"> |
| 506 |
|
<span class="method-result">string</span> |
| 507 |
|
<a href="#search_value_filter" title="details" class="method-name">search_value_filter</a> |
| 508 |
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
| 509 |
|
</div> |
| 510 |
|
|
| 511 |
|
<div class="method-definition"> |
| 512 |
|
<span class="method-result">void</span> |
| 513 |
|
<a href="#setup_columns" title="details" class="method-name">setup_columns</a> |
| 514 |
|
() |
| 515 |
|
</div> |
| 516 |
|
|
| 517 |
|
<div class="method-definition"> |
| 518 |
|
<span class="method-result">void</span> |
| 519 |
|
<a href="#set_data_source" title="details" class="method-name">set_data_source</a> |
| 520 |
|
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
| 521 |
|
</div> |
| 522 |
|
|
| 523 |
|
<div class="method-definition"> |
| 524 |
|
<span class="method-result">void</span> |
| 525 |
|
<a href="#set_default_num_rows" title="details" class="method-name">set_default_num_rows</a> |
| 526 |
|
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
| 527 |
|
</div> |
| 528 |
|
|
| 529 |
|
<div class="method-definition"> |
| 530 |
|
<span class="method-result">void</span> |
| 531 |
|
<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 |
|
|
| 535 |
|
<div class="method-definition"> |
| 536 |
|
<span class="method-result">void</span> |
| 537 |
|
<a href="#set_form_action" title="details" class="method-name">set_form_action</a> |
| 538 |
|
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
| 539 |
|
</div> |
| 540 |
|
|
| 541 |
|
<div class="method-definition"> |
| 542 |
|
<span class="method-result">void</span> |
| 543 |
|
<a href="#set_form_method" title="details" class="method-name">set_form_method</a> |
| 544 |
|
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
| 545 |
|
</div> |
| 546 |
|
|
| 547 |
|
<div class="method-definition"> |
| 548 |
|
<span class="method-result">void</span> |
| 549 |
|
<a href="#set_form_name" title="details" class="method-name">set_form_name</a> |
| 550 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
| 551 |
|
</div> |
| 552 |
|
|
| 553 |
|
<div class="method-definition"> |
| 554 |
|
<span class="method-result">void</span> |
| 555 |
|
<a href="#set_form_render" title="details" class="method-name">set_form_render</a> |
| 556 |
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
| 557 |
|
</div> |
| 558 |
|
|
| 559 |
|
<div class="method-definition"> |
| 560 |
|
<span class="method-result">void</span> |
| 561 |
|
<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 |
|
</div> |
| 564 |
|
|
| 565 |
|
<div class="method-definition"> |
| 566 |
|
<span class="method-result">void</span> |
| 567 |
|
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
| 568 |
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
| 569 |
|
</div> |
| 570 |
|
|
| 571 |
|
<div class="method-definition"> |
| 572 |
|
<span class="method-result">string</span> |
| 573 |
|
<a href="#set_image_path" title="details" class="method-name">set_image_path</a> |
| 574 |
|
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
| 575 |
|
</div> |
| 576 |
|
|
| 577 |
|
<div class="method-definition"> |
| 578 |
|
<span class="method-result">void</span> |
| 579 |
|
<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 |
|
</div> |
| 582 |
|
|
| 583 |
|
<div class="method-definition"> |
| 584 |
|
<span class="method-result">void</span> |
| 585 |
|
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
| 586 |
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 587 |
|
</div> |
| 588 |
|
|
| 589 |
|
<div class="method-definition"> |
| 590 |
|
<span class="method-result">void</span> |
| 591 |
|
<a href="#set_numrows" title="details" class="method-name">set_numrows</a> |
| 592 |
|
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
| 593 |
|
</div> |
| 594 |
|
|
| 595 |
|
<div class="method-definition"> |
| 596 |
|
<span class="method-result">void</span> |
| 597 |
|
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
| 598 |
|
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
| 599 |
|
</div> |
| 600 |
|
|
| 601 |
|
<div class="method-definition"> |
| 602 |
|
<span class="method-result">void</span> |
| 603 |
|
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
| 604 |
|
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
| 605 |
|
</div> |
| 606 |
|
|
| 607 |
|
<div class="method-definition"> |
| 608 |
|
<span class="method-result">void</span> |
| 609 |
|
<a href="#set_save_vars" title="details" class="method-name">set_save_vars</a> |
| 610 |
|
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
| 611 |
|
</div> |
| 612 |
|
|
| 613 |
|
<div class="method-definition"> |
| 614 |
|
<span class="method-result">void</span> |
| 615 |
|
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
| 616 |
|
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
| 617 |
|
</div> |
| 618 |
|
|
| 619 |
|
<div class="method-definition"> |
| 620 |
|
<span class="method-result">void</span> |
| 621 |
|
<a href="#set_showall" title="details" class="method-name">set_showall</a> |
| 622 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 623 |
|
</div> |
| 624 |
|
|
| 625 |
|
<div class="method-definition"> |
| 626 |
|
<span class="method-result">void</span> |
| 627 |
|
<a href="#set_show_results" title="details" class="method-name">set_show_results</a> |
| 628 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 629 |
|
</div> |
| 630 |
|
|
| 631 |
|
<div class="method-definition"> |
| 632 |
|
<span class="method-result">void</span> |
| 633 |
|
<a href="#set_simple_search_modifier" title="details" class="method-name">set_simple_search_modifier</a> |
| 634 |
|
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
| 635 |
|
</div> |
| 636 |
|
|
| 637 |
|
<div class="method-definition"> |
| 638 |
|
<span class="method-result">string</span> |
| 639 |
|
<a href="#simple_search_modifier_value" title="details" class="method-name">simple_search_modifier_value</a> |
| 640 |
|
() |
| 641 |
|
</div> |
| 642 |
|
|
| 643 |
|
<div class="method-definition"> |
| 644 |
|
<span class="method-result">void</span> |
| 645 |
|
<a href="#user_setup" title="details" class="method-name">user_setup</a> |
| 646 |
|
() |
| 647 |
|
</div> |
| 648 |
|
|
| 649 |
|
<div class="method-definition"> |
| 650 |
|
<span class="method-result">Container</span> |
| 651 |
|
<a href="#_build_default_vars" title="details" class="method-name">_build_default_vars</a> |
| 652 |
|
() |
| 653 |
|
</div> |
| 654 |
|
|
| 655 |
|
<div class="method-definition"> |
| 656 |
|
<span class="method-result">mixed</span> |
| 657 |
|
<a href="#_build_save_vars" title="details" class="method-name">_build_save_vars</a> |
| 658 |
|
() |
| 659 |
|
</div> |
| 660 |
|
|
| 661 |
|
<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 |
|
() |
| 665 |
|
</div> |
| 666 |
|
|
| 667 |
|
<div class="method-definition"> |
| 668 |
|
<span class="method-result">string</span> |
| 669 |
|
<a href="#_build_tool_url" title="details" class="method-name">_build_tool_url</a> |
| 670 |
|
(<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 |
|
</div> |
| 672 |
|
|
| 673 |
|
<div class="method-definition"> |
| 674 |
|
<span class="method-result">void</span> |
| 675 |
|
<a href="#_check_datasource" title="details" class="method-name">_check_datasource</a> |
| 676 |
|
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
| 677 |
|
</div> |
| 678 |
|
|
| 679 |
|
<div class="method-definition"> |
| 680 |
|
<span class="method-result">mixed</span> |
| 681 |
|
<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 |
|
</div> |
| 684 |
|
|
| 685 |
|
<div class="method-definition"> |
| 686 |
|
<span class="method-result">string</span> |
| 687 |
|
<a href="#_filter_column_string" title="details" class="method-name">_filter_column_string</a> |
| 688 |
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
| 689 |
|
</div> |
| 690 |
|
|
| 691 |
|
<div class="method-definition"> |
| 692 |
|
<span class="method-result">the</span> |
| 693 |
|
<a href="#_get" title="details" class="method-name">_get</a> |
| 694 |
|
(<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 |
|
</div> |
| 696 |
|
|
| 697 |
|
<div class="method-definition"> |
| 698 |
|
<span class="method-result">array</span> |
| 699 |
|
<a href="#_get_searchable_fields" title="details" class="method-name">_get_searchable_fields</a> |
| 700 |
|
() |
| 701 |
|
</div> |
| 702 |
|
|
| 703 |
|
<div class="method-definition"> |
| 704 |
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
| 705 |
|
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
| 706 |
|
() |
| 707 |
|
</div> |
| 708 |
|
|
| 709 |
|
<div class="method-definition"> |
| 710 |
|
<span class="method-result">void</span> |
| 711 |
|
<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 |
|
</div> |
| 714 |
|
|
| 715 |
|
<div class="method-definition"> |
| 716 |
|
<span class="method-result">void</span> |
| 717 |
|
<a href="#_set" title="details" class="method-name">_set</a> |
| 718 |
|
(<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 |
|
</div> |
| 720 |
|
|
| 721 |
|
<div class="method-definition"> |
| 722 |
|
<span class="method-result">boolean</span> |
| 723 |
|
<a href="#_show_results" title="details" class="method-name">_show_results</a> |
| 724 |
|
() |
| 725 |
|
</div> |
| 726 |
|
</div> |
| 727 |
|
</div> |
| 728 |
|
</div> |
| 729 |
|
|
| 730 |
|
<a name="sec-vars"></a> |
| 731 |
|
<div class="info-box"> |
| 732 |
|
<div class="info-box-title">Variables</div> |
| 733 |
|
<div class="nav-bar"> |
| 734 |
|
<a href="#sec-description">Description</a> | |
| 735 |
|
<a href="#sec-descendents">Descendents</a> | |
| 736 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 737 |
|
|
| 738 |
|
|
| 739 |
|
| |
| 740 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 741 |
|
|
| 742 |
|
</div> |
| 743 |
|
<div class="info-box-body"> |
| 744 |
|
<a name="var$alternating_row_colors" id="$alternating_row_colors"><!-- --></A> |
| 745 |
|
<div class="oddrow"> |
| 746 |
|
|
| 747 |
|
<div class="var-header"> |
| 748 |
|
<span class="var-title"> |
| 749 |
|
<span class="var-type">mixed</span> |
| 750 |
|
<span class="var-name">$alternating_row_colors</span> |
| 751 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">150</span>) |
| 752 |
|
</span> |
| 753 |
|
</div> |
| 754 |
|
|
| 755 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 756 |
|
<p class="short-description">Do we want to alternate the row colors? This helps to see each row easier.</p> |
| 757 |
|
|
| 758 |
|
|
| 759 |
|
|
| 760 |
|
|
| 761 |
|
|
| 762 |
|
</div> |
| 763 |
|
<a name="var$_advanced_search_flag" id="$_advanced_search_flag"><!-- --></A> |
| 764 |
|
<div class="evenrow"> |
| 765 |
|
|
| 766 |
|
<div class="var-header"> |
| 767 |
|
<span class="var-title"> |
| 768 |
|
<span class="var-type">mixed</span> |
| 769 |
|
<span class="var-name">$_advanced_search_flag</span> |
| 770 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">199</span>) |
| 771 |
|
</span> |
| 772 |
|
</div> |
| 773 |
|
|
| 774 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 775 |
|
<p class="short-description">Flag to let us know that</p> |
| 776 |
|
<p class="description"><p>advanced search is enabled</p></p> |
| 777 |
|
|
| 778 |
|
|
| 779 |
|
|
| 780 |
|
|
| 781 |
|
|
| 782 |
|
</div> |
| 783 |
|
<a name="var$_columns" id="$_columns"><!-- --></A> |
| 784 |
|
<div class="oddrow"> |
| 785 |
|
|
| 786 |
|
<div class="var-header"> |
| 787 |
|
<span class="var-title"> |
| 788 |
|
<span class="var-type">array</span> |
| 789 |
|
<span class="var-name">$_columns</span> |
| 790 |
|
= <span class="var-default">array()</span> (line <span class="line-number">232</span>) |
| 791 |
|
</span> |
| 792 |
|
</div> |
| 793 |
|
|
| 794 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 795 |
|
<p class="short-description">The column descriptions for the data we are working on</p> |
| 796 |
|
|
| 797 |
|
|
| 798 |
|
|
| 799 |
|
|
| 800 |
|
|
| 801 |
|
</div> |
| 802 |
|
<a name="var$_datasource" id="$_datasource"><!-- --></A> |
| 803 |
|
<div class="evenrow"> |
| 804 |
|
|
| 805 |
|
<div class="var-header"> |
| 806 |
|
<span class="var-title"> |
| 807 |
|
<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
| 808 |
|
<span class="var-name">$_datasource</span> |
| 809 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">270</span>) |
| 810 |
|
</span> |
| 811 |
|
</div> |
| 812 |
|
|
| 813 |
|
<!-- ========== 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 |
|
<ul class="tags"> |
| 816 |
|
<li><span class="field">var:</span> object</li> |
| 817 |
|
</ul> |
| 818 |
|
|
| 819 |
|
|
| 820 |
|
|
| 821 |
|
|
| 822 |
|
|
| 823 |
|
</div> |
| 824 |
|
<a name="var$_default_orderby" id="$_default_orderby"><!-- --></A> |
| 825 |
|
<div class="oddrow"> |
| 826 |
|
|
| 827 |
|
<div class="var-header"> |
| 828 |
|
<span class="var-title"> |
| 829 |
|
<span class="var-type">mixed</span> |
| 830 |
|
<span class="var-name">$_default_orderby</span> |
| 831 |
|
= <span class="var-default"> ''</span> (line <span class="line-number">179</span>) |
| 832 |
|
</span> |
| 833 |
|
</div> |
| 834 |
|
|
| 835 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 836 |
|
<p class="short-description">Holds the db column name that we want to order by default.</p> |
| 837 |
|
|
| 838 |
|
|
| 839 |
|
|
| 840 |
|
|
| 841 |
|
|
| 842 |
|
</div> |
| 843 |
|
<a name="var$_default_reverseorder" id="$_default_reverseorder"><!-- --></A> |
| 844 |
|
<div class="evenrow"> |
| 845 |
|
|
| 846 |
|
<div class="var-header"> |
| 847 |
|
<span class="var-title"> |
| 848 |
|
<span class="var-type">mixed</span> |
| 849 |
|
<span class="var-name">$_default_reverseorder</span> |
| 850 |
|
= <span class="var-default"> "false"</span> (line <span class="line-number">185</span>) |
| 851 |
|
</span> |
| 852 |
|
</div> |
| 853 |
|
|
| 854 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 855 |
|
<p class="short-description">Holds a flag to let us know to</p> |
| 856 |
|
<p class="description"><p>reverse order the column by default</p></p> |
| 857 |
|
|
| 858 |
|
|
| 859 |
|
|
| 860 |
|
|
| 861 |
|
|
| 862 |
|
</div> |
| 863 |
|
<a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A> |
| 864 |
|
<div class="oddrow"> |
| 865 |
|
|
| 866 |
|
<div class="var-header"> |
| 867 |
|
<span class="var-title"> |
| 868 |
|
<span class="var-type">mixed</span> |
| 869 |
|
<span class="var-name">$_default_rows_per_page</span> |
| 870 |
|
= <span class="var-default"> 10</span> (line <span class="line-number">129</span>) |
| 871 |
|
</span> |
| 872 |
|
</div> |
| 873 |
|
|
| 874 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 875 |
|
<p class="short-description">The number of rows of data to show per "page".</p> |
| 876 |
|
<p class="description"><p>The default is 20.</p></p> |
| 877 |
|
|
| 878 |
|
|
| 879 |
|
|
| 880 |
|
|
| 881 |
|
|
| 882 |
|
</div> |
| 883 |
|
<a name="var$_form_attributes" id="$_form_attributes"><!-- --></A> |
| 884 |
|
<div class="evenrow"> |
| 885 |
|
|
| 886 |
|
<div class="var-header"> |
| 887 |
|
<span class="var-title"> |
| 888 |
|
<span class="var-type">mixed</span> |
| 889 |
|
<span class="var-name">$_form_attributes</span> |
| 890 |
|
= <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 |
|
</div> |
| 893 |
|
|
| 894 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 895 |
|
<p class="short-description">This holds the form attributes</p> |
| 896 |
|
|
| 897 |
|
|
| 898 |
|
|
| 899 |
|
|
| 900 |
|
|
| 901 |
|
</div> |
| 902 |
|
<a name="var$_form_render_flag" id="$_form_render_flag"><!-- --></A> |
| 903 |
|
<div class="oddrow"> |
| 904 |
|
|
| 905 |
|
<div class="var-header"> |
| 906 |
|
<span class="var-title"> |
| 907 |
|
<span class="var-type">mixed</span> |
| 908 |
|
<span class="var-name">$_form_render_flag</span> |
| 909 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">253</span>) |
| 910 |
|
</span> |
| 911 |
|
</div> |
| 912 |
|
|
| 913 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 914 |
|
<p class="short-description">Build everything inside a form?</p> |
| 915 |
|
|
| 916 |
|
|
| 917 |
|
|
| 918 |
|
|
| 919 |
|
|
| 920 |
|
</div> |
| 921 |
|
<a name="var$_global_prefix" id="$_global_prefix"><!-- --></A> |
| 922 |
|
<div class="evenrow"> |
| 923 |
|
|
| 924 |
|
<div class="var-header"> |
| 925 |
|
<span class="var-title"> |
| 926 |
|
<span class="var-type">mixed</span> |
| 927 |
|
<span class="var-name">$_global_prefix</span> |
| 928 |
|
= <span class="var-default"> ''</span> (line <span class="line-number">157</span>) |
| 929 |
|
</span> |
| 930 |
|
</div> |
| 931 |
|
|
| 932 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 933 |
|
<p class="short-description">prefix for all list variable names, so we can potentially have more then 1 list per page.</p> |
| 934 |
|
|
| 935 |
|
|
| 936 |
|
|
| 937 |
|
|
| 938 |
|
|
| 939 |
|
</div> |
| 940 |
|
<a name="var$_image_path" id="$_image_path"><!-- --></A> |
| 941 |
|
<div class="oddrow"> |
| 942 |
|
|
| 943 |
|
<div class="var-header"> |
| 944 |
|
<span class="var-title"> |
| 945 |
|
<span class="var-type">mixed</span> |
| 946 |
|
<span class="var-name">$_image_path</span> |
| 947 |
|
= <span class="var-default"> "/phphtmllib/images/widgets"</span> (line <span class="line-number">278</span>) |
| 948 |
|
</span> |
| 949 |
|
</div> |
| 950 |
|
|
| 951 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 952 |
|
<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 |
|
|
| 954 |
|
|
| 955 |
|
|
| 956 |
|
|
| 957 |
|
|
| 958 |
|
</div> |
| 959 |
|
<a name="var$_max_rows" id="$_max_rows"><!-- --></A> |
| 960 |
|
<div class="evenrow"> |
| 961 |
|
|
| 962 |
|
<div class="var-header"> |
| 963 |
|
<span class="var-title"> |
| 964 |
|
<span class="var-type">mixed</span> |
| 965 |
|
<span class="var-name">$_max_rows</span> |
| 966 |
|
= <span class="var-default"> 200</span> (line <span class="line-number">136</span>) |
| 967 |
|
</span> |
| 968 |
|
</div> |
| 969 |
|
|
| 970 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 971 |
|
<p class="short-description">The max number of rows to show when the user does the "EXPAND" command.</p> |
| 972 |
|
|
| 973 |
|
|
| 974 |
|
|
| 975 |
|
|
| 976 |
|
|
| 977 |
|
</div> |
| 978 |
|
<a name="var$_num_columns" id="$_num_columns"><!-- --></A> |
| 979 |
|
<div class="oddrow"> |
| 980 |
|
|
| 981 |
|
<div class="var-header"> |
| 982 |
|
<span class="var-title"> |
| 983 |
|
<span class="var-type">mixed</span> |
| 984 |
|
<span class="var-name">$_num_columns</span> |
| 985 |
|
= <span class="var-default"> 0</span> (line <span class="line-number">237</span>) |
| 986 |
|
</span> |
| 987 |
|
</div> |
| 988 |
|
|
| 989 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 990 |
|
<p class="short-description">Keeps track of the # of columns we have</p> |
| 991 |
|
|
| 992 |
|
|
| 993 |
|
|
| 994 |
|
|
| 995 |
|
|
| 996 |
|
</div> |
| 997 |
|
<a name="var$_num_pages" id="$_num_pages"><!-- --></A> |
| 998 |
|
<div class="evenrow"> |
| 999 |
|
|
| 1000 |
|
<div class="var-header"> |
| 1001 |
|
<span class="var-title"> |
| 1002 |
|
<span class="var-type">mixed</span> |
| 1003 |
|
<span class="var-name">$_num_pages</span> |
| 1004 |
|
= <span class="var-default">1</span> (line <span class="line-number">121</span>) |
| 1005 |
|
</span> |
| 1006 |
|
</div> |
| 1007 |
|
|
| 1008 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1009 |
|
<p class="short-description">This value holds the number of pages of data we have to display.</p> |
| 1010 |
|
|
| 1011 |
|
|
| 1012 |
|
|
| 1013 |
|
|
| 1014 |
|
|
| 1015 |
|
</div> |
| 1016 |
|
<a name="var$_save_vars" id="$_save_vars"><!-- --></A> |
| 1017 |
|
<div class="oddrow"> |
| 1018 |
|
|
| 1019 |
|
<div class="var-header"> |
| 1020 |
|
<span class="var-title"> |
| 1021 |
|
<span class="var-type">mixed</span> |
| 1022 |
|
<span class="var-name">$_save_vars</span> |
| 1023 |
|
= <span class="var-default">array()</span> (line <span class="line-number">223</span>) |
| 1024 |
|
</span> |
| 1025 |
|
</div> |
| 1026 |
|
|
| 1027 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1028 |
|
<p class="short-description">This holds a list of name=>value vars that the caller/child wants to propogate automatically.</p> |
| 1029 |
|
|
| 1030 |
|
|
| 1031 |
|
|
| 1032 |
|
|
| 1033 |
|
|
| 1034 |
|
</div> |
| 1035 |
|
<a name="var$_search_flag" id="$_search_flag"><!-- --></A> |
| 1036 |
|
<div class="evenrow"> |
| 1037 |
|
|
| 1038 |
|
<div class="var-header"> |
| 1039 |
|
<span class="var-title"> |
| 1040 |
|
<span class="var-type">mixed</span> |
| 1041 |
|
<span class="var-name">$_search_flag</span> |
| 1042 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">192</span>) |
| 1043 |
|
</span> |
| 1044 |
|
</div> |
| 1045 |
|
|
| 1046 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1047 |
|
<p class="short-description">Flag to let us know that search is enabled.</p> |
| 1048 |
|
|
| 1049 |
|
|
| 1050 |
|
|
| 1051 |
|
|
| 1052 |
|
|
| 1053 |
|
</div> |
| 1054 |
|
<a name="var$_search_table" id="$_search_table"><!-- --></A> |
| 1055 |
|
<div class="oddrow"> |
| 1056 |
|
|
| 1057 |
|
<div class="var-header"> |
| 1058 |
|
<span class="var-title"> |
| 1059 |
|
<span class="var-type">mixed</span> |
| 1060 |
|
<span class="var-name">$_search_table</span> |
| 1061 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">214</span>) |
| 1062 |
|
</span> |
| 1063 |
|
</div> |
| 1064 |
|
|
| 1065 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1066 |
|
<p class="short-description">Holds the object block that is the</p> |
| 1067 |
|
<p class="description"><p>search UI</p></p> |
| 1068 |
|
|
| 1069 |
|
|
| 1070 |
|
|
| 1071 |
|
|
| 1072 |
|
|
| 1073 |
|
</div> |
| 1074 |
|
<a name="var$_show_all_rows" id="$_show_all_rows"><!-- --></A> |
| 1075 |
|
<div class="evenrow"> |
| 1076 |
|
|
| 1077 |
|
<div class="var-header"> |
| 1078 |
|
<span class="var-title"> |
| 1079 |
|
<span class="var-type">mixed</span> |
| 1080 |
|
<span class="var-name">$_show_all_rows</span> |
| 1081 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">143</span>) |
| 1082 |
|
</span> |
| 1083 |
|
</div> |
| 1084 |
|
|
| 1085 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1086 |
|
<p class="short-description">Flag to tell us to show every row that comes from the DB or not.</p> |
| 1087 |
|
<p class="description"><p>By default this is off.</p></p> |
| 1088 |
|
|
| 1089 |
|
|
| 1090 |
|
|
| 1091 |
|
|
| 1092 |
|
|
| 1093 |
|
</div> |
| 1094 |
|
<a name="var$_show_results_flag" id="$_show_results_flag"><!-- --></A> |
| 1095 |
|
<div class="oddrow"> |
| 1096 |
|
|
| 1097 |
|
<div class="var-header"> |
| 1098 |
|
<span class="var-title"> |
| 1099 |
|
<span class="var-type">mixed</span> |
| 1100 |
|
<span class="var-name">$_show_results_flag</span> |
| 1101 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">260</span>) |
| 1102 |
|
</span> |
| 1103 |
|
</div> |
| 1104 |
|
|
| 1105 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1106 |
|
<p class="short-description">flag to let us know if we want to show the results or not.</p> |
| 1107 |
|
|
| 1108 |
|
|
| 1109 |
|
|
| 1110 |
|
|
| 1111 |
|
|
| 1112 |
|
</div> |
| 1113 |
|
<a name="var$_simple_search_modifier" id="$_simple_search_modifier"><!-- --></A> |
| 1114 |
|
<div class="evenrow"> |
| 1115 |
|
|
| 1116 |
|
<div class="var-header"> |
| 1117 |
|
<span class="var-title"> |
| 1118 |
|
<span class="var-type">mixed</span> |
| 1119 |
|
<span class="var-name">$_simple_search_modifier</span> |
| 1120 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">207</span>) |
| 1121 |
|
</span> |
| 1122 |
|
</div> |
| 1123 |
|
|
| 1124 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1125 |
|
<p class="short-description">Flag to enable simple search modifyer.</p> |
| 1126 |
|
<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 |
|
|
| 1128 |
|
|
| 1129 |
|
|
| 1130 |
|
|
| 1131 |
|
|
| 1132 |
|
</div> |
| 1133 |
|
<a name="var$_vars" id="$_vars"><!-- --></A> |
| 1134 |
|
<div class="oddrow"> |
| 1135 |
|
|
| 1136 |
|
<div class="var-header"> |
| 1137 |
|
<span class="var-title"> |
| 1138 |
|
<span class="var-type">mixed</span> |
| 1139 |
|
<span class="var-name">$_vars</span> |
| 1140 |
|
= <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 |
|
</span> |
| 1142 |
|
</div> |
| 1143 |
|
|
| 1144 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1145 |
|
<p class="short-description">Holds an array of all the form vars we need for this class to work.</p> |
| 1146 |
|
|
| 1147 |
|
|
| 1148 |
|
|
| 1149 |
|
|
| 1150 |
|
|
| 1151 |
|
</div> |
| 1152 |
|
<h4>Inherited Variables</h4> |
| 1153 |
|
<A NAME='inherited_vars'><!-- --></A> |
| 1154 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 1155 |
|
<blockquote> |
| 1156 |
|
<span class="var-title"> |
| 1157 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
| 1158 |
|
</span> |
| 1159 |
|
<span class="var-title"> |
| 1160 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
| 1161 |
|
</span> |
| 1162 |
|
</blockquote> |
| 1163 |
|
|
| 1164 |
|
</div> |
| 1165 |
|
</div> |
| 1166 |
|
|
| 1167 |
|
<a name="sec-methods"></a> |
| 1168 |
|
<div class="info-box"> |
| 1169 |
|
<div class="info-box-title">Methods</div> |
| 1170 |
|
<div class="nav-bar"> |
| 1171 |
|
<a href="#sec-description">Description</a> | |
| 1172 |
|
<a href="#sec-descendents">Descendents</a> | |
| 1173 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 1174 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 1175 |
|
|
| 1176 |
|
</div> |
| 1177 |
|
<div class="info-box-body"> |
| 1178 |
|
<A NAME='method_detail'></A> |
| 1179 |
|
<a name="methodDataList" id="DataList"><!-- --></a> |
| 1180 |
|
<div class="evenrow"> |
| 1181 |
|
|
| 1182 |
|
<div class="method-header"> |
| 1183 |
|
<span class="method-title">Constructor DataList</span> (line <span class="line-number">289</span>) |
| 1184 |
|
</div> |
| 1185 |
|
|
| 1186 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1187 |
|
<p class="short-description">The constructor</p> |
| 1188 |
|
|
| 1189 |
|
<div class="method-signature"> |
| 1190 |
|
<span class="method-result">DataList</span> |
| 1191 |
|
<span class="method-name"> |
| 1192 |
|
DataList |
| 1193 |
|
</span> |
| 1194 |
|
(<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 |
|
</div> |
| 1196 |
|
|
| 1197 |
|
<ul class="parameters"> |
| 1198 |
|
<li> |
| 1199 |
|
<span class="var-type">string</span> |
| 1200 |
|
<span class="var-name">$title</span><span class="var-description">: - the title of the data list</span> </li> |
| 1201 |
|
<li> |
| 1202 |
|
<span class="var-type">string</span> |
| 1203 |
|
<span class="var-name">$width</span><span class="var-description">: - the overall width</span> </li> |
| 1204 |
|
<li> |
| 1205 |
|
<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 |
|
<li> |
| 1208 |
|
<span class="var-type">boolean</span> |
| 1209 |
|
<span class="var-name">$default_reverseorder</span><span class="var-description">: - sort the default column in reverse order?</span> </li> |
| 1210 |
|
</ul> |
| 1211 |
|
|
| 1212 |
|
|
| 1213 |
|
</div> |
| 1214 |
|
<a name="methodadd_header_item" id="add_header_item"><!-- --></a> |
| 1215 |
|
<div class="oddrow"> |
| 1216 |
|
|
| 1217 |
|
<div class="method-header"> |
| 1218 |
|
<span class="method-title">add_header_item</span> (line <span class="line-number">606</span>) |
| 1219 |
|
</div> |
| 1220 |
|
|
| 1221 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1222 |
|
<p class="short-description">This function adds a header item to the column headers from a list of parameters.</p> |
| 1223 |
|
<ul class="tags"> |
| 1224 |
|
<li><span class="field">return:</span> a single header array</li> |
| 1225 |
|
</ul> |
| 1226 |
|
|
| 1227 |
|
<div class="method-signature"> |
| 1228 |
|
<span class="method-result">array</span> |
| 1229 |
|
<span class="method-name"> |
| 1230 |
|
add_header_item |
| 1231 |
|
</span> |
| 1232 |
|
(<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 |
|
</div> |
| 1234 |
|
|
| 1235 |
|
<ul class="parameters"> |
| 1236 |
|
<li> |
| 1237 |
|
<span class="var-type">string</span> |
| 1238 |
|
<span class="var-name">$label</span><span class="var-description">: - $label - the label to use for the column header.</span> </li> |
| 1239 |
|
<li> |
| 1240 |
|
<span class="var-type">int</span> |
| 1241 |
|
<span class="var-name">$size</span><span class="var-description">: - $size - the size for the table column.</span> </li> |
| 1242 |
|
<li> |
| 1243 |
|
<span class="var-type">string</span> |
| 1244 |
|
<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 |
|
<li> |
| 1246 |
|
<span class="var-type">boolean</span> |
| 1247 |
|
<span class="var-name">$sortable</span><span class="var-description">: - $sortable - flag to make this column sortable.</span> </li> |
| 1248 |
|
<li> |
| 1249 |
|
<span class="var-type">boolean</span> |
| 1250 |
|
<span class="var-name">$searchable</span><span class="var-description">: - $searchable - flag to make this column searchable.</span> </li> |
| 1251 |
|
<li> |
| 1252 |
|
<span class="var-type">string</span> |
| 1253 |
|
<span class="var-name">$align</span><span class="var-description">: - header align value.</span> </li> |
| 1254 |
|
<li> |
| 1255 |
|
<span class="var-type">string</span> |
| 1256 |
|
<span class="var-name">$sortorder</span><span class="var-description">: - the sort order</span> </li> |
| 1257 |
|
<li> |
| 1258 |
|
<span class="var-type">string</span> |
| 1259 |
|
<span class="var-name">$max_text_length</span><span class="var-description">: - the maximum # of characters to allow in the cell.</span> </li> |
| 1260 |
|
</ul> |
| 1261 |
|
|
| 1262 |
|
|
| 1263 |
|
</div> |
| 1264 |
|
<a name="methodadvanced_search_disable" id="advanced_search_disable"><!-- --></a> |
| 1265 |
|
<div class="evenrow"> |
| 1266 |
|
|
| 1267 |
|
<div class="method-header"> |
| 1268 |
|
<span class="method-title">advanced_search_disable</span> (line <span class="line-number">714</span>) |
| 1269 |
|
</div> |
| 1270 |
|
|
| 1271 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1272 |
|
<p class="short-description">Disable the advanced search</p> |
| 1273 |
|
<p class="description"><p>capability</p></p> |
| 1274 |
|
|
| 1275 |
|
<div class="method-signature"> |
| 1276 |
|
<span class="method-result">void</span> |
| 1277 |
|
<span class="method-name"> |
| 1278 |
|
advanced_search_disable |
| 1279 |
|
</span> |
| 1280 |
|
() |
| 1281 |
|
</div> |
| 1282 |
|
|
| 1283 |
|
|
| 1284 |
|
|
| 1285 |
|
</div> |
| 1286 |
|
<a name="methodadvanced_search_enable" id="advanced_search_enable"><!-- --></a> |
| 1287 |
|
<div class="oddrow"> |
| 1288 |
|
|
| 1289 |
|
<div class="method-header"> |
| 1290 |
|
<span class="method-title">advanced_search_enable</span> (line <span class="line-number">702</span>) |
| 1291 |
|
</div> |
| 1292 |
|
|
| 1293 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1294 |
|
<p class="short-description">Enable the advanced search</p> |
| 1295 |
|
<p class="description"><p>capability NOTE: Child class MUST extend the _build_advanced_search_table</p></p> |
| 1296 |
|
|
| 1297 |
|
<div class="method-signature"> |
| 1298 |
|
<span class="method-result">void</span> |
| 1299 |
|
<span class="method-name"> |
| 1300 |
|
advanced_search_enable |
| 1301 |
|
</span> |
| 1302 |
|
() |
| 1303 |
|
</div> |
| 1304 |
|
|
| 1305 |
|
|
| 1306 |
|
|
| 1307 |
|
</div> |
| 1308 |
|
<a name="methodbuild_base_url" id="build_base_url"><!-- --></a> |
| 1309 |
|
<div class="evenrow"> |
| 1310 |
|
|
| 1311 |
|
<div class="method-header"> |
| 1312 |
|
<span class="method-title">build_base_url</span> (line <span class="line-number">1361</span>) |
| 1313 |
|
</div> |
| 1314 |
|
|
| 1315 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1316 |
|
<p class="short-description">This builds the base url used by the column headers as well as the page tool links.</p> |
| 1317 |
|
<p class="description"><p>it basically builds: $_SELF?$_GET</p></p> |
| 1318 |
|
|
| 1319 |
|
<div class="method-signature"> |
| 1320 |
|
<span class="method-result">string</span> |
| 1321 |
|
<span class="method-name"> |
| 1322 |
|
build_base_url |
| 1323 |
|
</span> |
| 1324 |
|
() |
| 1325 |
|
</div> |
| 1326 |
|
|
| 1327 |
|
|
| 1328 |
|
|
| 1329 |
|
</div> |
| 1330 |
|
<a name="methodbuild_column_item" id="build_column_item"><!-- --></a> |
| 1331 |
|
<div class="oddrow"> |
| 1332 |
|
|
| 1333 |
|
<div class="method-header"> |
| 1334 |
|
<span class="method-title">build_column_item</span> (line <span class="line-number">1139</span>) |
| 1335 |
|
</div> |
| 1336 |
|
|
| 1337 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1338 |
|
<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 |
|
<p class="description"><p>NOTE: this function is meant to be overridden so that you can push whatever you want.</p></p> |
| 1340 |
|
<ul class="tags"> |
| 1341 |
|
<li><span class="field">return:</span> - either a HTMLTag object, or raw text.</li> |
| 1342 |
|
</ul> |
| 1343 |
|
|
| 1344 |
|
<div class="method-signature"> |
| 1345 |
|
<span class="method-result">mixed</span> |
| 1346 |
|
<span class="method-name"> |
| 1347 |
|
build_column_item |
| 1348 |
|
</span> |
| 1349 |
|
(<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 |
|
</div> |
| 1351 |
|
|
| 1352 |
|
<ul class="parameters"> |
| 1353 |
|
<li> |
| 1354 |
|
<span class="var-type">array</span> |
| 1355 |
|
<span class="var-name">$row_data</span><span class="var-description">: - $row_data - the entire data for the row</span> </li> |
| 1356 |
|
<li> |
| 1357 |
|
<span class="var-type">string</span> |
| 1358 |
|
<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 |
|
</ul> |
| 1360 |
|
|
| 1361 |
|
|
| 1362 |
|
</div> |
| 1363 |
|
<a name="methodbuild_column_url" id="build_column_url"><!-- --></a> |
| 1364 |
|
<div class="evenrow"> |
| 1365 |
|
|
| 1366 |
|
<div class="method-header"> |
| 1367 |
|
<span class="method-title">build_column_url</span> (line <span class="line-number">1680</span>) |
| 1368 |
|
</div> |
| 1369 |
|
|
| 1370 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1371 |
|
<p class="short-description">This builds a url for a particular column header.</p> |
| 1372 |
|
<ul class="tags"> |
| 1373 |
|
<li><span class="field">return:</span> object;</li> |
| 1374 |
|
</ul> |
| 1375 |
|
|
| 1376 |
|
<div class="method-signature"> |
| 1377 |
|
<span class="method-result"><a href="../phpHtmlLib/Atag.html">Atag</a></span> |
| 1378 |
|
<span class="method-name"> |
| 1379 |
|
build_column_url |
| 1380 |
|
</span> |
| 1381 |
|
(<span class="var-type">string</span> <span class="var-name">$col_name</span>) |
| 1382 |
|
</div> |
| 1383 |
|
|
| 1384 |
|
<ul class="parameters"> |
| 1385 |
|
<li> |
| 1386 |
|
<span class="var-type">string</span> |
| 1387 |
|
<span class="var-name">$col_name</span><span class="var-description">: - $col_name</span> </li> |
| 1388 |
|
</ul> |
| 1389 |
|
|
| 1390 |
|
|
| 1391 |
|
</div> |
| 1392 |
|
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
| 1393 |
|
<div class="oddrow"> |
| 1394 |
|
|
| 1395 |
|
<div class="method-header"> |
| 1396 |
|
<span class="method-title">build_gui</span> (line <span class="line-number">413</span>) |
| 1397 |
|
</div> |
| 1398 |
|
|
| 1399 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1400 |
|
<p class="short-description">This function is responsible for calling the child class's methods for building the GUI container.</p> |
| 1401 |
|
<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 |
|
|
| 1403 |
|
<div class="method-signature"> |
| 1404 |
|
<span class="method-result">Container</span> |
| 1405 |
|
<span class="method-name"> |
| 1406 |
|
build_gui |
| 1407 |
|
</span> |
| 1408 |
|
() |
| 1409 |
|
</div> |
| 1410 |
|
|
| 1411 |
|
|
| 1412 |
|
|
| 1413 |
|
<hr class="separator" /> |
| 1414 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1415 |
|
<ul class="redefinitions"> |
| 1416 |
|
<li> |
| 1417 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodbuild_gui">DefaultGUIDatalist::build_gui()</a> |
| 1418 |
|
: Override the parent's method so we can wrap everything in a div to hold it all together when we change the alignment |
| 1419 |
|
</li> |
| 1420 |
|
</ul> |
| 1421 |
|
</div> |
| 1422 |
|
<a name="methodbuild_orderby_querystring" id="build_orderby_querystring"><!-- --></a> |
| 1423 |
|
<div class="evenrow"> |
| 1424 |
|
|
| 1425 |
|
<div class="method-header"> |
| 1426 |
|
<span class="method-title">build_orderby_querystring</span> (line <span class="line-number">971</span>) |
| 1427 |
|
</div> |
| 1428 |
|
|
| 1429 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1430 |
|
<p class="short-description">This builds a query string var for the orderby value.</p> |
| 1431 |
|
<ul class="tags"> |
| 1432 |
|
<li><span class="field">return:</span> - "orderby=(thevalue)"</li> |
| 1433 |
|
</ul> |
| 1434 |
|
|
| 1435 |
|
<div class="method-signature"> |
| 1436 |
|
<span class="method-result">string</span> |
| 1437 |
|
<span class="method-name"> |
| 1438 |
|
build_orderby_querystring |
| 1439 |
|
</span> |
| 1440 |
|
() |
| 1441 |
|
</div> |
| 1442 |
|
|
| 1443 |
|
|
| 1444 |
|
|
| 1445 |
|
</div> |
| 1446 |
|
<a name="methodbuild_reverseorder_querystring" id="build_reverseorder_querystring"><!-- --></a> |
| 1447 |
|
<div class="oddrow"> |
| 1448 |
|
|
| 1449 |
|
<div class="method-header"> |
| 1450 |
|
<span class="method-title">build_reverseorder_querystring</span> (line <span class="line-number">1002</span>) |
| 1451 |
|
</div> |
| 1452 |
|
|
| 1453 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1454 |
|
<p class="short-description">This builds a query string var for the reverseorder value.</p> |
| 1455 |
|
<ul class="tags"> |
| 1456 |
|
<li><span class="field">return:</span> - "orderby=(thevalue)"</li> |
| 1457 |
|
</ul> |
| 1458 |
|
|
| 1459 |
|
<div class="method-signature"> |
| 1460 |
|
<span class="method-result">string</span> |
| 1461 |
|
<span class="method-name"> |
| 1462 |
|
build_reverseorder_querystring |
| 1463 |
|
</span> |
| 1464 |
|
() |
| 1465 |
|
</div> |
| 1466 |
|
|
| 1467 |
|
|
| 1468 |
|
|
| 1469 |
|
</div> |
| 1470 |
|
<a name="methodbuild_searchfield_querystring" id="build_searchfield_querystring"><!-- --></a> |
| 1471 |
|
<div class="evenrow"> |
| 1472 |
|
|
| 1473 |
|
<div class="method-header"> |
| 1474 |
|
<span class="method-title">build_searchfield_querystring</span> (line <span class="line-number">1043</span>) |
| 1475 |
|
</div> |
| 1476 |
|
|
| 1477 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1478 |
|
<p class="short-description">This builds a query string var for the searchfield value.</p> |
| 1479 |
|
<ul class="tags"> |
| 1480 |
|
<li><span class="field">return:</span> - "orderby=(thevalue)"</li> |
| 1481 |
|
</ul> |
| 1482 |
|
|
| 1483 |
|
<div class="method-signature"> |
| 1484 |
|
<span class="method-result">string</span> |
| 1485 |
|
<span class="method-name"> |
| 1486 |
|
build_searchfield_querystring |
| 1487 |
|
</span> |
| 1488 |
|
() |
| 1489 |
|
</div> |
| 1490 |
|
|
| 1491 |
|
|
| 1492 |
|
|
| 1493 |
|
</div> |
| 1494 |
|
<a name="methodbuild_searchvalue_querystring" id="build_searchvalue_querystring"><!-- --></a> |
| 1495 |
|
<div class="oddrow"> |
| 1496 |
|
|
| 1497 |
|
<div class="method-header"> |
| 1498 |
|
<span class="method-title">build_searchvalue_querystring</span> (line <span class="line-number">1064</span>) |
| 1499 |
|
</div> |
| 1500 |
|
|
| 1501 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1502 |
|
<p class="short-description">This builds a query string var for the searchfield value.</p> |
| 1503 |
|
<ul class="tags"> |
| 1504 |
|
<li><span class="field">return:</span> - "orderby=(thevalue)"</li> |
| 1505 |
|
</ul> |
| 1506 |
|
|
| 1507 |
|
<div class="method-signature"> |
| 1508 |
|
<span class="method-result">string</span> |
| 1509 |
|
<span class="method-name"> |
| 1510 |
|
build_searchvalue_querystring |
| 1511 |
|
</span> |
| 1512 |
|
() |
| 1513 |
|
</div> |
| 1514 |
|
|
| 1515 |
|
|
| 1516 |
|
|
| 1517 |
|
</div> |
| 1518 |
|
<a name="methodbuild_state_vars_query_string" id="build_state_vars_query_string"><!-- --></a> |
| 1519 |
|
<div class="evenrow"> |
| 1520 |
|
|
| 1521 |
|
<div class="method-header"> |
| 1522 |
|
<span class="method-title">build_state_vars_query_string</span> (line <span class="line-number">1541</span>) |
| 1523 |
|
</div> |
| 1524 |
|
|
| 1525 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1526 |
|
<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 |
|
<ul class="tags"> |
| 1529 |
|
<li><span class="field">return:</span> - name=value& pairs</li> |
| 1530 |
|
</ul> |
| 1531 |
|
|
| 1532 |
|
<div class="method-signature"> |
| 1533 |
|
<span class="method-result">string</span> |
| 1534 |
|
<span class="method-name"> |
| 1535 |
|
build_state_vars_query_string |
| 1536 |
|
</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 |
|
</div> |
| 1539 |
|
|
| 1540 |
|
<ul class="parameters"> |
| 1541 |
|
<li> |
| 1542 |
|
<span class="var-type">int</span> |
| 1543 |
|
<span class="var-name">$offset</span><span class="var-description">: - the offset for the link</span> </li> |
| 1544 |
|
<li> |
| 1545 |
|
<span class="var-type">boolean</span> |
| 1546 |
|
<span class="var-name">$expandrows_flag</span><span class="var-description">: - add the expandrows value to the url</span> </li> |
| 1547 |
|
<li> |
| 1548 |
|
<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> |
| 1551 |
|
|
| 1552 |
|
|
| 1553 |
|
</div> |
| 1554 |
|
<a name="methodbuild_tool_link" id="build_tool_link"><!-- --></a> |
| 1555 |
|
<div class="oddrow"> |
| 1556 |
|
|
| 1557 |
|
<div class="method-header"> |
| 1558 |
|
<span class="method-title">build_tool_link</span> (line <span class="line-number">1407</span>) |
| 1559 |
|
</div> |
| 1560 |
|
|
| 1561 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1562 |
|
<p class="short-description">This function builds the 'tool' images that allow you to walk through the data list itself.</p> |
| 1563 |
|
<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 |
|
<span class="method-result">Object</span> |
| 1567 |
|
<span class="method-name"> |
| 1568 |
|
build_tool_link |
| 1569 |
|
</span> |
| 1570 |
|
(<span class="var-type">string</span> <span class="var-name">$which</span>) |
| 1571 |
|
</div> |
| 1572 |
|
|
| 1573 |
|
<ul class="parameters"> |
| 1574 |
|
<li> |
| 1575 |
|
<span class="var-type">string</span> |
| 1576 |
|
<span class="var-name">$which</span><span class="var-description">: - which tool image to build</span> </li> |
| 1577 |
|
</ul> |
| 1578 |
|
|
| 1579 |
|
|
| 1580 |
|
</div> |
| 1581 |
|
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
| 1582 |
|
<div class="evenrow"> |
| 1583 |
|
|
| 1584 |
|
<div class="method-header"> |
| 1585 |
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">544</span>) |
| 1586 |
|
</div> |
| 1587 |
|
|
| 1588 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1589 |
|
<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 |
|
|
| 1591 |
|
<div class="method-signature"> |
| 1592 |
|
<span class="method-result">void</span> |
| 1593 |
|
<span class="method-name"> |
| 1594 |
|
child_add_row_cell |
| 1595 |
|
</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 |
|
</div> |
| 1598 |
|
|
| 1599 |
|
<ul class="parameters"> |
| 1600 |
|
<li> |
| 1601 |
|
<span class="var-type">mixed</span> |
| 1602 |
|
<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 |
|
<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 |
|
<li> |
| 1607 |
|
<span class="var-type">boolean</span> |
| 1608 |
|
<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 |
|
|
| 1611 |
|
|
| 1612 |
|
<hr class="separator" /> |
| 1613 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1614 |
|
<ul class="redefinitions"> |
| 1615 |
|
<li> |
| 1616 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_add_row_cell">DefaultGUIDatalist::child_add_row_cell()</a> |
| 1617 |
|
</li> |
| 1618 |
|
<li> |
| 1619 |
|
<a href="../phpHtmlLib/ListAction.html#methodchild_add_row_cell">ListAction::child_add_row_cell()</a> |
| 1620 |
|
</li> |
| 1621 |
|
<li> |
| 1622 |
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_add_row_cell">SimpleGUIDataList::child_add_row_cell()</a> |
| 1623 |
|
</li> |
| 1624 |
|
</ul> |
| 1625 |
|
</div> |
| 1626 |
|
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
| 1627 |
|
<div class="oddrow"> |
| 1628 |
|
|
| 1629 |
|
<div class="method-header"> |
| 1630 |
|
<span class="method-title">child_build_column_header</span> (line <span class="line-number">524</span>) |
| 1631 |
|
</div> |
| 1632 |
|
|
| 1633 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1634 |
|
<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 |
|
<div class="method-signature"> |
| 1637 |
|
<span class="method-result">void</span> |
| 1638 |
|
<span class="method-name"> |
| 1639 |
|
child_build_column_header |
| 1640 |
|
</span> |
| 1641 |
|
(<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 |
|
</div> |
| 1643 |
|
|
| 1644 |
|
<ul class="parameters"> |
| 1645 |
|
<li> |
| 1646 |
|
<span class="var-type">string</span> |
| 1647 |
|
<span class="var-name">$title</span><span class="var-description">: - the title of the column</span> </li> |
| 1648 |
|
<li> |
| 1649 |
|
<span class="var-type">array</span> |
| 1650 |
|
<span class="var-name">$col_data</span><span class="var-description">: - the column data ( from $this->_columns )</span> </li> |
| 1651 |
|
<li> |
| 1652 |
|
<span class="var-type">int</span> |
| 1653 |
|
<span class="var-name">$col_count</span><span class="var-description">: - the column #</span> </li> |
| 1654 |
|
</ul> |
| 1655 |
|
|
| 1656 |
|
|
| 1657 |
|
<hr class="separator" /> |
| 1658 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1659 |
|
<ul class="redefinitions"> |
| 1660 |
|
<li> |
| 1661 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_column_header">DefaultGUIDatalist::child_build_column_header()</a> |
| 1662 |
|
</li> |
| 1663 |
|
<li> |
| 1664 |
|
<a href="../phpHtmlLib/ListAction.html#methodchild_build_column_header">ListAction::child_build_column_header()</a> |
| 1665 |
|
</li> |
| 1666 |
|
<li> |
| 1667 |
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_build_column_header">SimpleGUIDataList::child_build_column_header()</a> |
| 1668 |
|
</li> |
| 1669 |
|
</ul> |
| 1670 |
|
</div> |
| 1671 |
|
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
| 1672 |
|
<div class="evenrow"> |
| 1673 |
|
|
| 1674 |
|
<div class="method-header"> |
| 1675 |
|
<span class="method-title">child_build_search_table</span> (line <span class="line-number">571</span>) |
| 1676 |
|
</div> |
| 1677 |
|
|
| 1678 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1679 |
|
<p class="short-description">This function builds the search block that lives above the results</p> |
| 1680 |
|
|
| 1681 |
|
<div class="method-signature"> |
| 1682 |
|
<span class="method-result">Container</span> |
| 1683 |
|
<span class="method-name"> |
| 1684 |
|
child_build_search_table |
| 1685 |
|
</span> |
| 1686 |
|
() |
| 1687 |
|
</div> |
| 1688 |
|
|
| 1689 |
|
|
| 1690 |
|
|
| 1691 |
|
<hr class="separator" /> |
| 1692 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1693 |
|
<ul class="redefinitions"> |
| 1694 |
|
<li> |
| 1695 |
|
<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 |
|
</li> |
| 1698 |
|
</ul> |
| 1699 |
|
</div> |
| 1700 |
|
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
| 1701 |
|
<div class="oddrow"> |
| 1702 |
|
|
| 1703 |
|
<div class="method-header"> |
| 1704 |
|
<span class="method-title">child_get_gui</span> (line <span class="line-number">558</span>) |
| 1705 |
|
</div> |
| 1706 |
|
|
| 1707 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1708 |
|
<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 |
|
<div class="method-signature"> |
| 1711 |
|
<span class="method-result">Container</span> |
| 1712 |
|
<span class="method-name"> |
| 1713 |
|
child_get_gui |
| 1714 |
|
</span> |
| 1715 |
|
() |
| 1716 |
|
</div> |
| 1717 |
|
|
| 1718 |
|
|
| 1719 |
|
|
| 1720 |
|
<hr class="separator" /> |
| 1721 |
|
<div class="notes">Redefined in descendants as:</div> |
| 1722 |
|
<ul class="redefinitions"> |
| 1723 |
|
<li> |
| 1724 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodchild_get_gui">DefaultGUIDatalist::child_get_gui()</a> |
| 1725 |
|
</li> |
| 1726 |
|
<li> |
| 1727 |
|
<a href="../phpHtmlLib/ListAction.html#methodchild_get_gui">ListAction::child_get_gui()</a> |
| 1728 |
|
</li> |
| 1729 |
|
<li> |
| 1730 |
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodchild_get_gui">SimpleGUIDataList::child_get_gui()</a> |
| 1731 |
|
</li> |
| 1732 |
|
</ul> |
| 1733 |
|
</div> |
| 1734 |
|
<a name="methoddata_prefetch" id="data_prefetch"><!-- --></a> |
| 1735 |
|
<div class="evenrow"> |
| 1736 |
|
|
| 1737 |
|
<div class="method-header"> |
| 1738 |
|
<span class="method-title">data_prefetch</span> (line <span class="line-number">840</span>) |
| 1739 |
|
</div> |
| 1740 |
|
|
| 1741 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1742 |
|
<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 |
|
<div class="method-signature"> |
| 1746 |
|
<span class="method-result">void</span> |
| 1747 |
|
<span class="method-name"> |
| 1748 |
|
data_prefetch |
| 1749 |
|
</span> |
| 1750 |
|
() |
| 1751 |
|
</div> |
| 1752 |
|
|
| 1753 |
|
|
| 1754 |
|
|
| 1755 |
|
</div> |
| 1756 |
|
<a name="methoddo_action" id="do_action"><!-- --></a> |
| 1757 |
|
<div class="oddrow"> |
| 1758 |
|
|
| 1759 |
|
<div class="method-header"> |
| 1760 |
|
<span class="method-title">do_action</span> (line <span class="line-number">467</span>) |
| 1761 |
|
</div> |
| 1762 |
|
|
| 1763 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1764 |
|
<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 |
|
<div class="method-signature"> |
| 1767 |
|
<span class="method-result">void</span> |
| 1768 |
|
<span class="method-name"> |
| 1769 |
|
do_action |
| 1770 |
|
</span> |
| 1771 |
|
() |
| 1772 |
|
</div> |
| 1773 |
|
|
| 1774 |
|
|
| 1775 |
|
|
| 1776 |
|
</div> |
| 1777 |
|
<a name="methodexpandrows" id="expandrows"><!-- --></a> |
| 1778 |
|
<div class="evenrow"> |
| 1779 |
|
|
| 1780 |
|
<div class="method-header"> |
| 1781 |
|
<span class="method-title">expandrows</span> (line <span class="line-number">1107</span>) |
| 1782 |
|
</div> |
| 1783 |
|
|
| 1784 |
|
<!-- ========== 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 |
|
<li><span class="field">return:</span> - the current value</li> |
| 1788 |
|
</ul> |
| 1789 |
|
|
| 1790 |
|
<div class="method-signature"> |
| 1791 |
|
<span class="method-result">string</span> |
| 1792 |
|
<span class="method-name"> |
| 1793 |
|
expandrows |
| 1794 |
|
</span> |
| 1795 |
|
() |
| 1796 |
|
</div> |
| 1797 |
|
|
| 1798 |
|
|
| 1799 |
|
|
| 1800 |
|
</div> |
| 1801 |
|
<a name="methodfilter_column_string" id="filter_column_string"><!-- --></a> |
| 1802 |
|
<div class="oddrow"> |
| 1803 |
|
|
| 1804 |
|
<div class="method-header"> |
| 1805 |
|
<span class="method-title">filter_column_string</span> (line <span class="line-number">1734</span>) |
| 1806 |
|
</div> |
| 1807 |
|
|
| 1808 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1809 |
|
<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 |
|
<ul class="tags"> |
| 1811 |
|
<li><span class="field">return:</span> the cleaned/filtered data</li> |
| 1812 |
|
</ul> |
| 1813 |
|
|
| 1814 |
|
<div class="method-signature"> |
| 1815 |
|
<span class="method-result">string</span> |
| 1816 |
|
<span class="method-name"> |
| 1817 |
|
filter_column_string |
| 1818 |
|
</span> |
| 1819 |
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
| 1820 |
|
</div> |
| 1821 |
|
|
| 1822 |
|
<ul class="parameters"> |
| 1823 |
|
<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> |
| 1827 |
|
|
| 1828 |
|
|
| 1829 |
|
</div> |
| 1830 |
|
<a name="methodget_current_page" id="get_current_page"><!-- --></a> |
| 1831 |
|
<div class="evenrow"> |
| 1832 |
|
|
| 1833 |
|
<div class="method-header"> |
| 1834 |
|
<span class="method-title">get_current_page</span> (line <span class="line-number">1599</span>) |
| 1835 |
|
</div> |
| 1836 |
|
|
| 1837 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1838 |
|
<p class="short-description">This function returns the current page that the item list is on.</p> |
| 1839 |
|
|
| 1840 |
|
<div class="method-signature"> |
| 1841 |
|
<span class="method-result">int</span> |
| 1842 |
|
<span class="method-name"> |
| 1843 |
|
get_current_page |
| 1844 |
|
</span> |
| 1845 |
|
() |
| 1846 |
|
</div> |
| 1847 |
|
|
| 1848 |
|
|
| 1849 |
|
|
| 1850 |
|
</div> |
| 1851 |
|
<a name="methodget_data_source" id="get_data_source"><!-- --></a> |
| 1852 |
|
<div class="oddrow"> |
| 1853 |
|
|
| 1854 |
|
<div class="method-header"> |
| 1855 |
|
<span class="method-title">get_data_source</span> (line <span class="line-number">479</span>) |
| 1856 |
|
</div> |
| 1857 |
|
|
| 1858 |
|
<!-- ========== 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 |
|
|
| 1861 |
|
<div class="method-signature"> |
| 1862 |
|
<span class="method-result">void</span> |
| 1863 |
|
<span class="method-name"> |
| 1864 |
|
get_data_source |
| 1865 |
|
</span> |
| 1866 |
|
() |
| 1867 |
|
</div> |
| 1868 |
|
|
| 1869 |
|
|
| 1870 |
|
|
| 1871 |
|
</div> |
| 1872 |
|
<a name="methodget_default_num_rows" id="get_default_num_rows"><!-- --></a> |
| 1873 |
|
<div class="evenrow"> |
| 1874 |
|
|
| 1875 |
|
<div class="method-header"> |
| 1876 |
|
<span class="method-title">get_default_num_rows</span> (line <span class="line-number">785</span>) |
| 1877 |
|
</div> |
| 1878 |
|
|
| 1879 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1880 |
|
<p class="short-description">This function gets the current default number of rows to display setting.</p> |
| 1881 |
|
|
| 1882 |
|
<div class="method-signature"> |
| 1883 |
|
<span class="method-result">int</span> |
| 1884 |
|
<span class="method-name"> |
| 1885 |
|
get_default_num_rows |
| 1886 |
|
</span> |
| 1887 |
|
() |
| 1888 |
|
</div> |
| 1889 |
|
|
| 1890 |
|
|
| 1891 |
|
|
| 1892 |
|
</div> |
| 1893 |
|
<a name="methodget_form_action" id="get_form_action"><!-- --></a> |
| 1894 |
|
<div class="oddrow"> |
| 1895 |
|
|
| 1896 |
|
<div class="method-header"> |
| 1897 |
|
<span class="method-title">get_form_action</span> (line <span class="line-number">1247</span>) |
| 1898 |
|
</div> |
| 1899 |
|
|
| 1900 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1901 |
|
<p class="short-description">This function is used to get the form action</p> |
| 1902 |
|
<ul class="tags"> |
| 1903 |
|
<li><span class="field">return:</span> (POST or GET)</li> |
| 1904 |
|
</ul> |
| 1905 |
|
|
| 1906 |
|
<div class="method-signature"> |
| 1907 |
|
<span class="method-result">string</span> |
| 1908 |
|
<span class="method-name"> |
| 1909 |
|
get_form_action |
| 1910 |
|
</span> |
| 1911 |
|
() |
| 1912 |
|
</div> |
| 1913 |
|
|
| 1914 |
|
|
| 1915 |
|
|
| 1916 |
|
</div> |
| 1917 |
|
<a name="methodget_form_method" id="get_form_method"><!-- --></a> |
| 1918 |
|
<div class="evenrow"> |
| 1919 |
|
|
| 1920 |
|
<div class="method-header"> |
| 1921 |
|
<span class="method-title">get_form_method</span> (line <span class="line-number">1228</span>) |
| 1922 |
|
</div> |
| 1923 |
|
|
| 1924 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1925 |
|
<p class="short-description">This function is used to get the form method</p> |
| 1926 |
|
<ul class="tags"> |
| 1927 |
|
<li><span class="field">return:</span> (POST or GET)</li> |
| 1928 |
|
</ul> |
| 1929 |
|
|
| 1930 |
|
<div class="method-signature"> |
| 1931 |
|
<span class="method-result">string</span> |
| 1932 |
|
<span class="method-name"> |
| 1933 |
|
get_form_method |
| 1934 |
|
</span> |
| 1935 |
|
() |
| 1936 |
|
</div> |
| 1937 |
|
|
| 1938 |
|
|
| 1939 |
|
|
| 1940 |
|
</div> |
| 1941 |
|
<a name="methodget_form_name" id="get_form_name"><!-- --></a> |
| 1942 |
|
<div class="oddrow"> |
| 1943 |
|
|
| 1944 |
|
<div class="method-header"> |
| 1945 |
|
<span class="method-title">get_form_name</span> (line <span class="line-number">1184</span>) |
| 1946 |
|
</div> |
| 1947 |
|
|
| 1948 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1949 |
|
<p class="short-description">This function is used to get the form name</p> |
| 1950 |
|
|
| 1951 |
|
<div class="method-signature"> |
| 1952 |
|
<span class="method-result">string</span> |
| 1953 |
|
<span class="method-name"> |
| 1954 |
|
get_form_name |
| 1955 |
|
</span> |
| 1956 |
|
() |
| 1957 |
|
</div> |
| 1958 |
|
|
| 1959 |
|
|
| 1960 |
|
|
| 1961 |
|
</div> |
| 1962 |
|
<a name="methodget_form_render" id="get_form_render"><!-- --></a> |
| 1963 |
|
<div class="evenrow"> |
| 1964 |
|
|
| 1965 |
|
<div class="method-header"> |
| 1966 |
|
<span class="method-title">get_form_render</span> (line <span class="line-number">1265</span>) |
| 1967 |
|
</div> |
| 1968 |
|
|
| 1969 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1970 |
|
<p class="short-description">Return the state of the form render</p> |
| 1971 |
|
|
| 1972 |
|
<div class="method-signature"> |
| 1973 |
|
<span class="method-result">bool</span> |
| 1974 |
|
<span class="method-name"> |
| 1975 |
|
get_form_render |
| 1976 |
|
</span> |
| 1977 |
|
() |
| 1978 |
|
</div> |
| 1979 |
|
|
| 1980 |
|
|
| 1981 |
|
|
| 1982 |
|
</div> |
| 1983 |
|
<a name="methodget_form_target" id="get_form_target"><!-- --></a> |
| 1984 |
|
<div class="oddrow"> |
| 1985 |
|
|
| 1986 |
|
<div class="method-header"> |
| 1987 |
|
<span class="method-title">get_form_target</span> (line <span class="line-number">1204</span>) |
| 1988 |
|
</div> |
| 1989 |
|
|
| 1990 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 1991 |
|
<p class="short-description">This function is used to get the form target</p> |
| 1992 |
|
|
| 1993 |
|
<div class="method-signature"> |
| 1994 |
|
<span class="method-result">string</span> |
| 1995 |
|
<span class="method-name"> |
| 1996 |
|
get_form_target |
| 1997 |
|
</span> |
| 1998 |
|
() |
| 1999 |
|
</div> |
| 2000 |
|
|
| 2001 |
|
|
| 2002 |
|
|
| 2003 |
|
</div> |
| 2004 |
|
<a name="methodget_global_prefix" id="get_global_prefix"><!-- --></a> |
| 2005 |
|
<div class="evenrow"> |
| 2006 |
|
|
| 2007 |
|
<div class="method-header"> |
| 2008 |
|
<span class="method-title">get_global_prefix</span> (line <span class="line-number">649</span>) |
| 2009 |
|
</div> |
| 2010 |
|
|
| 2011 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2012 |
|
<p class="short-description">returns the current variable prefix string being used.</p> |
| 2013 |
|
<ul class="tags"> |
| 2014 |
|
<li><span class="field">return:</span> - current global prefix</li> |
| 2015 |
|
</ul> |
| 2016 |
|
|
| 2017 |
|
<div class="method-signature"> |
| 2018 |
|
<span class="method-result">string</span> |
| 2019 |
|
<span class="method-name"> |
| 2020 |
|
get_global_prefix |
| 2021 |
|
</span> |
| 2022 |
|
() |
| 2023 |
|
</div> |
| 2024 |
|
|
| 2025 |
|
|
| 2026 |
|
|
| 2027 |
|
</div> |
| 2028 |
|
<a name="methodget_image_path" id="get_image_path"><!-- --></a> |
| 2029 |
|
<div class="oddrow"> |
| 2030 |
|
|
| 2031 |
|
<div class="method-header"> |
| 2032 |
|
<span class="method-title">get_image_path</span> (line <span class="line-number">1579</span>) |
| 2033 |
|
</div> |
| 2034 |
|
|
| 2035 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2036 |
|
<p class="short-description">This function returns the path to the images used in this class</p> |
| 2037 |
|
|
| 2038 |
|
<div class="method-signature"> |
| 2039 |
|
<span class="method-result">string</span> |
| 2040 |
|
<span class="method-name"> |
| 2041 |
|
get_image_path |
| 2042 |
|
</span> |
| 2043 |
|
() |
| 2044 |
|
</div> |
| 2045 |
|
|
| 2046 |
|
|
| 2047 |
|
|
| 2048 |
|
</div> |
| 2049 |
|
<a name="methodget_last_page" id="get_last_page"><!-- --></a> |
| 2050 |
|
<div class="evenrow"> |
| 2051 |
|
|
| 2052 |
|
<div class="method-header"> |
| 2053 |
|
<span class="method-title">get_last_page</span> (line <span class="line-number">1631</span>) |
| 2054 |
|
</div> |
| 2055 |
|
|
| 2056 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2057 |
|
<p class="short-description">This calculates the last page # for this list of items</p> |
| 2058 |
|
|
| 2059 |
|
<div class="method-signature"> |
| 2060 |
|
<span class="method-result">int</span> |
| 2061 |
|
<span class="method-name"> |
| 2062 |
|
get_last_page |
| 2063 |
|
</span> |
| 2064 |
|
() |
| 2065 |
|
</div> |
| 2066 |
|
|
| 2067 |
|
|
| 2068 |
|
|
| 2069 |
|
</div> |
| 2070 |
|
<a name="methodget_max_rows" id="get_max_rows"><!-- --></a> |
| 2071 |
|
<div class="oddrow"> |
| 2072 |
|
|
| 2073 |
|
<div class="method-header"> |
| 2074 |
|
<span class="method-title">get_max_rows</span> (line <span class="line-number">795</span>) |
| 2075 |
|
</div> |
| 2076 |
|
|
| 2077 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2078 |
|
<p class="short-description">This returns the Maximum # of rows to display when in expand mode</p> |
| 2079 |
|
|
| 2080 |
|
<div class="method-signature"> |
| 2081 |
|
<span class="method-result">int</span> |
| 2082 |
|
<span class="method-name"> |
| 2083 |
|
get_max_rows |
| 2084 |
|
</span> |
| 2085 |
|
() |
| 2086 |
|
</div> |
| 2087 |
|
|
| 2088 |
|
|
| 2089 |
|
|
| 2090 |
|
</div> |
| 2091 |
|
<a name="methodget_num_pages" id="get_num_pages"><!-- --></a> |
| 2092 |
|
<div class="evenrow"> |
| 2093 |
|
|
| 2094 |
|
<div class="method-header"> |
| 2095 |
|
<span class="method-title">get_num_pages</span> (line <span class="line-number">1610</span>) |
| 2096 |
|
</div> |
| 2097 |
|
|
| 2098 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2099 |
|
<p class="short-description">This function returns the # of pages that are available for this list of items.</p> |
| 2100 |
|
|
| 2101 |
|
<div class="method-signature"> |
| 2102 |
|
<span class="method-result">int</span> |
| 2103 |
|
<span class="method-name"> |
| 2104 |
|
get_num_pages |
| 2105 |
|
</span> |
| 2106 |
|
() |
| 2107 |
|
</div> |
| 2108 |
|
|
| 2109 |
|
|
| 2110 |
|
|
| 2111 |
|
</div> |
| 2112 |
|
<a name="methodget_page_info" id="get_page_info"><!-- --></a> |
| 2113 |
|
<div class="oddrow"> |
| 2114 |
|
|
| 2115 |
|
<div class="method-header"> |
| 2116 |
|
<span class="method-title">get_page_info</span> (line <span class="line-number">1642</span>) |
| 2117 |
|
</div> |
| 2118 |
|
|
| 2119 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2120 |
|
<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 |
|
<li><span class="field">return:</span> (ie. 1 to 10 of 25)</li> |
| 2123 |
|
</ul> |
| 2124 |
|
|
| 2125 |
|
<div class="method-signature"> |
| 2126 |
|
<span class="method-result">string</span> |
| 2127 |
|
<span class="method-name"> |
| 2128 |
|
get_page_info |
| 2129 |
|
</span> |
| 2130 |
|
() |
| 2131 |
|
</div> |
| 2132 |
|
|
| 2133 |
|
|
| 2134 |
|
|
| 2135 |
|
</div> |
| 2136 |
|
<a name="methodget_showall" id="get_showall"><!-- --></a> |
| 2137 |
|
<div class="evenrow"> |
| 2138 |
|
|
| 2139 |
|
<div class="method-header"> |
| 2140 |
|
<span class="method-title">get_showall</span> (line <span class="line-number">828</span>) |
| 2141 |
|
</div> |
| 2142 |
|
|
| 2143 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2144 |
|
<p class="short-description">This returns the value of the show all rows flag</p> |
| 2145 |
|
|
| 2146 |
|
<div class="method-signature"> |
| 2147 |
|
<span class="method-result">boolean</span> |
| 2148 |
|
<span class="method-name"> |
| 2149 |
|
get_showall |
| 2150 |
|
</span> |
| 2151 |
|
() |
| 2152 |
|
</div> |
| 2153 |
|
|
| 2154 |
|
|
| 2155 |
|
|
| 2156 |
|
</div> |
| 2157 |
|
<a name="methodget_simple_search_modifier" id="get_simple_search_modifier"><!-- --></a> |
| 2158 |
|
<div class="oddrow"> |
| 2159 |
|
|
| 2160 |
|
<div class="method-header"> |
| 2161 |
|
<span class="method-title">get_simple_search_modifier</span> (line <span class="line-number">764</span>) |
| 2162 |
|
</div> |
| 2163 |
|
|
| 2164 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2165 |
|
<p class="short-description">gets the value of the search modifier flag.</p> |
| 2166 |
|
|
| 2167 |
|
<div class="method-signature"> |
| 2168 |
|
<span class="method-result">void</span> |
| 2169 |
|
<span class="method-name"> |
| 2170 |
|
get_simple_search_modifier |
| 2171 |
|
</span> |
| 2172 |
|
() |
| 2173 |
|
</div> |
| 2174 |
|
|
| 2175 |
|
|
| 2176 |
|
|
| 2177 |
|
</div> |
| 2178 |
|
<a name="methodgui_init" id="gui_init"><!-- --></a> |
| 2179 |
|
<div class="evenrow"> |
| 2180 |
|
|
| 2181 |
|
<div class="method-header"> |
| 2182 |
|
<span class="method-title">gui_init</span> (line <span class="line-number">506</span>) |
| 2183 |
|
</div> |
| 2184 |
|
|
| 2185 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2186 |
|
<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 |
|
|
| 2188 |
|
<div class="method-signature"> |
| 2189 |
|
<span class="method-result">void</span> |
| 2190 |
|
<span class="method-name"> |
| 2191 |
|
gui_init |
| 2192 |
|
</span> |
| 2193 |
|
() |
| 2194 |
|
</div> |
| 2195 |
|
|
| 2196 |
|
|
| 2197 |
|
|
| 2198 |
|
<hr class="separator" /> |
| 2199 |
|
<div class="notes">Redefined in descendants as:</div> |
| 2200 |
|
<ul class="redefinitions"> |
| 2201 |
|
<li> |
| 2202 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodgui_init">DefaultGUIDatalist::gui_init()</a> |
| 2203 |
|
</li> |
| 2204 |
|
<li> |
| 2205 |
|
<a href="../phpHtmlLib/ListAction.html#methodgui_init">ListAction::gui_init()</a> |
| 2206 |
|
: Initialize the gui layout |
| 2207 |
|
</li> |
| 2208 |
|
<li> |
| 2209 |
|
<a href="../phpHtmlLib/SimpleGUIDataList.html#methodgui_init">SimpleGUIDataList::gui_init()</a> |
| 2210 |
|
: Initialize the gui layout |
| 2211 |
|
</li> |
| 2212 |
|
</ul> |
| 2213 |
|
</div> |
| 2214 |
|
<a name="methodis_advanced_search_enabled" id="is_advanced_search_enabled"><!-- --></a> |
| 2215 |
|
<div class="oddrow"> |
| 2216 |
|
|
| 2217 |
|
<div class="method-header"> |
| 2218 |
|
<span class="method-title">is_advanced_search_enabled</span> (line <span class="line-number">724</span>) |
| 2219 |
|
</div> |
| 2220 |
|
|
| 2221 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2222 |
|
<p class="short-description">This returns the status of the advanced search flag.</p> |
| 2223 |
|
|
| 2224 |
|
<div class="method-signature"> |
| 2225 |
|
<span class="method-result">boolean</span> |
| 2226 |
|
<span class="method-name"> |
| 2227 |
|
is_advanced_search_enabled |
| 2228 |
|
</span> |
| 2229 |
|
() |
| 2230 |
|
</div> |
| 2231 |
|
|
| 2232 |
|
|
| 2233 |
|
|
| 2234 |
|
</div> |
| 2235 |
|
<a name="methodis_search_enabled" id="is_search_enabled"><!-- --></a> |
| 2236 |
|
<div class="evenrow"> |
| 2237 |
|
|
| 2238 |
|
<div class="method-header"> |
| 2239 |
|
<span class="method-title">is_search_enabled</span> (line <span class="line-number">690</span>) |
| 2240 |
|
</div> |
| 2241 |
|
|
| 2242 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2243 |
|
<p class="short-description">get the status of the search ability.</p> |
| 2244 |
|
|
| 2245 |
|
<div class="method-signature"> |
| 2246 |
|
<span class="method-result">boolean</span> |
| 2247 |
|
<span class="method-name"> |
| 2248 |
|
is_search_enabled |
| 2249 |
|
</span> |
| 2250 |
|
() |
| 2251 |
|
</div> |
| 2252 |
|
|
| 2253 |
|
|
| 2254 |
|
|
| 2255 |
|
</div> |
| 2256 |
|
<a name="methodnumrows" id="numrows"><!-- --></a> |
| 2257 |
|
<div class="oddrow"> |
| 2258 |
|
|
| 2259 |
|
<div class="method-header"> |
| 2260 |
|
<span class="method-title">numrows</span> (line <span class="line-number">1013</span>) |
| 2261 |
|
</div> |
| 2262 |
|
|
| 2263 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2264 |
|
<p class="short-description">This function returns the number of rows that the query found.</p> |
| 2265 |
|
<ul class="tags"> |
| 2266 |
|
<li><span class="field">return:</span> - the number of rows</li> |
| 2267 |
|
</ul> |
| 2268 |
|
|
| 2269 |
|
<div class="method-signature"> |
| 2270 |
|
<span class="method-result">int</span> |
| 2271 |
|
<span class="method-name"> |
| 2272 |
|
numrows |
| 2273 |
|
</span> |
| 2274 |
|
() |
| 2275 |
|
</div> |
| 2276 |
|
|
| 2277 |
|
|
| 2278 |
|
|
| 2279 |
|
</div> |
| 2280 |
|
<a name="methodoffset" id="offset"><!-- --></a> |
| 2281 |
|
<div class="evenrow"> |
| 2282 |
|
|
| 2283 |
|
<div class="method-header"> |
| 2284 |
|
<span class="method-title">offset</span> (line <span class="line-number">937</span>) |
| 2285 |
|
</div> |
| 2286 |
|
|
| 2287 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2288 |
|
<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 |
|
<ul class="tags"> |
| 2290 |
|
<li><span class="field">return:</span> - the current value.</li> |
| 2291 |
|
</ul> |
| 2292 |
|
|
| 2293 |
|
<div class="method-signature"> |
| 2294 |
|
<span class="method-result">int</span> |
| 2295 |
|
<span class="method-name"> |
| 2296 |
|
offset |
| 2297 |
|
</span> |
| 2298 |
|
() |
| 2299 |
|
</div> |
| 2300 |
|
|
| 2301 |
|
|
| 2302 |
|
|
| 2303 |
|
</div> |
| 2304 |
|
<a name="methodorderby" id="orderby"><!-- --></a> |
| 2305 |
|
<div class="oddrow"> |
| 2306 |
|
|
| 2307 |
|
<div class="method-header"> |
| 2308 |
|
<span class="method-title">orderby</span> (line <span class="line-number">961</span>) |
| 2309 |
|
</div> |
| 2310 |
|
|
| 2311 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2312 |
|
<p class="short-description">This function returns the value of the current orderby variable.</p> |
| 2313 |
|
|
| 2314 |
|
<div class="method-signature"> |
| 2315 |
|
<span class="method-result">string.</span> |
| 2316 |
|
<span class="method-name"> |
| 2317 |
|
orderby |
| 2318 |
|
</span> |
| 2319 |
|
() |
| 2320 |
|
</div> |
| 2321 |
|
|
| 2322 |
|
|
| 2323 |
|
|
| 2324 |
|
</div> |
| 2325 |
|
<a name="methodrender" id="render"><!-- --></a> |
| 2326 |
|
<div class="evenrow"> |
| 2327 |
|
|
| 2328 |
|
<div class="method-header"> |
| 2329 |
|
<span class="method-title">render</span> (line <span class="line-number">335</span>) |
| 2330 |
|
</div> |
| 2331 |
|
|
| 2332 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2333 |
|
<p class="short-description">This function renders the final</p> |
| 2334 |
|
<p class="description"><p>widget</p></p> |
| 2335 |
|
|
| 2336 |
|
<div class="method-signature"> |
| 2337 |
|
<span class="method-result">void</span> |
| 2338 |
|
<span class="method-name"> |
| 2339 |
|
render |
| 2340 |
|
</span> |
| 2341 |
|
(<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 |
|
|
| 2344 |
|
|
| 2345 |
|
<hr class="separator" /> |
| 2346 |
|
<div class="notes">Redefinition of:</div> |
| 2347 |
|
<dl> |
| 2348 |
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
| 2349 |
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
| 2350 |
|
</dl> |
| 2351 |
|
|
| 2352 |
|
</div> |
| 2353 |
|
<a name="methodreverseorder" id="reverseorder"><!-- --></a> |
| 2354 |
|
<div class="oddrow"> |
| 2355 |
|
|
| 2356 |
|
<div class="method-header"> |
| 2357 |
|
<span class="method-title">reverseorder</span> (line <span class="line-number">982</span>) |
| 2358 |
|
</div> |
| 2359 |
|
|
| 2360 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2361 |
|
<p class="short-description">This function returns the current value of the reverse order member variable.</p> |
| 2362 |
|
|
| 2363 |
|
<div class="method-signature"> |
| 2364 |
|
<span class="method-result">string.</span> |
| 2365 |
|
<span class="method-name"> |
| 2366 |
|
reverseorder |
| 2367 |
|
</span> |
| 2368 |
|
() |
| 2369 |
|
</div> |
| 2370 |
|
|
| 2371 |
|
|
| 2372 |
|
|
| 2373 |
|
</div> |
| 2374 |
|
<a name="methodsearch_disable" id="search_disable"><!-- --></a> |
| 2375 |
|
<div class="evenrow"> |
| 2376 |
|
|
| 2377 |
|
<div class="method-header"> |
| 2378 |
|
<span class="method-title">search_disable</span> (line <span class="line-number">680</span>) |
| 2379 |
|
</div> |
| 2380 |
|
|
| 2381 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2382 |
|
<p class="short-description">Disable the search ability.</p> |
| 2383 |
|
|
| 2384 |
|
<div class="method-signature"> |
| 2385 |
|
<span class="method-result">void</span> |
| 2386 |
|
<span class="method-name"> |
| 2387 |
|
search_disable |
| 2388 |
|
</span> |
| 2389 |
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
| 2390 |
|
</div> |
| 2391 |
|
|
| 2392 |
|
<ul class="parameters"> |
| 2393 |
|
<li> |
| 2394 |
|
<span class="var-type">boolean</span> |
| 2395 |
|
<span class="var-name">0</span> </li> |
| 2396 |
|
</ul> |
| 2397 |
|
|
| 2398 |
|
|
| 2399 |
|
</div> |
| 2400 |
|
<a name="methodsearch_enable" id="search_enable"><!-- --></a> |
| 2401 |
|
<div class="oddrow"> |
| 2402 |
|
|
| 2403 |
|
<div class="method-header"> |
| 2404 |
|
<span class="method-title">search_enable</span> (line <span class="line-number">668</span>) |
| 2405 |
|
</div> |
| 2406 |
|
|
| 2407 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2408 |
|
<p class="short-description">Enable the search ability.</p> |
| 2409 |
|
|
| 2410 |
|
<div class="method-signature"> |
| 2411 |
|
<span class="method-result">void</span> |
| 2412 |
|
<span class="method-name"> |
| 2413 |
|
search_enable |
| 2414 |
|
</span> |
| 2415 |
|
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
| 2416 |
|
</div> |
| 2417 |
|
|
| 2418 |
|
<ul class="parameters"> |
| 2419 |
|
<li> |
| 2420 |
|
<span class="var-type">boolean</span> |
| 2421 |
|
<span class="var-name">0</span> </li> |
| 2422 |
|
</ul> |
| 2423 |
|
|
| 2424 |
|
|
| 2425 |
|
</div> |
| 2426 |
|
<a name="methodsearch_field" id="search_field"><!-- --></a> |
| 2427 |
|
<div class="evenrow"> |
| 2428 |
|
|
| 2429 |
|
<div class="method-header"> |
| 2430 |
|
<span class="method-title">search_field</span> (line <span class="line-number">1033</span>) |
| 2431 |
|
</div> |
| 2432 |
|
|
| 2433 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2434 |
|
<p class="short-description">returns the current value of the search field name</p> |
| 2435 |
|
|
| 2436 |
|
<div class="method-signature"> |
| 2437 |
|
<span class="method-result">string</span> |
| 2438 |
|
<span class="method-name"> |
| 2439 |
|
search_field |
| 2440 |
|
</span> |
| 2441 |
|
() |
| 2442 |
|
</div> |
| 2443 |
|
|
| 2444 |
|
|
| 2445 |
|
|
| 2446 |
|
</div> |
| 2447 |
|
<a name="methodsearch_type" id="search_type"><!-- --></a> |
| 2448 |
|
<div class="oddrow"> |
| 2449 |
|
|
| 2450 |
|
<div class="method-header"> |
| 2451 |
|
<span class="method-title">search_type</span> (line <span class="line-number">1085</span>) |
| 2452 |
|
</div> |
| 2453 |
|
|
| 2454 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2455 |
|
<p class="short-description">returns the type of search being used</p> |
| 2456 |
|
|
| 2457 |
|
<div class="method-signature"> |
| 2458 |
|
<span class="method-result">string</span> |
| 2459 |
|
<span class="method-name"> |
| 2460 |
|
search_type |
| 2461 |
|
</span> |
| 2462 |
|
() |
| 2463 |
|
</div> |
| 2464 |
|
|
| 2465 |
|
|
| 2466 |
|
|
| 2467 |
|
</div> |
| 2468 |
|
<a name="methodsearch_value" id="search_value"><!-- --></a> |
| 2469 |
|
<div class="evenrow"> |
| 2470 |
|
|
| 2471 |
|
<div class="method-header"> |
| 2472 |
|
<span class="method-title">search_value</span> (line <span class="line-number">1054</span>) |
| 2473 |
|
</div> |
| 2474 |
|
|
| 2475 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2476 |
|
<p class="short-description">returns the current value of te search field value.</p> |
| 2477 |
|
|
| 2478 |
|
<div class="method-signature"> |
| 2479 |
|
<span class="method-result">string</span> |
| 2480 |
|
<span class="method-name"> |
| 2481 |
|
search_value |
| 2482 |
|
</span> |
| 2483 |
|
() |
| 2484 |
|
</div> |
| 2485 |
|
|
| 2486 |
|
|
| 2487 |
|
|
| 2488 |
|
</div> |
| 2489 |
|
<a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a> |
| 2490 |
|
<div class="oddrow"> |
| 2491 |
|
|
| 2492 |
|
<div class="method-header"> |
| 2493 |
|
<span class="method-title">search_value_filter</span> (line <span class="line-number">1830</span>) |
| 2494 |
|
</div> |
| 2495 |
|
|
| 2496 |
|
<!-- ========== 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 |
|
<div class="method-signature"> |
| 2500 |
|
<span class="method-result">string</span> |
| 2501 |
|
<span class="method-name"> |
| 2502 |
|
search_value_filter |
| 2503 |
|
</span> |
| 2504 |
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
| 2505 |
|
</div> |
| 2506 |
|
|
| 2507 |
|
<ul class="parameters"> |
| 2508 |
|
<li> |
| 2509 |
|
<span class="var-type">string</span> |
| 2510 |
|
<span class="var-name">$value</span> </li> |
| 2511 |
|
</ul> |
| 2512 |
|
|
| 2513 |
|
|
| 2514 |
|
</div> |
| 2515 |
|
<a name="methodsetup_columns" id="setup_columns"><!-- --></a> |
| 2516 |
|
<div class="evenrow"> |
| 2517 |
|
|
| 2518 |
|
<div class="method-header"> |
| 2519 |
|
<span class="method-title">setup_columns</span> (line <span class="line-number">868</span>) |
| 2520 |
|
</div> |
| 2521 |
|
|
| 2522 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2523 |
|
|
| 2524 |
|
<div class="method-signature"> |
| 2525 |
|
<span class="method-result">void</span> |
| 2526 |
|
<span class="method-name"> |
| 2527 |
|
setup_columns |
| 2528 |
|
</span> |
| 2529 |
|
() |
| 2530 |
|
</div> |
| 2531 |
|
|
| 2532 |
|
|
| 2533 |
|
|
| 2534 |
|
</div> |
| 2535 |
|
<a name="methodset_data_source" id="set_data_source"><!-- --></a> |
| 2536 |
|
<div class="oddrow"> |
| 2537 |
|
|
| 2538 |
|
<div class="method-header"> |
| 2539 |
|
<span class="method-title">set_data_source</span> (line <span class="line-number">659</span>) |
| 2540 |
|
</div> |
| 2541 |
|
|
| 2542 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2543 |
|
<p class="short-description">This function is used to set the DataListSource object for this instance</p> |
| 2544 |
|
|
| 2545 |
|
<div class="method-signature"> |
| 2546 |
|
<span class="method-result">void</span> |
| 2547 |
|
<span class="method-name"> |
| 2548 |
|
set_data_source |
| 2549 |
|
</span> |
| 2550 |
|
(<span class="var-type"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> <span class="var-name">$datasource</span>) |
| 2551 |
|
</div> |
| 2552 |
|
|
| 2553 |
|
<ul class="parameters"> |
| 2554 |
|
<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 |
|
</ul> |
| 2558 |
|
|
| 2559 |
|
|
| 2560 |
|
</div> |
| 2561 |
|
<a name="methodset_default_num_rows" id="set_default_num_rows"><!-- --></a> |
| 2562 |
|
<div class="evenrow"> |
| 2563 |
|
|
| 2564 |
|
<div class="method-header"> |
| 2565 |
|
<span class="method-title">set_default_num_rows</span> (line <span class="line-number">775</span>) |
| 2566 |
|
</div> |
| 2567 |
|
|
| 2568 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2569 |
|
<p class="short-description">This function sets the default # of rows per page to display. By default its 10.</p> |
| 2570 |
|
<p class="description"><p>This lets the user override this value.</p></p> |
| 2571 |
|
|
| 2572 |
|
<div class="method-signature"> |
| 2573 |
|
<span class="method-result">void</span> |
| 2574 |
|
<span class="method-name"> |
| 2575 |
|
set_default_num_rows |
| 2576 |
|
</span> |
| 2577 |
|
(<span class="var-type">int</span> <span class="var-name">$num_rows</span>) |
| 2578 |
|
</div> |
| 2579 |
|
|
| 2580 |
|
<ul class="parameters"> |
| 2581 |
|
<li> |
| 2582 |
|
<span class="var-type">int</span> |
| 2583 |
|
<span class="var-name">$num_rows</span><span class="var-description">: - the # of rows to use.</span> </li> |
| 2584 |
|
</ul> |
| 2585 |
|
|
| 2586 |
|
|
| 2587 |
|
</div> |
| 2588 |
|
<a name="methodset_expandrows" id="set_expandrows"><!-- --></a> |
| 2589 |
|
<div class="oddrow"> |
| 2590 |
|
|
| 2591 |
|
<div class="method-header"> |
| 2592 |
|
<span class="method-title">set_expandrows</span> (line <span class="line-number">1121</span>) |
| 2593 |
|
</div> |
| 2594 |
|
|
| 2595 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2596 |
|
<p class="short-description">This sets the expandrows.</p> |
| 2597 |
|
|
| 2598 |
|
<div class="method-signature"> |
| 2599 |
|
<span class="method-result">void</span> |
| 2600 |
|
<span class="method-name"> |
| 2601 |
|
set_expandrows |
| 2602 |
|
</span> |
| 2603 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 2604 |
|
</div> |
| 2605 |
|
|
| 2606 |
|
<ul class="parameters"> |
| 2607 |
|
<li> |
| 2608 |
|
<span class="var-type">boolean</span> |
| 2609 |
|
<span class="var-name">$flag</span> </li> |
| 2610 |
|
</ul> |
| 2611 |
|
|
| 2612 |
|
|
| 2613 |
|
</div> |
| 2614 |
|
<a name="methodset_form_action" id="set_form_action"><!-- --></a> |
| 2615 |
|
<div class="evenrow"> |
| 2616 |
|
|
| 2617 |
|
<div class="method-header"> |
| 2618 |
|
<span class="method-title">set_form_action</span> (line <span class="line-number">1237</span>) |
| 2619 |
|
</div> |
| 2620 |
|
|
| 2621 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2622 |
|
<p class="short-description">Sets the form action</p> |
| 2623 |
|
|
| 2624 |
|
<div class="method-signature"> |
| 2625 |
|
<span class="method-result">void</span> |
| 2626 |
|
<span class="method-name"> |
| 2627 |
|
set_form_action |
| 2628 |
|
</span> |
| 2629 |
|
(<span class="var-type">string</span> <span class="var-name">$action</span>) |
| 2630 |
|
</div> |
| 2631 |
|
|
| 2632 |
|
<ul class="parameters"> |
| 2633 |
|
<li> |
| 2634 |
|
<span class="var-type">string</span> |
| 2635 |
|
<span class="var-name">$action</span> </li> |
| 2636 |
|
</ul> |
| 2637 |
|
|
| 2638 |
|
|
| 2639 |
|
</div> |
| 2640 |
|
<a name="methodset_form_method" id="set_form_method"><!-- --></a> |
| 2641 |
|
<div class="oddrow"> |
| 2642 |
|
|
| 2643 |
|
<div class="method-header"> |
| 2644 |
|
<span class="method-title">set_form_method</span> (line <span class="line-number">1214</span>) |
| 2645 |
|
</div> |
| 2646 |
|
|
| 2647 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2648 |
|
<p class="short-description">This function is used to set the form method</p> |
| 2649 |
|
|
| 2650 |
|
<div class="method-signature"> |
| 2651 |
|
<span class="method-result">void</span> |
| 2652 |
|
<span class="method-name"> |
| 2653 |
|
set_form_method |
| 2654 |
|
</span> |
| 2655 |
|
(<span class="var-type">string</span> <span class="var-name">$method</span>) |
| 2656 |
|
</div> |
| 2657 |
|
|
| 2658 |
|
<ul class="parameters"> |
| 2659 |
|
<li> |
| 2660 |
|
<span class="var-type">string</span> |
| 2661 |
|
<span class="var-name">$method</span><span class="var-description">: (POST or GET)</span> </li> |
| 2662 |
|
</ul> |
| 2663 |
|
|
| 2664 |
|
|
| 2665 |
|
</div> |
| 2666 |
|
<a name="methodset_form_name" id="set_form_name"><!-- --></a> |
| 2667 |
|
<div class="evenrow"> |
| 2668 |
|
|
| 2669 |
|
<div class="method-header"> |
| 2670 |
|
<span class="method-title">set_form_name</span> (line <span class="line-number">1174</span>) |
| 2671 |
|
</div> |
| 2672 |
|
|
| 2673 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2674 |
|
<p class="short-description">This function is used to set the form name</p> |
| 2675 |
|
|
| 2676 |
|
<div class="method-signature"> |
| 2677 |
|
<span class="method-result">void</span> |
| 2678 |
|
<span class="method-name"> |
| 2679 |
|
set_form_name |
| 2680 |
|
</span> |
| 2681 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
| 2682 |
|
</div> |
| 2683 |
|
|
| 2684 |
|
<ul class="parameters"> |
| 2685 |
|
<li> |
| 2686 |
|
<span class="var-type">string</span> |
| 2687 |
|
<span class="var-name">$name</span> </li> |
| 2688 |
|
</ul> |
| 2689 |
|
|
| 2690 |
|
|
| 2691 |
|
</div> |
| 2692 |
|
<a name="methodset_form_render" id="set_form_render"><!-- --></a> |
| 2693 |
|
<div class="oddrow"> |
| 2694 |
|
|
| 2695 |
|
<div class="method-header"> |
| 2696 |
|
<span class="method-title">set_form_render</span> (line <span class="line-number">1256</span>) |
| 2697 |
|
</div> |
| 2698 |
|
|
| 2699 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2700 |
|
<p class="short-description">Sets whether to the output into a form</p> |
| 2701 |
|
|
| 2702 |
|
<div class="method-signature"> |
| 2703 |
|
<span class="method-result">void</span> |
| 2704 |
|
<span class="method-name"> |
| 2705 |
|
set_form_render |
| 2706 |
|
</span> |
| 2707 |
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
| 2708 |
|
</div> |
| 2709 |
|
|
| 2710 |
|
<ul class="parameters"> |
| 2711 |
|
<li> |
| 2712 |
|
<span class="var-type">bool</span> |
| 2713 |
|
<span class="var-name">$flag</span> </li> |
| 2714 |
|
</ul> |
| 2715 |
|
|
| 2716 |
|
|
| 2717 |
|
</div> |
| 2718 |
|
<a name="methodset_form_target" id="set_form_target"><!-- --></a> |
| 2719 |
|
<div class="evenrow"> |
| 2720 |
|
|
| 2721 |
|
<div class="method-header"> |
| 2722 |
|
<span class="method-title">set_form_target</span> (line <span class="line-number">1194</span>) |
| 2723 |
|
</div> |
| 2724 |
|
|
| 2725 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2726 |
|
<p class="short-description">This function is used to set the form target</p> |
| 2727 |
|
|
| 2728 |
|
<div class="method-signature"> |
| 2729 |
|
<span class="method-result">void</span> |
| 2730 |
|
<span class="method-name"> |
| 2731 |
|
set_form_target |
| 2732 |
|
</span> |
| 2733 |
|
(<span class="var-type">string</span> <span class="var-name">$target</span>) |
| 2734 |
|
</div> |
| 2735 |
|
|
| 2736 |
|
<ul class="parameters"> |
| 2737 |
|
<li> |
| 2738 |
|
<span class="var-type">string</span> |
| 2739 |
|
<span class="var-name">$target</span> </li> |
| 2740 |
|
</ul> |
| 2741 |
|
|
| 2742 |
|
|
| 2743 |
|
</div> |
| 2744 |
|
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
| 2745 |
|
<div class="oddrow"> |
| 2746 |
|
|
| 2747 |
|
<div class="method-header"> |
| 2748 |
|
<span class="method-title">set_global_prefix</span> (line <span class="line-number">635</span>) |
| 2749 |
|
</div> |
| 2750 |
|
|
| 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 |
|
|
| 2754 |
|
<div class="method-signature"> |
| 2755 |
|
<span class="method-result">void</span> |
| 2756 |
|
<span class="method-name"> |
| 2757 |
|
set_global_prefix |
| 2758 |
|
</span> |
| 2759 |
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
| 2760 |
|
</div> |
| 2761 |
|
|
| 2762 |
|
<ul class="parameters"> |
| 2763 |
|
<li> |
| 2764 |
|
<span class="var-type">string</span> |
| 2765 |
|
<span class="var-name">$prefix</span><span class="var-description">: - the prefix for all vars.</span> </li> |
| 2766 |
|
</ul> |
| 2767 |
|
|
| 2768 |
|
|
| 2769 |
|
<hr class="separator" /> |
| 2770 |
|
<div class="notes">Redefined in descendants as:</div> |
| 2771 |
|
<ul class="redefinitions"> |
| 2772 |
|
<li> |
| 2773 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_global_prefix">DefaultGUIDatalist::set_global_prefix()</a> |
| 2774 |
|
: 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 |
|
</ul> |
| 2777 |
|
</div> |
| 2778 |
|
<a name="methodset_image_path" id="set_image_path"><!-- --></a> |
| 2779 |
|
<div class="evenrow"> |
| 2780 |
|
|
| 2781 |
|
<div class="method-header"> |
| 2782 |
|
<span class="method-title">set_image_path</span> (line <span class="line-number">1589</span>) |
| 2783 |
|
</div> |
| 2784 |
|
|
| 2785 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2786 |
|
<p class="short-description">This function returns the path to the images used in this class</p> |
| 2787 |
|
|
| 2788 |
|
<div class="method-signature"> |
| 2789 |
|
<span class="method-result">string</span> |
| 2790 |
|
<span class="method-name"> |
| 2791 |
|
set_image_path |
| 2792 |
|
</span> |
| 2793 |
|
(<span class="var-type">mixed</span> <span class="var-name">$path</span>) |
| 2794 |
|
</div> |
| 2795 |
|
|
| 2796 |
|
|
| 2797 |
|
|
| 2798 |
|
</div> |
| 2799 |
|
<a name="methodset_max_rows" id="set_max_rows"><!-- --></a> |
| 2800 |
|
<div class="oddrow"> |
| 2801 |
|
|
| 2802 |
|
<div class="method-header"> |
| 2803 |
|
<span class="method-title">set_max_rows</span> (line <span class="line-number">807</span>) |
| 2804 |
|
</div> |
| 2805 |
|
|
| 2806 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2807 |
|
<p class="short-description">This sets the maximum # of rows to display when in expand mode</p> |
| 2808 |
|
|
| 2809 |
|
<div class="method-signature"> |
| 2810 |
|
<span class="method-result">void</span> |
| 2811 |
|
<span class="method-name"> |
| 2812 |
|
set_max_rows |
| 2813 |
|
</span> |
| 2814 |
|
(<span class="var-type">int</span> <span class="var-name">$max</span>) |
| 2815 |
|
</div> |
| 2816 |
|
|
| 2817 |
|
<ul class="parameters"> |
| 2818 |
|
<li> |
| 2819 |
|
<span class="var-type">int</span> |
| 2820 |
|
<span class="var-name">$max</span><span class="var-description">: - new # of maximum rows to display when in 'expand' mode</span> </li> |
| 2821 |
|
</ul> |
| 2822 |
|
|
| 2823 |
|
|
| 2824 |
|
</div> |
| 2825 |
|
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
| 2826 |
|
<div class="evenrow"> |
| 2827 |
|
|
| 2828 |
|
<div class="method-header"> |
| 2829 |
|
<span class="method-title">set_not_found_message</span> (line <span class="line-number">1275</span>) |
| 2830 |
|
</div> |
| 2831 |
|
|
| 2832 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2833 |
|
<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 |
|
<span class="method-result">void</span> |
| 2837 |
|
<span class="method-name"> |
| 2838 |
|
set_not_found_message |
| 2839 |
|
</span> |
| 2840 |
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 2841 |
|
</div> |
| 2842 |
|
|
| 2843 |
|
<ul class="parameters"> |
| 2844 |
|
<li> |
| 2845 |
|
<span class="var-type">string</span> |
| 2846 |
|
<span class="var-name">$mesg</span> </li> |
| 2847 |
|
</ul> |
| 2848 |
|
|
| 2849 |
|
|
| 2850 |
|
</div> |
| 2851 |
|
<a name="methodset_numrows" id="set_numrows"><!-- --></a> |
| 2852 |
|
<div class="oddrow"> |
| 2853 |
|
|
| 2854 |
|
<div class="method-header"> |
| 2855 |
|
<span class="method-title">set_numrows</span> (line <span class="line-number">1023</span>) |
| 2856 |
|
</div> |
| 2857 |
|
|
| 2858 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2859 |
|
<p class="short-description">This function sets the # of rows to display per page.</p> |
| 2860 |
|
|
| 2861 |
|
<div class="method-signature"> |
| 2862 |
|
<span class="method-result">void</span> |
| 2863 |
|
<span class="method-name"> |
| 2864 |
|
set_numrows |
| 2865 |
|
</span> |
| 2866 |
|
(<span class="var-type">int</span> <span class="var-name">$new_numrows</span>) |
| 2867 |
|
</div> |
| 2868 |
|
|
| 2869 |
|
<ul class="parameters"> |
| 2870 |
|
<li> |
| 2871 |
|
<span class="var-type">int</span> |
| 2872 |
|
<span class="var-name">$new_numrows</span><span class="var-description">: - the # of rows</span> </li> |
| 2873 |
|
</ul> |
| 2874 |
|
|
| 2875 |
|
|
| 2876 |
|
</div> |
| 2877 |
|
<a name="methodset_offset" id="set_offset"><!-- --></a> |
| 2878 |
|
<div class="evenrow"> |
| 2879 |
|
|
| 2880 |
|
<div class="method-header"> |
| 2881 |
|
<span class="method-title">set_offset</span> (line <span class="line-number">951</span>) |
| 2882 |
|
</div> |
| 2883 |
|
|
| 2884 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2885 |
|
<p class="short-description">This function is used to set/change the offset for this list.</p> |
| 2886 |
|
|
| 2887 |
|
<div class="method-signature"> |
| 2888 |
|
<span class="method-result">void</span> |
| 2889 |
|
<span class="method-name"> |
| 2890 |
|
set_offset |
| 2891 |
|
</span> |
| 2892 |
|
(<span class="var-type">int</span> <span class="var-name">$new_offset</span>) |
| 2893 |
|
</div> |
| 2894 |
|
|
| 2895 |
|
<ul class="parameters"> |
| 2896 |
|
<li> |
| 2897 |
|
<span class="var-type">int</span> |
| 2898 |
|
<span class="var-name">$new_offset</span><span class="var-description">: - the new offset.</span> </li> |
| 2899 |
|
</ul> |
| 2900 |
|
|
| 2901 |
|
|
| 2902 |
|
</div> |
| 2903 |
|
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
| 2904 |
|
<div class="oddrow"> |
| 2905 |
|
|
| 2906 |
|
<div class="method-header"> |
| 2907 |
|
<span class="method-title">set_reverseorder</span> (line <span class="line-number">992</span>) |
| 2908 |
|
</div> |
| 2909 |
|
|
| 2910 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2911 |
|
<p class="short-description">This function sets the reverse order flag to a new value.</p> |
| 2912 |
|
|
| 2913 |
|
<div class="method-signature"> |
| 2914 |
|
<span class="method-result">void</span> |
| 2915 |
|
<span class="method-name"> |
| 2916 |
|
set_reverseorder |
| 2917 |
|
</span> |
| 2918 |
|
(<span class="var-type">string</span> <span class="var-name">$new_value</span>) |
| 2919 |
|
</div> |
| 2920 |
|
|
| 2921 |
|
<ul class="parameters"> |
| 2922 |
|
<li> |
| 2923 |
|
<span class="var-type">string</span> |
| 2924 |
|
<span class="var-name">$new_value</span><span class="var-description">: - the new value.</span> </li> |
| 2925 |
|
</ul> |
| 2926 |
|
|
| 2927 |
|
|
| 2928 |
|
</div> |
| 2929 |
|
<a name="methodset_save_vars" id="set_save_vars"><!-- --></a> |
| 2930 |
|
<div class="evenrow"> |
| 2931 |
|
|
| 2932 |
|
<div class="method-header"> |
| 2933 |
|
<span class="method-title">set_save_vars</span> (line <span class="line-number">1330</span>) |
| 2934 |
|
</div> |
| 2935 |
|
|
| 2936 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2937 |
|
<p class="short-description">This function sets the save variables that the user/child wants to automatically propogate</p> |
| 2938 |
|
|
| 2939 |
|
<div class="method-signature"> |
| 2940 |
|
<span class="method-result">void</span> |
| 2941 |
|
<span class="method-name"> |
| 2942 |
|
set_save_vars |
| 2943 |
|
</span> |
| 2944 |
|
(<span class="var-type">array</span> <span class="var-name">$vars</span>) |
| 2945 |
|
</div> |
| 2946 |
|
|
| 2947 |
|
<ul class="parameters"> |
| 2948 |
|
<li> |
| 2949 |
|
<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 |
|
</ul> |
| 2952 |
|
|
| 2953 |
|
|
| 2954 |
|
</div> |
| 2955 |
|
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
| 2956 |
|
<div class="oddrow"> |
| 2957 |
|
|
| 2958 |
|
<div class="method-header"> |
| 2959 |
|
<span class="method-title">set_search_type</span> (line <span class="line-number">1095</span>) |
| 2960 |
|
</div> |
| 2961 |
|
|
| 2962 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2963 |
|
<p class="short-description">This function sets the search type</p> |
| 2964 |
|
|
| 2965 |
|
<div class="method-signature"> |
| 2966 |
|
<span class="method-result">void</span> |
| 2967 |
|
<span class="method-name"> |
| 2968 |
|
set_search_type |
| 2969 |
|
</span> |
| 2970 |
|
(<span class="var-type">string</span> <span class="var-name">$type</span>) |
| 2971 |
|
</div> |
| 2972 |
|
|
| 2973 |
|
<ul class="parameters"> |
| 2974 |
|
<li> |
| 2975 |
|
<span class="var-type">string</span> |
| 2976 |
|
<span class="var-name">$type</span><span class="var-description">: - the search type "simple" or "advanced"</span> </li> |
| 2977 |
|
</ul> |
| 2978 |
|
|
| 2979 |
|
|
| 2980 |
|
</div> |
| 2981 |
|
<a name="methodset_showall" id="set_showall"><!-- --></a> |
| 2982 |
|
<div class="evenrow"> |
| 2983 |
|
|
| 2984 |
|
<div class="method-header"> |
| 2985 |
|
<span class="method-title">set_showall</span> (line <span class="line-number">818</span>) |
| 2986 |
|
</div> |
| 2987 |
|
|
| 2988 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 2989 |
|
<p class="short-description">This method sets the flag to tell us to show every row found in the DataListSource.</p> |
| 2990 |
|
|
| 2991 |
|
<div class="method-signature"> |
| 2992 |
|
<span class="method-result">void</span> |
| 2993 |
|
<span class="method-name"> |
| 2994 |
|
set_showall |
| 2995 |
|
</span> |
| 2996 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 2997 |
|
</div> |
| 2998 |
|
|
| 2999 |
|
<ul class="parameters"> |
| 3000 |
|
<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 |
|
</ul> |
| 3004 |
|
|
| 3005 |
|
|
| 3006 |
|
</div> |
| 3007 |
|
<a name="methodset_show_results" id="set_show_results"><!-- --></a> |
| 3008 |
|
<div class="oddrow"> |
| 3009 |
|
|
| 3010 |
|
<div class="method-header"> |
| 3011 |
|
<span class="method-title">set_show_results</span> (line <span class="line-number">1287</span>) |
| 3012 |
|
</div> |
| 3013 |
|
|
| 3014 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3015 |
|
<p class="short-description">This function is used to set the value of the _show_results_flag</p> |
| 3016 |
|
|
| 3017 |
|
<div class="method-signature"> |
| 3018 |
|
<span class="method-result">void</span> |
| 3019 |
|
<span class="method-name"> |
| 3020 |
|
set_show_results |
| 3021 |
|
</span> |
| 3022 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 3023 |
|
</div> |
| 3024 |
|
|
| 3025 |
|
<ul class="parameters"> |
| 3026 |
|
<li> |
| 3027 |
|
<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 |
|
|
| 3031 |
|
|
| 3032 |
|
</div> |
| 3033 |
|
<a name="methodset_simple_search_modifier" id="set_simple_search_modifier"><!-- --></a> |
| 3034 |
|
<div class="evenrow"> |
| 3035 |
|
|
| 3036 |
|
<div class="method-header"> |
| 3037 |
|
<span class="method-title">set_simple_search_modifier</span> (line <span class="line-number">749</span>) |
| 3038 |
|
</div> |
| 3039 |
|
|
| 3040 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3041 |
|
<p class="short-description">Set the simple search modifyer flag.</p> |
| 3042 |
|
<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 |
|
|
| 3044 |
|
<div class="method-signature"> |
| 3045 |
|
<span class="method-result">void</span> |
| 3046 |
|
<span class="method-name"> |
| 3047 |
|
set_simple_search_modifier |
| 3048 |
|
</span> |
| 3049 |
|
([<span class="var-type">string</span> <span class="var-name">$modifier</span> = <span class="var-default">SEARCH_ALL</span>]) |
| 3050 |
|
</div> |
| 3051 |
|
|
| 3052 |
|
<ul class="parameters"> |
| 3053 |
|
<li> |
| 3054 |
|
<span class="var-type">string</span> |
| 3055 |
|
<span class="var-name">$modifier</span> </li> |
| 3056 |
|
</ul> |
| 3057 |
|
|
| 3058 |
|
|
| 3059 |
|
</div> |
| 3060 |
|
<a name="methodsimple_search_modifier_value" id="simple_search_modifier_value"><!-- --></a> |
| 3061 |
|
<div class="oddrow"> |
| 3062 |
|
|
| 3063 |
|
<div class="method-header"> |
| 3064 |
|
<span class="method-title">simple_search_modifier_value</span> (line <span class="line-number">1075</span>) |
| 3065 |
|
</div> |
| 3066 |
|
|
| 3067 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3068 |
|
<p class="short-description">returns the current value of the simple search modifier</p> |
| 3069 |
|
|
| 3070 |
|
<div class="method-signature"> |
| 3071 |
|
<span class="method-result">string</span> |
| 3072 |
|
<span class="method-name"> |
| 3073 |
|
simple_search_modifier_value |
| 3074 |
|
</span> |
| 3075 |
|
() |
| 3076 |
|
</div> |
| 3077 |
|
|
| 3078 |
|
|
| 3079 |
|
|
| 3080 |
|
</div> |
| 3081 |
|
<a name="methoduser_setup" id="user_setup"><!-- --></a> |
| 3082 |
|
<div class="evenrow"> |
| 3083 |
|
|
| 3084 |
|
<div class="method-header"> |
| 3085 |
|
<span class="method-title">user_setup</span> (line <span class="line-number">492</span>) |
| 3086 |
|
</div> |
| 3087 |
|
|
| 3088 |
|
<!-- ========== 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 |
|
|
| 3091 |
|
<div class="method-signature"> |
| 3092 |
|
<span class="method-result">void</span> |
| 3093 |
|
<span class="method-name"> |
| 3094 |
|
user_setup |
| 3095 |
|
</span> |
| 3096 |
|
() |
| 3097 |
|
</div> |
| 3098 |
|
|
| 3099 |
|
|
| 3100 |
|
|
| 3101 |
|
</div> |
| 3102 |
|
<a name="method_build_default_vars" id="_build_default_vars"><!-- --></a> |
| 3103 |
|
<div class="oddrow"> |
| 3104 |
|
|
| 3105 |
|
<div class="method-header"> |
| 3106 |
|
<span class="method-title">_build_default_vars</span> (line <span class="line-number">1342</span>) |
| 3107 |
|
</div> |
| 3108 |
|
|
| 3109 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3110 |
|
<p class="short-description">This function builds the list of</p> |
| 3111 |
|
<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 |
|
<span class="method-result">Container</span> |
| 3115 |
|
<span class="method-name"> |
| 3116 |
|
_build_default_vars |
| 3117 |
|
</span> |
| 3118 |
|
() |
| 3119 |
|
</div> |
| 3120 |
|
|
| 3121 |
|
|
| 3122 |
|
|
| 3123 |
|
<hr class="separator" /> |
| 3124 |
|
<div class="notes">Redefined in descendants as:</div> |
| 3125 |
|
<ul class="redefinitions"> |
| 3126 |
|
<li> |
| 3127 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#method_build_default_vars">DefaultGUIDatalist::_build_default_vars()</a> |
| 3128 |
|
</li> |
| 3129 |
|
</ul> |
| 3130 |
|
</div> |
| 3131 |
|
<a name="method_build_save_vars" id="_build_save_vars"><!-- --></a> |
| 3132 |
|
<div class="evenrow"> |
| 3133 |
|
|
| 3134 |
|
<div class="method-header"> |
| 3135 |
|
<span class="method-title">_build_save_vars</span> (line <span class="line-number">1314</span>) |
| 3136 |
|
</div> |
| 3137 |
|
|
| 3138 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3139 |
|
<p class="short-description">this method builds some hidden form fields to automatically be placed inside the form.</p> |
| 3140 |
|
<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 |
|
</ul> |
| 3144 |
|
|
| 3145 |
|
<div class="method-signature"> |
| 3146 |
|
<span class="method-result">mixed</span> |
| 3147 |
|
<span class="method-name"> |
| 3148 |
|
_build_save_vars |
| 3149 |
|
</span> |
| 3150 |
|
() |
| 3151 |
|
</div> |
| 3152 |
|
|
| 3153 |
|
|
| 3154 |
|
|
| 3155 |
|
</div> |
| 3156 |
|
<a name="method_build_simple_search_modifier" id="_build_simple_search_modifier"><!-- --></a> |
| 3157 |
|
<div class="oddrow"> |
| 3158 |
|
|
| 3159 |
|
<div class="method-header"> |
| 3160 |
|
<span class="method-title">_build_simple_search_modifier</span> (line <span class="line-number">1795</span>) |
| 3161 |
|
</div> |
| 3162 |
|
|
| 3163 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3164 |
|
<p class="short-description">This builds the simple search modifier select box.</p> |
| 3165 |
|
<ul class="tags"> |
| 3166 |
|
<li><span class="field">return:</span> object.</li> |
| 3167 |
|
</ul> |
| 3168 |
|
|
| 3169 |
|
<div class="method-signature"> |
| 3170 |
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
| 3171 |
|
<span class="method-name"> |
| 3172 |
|
_build_simple_search_modifier |
| 3173 |
|
</span> |
| 3174 |
|
() |
| 3175 |
|
</div> |
| 3176 |
|
|
| 3177 |
|
|
| 3178 |
|
|
| 3179 |
|
</div> |
| 3180 |
|
<a name="method_build_tool_url" id="_build_tool_url"><!-- --></a> |
| 3181 |
|
<div class="evenrow"> |
| 3182 |
|
|
| 3183 |
|
<div class="method-header"> |
| 3184 |
|
<span class="method-title">_build_tool_url</span> (line <span class="line-number">1508</span>) |
| 3185 |
|
</div> |
| 3186 |
|
|
| 3187 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3188 |
|
<p class="short-description">This function is used to build the url for a tool link.</p> |
| 3189 |
|
<p class="description"><p>(first, prev, next, last, all)</p></p> |
| 3190 |
|
|
| 3191 |
|
<div class="method-signature"> |
| 3192 |
|
<span class="method-result">string</span> |
| 3193 |
|
<span class="method-name"> |
| 3194 |
|
_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 |
|
</div> |
| 3198 |
|
|
| 3199 |
|
<ul class="parameters"> |
| 3200 |
|
<li> |
| 3201 |
|
<span class="var-type">int</span> |
| 3202 |
|
<span class="var-name">$offset</span><span class="var-description">: - the offset for the link</span> </li> |
| 3203 |
|
<li> |
| 3204 |
|
<span class="var-type">boolean</span> |
| 3205 |
|
<span class="var-name">$expandrows_flag</span><span class="var-description">: - add the expandrows value to the url</span> </li> |
| 3206 |
|
<li> |
| 3207 |
|
<span class="var-type">int</span> |
| 3208 |
|
<span class="var-name">$expandrows_value</span><span class="var-description">: - the expandrows value to use if the flag is on</span> </li> |
| 3209 |
|
</ul> |
| 3210 |
|
|
| 3211 |
|
|
| 3212 |
|
</div> |
| 3213 |
|
<a name="method_check_datasource" id="_check_datasource"><!-- --></a> |
| 3214 |
|
<div class="oddrow"> |
| 3215 |
|
|
| 3216 |
|
<div class="method-header"> |
| 3217 |
|
<span class="method-title">_check_datasource</span> (line <span class="line-number">888</span>) |
| 3218 |
|
</div> |
| 3219 |
|
|
| 3220 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3221 |
|
<p class="short-description">general DataListSource object checker.</p> |
| 3222 |
|
|
| 3223 |
|
<div class="method-signature"> |
| 3224 |
|
<span class="method-result">void</span> |
| 3225 |
|
<span class="method-name"> |
| 3226 |
|
_check_datasource |
| 3227 |
|
</span> |
| 3228 |
|
(<span class="var-type">mixed</span> <span class="var-name">$function_name</span>) |
| 3229 |
|
</div> |
| 3230 |
|
|
| 3231 |
|
|
| 3232 |
|
|
| 3233 |
|
</div> |
| 3234 |
|
<a name="method_clean_string" id="_clean_string"><!-- --></a> |
| 3235 |
|
<div class="evenrow"> |
| 3236 |
|
|
| 3237 |
|
<div class="method-header"> |
| 3238 |
|
<span class="method-title">_clean_string</span> (line <span class="line-number">1750</span>) |
| 3239 |
|
</div> |
| 3240 |
|
|
| 3241 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3242 |
|
<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 |
|
<ul class="tags"> |
| 3244 |
|
<li><span class="field">return:</span> - the cleaned string or object</li> |
| 3245 |
|
</ul> |
| 3246 |
|
|
| 3247 |
|
<div class="method-signature"> |
| 3248 |
|
<span class="method-result">mixed</span> |
| 3249 |
|
<span class="method-name"> |
| 3250 |
|
_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 |
|
</div> |
| 3254 |
|
|
| 3255 |
|
<ul class="parameters"> |
| 3256 |
|
<li> |
| 3257 |
|
<span class="var-type">mixed</span> |
| 3258 |
|
<span class="var-name">$obj</span><span class="var-description">: - the cell object. It can be a string.</span> </li> |
| 3259 |
|
<li> |
| 3260 |
|
<span class="var-type">string</span> |
| 3261 |
|
<span class="var-name">$col_name</span><span class="var-description">: - the name of the column this object/string will live</span> </li> |
| 3262 |
|
</ul> |
| 3263 |
|
|
| 3264 |
|
|
| 3265 |
|
</div> |
| 3266 |
|
<a name="method_filter_column_string" id="_filter_column_string"><!-- --></a> |
| 3267 |
|
<div class="oddrow"> |
| 3268 |
|
|
| 3269 |
|
<div class="method-header"> |
| 3270 |
|
<span class="method-title">_filter_column_string</span> (line <span class="line-number">1159</span>) |
| 3271 |
|
</div> |
| 3272 |
|
|
| 3273 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3274 |
|
<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 |
|
<li><span class="field">return:</span> the cleaned/filtered data</li> |
| 3277 |
|
</ul> |
| 3278 |
|
|
| 3279 |
|
<div class="method-signature"> |
| 3280 |
|
<span class="method-result">string</span> |
| 3281 |
|
<span class="method-name"> |
| 3282 |
|
_filter_column_string |
| 3283 |
|
</span> |
| 3284 |
|
(<span class="var-type">string</span> <span class="var-name">$data</span>) |
| 3285 |
|
</div> |
| 3286 |
|
|
| 3287 |
|
<ul class="parameters"> |
| 3288 |
|
<li> |
| 3289 |
|
<span class="var-type">string</span> |
| 3290 |
|
<span class="var-name">$data</span><span class="var-description">: - the column data u want to filter</span> </li> |
| 3291 |
|
</ul> |
| 3292 |
|
|
| 3293 |
|
|
| 3294 |
|
</div> |
| 3295 |
|
<a name="method_get" id="_get"><!-- --></a> |
| 3296 |
|
<div class="evenrow"> |
| 3297 |
|
|
| 3298 |
|
<div class="method-header"> |
| 3299 |
|
<span class="method-title">_get</span> (line <span class="line-number">911</span>) |
| 3300 |
|
</div> |
| 3301 |
|
|
| 3302 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3303 |
|
<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 |
|
</ul> |
| 3307 |
|
|
| 3308 |
|
<div class="method-signature"> |
| 3309 |
|
<span class="method-result">the</span> |
| 3310 |
|
<span class="method-name"> |
| 3311 |
|
_get |
| 3312 |
|
</span> |
| 3313 |
|
(<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 |
|
</div> |
| 3315 |
|
|
| 3316 |
|
<ul class="parameters"> |
| 3317 |
|
<li> |
| 3318 |
|
<span class="var-type">string</span> |
| 3319 |
|
<span class="var-name">$name</span><span class="var-description">: - the name we want to get</span> </li> |
| 3320 |
|
<li> |
| 3321 |
|
<span class="var-type">mixed</span> |
| 3322 |
|
<span class="var-name">$default_value</span><span class="var-description">: - the default value if not set</span> </li> |
| 3323 |
|
</ul> |
| 3324 |
|
|
| 3325 |
|
|
| 3326 |
|
</div> |
| 3327 |
|
<a name="method_get_searchable_fields" id="_get_searchable_fields"><!-- --></a> |
| 3328 |
|
<div class="oddrow"> |
| 3329 |
|
|
| 3330 |
|
<div class="method-header"> |
| 3331 |
|
<span class="method-title">_get_searchable_fields</span> (line <span class="line-number">1777</span>) |
| 3332 |
|
</div> |
| 3333 |
|
|
| 3334 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3335 |
|
<p class="short-description">This method gets the array of searchable header fields (columns)</p> |
| 3336 |
|
|
| 3337 |
|
<div class="method-signature"> |
| 3338 |
|
<span class="method-result">array</span> |
| 3339 |
|
<span class="method-name"> |
| 3340 |
|
_get_searchable_fields |
| 3341 |
|
</span> |
| 3342 |
|
() |
| 3343 |
|
</div> |
| 3344 |
|
|
| 3345 |
|
|
| 3346 |
|
|
| 3347 |
|
</div> |
| 3348 |
|
<a name="method_javascript" id="_javascript"><!-- --></a> |
| 3349 |
|
<div class="evenrow"> |
| 3350 |
|
|
| 3351 |
|
<div class="method-header"> |
| 3352 |
|
<span class="method-title">_javascript</span> (line <span class="line-number">585</span>) |
| 3353 |
|
</div> |
| 3354 |
|
|
| 3355 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3356 |
|
<p class="short-description">This function provides a way to automatically add javascript to this object.</p> |
| 3357 |
|
<p class="description"><p>This function is meant to be extended by the child class.</p></p> |
| 3358 |
|
<ul class="tags"> |
| 3359 |
|
<li><span class="field">return:</span> object</li> |
| 3360 |
|
</ul> |
| 3361 |
|
|
| 3362 |
|
<div class="method-signature"> |
| 3363 |
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
| 3364 |
|
<span class="method-name"> |
| 3365 |
|
_javascript |
| 3366 |
|
</span> |
| 3367 |
|
() |
| 3368 |
|
</div> |
| 3369 |
|
|
| 3370 |
|
|
| 3371 |
|
|
| 3372 |
|
<hr class="separator" /> |
| 3373 |
|
<div class="notes">Redefined in descendants as:</div> |
| 3374 |
|
<ul class="redefinitions"> |
| 3375 |
|
<li> |
| 3376 |
|
<a href="../phpHtmlLib/DefaultGUIDatalist.html#method_javascript">DefaultGUIDatalist::_javascript()</a> |
| 3377 |
|
: This function returns any Javascript required for this widget |
| 3378 |
|
</li> |
| 3379 |
|
</ul> |
| 3380 |
|
</div> |
| 3381 |
|
<a name="method_save_mozilla_nav_link" id="_save_mozilla_nav_link"><!-- --></a> |
| 3382 |
|
<div class="oddrow"> |
| 3383 |
|
|
| 3384 |
|
<div class="method-header"> |
| 3385 |
|
<span class="method-title">_save_mozilla_nav_link</span> (line <span class="line-number">1568</span>) |
| 3386 |
|
</div> |
| 3387 |
|
|
| 3388 |
|
<!-- ========== 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 |
|
<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 class="method-signature"> |
| 3393 |
|
<span class="method-result">void</span> |
| 3394 |
|
<span class="method-name"> |
| 3395 |
|
_save_mozilla_nav_link |
| 3396 |
|
</span> |
| 3397 |
|
(<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 |
|
</div> |
| 3399 |
|
|
| 3400 |
|
<ul class="parameters"> |
| 3401 |
|
<li> |
| 3402 |
|
<span class="var-type">string</span> |
| 3403 |
|
<span class="var-name">$which</span><span class="var-description">: - which tool link</span> </li> |
| 3404 |
|
<li> |
| 3405 |
|
<span class="var-type">string</span> |
| 3406 |
|
<span class="var-name">$url</span><span class="var-description">: - the url for that link</span> </li> |
| 3407 |
|
</ul> |
| 3408 |
|
|
| 3409 |
|
|
| 3410 |
|
</div> |
| 3411 |
|
<a name="method_set" id="_set"><!-- --></a> |
| 3412 |
|
<div class="evenrow"> |
| 3413 |
|
|
| 3414 |
|
<div class="method-header"> |
| 3415 |
|
<span class="method-title">_set</span> (line <span class="line-number">926</span>) |
| 3416 |
|
</div> |
| 3417 |
|
|
| 3418 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 3419 |
|
<p class="short-description">This function is used to set the value of the control var</p> |
| 3420 |
|
|
| 3421 |
|
<div class="method-signature"> |
| 3422 |
|
<span class="method-result">void</span> |
| 3423 |
|
<span class="method-name"> |
| 3424 |
|
_set |
| 3425 |
|
</span> |
| 3426 |
|
(<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 |
|
</div> |
| 3428 |
|
|
| 3429 |
|
<ul class="parameters"> |
| 3430 |
|
<li> |
| 3431 |
|
<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 |
|
<li> |
| 3434 |
|
<span class="var-type">mixed</span> |
| 3435 |
|
<span class="var-name">$value</span><span class="var-description">: - the new value for it.</span> </li> |
| 3436 |
|
</ul> |
| 3437 |
|
|
| 3438 |
|
|
| 3439 |
|
</div> |
| 3440 |
|
<a name="method_show_results" id="_show_results"><!-- --></a> |
| 3441 |
|
<div class="oddrow"> |
| 3442 |
|
|
| 3443 |
|
<div class="method-header"> |
| 3444 |
|
<span class="method-title">_show_results</span> (line <span class="line-number">1298</span>) |
| 3445 |
|
</div> |
| 3446 |
|
|
| 3447 |
|
<!-- ========== 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 |
|
|
| 3450 |
|
<div class="method-signature"> |
| 3451 |
|
<span class="method-result">boolean</span> |
| 3452 |
|
<span class="method-name"> |
| 3453 |
|
_show_results |
| 3454 |
|
</span> |
| 3455 |
|
() |
| 3456 |
|
</div> |
| 3457 |
|
|
| 3458 |
|
|
| 3459 |
|
|
| 3460 |
|
</div> |
| 3461 |
|
<h4>Inherited Methods</h4> |
| 3462 |
|
<a name='inherited_methods'><!-- --></a> |
| 3463 |
|
<!-- =========== Summary =========== --> |
| 3464 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 3465 |
|
<blockquote> |
| 3466 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
| 3467 |
|
<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 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
| 3470 |
|
<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 |
|
<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 |
|
<!-- =========== Summary =========== --> |
| 3476 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 3477 |
|
<blockquote> |
| 3478 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
| 3479 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
| 3480 |
|
<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 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
| 3483 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
| 3484 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
| 3485 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
| 3486 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
| 3487 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
| 3488 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
| 3489 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
| 3490 |
|
</blockquote> |
| 3491 |
|
|
| 3492 |
|
</div> |
| 3493 |
|
</div> |
| 3494 |
|
|
| 3495 |
|
|
| 3496 |
|
<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 |
|
</p> |
| 3499 |
|
</div></body> |
| 3500 |
|
</html> |
Parent Directory
| 
Revision Log
| 
Patch
