\apex\core\tablepackages

Summary

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

Properties

$columns

$columns :

Type

$rows_per_page

$rows_per_page :

Type

$form_field

$form_field :

Type

$form_name

$form_name :

Type

$form_value

$form_value :

Type

$network

$network :\apex\app\sys\network

Type

\apex\app\sys\network

Methods

get_attributes()

get_attributes(array  $data = array())

Passes the attributes contained within the <e:function> 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 = ''): integer

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.

Returns

integer —

The total number of rows available for this table.

get_rows()

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

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): array

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.

Returns

array —

The resulting array that should be displayed to the browser.