\apex\devkit\tablepackages

Handles the table including obtaining the rows to display, total rows in the table, formatting of cells, etc.

Summary

Methods
Properties
Constants
__construct()
get_attributes()
get_total()
get_rows()
format_row()
$columns
$sortable
$rows_per_page
$has_search
$form_field
$form_name
$form_value
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$columns

$columns :

Type

$sortable

$sortable :

Type

$rows_per_page

$rows_per_page :

Type

$has_search

$has_search :

Type

$form_field

$form_field :

Type

$form_name

$form_name :

Type

$form_value

$form_value :

Type

Methods

__construct()

__construct()

Constructor

get_attributes()

get_attributes(array  $data = array())

Parse attributes within <a:function> tag.

Passes the attributes contained within the tag that called the table. Used mainly to show/hide columns, and retrieve subsets of data (eg. specific records for a user ID#).

Parameters

array $data

The attributes contained within the tag that called the table.

get_total()

get_total(string  $search_term = '')

Get total rows.

Get the total number of rows available for this table. This is used to determine pagination links.

Parameters

string $search_term

Only applicable if the AJAX search box has been submitted, and is the term being searched for. @return int The total number of rows available for this table.

get_rows()

get_rows(integer  $start,string  $search_term = '',string  $order_by = 'name asc'): array

Get rows to display

Gets the actual rows to display to the web browser. Used for when initially displaying the table, plus AJAX based search, sort, and pagination.

Parameters

integer $start

The number to start retrieving rows at, used within the LIMIT clause of the SQL statement.

string $search_term

Only applicable if the AJAX based search base is submitted, and is the term being searched form.

string $order_by

Must have a default value, but changes when the sort arrows in column headers are clicked. Used within the ORDER BY clause in the SQL statement.

Returns

array —

An array of associative arrays giving key-value pairs of the rows to display.

format_row()

format_row(array  $row)

Format a single row.

Retrieves raw data from the database, which must be formatted into user readable format (eg. format amounts, dates, etc.).

Parameters

array $row

The row from the database.

@return array The resulting array that should be displayed to the browser.