| 1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!--NewPage--> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<HTML> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<HEAD> |
<head> |
| 5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:03 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<TITLE>Docs For Class ListAction</TITLE> |
<title>Docs For Class ListAction</title> |
| 7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
</HEAD> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
</head> |
| 10 |
<!-- Links --> |
<body> |
| 11 |
<a NAME="top"></A> |
<div class="page-body"> |
| 12 |
<table WIDTH="100%" class="links"> |
<h2 class="class-name">Class ListAction</h2> |
| 13 |
<TR> |
|
| 14 |
<TD class="font10"> |
<a name="sec-description"></a> |
| 15 |
Links: |
<div class="info-box"> |
| 16 |
<A HREF="#children_summary" class="links" title="Classes extended from ListAction">Child Classes</A> |
<div class="info-box-title">Description</div> |
| 17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<div class="nav-bar"> |
| 18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
<span class="disabled">Description</span> | |
| 19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
|
| 22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
</div> |
| 23 |
</TD> |
<div class="info-box-body"> |
| 24 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
| 25 |
</TABLE> |
<p class="short-description">A class for showing a list of items to preform an action on</p> |
| 26 |
<BR> |
<ul class="tags"> |
| 27 |
<!-- Start of Class Data --> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 28 |
<H2> |
</ul> |
| 29 |
Class ListAction |
<p class="notes"> |
| 30 |
</H2> (line <span class="linenumber">18</span>) |
Located in <a class="field" href="_widgets_data_list_ListAction_inc.html">/widgets/data_list/ListAction.inc</a> (line <span class="field">18</span>) |
| 31 |
<pre> |
</p> |
| 32 |
<a href="../phpHtmlLib/Container.html">Container</a> |
|
| 33 |
|
|
| 34 |
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
| 35 |
| |
| |
| 36 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
| 37 |
| |
| |
| 38 |
--<a href="../phpHtmlLib/DataList.html">DataList</a> |
--<a href="../phpHtmlLib/DataList.html">DataList</a> |
| 39 |
| |
| |
|
--ListAction</pre> |
|
|
<p> |
|
|
<b><i>Located in File: Program_Root/widgets/data_list/ListAction.inc</i></b><br> |
|
|
</p> |
|
|
<hr> |
|
|
A class for showing a list of items to preform an action on |
|
|
<br /> |
|
|
|
|
|
<UL> |
|
|
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
|
|
</UL> |
|
|
<hr> |
|
|
<!-- =========== VAR SUMMARY =========== --> |
|
|
<A NAME='var_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Class Variable Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_action_name">$_action_name</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The string that describes </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> 'delete'<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_align">$_align</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The overall alignment </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> "center"<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_cancel_url">$_cancel_url</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the url for the </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> "index.php"<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_data_post_name">$_data_post_name</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The name of the array variable </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> "checkbox"<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_item_name">$_item_name</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> name/description of the type of </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> ''<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF="../phpHtmlLib/ListAction.html#var$_save_all_vars">$_save_all_vars</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> A flag to tell us to save all </blockquote> |
|
|
<blockquote> Default Value: <CODE>-> TRUE<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<hr> |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td> |
|
|
<td CLASS="font10">Do we want to alternate the row colors? This helps to see each row easier.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Flag to let us know that</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
|
|
<td CLASS="font10">The column descriptions for the data we are working on</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td> |
|
|
<td CLASS="font10">Holds the db column name that we want to order by default.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> "false"<-</td> |
|
|
<td CLASS="font10">Holds a flag to let us know to</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> 10<-</td> |
|
|
<td CLASS="font10">The number of rows of data to show per "page".</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->array("method" => "GET", |
|
|
"target" => "", |
|
|
"action" => "", |
|
|
"name" => "")<-</td> |
|
|
<td CLASS="font10">This holds the form attributes</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Build everything inside a form?</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td> |
|
|
<td CLASS="font10">prefix for all list variable names, so we can potentially have more then 1 list per page.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> "/phphtmllib/images/widgets"<-</td> |
|
|
<td CLASS="font10">This stores the base path to where the tool link images live. This lets you specify a new path to where your images live.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> 200<-</td> |
|
|
<td CLASS="font10">The max number of rows to show when the user does the "EXPAND" command.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td> |
|
|
<td CLASS="font10">Keeps track of the # of columns we have</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->1<-</td> |
|
|
<td CLASS="font10">This value holds the number of pages of data we have to display.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
|
|
<td CLASS="font10">This holds a list of name=>value vars that the caller/child wants to propogate automatically.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Flag to let us know that search is enabled.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the object block that is the</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td> |
|
|
<td CLASS="font10">flag to let us know if we want to show the results or not.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Flag to enable simple search modifyer.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->array("offsetVar" => "offset", |
|
|
"orderbyVar" => "orderby", |
|
|
"reverseorderVar" => "reverseorder", |
|
|
"numrowsVar" => "numrows", |
|
|
"showallVar" => "showall", |
|
|
"search_fieldVar" => "search_field", |
|
|
"search_valueVar" => "search_value", |
|
|
"search_typeVar" => "search_type", |
|
|
"simple_search_modifierVar" => "simple_search_modifier")<-</td> |
|
|
<td CLASS="font10">Holds an array of all the form vars we need for this class to work.</td> |
|
|
</tr> |
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
|
|
<td CLASS="font10">The title of the table.</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
|
|
<td CLASS="font10">the width of the widget</td> |
|
|
</tr> |
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
|
|
<td CLASS="font10">The flags that tell us</td> |
|
|
</tr> |
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== METHOD SUMMARY =========== --> |
|
|
<A NAME='method_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span class="font12bold">Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_column_header'>mixed build_column_header ( $col_name, $col_data, $col_num )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function builds the object/text </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_in_clause'>string build_in_clause ( $field )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This method is used to build the portion </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodbuild_options'>void build_options ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Build any additional custom options such as checkboxes, radiobuttons for special options for the action. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag, $row_data )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_build_column_header'>void child_build_column_header ( $name, $col, $cnt )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodchild_get_gui'>void child_get_gui ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodget_cancel_url'>string get_cancel_url ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> this returns the current cancel url </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodgui_init'>void gui_init ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Initialize the gui layout </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_action_name'>void set_action_name ( $item )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Set the name of the action </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_align'>void set_align ( $align )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> this function is used to set the overall alignment of the widget </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_cancel_url'>void set_cancel_url ( $url )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the url to post to when a cancel/no action is clicked </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_item_name'>void set_item_name ( $item )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Set the name of the deleted items </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodset_save_vars_Flag'>void set_save_vars_Flag ( [$flag = TRUE] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#methodwrap_column_item'><a href="../phpHtmlLib/TDtag.html">TDtag</a> wrap_column_item ( $obj, $col_name )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function ensures that the data we place in a column is aligned according to what the user wants. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#method_build_delete_confirm'>void _build_delete_confirm ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function builds the actual form </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/ListAction.html#method_build_hidden_vars'>Container _build_hidden_vars ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This builds the hidden form fields of the data that was originally sent to us </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
|
|
<A NAME='functions_inherited'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></td> |
|
|
<td CLASS="font10">The constructor</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></td> |
|
|
<td CLASS="font10">This function adds a header item to the column headers from a list of parameters.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></td> |
|
|
<td CLASS="font10">Disable the advanced search</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></td> |
|
|
<td CLASS="font10">Enable the advanced search</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></td> |
|
|
<td CLASS="font10">This builds the base url used by the column headers as well as the page tool links.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></td> |
|
|
<td CLASS="font10">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.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></td> |
|
|
<td CLASS="font10">This builds a url for a particular column header.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></td> |
|
|
<td CLASS="font10">This function is responsible for calling the child class's methods for building the GUI container.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></td> |
|
|
<td CLASS="font10">This builds a query string var for the orderby value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></td> |
|
|
<td CLASS="font10">This builds a query string var for the reverseorder value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></td> |
|
|
<td CLASS="font10">This builds a query string var for the searchfield value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></td> |
|
|
<td CLASS="font10">This builds a query string var for the searchfield value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></td> |
|
|
<td CLASS="font10">this function is used to build a sub query string</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></td> |
|
|
<td CLASS="font10">This function builds the 'tool' images that allow you to walk through the data list itself.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></td> |
|
|
<td CLASS="font10">This method is supposed to be written by the child class to add the cell data to the current row in the UI</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></td> |
|
|
<td CLASS="font10">This method is supposed to be written by the child class to build and add the column title to the UI</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></td> |
|
|
<td CLASS="font10">This function builds the search block that lives above the results</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></td> |
|
|
<td CLASS="font10">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</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></td> |
|
|
<td CLASS="font10">This function is used to set up any</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></td> |
|
|
<td CLASS="font10">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.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></td> |
|
|
<td CLASS="font10">This function returns the current page that the item list is on.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></td> |
|
|
<td CLASS="font10">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></td> |
|
|
<td CLASS="font10">This function gets the current default number of rows to display setting.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></td> |
|
|
<td CLASS="font10">This function is used to get the form action</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></td> |
|
|
<td CLASS="font10">This function is used to get the form method</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></td> |
|
|
<td CLASS="font10">This function is used to get the form name</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></td> |
|
|
<td CLASS="font10">Return the state of the form render</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></td> |
|
|
<td CLASS="font10">This function is used to get the form target</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></td> |
|
|
<td CLASS="font10">returns the current variable prefix string being used.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></td> |
|
|
<td CLASS="font10">This function returns the path to the images used in this class</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></td> |
|
|
<td CLASS="font10">This calculates the last page # for this list of items</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></td> |
|
|
<td CLASS="font10">This returns the Maximum # of rows to display when in expand mode</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></td> |
|
|
<td CLASS="font10">This function returns the # of pages that are available for this list of items.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></td> |
|
|
<td CLASS="font10">This function builds the string that describes the current page out of n pages the list is showing</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></td> |
|
|
<td CLASS="font10">gets the value of the search modifier flag.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></td> |
|
|
<td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></td> |
|
|
<td CLASS="font10">This returns the status of the advanced search flag.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></td> |
|
|
<td CLASS="font10">get the status of the search ability.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></td> |
|
|
<td CLASS="font10">This function returns the number of rows that the query found.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></td> |
|
|
<td CLASS="font10">This function returns the current value of the offset variable. This is an offset into the query return data set.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></td> |
|
|
<td CLASS="font10">This function returns the value of the current orderby variable.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></td> |
|
|
<td CLASS="font10">This function renders the final</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></td> |
|
|
<td CLASS="font10">This function returns the current value of the reverse order member variable.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></td> |
|
|
<td CLASS="font10">Disable the search ability.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></td> |
|
|
<td CLASS="font10">Enable the search ability.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></td> |
|
|
<td CLASS="font10">returns the current value of the search field name</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></td> |
|
|
<td CLASS="font10">returns the type of search being used</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></td> |
|
|
<td CLASS="font10">returns the current value of te search field value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></td> |
|
|
<td CLASS="font10">This function is used to make safe any query string value that is used</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></td> |
|
|
<td CLASS="font10"></td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></td> |
|
|
<td CLASS="font10">This function is used to set the DataListSource object for this instance</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></td> |
|
|
<td CLASS="font10">This function sets the default # of rows per page to display. By default its 10.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></td> |
|
|
<td CLASS="font10">Sets the form action</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></td> |
|
|
<td CLASS="font10">This function is used to set the form method</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></td> |
|
|
<td CLASS="font10">This function is used to set the form name</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></td> |
|
|
<td CLASS="font10">Sets whether to the output into a form</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></td> |
|
|
<td CLASS="font10">This function is used to set the form target</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></td> |
|
|
<td CLASS="font10">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.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></td> |
|
|
<td CLASS="font10">This function returns the path to the images used in this class</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></td> |
|
|
<td CLASS="font10">This sets the maximum # of rows to display when in expand mode</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></td> |
|
|
<td CLASS="font10">This function is used to set the message displayed when no data is found</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></td> |
|
|
<td CLASS="font10">This function sets the # of rows to display per page.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></td> |
|
|
<td CLASS="font10">This function is used to set/change the offset for this list.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></td> |
|
|
<td CLASS="font10">This function sets the reverse order flag to a new value.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></td> |
|
|
<td CLASS="font10">This function sets the save variables that the user/child wants to automatically propogate</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></td> |
|
|
<td CLASS="font10">This function sets the search type</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></td> |
|
|
<td CLASS="font10">This function is used to set the value of the _show_results_flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></td> |
|
|
<td CLASS="font10">Set the simple search modifyer flag.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></td> |
|
|
<td CLASS="font10">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></td> |
|
|
<td CLASS="font10">returns the current value of the simple search modifier</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></td> |
|
|
<td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></td> |
|
|
<td CLASS="font10">This function builds the list of</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></td> |
|
|
<td CLASS="font10">this method builds some hidden form fields to automatically be placed inside the form.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></td> |
|
|
<td CLASS="font10">This builds the simple search modifier select box.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></td> |
|
|
<td CLASS="font10">This function is used to build the url for a tool link.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></td> |
|
|
<td CLASS="font10">general DataListSource object checker.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></td> |
|
|
<td CLASS="font10">This function is used to make sure that the string we are placing in a cell has been "cleaned"</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></td> |
|
|
<td CLASS="font10">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.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></td> |
|
|
<td CLASS="font10">Function used to get the current value of one of the control vars for this class</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></td> |
|
|
<td CLASS="font10">This method gets the array of searchable header fields (columns)</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></td> |
|
|
<td CLASS="font10">This function provides a way to automatically add javascript to this object.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></td> |
|
|
<td CLASS="font10">This function stores the url for each of the tool urls, so we can push these out for mozilla.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></td> |
|
|
<td CLASS="font10">This function is used to set the value of the control var</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></td> |
|
|
<td CLASS="font10">This function is used to let render() know that we should show the results or not.</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
|
|
<td CLASS="font10">This gets the alignment value for the outer table</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
|
|
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
|
|
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
|
|
<td CLASS="font10">Function for accessing the title of this widget</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
|
|
<td CLASS="font10">Function for getting the current widget width setting.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
|
|
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
|
|
<td CLASS="font10">Set the title for the widget.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
|
|
<td CLASS="font10">Set the width for the widget.</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
|
|
<td CLASS="font10">The constructor.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
|
|
<td CLASS="font10">add content onto content stack</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
|
|
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
|
|
<td CLASS="font10">counts the number of content objects</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
|
|
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
|
|
<td CLASS="font10">Same as add().</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
|
|
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
|
|
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
|
|
<td CLASS="font10">destroy existing content and start with new content.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
|
|
<td CLASS="font10">This function turns on the collapse flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
|
|
<td CLASS="font10">function to set the indent flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
|
|
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<hr> |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
|
|
|
|
|
<A NAME='variable_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Variable Detail</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
|
|
|
<A NAME='var$_action_name'><!-- --></A><H3>$_action_name</H3> (line <span class="linenumber">25</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>The string that describes |
|
|
<br /> |
|
|
<p>the action ie. 'delete'</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_align'><!-- --></A><H3>$_align</H3> (line <span class="linenumber">40</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>The overall alignment |
|
|
<br /> |
|
|
<p>DEFAULT: "center"</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_cancel_url'><!-- --></A><H3>$_cancel_url</H3> (line <span class="linenumber">53</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>This sets the url for the |
|
|
<br /> |
|
|
<p>cancel action to post to</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_data_post_name'><!-- --></A><H3>$_data_post_name</H3> (line <span class="linenumber">61</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>The name of the array variable |
|
|
<br /> |
|
|
<p>that the data was posted to us</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_item_name'><!-- --></A><H3>$_item_name</H3> (line <span class="linenumber">33</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>name/description of the type of |
|
|
<br /> |
|
|
<p>data we are working on ie 'users', 'files'</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_save_all_vars'><!-- --></A><H3>$_save_all_vars</H3> (line <span class="linenumber">47</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>A flag to tell us to save all |
|
|
<br /> |
|
|
<p>vars passed</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<hr> |
|
|
<!-- ============ METHOD DETAIL =========== --> |
|
|
|
|
|
<A NAME='method_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span class="font12bold">Method Detail</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodbuild_column_header'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">build_column_header</SPAN> (line <span class="linenumber">159</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">build_column_header( |
|
|
string |
|
|
$col_name, array |
|
|
$col_data, int |
|
|
$col_num)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function builds the object/text |
|
|
<br /> |
|
|
<p>to be used for a column header. It can either be an href because its sortable, or it can just be text, because its not sortable.</p> |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$col_name</SPAN></SPAN> - the column name to build from the headers.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$col_data</SPAN></SPAN> - the column's data.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$col_num</SPAN></SPAN> the column # we are working on.</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either an Atag object or raw text.</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodbuild_in_clause'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">build_in_clause</SPAN> (line <span class="linenumber">281</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">build_in_clause( |
|
|
string |
|
|
$field)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This method is used to build the portion |
|
|
<br /> |
|
|
<p>of the DB query that limits the list of items to show based on what was submitted from the original DataList action</p> |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$field</SPAN></SPAN> - the field</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodbuild_options'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">build_options</SPAN> (line <span class="linenumber">267</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">build_options( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Build any additional custom options such as checkboxes, radiobuttons for special options for the action. |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodchild_add_row_cell'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">child_add_row_cell</SPAN> (line <span class="linenumber">112</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">child_add_row_cell( |
|
|
mixed |
|
|
$obj, mixed |
|
|
$col_name, mixed |
|
|
$last_in_row_flag, mixed |
|
|
$row_data)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a> This method is supposed to be written by the child class to add the cell data to the current row in the UI |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
|
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodchild_build_column_header'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">child_build_column_header</SPAN> (line <span class="linenumber">106</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">child_build_column_header( |
|
|
mixed |
|
|
$name, mixed |
|
|
$col, mixed |
|
|
$cnt)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a> This method is supposed to be written by the child class to build and add the column title to the UI |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
|
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodchild_get_gui'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">child_get_gui</SPAN> (line <span class="linenumber">98</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">child_get_gui( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a> 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 |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
|
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_cancel_url'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_cancel_url</SPAN> (line <span class="linenumber">427</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_cancel_url( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
this returns the current cancel url |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the url</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodgui_init'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">gui_init</SPAN> (line <span class="linenumber">72</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">gui_init( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a> A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function. |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Initialize the gui layout |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_action_name'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_action_name</SPAN> (line <span class="linenumber">397</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_action_name( |
|
|
mixed |
|
|
$item)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Set the name of the action |
|
|
<br /> |
|
|
<p>used for display purposes only</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_align'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_align</SPAN> (line <span class="linenumber">380</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_align( |
|
|
string |
|
|
$align)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
this function is used to set the overall alignment of the widget |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - the align value</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_cancel_url'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_cancel_url</SPAN> (line <span class="linenumber">418</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_cancel_url( |
|
|
string |
|
|
$url)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This sets the url to post to when a cancel/no action is clicked |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> - the url</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_item_name'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_item_name</SPAN> (line <span class="linenumber">389</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_item_name( |
|
|
mixed |
|
|
$item)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Set the name of the deleted items |
|
|
<br /> |
|
|
<p>used for display purposes only</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_save_vars_Flag'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_save_vars_Flag</SPAN> (line <span class="linenumber">408</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_save_vars_Flag( |
|
|
[mixed |
|
|
$flag = TRUE])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us. |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodwrap_column_item'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">wrap_column_item</SPAN> (line <span class="linenumber">222</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">wrap_column_item( |
|
|
mixed |
|
|
$obj, string |
|
|
$col_name, int |
|
|
2, int |
|
|
3)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function ensures that the data we place in a column is aligned according to what the user wants. |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">2</SPAN></SPAN> - $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">3</SPAN></SPAN> - the column # we are working on.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$obj</SPAN></SPAN> - $obj - the data for the td.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$col_name</SPAN></SPAN> - $col_name - the name of the column header for this row to render.</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='method_build_delete_confirm'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_delete_confirm</SPAN> (line <span class="linenumber">301</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_delete_confirm( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function builds the actual form |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='method_build_hidden_vars'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_hidden_vars</SPAN> (line <span class="linenumber">131</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_hidden_vars( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This builds the hidden form fields of the data that was originally sent to us |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<div id="credit"> |
|
|
<hr> |
|
|
Documention generated on Thu, 20 Feb 2003 16:23:03 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
|
|
</div> |
|
|
</body> |
|
|
</html> |
|
| 40 |
|
--ListAction</pre> |
| 41 |
|
|
| 42 |
|
</div> |
| 43 |
|
</div> |
| 44 |
|
|
| 45 |
|
|
| 46 |
|
|
| 47 |
|
<a name="sec-var-summary"></a> |
| 48 |
|
<div class="info-box"> |
| 49 |
|
<div class="info-box-title">Variable Summary</span></div> |
| 50 |
|
<div class="nav-bar"> |
| 51 |
|
<a href="#sec-description">Description</a> | |
| 52 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 53 |
|
| |
| 54 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 55 |
|
|
| 56 |
|
</div> |
| 57 |
|
<div class="info-box-body"> |
| 58 |
|
<div class="var-summary"> |
| 59 |
|
<div class="var-title"> |
| 60 |
|
<span class="var-type">mixed</span> |
| 61 |
|
<a href="#$_action_name" title="details" class="var-name">$_action_name</a> |
| 62 |
|
</div> |
| 63 |
|
<div class="var-title"> |
| 64 |
|
<span class="var-type">mixed</span> |
| 65 |
|
<a href="#$_align" title="details" class="var-name">$_align</a> |
| 66 |
|
</div> |
| 67 |
|
<div class="var-title"> |
| 68 |
|
<span class="var-type">mixed</span> |
| 69 |
|
<a href="#$_cancel_url" title="details" class="var-name">$_cancel_url</a> |
| 70 |
|
</div> |
| 71 |
|
<div class="var-title"> |
| 72 |
|
<span class="var-type">mixed</span> |
| 73 |
|
<a href="#$_data_post_name" title="details" class="var-name">$_data_post_name</a> |
| 74 |
|
</div> |
| 75 |
|
<div class="var-title"> |
| 76 |
|
<span class="var-type">mixed</span> |
| 77 |
|
<a href="#$_item_name" title="details" class="var-name">$_item_name</a> |
| 78 |
|
</div> |
| 79 |
|
<div class="var-title"> |
| 80 |
|
<span class="var-type">mixed</span> |
| 81 |
|
<a href="#$_save_all_vars" title="details" class="var-name">$_save_all_vars</a> |
| 82 |
|
</div> |
| 83 |
|
</div> |
| 84 |
|
</div> |
| 85 |
|
</div> |
| 86 |
|
|
| 87 |
|
<a name="sec-method-summary"></a> |
| 88 |
|
<div class="info-box"> |
| 89 |
|
<div class="info-box-title">Method Summary</span></div> |
| 90 |
|
<div class="nav-bar"> |
| 91 |
|
<a href="#sec-description">Description</a> | |
| 92 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 93 |
|
|
| 94 |
|
| |
| 95 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 96 |
|
</div> |
| 97 |
|
<div class="info-box-body"> |
| 98 |
|
<div class="method-summary"> |
| 99 |
|
|
| 100 |
|
<div class="method-definition"> |
| 101 |
|
<span class="method-result">mixed</span> |
| 102 |
|
<a href="#build_column_header" title="details" class="method-name">build_column_header</a> |
| 103 |
|
(<span class="var-type">string</span> <span class="var-name">$col_name</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_num</span>) |
| 104 |
|
</div> |
| 105 |
|
|
| 106 |
|
<div class="method-definition"> |
| 107 |
|
<span class="method-result">string</span> |
| 108 |
|
<a href="#build_in_clause" title="details" class="method-name">build_in_clause</a> |
| 109 |
|
(<span class="var-type">string</span> <span class="var-name">$field</span>) |
| 110 |
|
</div> |
| 111 |
|
|
| 112 |
|
<div class="method-definition"> |
| 113 |
|
<span class="method-result">void</span> |
| 114 |
|
<a href="#build_options" title="details" class="method-name">build_options</a> |
| 115 |
|
() |
| 116 |
|
</div> |
| 117 |
|
|
| 118 |
|
<div class="method-definition"> |
| 119 |
|
<span class="method-result">void</span> |
| 120 |
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
| 121 |
|
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">mixed</span> <span class="var-name">$col_name</span>, <span class="var-type">mixed</span> <span class="var-name">$last_in_row_flag</span>, <span class="var-type">mixed</span> <span class="var-name">$row_data</span>) |
| 122 |
|
</div> |
| 123 |
|
|
| 124 |
|
<div class="method-definition"> |
| 125 |
|
<span class="method-result">void</span> |
| 126 |
|
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
| 127 |
|
(<span class="var-type">mixed</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$col</span>, <span class="var-type">mixed</span> <span class="var-name">$cnt</span>) |
| 128 |
|
</div> |
| 129 |
|
|
| 130 |
|
<div class="method-definition"> |
| 131 |
|
<span class="method-result">void</span> |
| 132 |
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
| 133 |
|
() |
| 134 |
|
</div> |
| 135 |
|
|
| 136 |
|
<div class="method-definition"> |
| 137 |
|
<span class="method-result">string</span> |
| 138 |
|
<a href="#get_cancel_url" title="details" class="method-name">get_cancel_url</a> |
| 139 |
|
() |
| 140 |
|
</div> |
| 141 |
|
|
| 142 |
|
<div class="method-definition"> |
| 143 |
|
<span class="method-result">void</span> |
| 144 |
|
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
| 145 |
|
() |
| 146 |
|
</div> |
| 147 |
|
|
| 148 |
|
<div class="method-definition"> |
| 149 |
|
<span class="method-result">void</span> |
| 150 |
|
<a href="#set_action_name" title="details" class="method-name">set_action_name</a> |
| 151 |
|
(<span class="var-type">mixed</span> <span class="var-name">$item</span>) |
| 152 |
|
</div> |
| 153 |
|
|
| 154 |
|
<div class="method-definition"> |
| 155 |
|
<span class="method-result">void</span> |
| 156 |
|
<a href="#set_align" title="details" class="method-name">set_align</a> |
| 157 |
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
| 158 |
|
</div> |
| 159 |
|
|
| 160 |
|
<div class="method-definition"> |
| 161 |
|
<span class="method-result">void</span> |
| 162 |
|
<a href="#set_cancel_url" title="details" class="method-name">set_cancel_url</a> |
| 163 |
|
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
| 164 |
|
</div> |
| 165 |
|
|
| 166 |
|
<div class="method-definition"> |
| 167 |
|
<span class="method-result">void</span> |
| 168 |
|
<a href="#set_item_name" title="details" class="method-name">set_item_name</a> |
| 169 |
|
(<span class="var-type">mixed</span> <span class="var-name">$item</span>) |
| 170 |
|
</div> |
| 171 |
|
|
| 172 |
|
<div class="method-definition"> |
| 173 |
|
<span class="method-result">void</span> |
| 174 |
|
<a href="#set_save_vars_Flag" title="details" class="method-name">set_save_vars_Flag</a> |
| 175 |
|
([<span class="var-type">mixed</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 176 |
|
</div> |
| 177 |
|
|
| 178 |
|
<div class="method-definition"> |
| 179 |
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 180 |
|
<a href="#wrap_column_item" title="details" class="method-name">wrap_column_item</a> |
| 181 |
|
(<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">int</span> <span class="var-name">2</span>, <span class="var-type">int</span> <span class="var-name">3</span>) |
| 182 |
|
</div> |
| 183 |
|
|
| 184 |
|
<div class="method-definition"> |
| 185 |
|
<span class="method-result">void</span> |
| 186 |
|
<a href="#_build_delete_confirm" title="details" class="method-name">_build_delete_confirm</a> |
| 187 |
|
() |
| 188 |
|
</div> |
| 189 |
|
|
| 190 |
|
<div class="method-definition"> |
| 191 |
|
<span class="method-result">Container</span> |
| 192 |
|
<a href="#_build_hidden_vars" title="details" class="method-name">_build_hidden_vars</a> |
| 193 |
|
() |
| 194 |
|
</div> |
| 195 |
|
</div> |
| 196 |
|
</div> |
| 197 |
|
</div> |
| 198 |
|
|
| 199 |
|
<a name="sec-vars"></a> |
| 200 |
|
<div class="info-box"> |
| 201 |
|
<div class="info-box-title">Variables</div> |
| 202 |
|
<div class="nav-bar"> |
| 203 |
|
<a href="#sec-description">Description</a> | |
| 204 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 205 |
|
|
| 206 |
|
|
| 207 |
|
| |
| 208 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 209 |
|
|
| 210 |
|
</div> |
| 211 |
|
<div class="info-box-body"> |
| 212 |
|
<a name="var$_action_name" id="$_action_name"><!-- --></A> |
| 213 |
|
<div class="evenrow"> |
| 214 |
|
|
| 215 |
|
<div class="var-header"> |
| 216 |
|
<span class="var-title"> |
| 217 |
|
<span class="var-type">mixed</span> |
| 218 |
|
<span class="var-name">$_action_name</span> |
| 219 |
|
= <span class="var-default"> 'delete'</span> (line <span class="line-number">25</span>) |
| 220 |
|
</span> |
| 221 |
|
</div> |
| 222 |
|
|
| 223 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 224 |
|
<p class="short-description">The string that describes</p> |
| 225 |
|
<p class="description"><p>the action ie. 'delete'</p></p> |
| 226 |
|
|
| 227 |
|
|
| 228 |
|
|
| 229 |
|
|
| 230 |
|
|
| 231 |
|
</div> |
| 232 |
|
<a name="var$_align" id="$_align"><!-- --></A> |
| 233 |
|
<div class="oddrow"> |
| 234 |
|
|
| 235 |
|
<div class="var-header"> |
| 236 |
|
<span class="var-title"> |
| 237 |
|
<span class="var-type">mixed</span> |
| 238 |
|
<span class="var-name">$_align</span> |
| 239 |
|
= <span class="var-default"> "center"</span> (line <span class="line-number">40</span>) |
| 240 |
|
</span> |
| 241 |
|
</div> |
| 242 |
|
|
| 243 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 244 |
|
<p class="short-description">The overall alignment</p> |
| 245 |
|
<p class="description"><p>DEFAULT: "center"</p></p> |
| 246 |
|
|
| 247 |
|
|
| 248 |
|
|
| 249 |
|
|
| 250 |
|
|
| 251 |
|
</div> |
| 252 |
|
<a name="var$_cancel_url" id="$_cancel_url"><!-- --></A> |
| 253 |
|
<div class="evenrow"> |
| 254 |
|
|
| 255 |
|
<div class="var-header"> |
| 256 |
|
<span class="var-title"> |
| 257 |
|
<span class="var-type">mixed</span> |
| 258 |
|
<span class="var-name">$_cancel_url</span> |
| 259 |
|
= <span class="var-default"> "index.php"</span> (line <span class="line-number">53</span>) |
| 260 |
|
</span> |
| 261 |
|
</div> |
| 262 |
|
|
| 263 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 264 |
|
<p class="short-description">This sets the url for the</p> |
| 265 |
|
<p class="description"><p>cancel action to post to</p></p> |
| 266 |
|
|
| 267 |
|
|
| 268 |
|
|
| 269 |
|
|
| 270 |
|
|
| 271 |
|
</div> |
| 272 |
|
<a name="var$_data_post_name" id="$_data_post_name"><!-- --></A> |
| 273 |
|
<div class="oddrow"> |
| 274 |
|
|
| 275 |
|
<div class="var-header"> |
| 276 |
|
<span class="var-title"> |
| 277 |
|
<span class="var-type">mixed</span> |
| 278 |
|
<span class="var-name">$_data_post_name</span> |
| 279 |
|
= <span class="var-default"> "checkbox"</span> (line <span class="line-number">61</span>) |
| 280 |
|
</span> |
| 281 |
|
</div> |
| 282 |
|
|
| 283 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 284 |
|
<p class="short-description">The name of the array variable</p> |
| 285 |
|
<p class="description"><p>that the data was posted to us</p></p> |
| 286 |
|
|
| 287 |
|
|
| 288 |
|
|
| 289 |
|
|
| 290 |
|
|
| 291 |
|
</div> |
| 292 |
|
<a name="var$_item_name" id="$_item_name"><!-- --></A> |
| 293 |
|
<div class="evenrow"> |
| 294 |
|
|
| 295 |
|
<div class="var-header"> |
| 296 |
|
<span class="var-title"> |
| 297 |
|
<span class="var-type">mixed</span> |
| 298 |
|
<span class="var-name">$_item_name</span> |
| 299 |
|
= <span class="var-default"> ''</span> (line <span class="line-number">33</span>) |
| 300 |
|
</span> |
| 301 |
|
</div> |
| 302 |
|
|
| 303 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 304 |
|
<p class="short-description">name/description of the type of</p> |
| 305 |
|
<p class="description"><p>data we are working on ie 'users', 'files'</p></p> |
| 306 |
|
|
| 307 |
|
|
| 308 |
|
|
| 309 |
|
|
| 310 |
|
|
| 311 |
|
</div> |
| 312 |
|
<a name="var$_save_all_vars" id="$_save_all_vars"><!-- --></A> |
| 313 |
|
<div class="oddrow"> |
| 314 |
|
|
| 315 |
|
<div class="var-header"> |
| 316 |
|
<span class="var-title"> |
| 317 |
|
<span class="var-type">mixed</span> |
| 318 |
|
<span class="var-name">$_save_all_vars</span> |
| 319 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">47</span>) |
| 320 |
|
</span> |
| 321 |
|
</div> |
| 322 |
|
|
| 323 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 324 |
|
<p class="short-description">A flag to tell us to save all</p> |
| 325 |
|
<p class="description"><p>vars passed</p></p> |
| 326 |
|
|
| 327 |
|
|
| 328 |
|
|
| 329 |
|
|
| 330 |
|
|
| 331 |
|
</div> |
| 332 |
|
<h4>Inherited Variables</h4> |
| 333 |
|
<A NAME='inherited_vars'><!-- --></A> |
| 334 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
| 335 |
|
<blockquote> |
| 336 |
|
<span class="var-title"> |
| 337 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></span><br> |
| 338 |
|
</span> |
| 339 |
|
<span class="var-title"> |
| 340 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></span><br> |
| 341 |
|
</span> |
| 342 |
|
<span class="var-title"> |
| 343 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></span><br> |
| 344 |
|
</span> |
| 345 |
|
<span class="var-title"> |
| 346 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></span><br> |
| 347 |
|
</span> |
| 348 |
|
<span class="var-title"> |
| 349 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></span><br> |
| 350 |
|
</span> |
| 351 |
|
<span class="var-title"> |
| 352 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></span><br> |
| 353 |
|
</span> |
| 354 |
|
<span class="var-title"> |
| 355 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></span><br> |
| 356 |
|
</span> |
| 357 |
|
<span class="var-title"> |
| 358 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></span><br> |
| 359 |
|
</span> |
| 360 |
|
<span class="var-title"> |
| 361 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></span><br> |
| 362 |
|
</span> |
| 363 |
|
<span class="var-title"> |
| 364 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></span><br> |
| 365 |
|
</span> |
| 366 |
|
<span class="var-title"> |
| 367 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></span><br> |
| 368 |
|
</span> |
| 369 |
|
<span class="var-title"> |
| 370 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></span><br> |
| 371 |
|
</span> |
| 372 |
|
<span class="var-title"> |
| 373 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></span><br> |
| 374 |
|
</span> |
| 375 |
|
<span class="var-title"> |
| 376 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></span><br> |
| 377 |
|
</span> |
| 378 |
|
<span class="var-title"> |
| 379 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></span><br> |
| 380 |
|
</span> |
| 381 |
|
<span class="var-title"> |
| 382 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></span><br> |
| 383 |
|
</span> |
| 384 |
|
<span class="var-title"> |
| 385 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></span><br> |
| 386 |
|
</span> |
| 387 |
|
<span class="var-title"> |
| 388 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_all_rows">DataList::$_show_all_rows</a></span><br> |
| 389 |
|
</span> |
| 390 |
|
<span class="var-title"> |
| 391 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></span><br> |
| 392 |
|
</span> |
| 393 |
|
<span class="var-title"> |
| 394 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></span><br> |
| 395 |
|
</span> |
| 396 |
|
<span class="var-title"> |
| 397 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></span><br> |
| 398 |
|
</span> |
| 399 |
|
</blockquote> |
| 400 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 401 |
|
<blockquote> |
| 402 |
|
<span class="var-title"> |
| 403 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
| 404 |
|
</span> |
| 405 |
|
<span class="var-title"> |
| 406 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
| 407 |
|
</span> |
| 408 |
|
</blockquote> |
| 409 |
|
|
| 410 |
|
</div> |
| 411 |
|
</div> |
| 412 |
|
|
| 413 |
|
<a name="sec-methods"></a> |
| 414 |
|
<div class="info-box"> |
| 415 |
|
<div class="info-box-title">Methods</div> |
| 416 |
|
<div class="nav-bar"> |
| 417 |
|
<a href="#sec-description">Description</a> | |
| 418 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 419 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 420 |
|
|
| 421 |
|
</div> |
| 422 |
|
<div class="info-box-body"> |
| 423 |
|
<A NAME='method_detail'></A> |
| 424 |
|
<a name="methodbuild_column_header" id="build_column_header"><!-- --></a> |
| 425 |
|
<div class="evenrow"> |
| 426 |
|
|
| 427 |
|
<div class="method-header"> |
| 428 |
|
<span class="method-title">build_column_header</span> (line <span class="line-number">159</span>) |
| 429 |
|
</div> |
| 430 |
|
|
| 431 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 432 |
|
<p class="short-description">This function builds the object/text</p> |
| 433 |
|
<p class="description"><p>to be used for a column header. It can either be an href because its sortable, or it can just be text, because its not sortable.</p></p> |
| 434 |
|
<ul class="tags"> |
| 435 |
|
<li><span class="field">return:</span> - either an Atag object or raw text.</li> |
| 436 |
|
</ul> |
| 437 |
|
|
| 438 |
|
<div class="method-signature"> |
| 439 |
|
<span class="method-result">mixed</span> |
| 440 |
|
<span class="method-name"> |
| 441 |
|
build_column_header |
| 442 |
|
</span> |
| 443 |
|
(<span class="var-type">string</span> <span class="var-name">$col_name</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_num</span>) |
| 444 |
|
</div> |
| 445 |
|
|
| 446 |
|
<ul class="parameters"> |
| 447 |
|
<li> |
| 448 |
|
<span class="var-type">string</span> |
| 449 |
|
<span class="var-name">$col_name</span><span class="var-description">: - the column name to build from the headers.</span> </li> |
| 450 |
|
<li> |
| 451 |
|
<span class="var-type">array</span> |
| 452 |
|
<span class="var-name">$col_data</span><span class="var-description">: - the column's data.</span> </li> |
| 453 |
|
<li> |
| 454 |
|
<span class="var-type">int</span> |
| 455 |
|
<span class="var-name">$col_num</span><span class="var-description">: the column # we are working on.</span> </li> |
| 456 |
|
</ul> |
| 457 |
|
|
| 458 |
|
|
| 459 |
|
</div> |
| 460 |
|
<a name="methodbuild_in_clause" id="build_in_clause"><!-- --></a> |
| 461 |
|
<div class="oddrow"> |
| 462 |
|
|
| 463 |
|
<div class="method-header"> |
| 464 |
|
<span class="method-title">build_in_clause</span> (line <span class="line-number">281</span>) |
| 465 |
|
</div> |
| 466 |
|
|
| 467 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 468 |
|
<p class="short-description">This method is used to build the portion</p> |
| 469 |
|
<p class="description"><p>of the DB query that limits the list of items to show based on what was submitted from the original DataList action</p></p> |
| 470 |
|
|
| 471 |
|
<div class="method-signature"> |
| 472 |
|
<span class="method-result">string</span> |
| 473 |
|
<span class="method-name"> |
| 474 |
|
build_in_clause |
| 475 |
|
</span> |
| 476 |
|
(<span class="var-type">string</span> <span class="var-name">$field</span>) |
| 477 |
|
</div> |
| 478 |
|
|
| 479 |
|
<ul class="parameters"> |
| 480 |
|
<li> |
| 481 |
|
<span class="var-type">string</span> |
| 482 |
|
<span class="var-name">$field</span><span class="var-description">: - the field</span> </li> |
| 483 |
|
</ul> |
| 484 |
|
|
| 485 |
|
|
| 486 |
|
</div> |
| 487 |
|
<a name="methodbuild_options" id="build_options"><!-- --></a> |
| 488 |
|
<div class="evenrow"> |
| 489 |
|
|
| 490 |
|
<div class="method-header"> |
| 491 |
|
<span class="method-title">build_options</span> (line <span class="line-number">267</span>) |
| 492 |
|
</div> |
| 493 |
|
|
| 494 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 495 |
|
<p class="short-description">Build any additional custom options such as checkboxes, radiobuttons for special options for the action.</p> |
| 496 |
|
|
| 497 |
|
<div class="method-signature"> |
| 498 |
|
<span class="method-result">void</span> |
| 499 |
|
<span class="method-name"> |
| 500 |
|
build_options |
| 501 |
|
</span> |
| 502 |
|
() |
| 503 |
|
</div> |
| 504 |
|
|
| 505 |
|
|
| 506 |
|
|
| 507 |
|
</div> |
| 508 |
|
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
| 509 |
|
<div class="oddrow"> |
| 510 |
|
|
| 511 |
|
<div class="method-header"> |
| 512 |
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">112</span>) |
| 513 |
|
</div> |
| 514 |
|
|
| 515 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 516 |
|
|
| 517 |
|
<div class="method-signature"> |
| 518 |
|
<span class="method-result">void</span> |
| 519 |
|
<span class="method-name"> |
| 520 |
|
child_add_row_cell |
| 521 |
|
</span> |
| 522 |
|
(<span class="var-type">mixed</span> <span class="var-name">$obj</span>, <span class="var-type">mixed</span> <span class="var-name">$col_name</span>, <span class="var-type">mixed</span> <span class="var-name">$last_in_row_flag</span>, <span class="var-type">mixed</span> <span class="var-name">$row_data</span>) |
| 523 |
|
</div> |
| 524 |
|
|
| 525 |
|
|
| 526 |
|
<hr class="separator" /> |
| 527 |
|
<div class="notes">Redefinition of:</div> |
| 528 |
|
<dl> |
| 529 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></dt> |
| 530 |
|
<dd>This method is supposed to be written by the child class to add the cell data to the current row in the UI</dd> |
| 531 |
|
</dl> |
| 532 |
|
|
| 533 |
|
</div> |
| 534 |
|
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
| 535 |
|
<div class="evenrow"> |
| 536 |
|
|
| 537 |
|
<div class="method-header"> |
| 538 |
|
<span class="method-title">child_build_column_header</span> (line <span class="line-number">106</span>) |
| 539 |
|
</div> |
| 540 |
|
|
| 541 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 542 |
|
|
| 543 |
|
<div class="method-signature"> |
| 544 |
|
<span class="method-result">void</span> |
| 545 |
|
<span class="method-name"> |
| 546 |
|
child_build_column_header |
| 547 |
|
</span> |
| 548 |
|
(<span class="var-type">mixed</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$col</span>, <span class="var-type">mixed</span> <span class="var-name">$cnt</span>) |
| 549 |
|
</div> |
| 550 |
|
|
| 551 |
|
|
| 552 |
|
<hr class="separator" /> |
| 553 |
|
<div class="notes">Redefinition of:</div> |
| 554 |
|
<dl> |
| 555 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></dt> |
| 556 |
|
<dd>This method is supposed to be written by the child class to build and add the column title to the UI</dd> |
| 557 |
|
</dl> |
| 558 |
|
|
| 559 |
|
</div> |
| 560 |
|
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
| 561 |
|
<div class="oddrow"> |
| 562 |
|
|
| 563 |
|
<div class="method-header"> |
| 564 |
|
<span class="method-title">child_get_gui</span> (line <span class="line-number">98</span>) |
| 565 |
|
</div> |
| 566 |
|
|
| 567 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 568 |
|
|
| 569 |
|
<div class="method-signature"> |
| 570 |
|
<span class="method-result">void</span> |
| 571 |
|
<span class="method-name"> |
| 572 |
|
child_get_gui |
| 573 |
|
</span> |
| 574 |
|
() |
| 575 |
|
</div> |
| 576 |
|
|
| 577 |
|
|
| 578 |
|
<hr class="separator" /> |
| 579 |
|
<div class="notes">Redefinition of:</div> |
| 580 |
|
<dl> |
| 581 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></dt> |
| 582 |
|
<dd>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</dd> |
| 583 |
|
</dl> |
| 584 |
|
|
| 585 |
|
</div> |
| 586 |
|
<a name="methodget_cancel_url" id="get_cancel_url"><!-- --></a> |
| 587 |
|
<div class="evenrow"> |
| 588 |
|
|
| 589 |
|
<div class="method-header"> |
| 590 |
|
<span class="method-title">get_cancel_url</span> (line <span class="line-number">427</span>) |
| 591 |
|
</div> |
| 592 |
|
|
| 593 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 594 |
|
<p class="short-description">this returns the current cancel url</p> |
| 595 |
|
<ul class="tags"> |
| 596 |
|
<li><span class="field">return:</span> - the url</li> |
| 597 |
|
</ul> |
| 598 |
|
|
| 599 |
|
<div class="method-signature"> |
| 600 |
|
<span class="method-result">string</span> |
| 601 |
|
<span class="method-name"> |
| 602 |
|
get_cancel_url |
| 603 |
|
</span> |
| 604 |
|
() |
| 605 |
|
</div> |
| 606 |
|
|
| 607 |
|
|
| 608 |
|
|
| 609 |
|
</div> |
| 610 |
|
<a name="methodgui_init" id="gui_init"><!-- --></a> |
| 611 |
|
<div class="oddrow"> |
| 612 |
|
|
| 613 |
|
<div class="method-header"> |
| 614 |
|
<span class="method-title">gui_init</span> (line <span class="line-number">72</span>) |
| 615 |
|
</div> |
| 616 |
|
|
| 617 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 618 |
|
<p class="short-description">Initialize the gui layout</p> |
| 619 |
|
|
| 620 |
|
<div class="method-signature"> |
| 621 |
|
<span class="method-result">void</span> |
| 622 |
|
<span class="method-name"> |
| 623 |
|
gui_init |
| 624 |
|
</span> |
| 625 |
|
() |
| 626 |
|
</div> |
| 627 |
|
|
| 628 |
|
|
| 629 |
|
<hr class="separator" /> |
| 630 |
|
<div class="notes">Redefinition of:</div> |
| 631 |
|
<dl> |
| 632 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></dt> |
| 633 |
|
<dd>A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</dd> |
| 634 |
|
</dl> |
| 635 |
|
|
| 636 |
|
</div> |
| 637 |
|
<a name="methodset_action_name" id="set_action_name"><!-- --></a> |
| 638 |
|
<div class="evenrow"> |
| 639 |
|
|
| 640 |
|
<div class="method-header"> |
| 641 |
|
<span class="method-title">set_action_name</span> (line <span class="line-number">397</span>) |
| 642 |
|
</div> |
| 643 |
|
|
| 644 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 645 |
|
<p class="short-description">Set the name of the action</p> |
| 646 |
|
<p class="description"><p>used for display purposes only</p></p> |
| 647 |
|
|
| 648 |
|
<div class="method-signature"> |
| 649 |
|
<span class="method-result">void</span> |
| 650 |
|
<span class="method-name"> |
| 651 |
|
set_action_name |
| 652 |
|
</span> |
| 653 |
|
(<span class="var-type">mixed</span> <span class="var-name">$item</span>) |
| 654 |
|
</div> |
| 655 |
|
|
| 656 |
|
|
| 657 |
|
|
| 658 |
|
</div> |
| 659 |
|
<a name="methodset_align" id="set_align"><!-- --></a> |
| 660 |
|
<div class="oddrow"> |
| 661 |
|
|
| 662 |
|
<div class="method-header"> |
| 663 |
|
<span class="method-title">set_align</span> (line <span class="line-number">380</span>) |
| 664 |
|
</div> |
| 665 |
|
|
| 666 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 667 |
|
<p class="short-description">this function is used to set the overall alignment of the widget</p> |
| 668 |
|
|
| 669 |
|
<div class="method-signature"> |
| 670 |
|
<span class="method-result">void</span> |
| 671 |
|
<span class="method-name"> |
| 672 |
|
set_align |
| 673 |
|
</span> |
| 674 |
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
| 675 |
|
</div> |
| 676 |
|
|
| 677 |
|
<ul class="parameters"> |
| 678 |
|
<li> |
| 679 |
|
<span class="var-type">string</span> |
| 680 |
|
<span class="var-name">$align</span><span class="var-description">: - the align value</span> </li> |
| 681 |
|
</ul> |
| 682 |
|
|
| 683 |
|
<hr class="separator" /> |
| 684 |
|
<div class="notes">Redefinition of:</div> |
| 685 |
|
<dl> |
| 686 |
|
<dt><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></dt> |
| 687 |
|
<dd>This function sets the align attribute for the outer table.</dd> |
| 688 |
|
</dl> |
| 689 |
|
|
| 690 |
|
</div> |
| 691 |
|
<a name="methodset_cancel_url" id="set_cancel_url"><!-- --></a> |
| 692 |
|
<div class="evenrow"> |
| 693 |
|
|
| 694 |
|
<div class="method-header"> |
| 695 |
|
<span class="method-title">set_cancel_url</span> (line <span class="line-number">418</span>) |
| 696 |
|
</div> |
| 697 |
|
|
| 698 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 699 |
|
<p class="short-description">This sets the url to post to when a cancel/no action is clicked</p> |
| 700 |
|
|
| 701 |
|
<div class="method-signature"> |
| 702 |
|
<span class="method-result">void</span> |
| 703 |
|
<span class="method-name"> |
| 704 |
|
set_cancel_url |
| 705 |
|
</span> |
| 706 |
|
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
| 707 |
|
</div> |
| 708 |
|
|
| 709 |
|
<ul class="parameters"> |
| 710 |
|
<li> |
| 711 |
|
<span class="var-type">string</span> |
| 712 |
|
<span class="var-name">$url</span><span class="var-description">: - the url</span> </li> |
| 713 |
|
</ul> |
| 714 |
|
|
| 715 |
|
|
| 716 |
|
</div> |
| 717 |
|
<a name="methodset_item_name" id="set_item_name"><!-- --></a> |
| 718 |
|
<div class="oddrow"> |
| 719 |
|
|
| 720 |
|
<div class="method-header"> |
| 721 |
|
<span class="method-title">set_item_name</span> (line <span class="line-number">389</span>) |
| 722 |
|
</div> |
| 723 |
|
|
| 724 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 725 |
|
<p class="short-description">Set the name of the deleted items</p> |
| 726 |
|
<p class="description"><p>used for display purposes only</p></p> |
| 727 |
|
|
| 728 |
|
<div class="method-signature"> |
| 729 |
|
<span class="method-result">void</span> |
| 730 |
|
<span class="method-name"> |
| 731 |
|
set_item_name |
| 732 |
|
</span> |
| 733 |
|
(<span class="var-type">mixed</span> <span class="var-name">$item</span>) |
| 734 |
|
</div> |
| 735 |
|
|
| 736 |
|
|
| 737 |
|
|
| 738 |
|
</div> |
| 739 |
|
<a name="methodset_save_vars_Flag" id="set_save_vars_Flag"><!-- --></a> |
| 740 |
|
<div class="evenrow"> |
| 741 |
|
|
| 742 |
|
<div class="method-header"> |
| 743 |
|
<span class="method-title">set_save_vars_Flag</span> (line <span class="line-number">408</span>) |
| 744 |
|
</div> |
| 745 |
|
|
| 746 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 747 |
|
<p class="short-description">This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us.</p> |
| 748 |
|
|
| 749 |
|
<div class="method-signature"> |
| 750 |
|
<span class="method-result">void</span> |
| 751 |
|
<span class="method-name"> |
| 752 |
|
set_save_vars_Flag |
| 753 |
|
</span> |
| 754 |
|
([<span class="var-type">mixed</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 755 |
|
</div> |
| 756 |
|
|
| 757 |
|
|
| 758 |
|
|
| 759 |
|
</div> |
| 760 |
|
<a name="methodwrap_column_item" id="wrap_column_item"><!-- --></a> |
| 761 |
|
<div class="oddrow"> |
| 762 |
|
|
| 763 |
|
<div class="method-header"> |
| 764 |
|
<span class="method-title">wrap_column_item</span> (line <span class="line-number">222</span>) |
| 765 |
|
</div> |
| 766 |
|
|
| 767 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 768 |
|
<p class="short-description">This function ensures that the data we place in a column is aligned according to what the user wants.</p> |
| 769 |
|
<ul class="tags"> |
| 770 |
|
<li><span class="field">return:</span> object</li> |
| 771 |
|
</ul> |
| 772 |
|
|
| 773 |
|
<div class="method-signature"> |
| 774 |
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 775 |
|
<span class="method-name"> |
| 776 |
|
wrap_column_item |
| 777 |
|
</span> |
| 778 |
|
(<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">int</span> <span class="var-name">2</span>, <span class="var-type">int</span> <span class="var-name">3</span>) |
| 779 |
|
</div> |
| 780 |
|
|
| 781 |
|
<ul class="parameters"> |
| 782 |
|
<li> |
| 783 |
|
<span class="var-type">int</span> |
| 784 |
|
<span class="var-name">2</span><span class="var-description">: - $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)</span> </li> |
| 785 |
|
<li> |
| 786 |
|
<span class="var-type">int</span> |
| 787 |
|
<span class="var-name">3</span><span class="var-description">: - the column # we are working on.</span> </li> |
| 788 |
|
<li> |
| 789 |
|
<span class="var-type">mixed</span> |
| 790 |
|
<span class="var-name">$obj</span><span class="var-description">: - $obj - the data for the td.</span> </li> |
| 791 |
|
<li> |
| 792 |
|
<span class="var-type">string</span> |
| 793 |
|
<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> |
| 794 |
|
</ul> |
| 795 |
|
|
| 796 |
|
|
| 797 |
|
</div> |
| 798 |
|
<a name="method_build_delete_confirm" id="_build_delete_confirm"><!-- --></a> |
| 799 |
|
<div class="evenrow"> |
| 800 |
|
|
| 801 |
|
<div class="method-header"> |
| 802 |
|
<span class="method-title">_build_delete_confirm</span> (line <span class="line-number">301</span>) |
| 803 |
|
</div> |
| 804 |
|
|
| 805 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 806 |
|
<p class="short-description">This function builds the actual form</p> |
| 807 |
|
|
| 808 |
|
<div class="method-signature"> |
| 809 |
|
<span class="method-result">void</span> |
| 810 |
|
<span class="method-name"> |
| 811 |
|
_build_delete_confirm |
| 812 |
|
</span> |
| 813 |
|
() |
| 814 |
|
</div> |
| 815 |
|
|
| 816 |
|
|
| 817 |
|
|
| 818 |
|
</div> |
| 819 |
|
<a name="method_build_hidden_vars" id="_build_hidden_vars"><!-- --></a> |
| 820 |
|
<div class="oddrow"> |
| 821 |
|
|
| 822 |
|
<div class="method-header"> |
| 823 |
|
<span class="method-title">_build_hidden_vars</span> (line <span class="line-number">131</span>) |
| 824 |
|
</div> |
| 825 |
|
|
| 826 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 827 |
|
<p class="short-description">This builds the hidden form fields of the data that was originally sent to us</p> |
| 828 |
|
|
| 829 |
|
<div class="method-signature"> |
| 830 |
|
<span class="method-result">Container</span> |
| 831 |
|
<span class="method-name"> |
| 832 |
|
_build_hidden_vars |
| 833 |
|
</span> |
| 834 |
|
() |
| 835 |
|
</div> |
| 836 |
|
|
| 837 |
|
|
| 838 |
|
|
| 839 |
|
</div> |
| 840 |
|
<h4>Inherited Methods</h4> |
| 841 |
|
<a name='inherited_methods'><!-- --></a> |
| 842 |
|
<!-- =========== Summary =========== --> |
| 843 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
| 844 |
|
<blockquote> |
| 845 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></span><br> |
| 846 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></span><br> |
| 847 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></span><br> |
| 848 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></span><br> |
| 849 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></span><br> |
| 850 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></span><br> |
| 851 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></span><br> |
| 852 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></span><br> |
| 853 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></span><br> |
| 854 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></span><br> |
| 855 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></span><br> |
| 856 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></span><br> |
| 857 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></span><br> |
| 858 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></span><br> |
| 859 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></span><br> |
| 860 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></span><br> |
| 861 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></span><br> |
| 862 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></span><br> |
| 863 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></span><br> |
| 864 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddo_action">DataList::do_action()</a></span><br> |
| 865 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodexpandrows">DataList::expandrows()</a></span><br> |
| 866 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></span><br> |
| 867 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></span><br> |
| 868 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></span><br> |
| 869 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></span><br> |
| 870 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></span><br> |
| 871 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></span><br> |
| 872 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></span><br> |
| 873 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></span><br> |
| 874 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></span><br> |
| 875 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></span><br> |
| 876 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></span><br> |
| 877 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></span><br> |
| 878 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></span><br> |
| 879 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></span><br> |
| 880 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></span><br> |
| 881 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_showall">DataList::get_showall()</a></span><br> |
| 882 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></span><br> |
| 883 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></span><br> |
| 884 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></span><br> |
| 885 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></span><br> |
| 886 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></span><br> |
| 887 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></span><br> |
| 888 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></span><br> |
| 889 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></span><br> |
| 890 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></span><br> |
| 891 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></span><br> |
| 892 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></span><br> |
| 893 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></span><br> |
| 894 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></span><br> |
| 895 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></span><br> |
| 896 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></span><br> |
| 897 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></span><br> |
| 898 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></span><br> |
| 899 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></span><br> |
| 900 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_expandrows">DataList::set_expandrows()</a></span><br> |
| 901 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></span><br> |
| 902 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></span><br> |
| 903 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></span><br> |
| 904 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></span><br> |
| 905 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></span><br> |
| 906 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></span><br> |
| 907 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></span><br> |
| 908 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></span><br> |
| 909 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></span><br> |
| 910 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></span><br> |
| 911 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></span><br> |
| 912 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></span><br> |
| 913 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></span><br> |
| 914 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></span><br> |
| 915 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_showall">DataList::set_showall()</a></span><br> |
| 916 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></span><br> |
| 917 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></span><br> |
| 918 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></span><br> |
| 919 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></span><br> |
| 920 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></span><br> |
| 921 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></span><br> |
| 922 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></span><br> |
| 923 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></span><br> |
| 924 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></span><br> |
| 925 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></span><br> |
| 926 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></span><br> |
| 927 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></span><br> |
| 928 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></span><br> |
| 929 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></span><br> |
| 930 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></span><br> |
| 931 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></span><br> |
| 932 |
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></span><br> |
| 933 |
|
</blockquote> |
| 934 |
|
<!-- =========== Summary =========== --> |
| 935 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 936 |
|
<blockquote> |
| 937 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
| 938 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
| 939 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
| 940 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
| 941 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
| 942 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
| 943 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
| 944 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
| 945 |
|
</blockquote> |
| 946 |
|
<!-- =========== Summary =========== --> |
| 947 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 948 |
|
<blockquote> |
| 949 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
| 950 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
| 951 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
| 952 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
| 953 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
| 954 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
| 955 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
| 956 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
| 957 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
| 958 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
| 959 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
| 960 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
| 961 |
|
</blockquote> |
| 962 |
|
|
| 963 |
|
</div> |
| 964 |
|
</div> |
| 965 |
|
|
| 966 |
|
|
| 967 |
|
<p class="notes" id="credit"> |
| 968 |
|
Documentation generated on Thu, 1 Apr 2004 09:39:02 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 969 |
|
</p> |
| 970 |
|
</div></body> |
| 971 |
|
</html> |
Parent Directory
| 
Revision Log
| 
Patch
