Class: SortableTableFromArray

Source Location: /main/inc/lib/sortabletable.class.php

Class Overview

HTML_Table
   |
   --SortableTable
      |
      --SortableTableFromArray

Sortable table which can be used for data available in an array

Inherited Variables

Class: SortableTable

SortableTable::$additional_parameters
SortableTable::$column
SortableTable::$column_filters
SortableTable::$default_items_per_page
SortableTable::$direction
SortableTable::$form_actions
SortableTable::$get_data_function
SortableTable::$get_total_number_function
SortableTable::$other_tables
SortableTable::$pager
SortableTable::$page_nr
SortableTable::$param_prefix
SortableTable::$per_page
SortableTable::$table_name
SortableTable::$td_attributes
SortableTable::$th_attributes
SortableTable::$total_number_of_items

Inherited Methods

Class: SortableTable

SortableTable::SortableTable(): Create a new SortableTable
SortableTable::display(): Displays the table, complete with navigation buttons to browse through the data-pages.
SortableTable::filter_data(): Transform all data in a table-row, using the filters defined by the function set_column_filter(...) defined elsewhere in this class.
SortableTable::get_additional_url_paramstring(): Get the parameter-string with additional parameters to use in the URLs
SortableTable::get_navigation_html(): Get the HTML-code with the navigational buttons to browse through the data-pages.
SortableTable::get_pager(): Get the Pager object to split the showed data in several pages
SortableTable::get_page_select_form(): Get the HTML-code wich represents a form to select how many items a page should contain.
SortableTable::get_sortable_table_param_string(): Get the parameter-string with the SortableTable-related parameters to use
SortableTable::get_table_data(): Get the data to display. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.
SortableTable::get_table_html(): Get the HTML-code with the data-table.
SortableTable::get_table_title(): Get the table title.
SortableTable::get_total_number_of_items(): Get the total number of items. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.
SortableTable::set_additional_parameters(): Define a list of additional parameters to use in the generated URLs
SortableTable::set_column_filter(): Add a filter to a column. If another filter was allready defined for the given column, it will be overwritten.
SortableTable::set_form_actions(): Define a list of actions which can be performed on the table-date.
SortableTable::set_header(): Set the header-label
SortableTable::set_other_tables(): Set other tables on the same page.

Class Details

[line 578]
Sortable table which can be used for data available in an array

[ Top ]

Class Variables

$table_data =

[line 583]

The array containing all data for this table

Type:

mixed

[ Top ]

Class Methods

constructor SortableTableFromArray [line 590]

SortableTableFromArray SortableTableFromArray(
array
$table_data, [int
$default_column = 1], [int
$default_items_per_page = 20], [
$tablename = 'tablename'])

Constructor

Parameters:

array	$table_data
int	$default_column
int	$default_items_per_page
	$tablename

[ Top ]

method get_table_data [line 599]

void get_table_data(
[
$from = 1])

Get table data to show on current page

Tags:

see:

get_table_data

Overrides SortableTable::get_table_data() (Get the data to display. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.)

Parameters:

$from

[ Top ]

method get_total_number_of_items [line 608]

void get_total_number_of_items(
)

Get total number of items

Tags:

see:

get_total_number_of_items

Overrides SortableTable::get_total_number_of_items() (Get the total number of items. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.)

[ Top ]

Documentation generated on Wed, 05 Sep 2007 06:15:09 +0200 by phpDocumentor 1.4.0