Docs For Class ListAction

## Class ListAction

Description

A class for showing a list of items to preform an action on

- author: Walter A. Boring IV <waboring@newsblob.com>

Located in /widgets/data_list/ListAction.inc (line 18)

    Container
       |
       --BaseWidget
          |
          --DataList
             |
             --ListAction

Variable Summary
mixed $_action_name
mixed $_align
mixed $_cancel_url
mixed $_data_post_name
mixed $_item_name
mixed $_save_all_vars
Method Summary
mixed build_column_header (string $col_name, array $col_data, int $col_num)
string build_in_clause (string $field)
void build_options ()
void child_add_row_cell (mixed $obj, mixed $col_name, mixed $last_in_row_flag, mixed $row_data)
void child_build_column_header (mixed $name, mixed $col, mixed $cnt)
void child_get_gui ()
string get_cancel_url ()
void gui_init ()
void set_action_name (mixed $item)
void set_align (string $align)
void set_cancel_url (string $url)
void set_item_name (mixed $item)
void set_save_vars_Flag ([mixed $flag = TRUE])
TDtag wrap_column_item (mixed $obj, string $col_name, int 2, int 3)
void _build_delete_confirm ()
Container _build_hidden_vars ()
Variables
mixed $_action_name = 'delete' (line 25)

The string that describes

the action ie. 'delete'

mixed $_align = "center" (line 40)

The overall alignment

DEFAULT: "center"

mixed $_cancel_url = "index.php" (line 53)

This sets the url for the

cancel action to post to

mixed $_data_post_name = "checkbox" (line 61)

The name of the array variable

that the data was posted to us

mixed $_item_name = '' (line 33)

name/description of the type of

data we are working on ie 'users', 'files'

mixed $_save_all_vars = TRUE (line 47)

A flag to tell us to save all

vars passed

#### Inherited Variables

Inherited from DataList

> DataList::$_advanced_search_flag
> DataList::$_clean_string
> DataList::$_columns
> DataList::$_datasource
> DataList::$_debug
> DataList::$_default_orderby
> DataList::$_default_reverseorder
> DataList::$_default_rows_per_page
> DataList::$_form_attributes
> DataList::$_form_render_flag
> DataList::$_global_prefix
> DataList::$_image_path
> DataList::$_max_rows
> DataList::$_not_found_message
> DataList::$_num_columns
> DataList::$_num_pages
> DataList::$_save_vars
> DataList::$_search_flag
> DataList::$_search_table
> DataList::$_show_all_rows
> DataList::$_show_results_flag
> DataList::$_simple_search_modifier
> DataList::$_vars

Inherited from BaseWidget

> BaseWidget::$title
> BaseWidget::$width
> BaseWidget::$_image_prefix

Methods
build_column_header (line 159)

This function builds the object/text

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.

- return: - either an Atag object or raw text.

mixed build_column_header (string $col_name, array $col_data, int $col_num)

- string $col_name: - the column name to build from the headers.
- array $col_data: - the column's data.
- int $col_num: the column # we are working on.

build_in_clause (line 281)

This method is used to build the portion

of the DB query that limits the list of items to show based on what was submitted from the original DataList action

string build_in_clause (string $field)

- string $field: - the field

build_options (line 267)

Build any additional custom options such as checkboxes, radiobuttons for special options for the action.

void build_options ()
child_add_row_cell (line 112)
void child_add_row_cell (mixed $obj, mixed $col_name, mixed $last_in_row_flag, mixed $row_data)

Redefinition of:

DataList::child_add_row_cell()
  This method is supposed to be written by the child class to add the cell data to the current row in the UI

child_build_column_header (line 106)
void child_build_column_header (mixed $name, mixed $col, mixed $cnt)

Redefinition of:

DataList::child_build_column_header()
  This method is supposed to be written by the child class to build and add the column title to the UI

child_get_gui (line 98)
void child_get_gui ()

Redefinition of:

DataList::child_get_gui()
  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

get_cancel_url (line 427)

this returns the current cancel url

- return: - the url

string get_cancel_url ()
gui_init (line 72)

Initialize the gui layout

void gui_init ()

Redefinition of:

DataList::gui_init()
  A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.

set_action_name (line 397)

Set the name of the action

used for display purposes only

void set_action_name (mixed $item)
set_align (line 380)

this function is used to set the overall alignment of the widget

void set_align (string $align)

- string $align: - the align value

Redefinition of:

BaseWidget::set_align()
  This function sets the align attribute for the outer table.

set_cancel_url (line 418)

This sets the url to post to when a cancel/no action is clicked

void set_cancel_url (string $url)

- string $url: - the url

set_item_name (line 389)

Set the name of the deleted items

used for display purposes only

void set_item_name (mixed $item)
set_save_vars_Flag (line 408)

This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us.

void set_save_vars_Flag ([mixed $flag = TRUE])
wrap_column_item (line 222)

This function ensures that the data we place in a column is aligned according to what the user wants.

- return: object

TDtag wrap_column_item (mixed $obj, string $col_name, int 2, int 3)

- int 2: - $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)
- int 3: - the column # we are working on.
- mixed $obj: - $obj - the data for the td.
- string $col_name: - $col_name - the name of the column header for this row to render.

_build_delete_confirm (line 301)

This function builds the actual form

void _build_delete_confirm ()
_build_hidden_vars (line 131)

This builds the hidden form fields of the data that was originally sent to us

Container _build_hidden_vars ()

#### Inherited Methods

Inherited From DataList

> DataList::DataList()
> DataList::add_header_item()
> DataList::advanced_search_disable()
> DataList::advanced_search_enable()
> DataList::build_base_url()
> DataList::build_column_item()
> DataList::build_column_url()
> DataList::build_gui()
> DataList::build_orderby_querystring()
> DataList::build_reverseorder_querystring()
> DataList::build_searchfield_querystring()
> DataList::build_searchvalue_querystring()
> DataList::build_state_vars_query_string()
> DataList::build_tool_link()
> DataList::child_add_row_cell()
> DataList::child_build_column_header()
> DataList::child_build_search_table()
> DataList::child_get_gui()
> DataList::data_prefetch()
> DataList::do_action()
> DataList::expandrows()
> DataList::filter_column_string()
> DataList::get_cleanstring()
> DataList::get_current_page()
> DataList::get_data_source()
> DataList::get_default_num_rows()
> DataList::get_form_action()
> DataList::get_form_method()
> DataList::get_form_name()
> DataList::get_form_render()
> DataList::get_form_target()
> DataList::get_global_prefix()
> DataList::get_image_path()
> DataList::get_last_page()
> DataList::get_max_rows()
> DataList::get_not_found_message()
> DataList::get_num_pages()
> DataList::get_page_info()
> DataList::get_showall()
> DataList::get_simple_search_modifier()
> DataList::gui_init()
> DataList::is_advanced_search_enabled()
> DataList::is_search_enabled()
> DataList::numrows()
> DataList::offset()
> DataList::orderby()
> DataList::pre_query_sanity_check()
> DataList::render()
> DataList::reverseorder()
> DataList::search_disable()
> DataList::search_enable()
> DataList::search_field()
> DataList::search_type()
> DataList::search_value()
> DataList::search_value_filter()
> DataList::setup_columns()
> DataList::set_cleanstring()
> DataList::set_data_source()
> DataList::set_debug()
> DataList::set_default_num_rows()
> DataList::set_expandrows()
> DataList::set_form_action()
> DataList::set_form_method()
> DataList::set_form_name()
> DataList::set_form_render()
> DataList::set_form_target()
> DataList::set_global_prefix()
> DataList::set_image_path()
> DataList::set_max_rows()
> DataList::set_not_found_message()
> DataList::set_numrows()
> DataList::set_offset()
> DataList::set_orderby()
> DataList::set_reverseorder()
> DataList::set_save_vars()
> DataList::set_search_type()
> DataList::set_showall()
> DataList::set_show_results()
> DataList::set_simple_search_modifier()
> DataList::simple_search_modifier_value()
> DataList::user_setup()
> DataList::_build_default_vars()
> DataList::_build_save_vars()
> DataList::_build_simple_search_modifier()
> DataList::_build_tool_url()
> DataList::_check_datasource()
> DataList::_clean_string()
> DataList::_filter_column_string()
> DataList::_get()
> DataList::_get_searchable_fields()
> DataList::_javascript()
> DataList::_save_mozilla_nav_link()
> DataList::_set()
> DataList::_show_results()

Inherited From BaseWidget

> BaseWidget::get_align()
> BaseWidget::get_css()
> BaseWidget::get_javascript()
> BaseWidget::get_title()
> BaseWidget::get_width()
> BaseWidget::set_align()
> BaseWidget::set_image_path_prefix()
> BaseWidget::set_title()
> BaseWidget::set_width()

Inherited From Container

> Container::Container()
> Container::add()
> Container::add_reference()
> Container::count_content()
> Container::get_element()
> Container::get_indent_flag()
> Container::push()
> Container::push_reference()
> Container::render()
> Container::reset_content()
> Container::set_collapse()
> Container::set_indent_flag()

Documentation generated on Thu, 1 Sep 2005 17:06:05 -0700 by phpDocumentor 1.3.0RC3