\apex\core\tabledb_servers

Summary

Methods

Properties

Constants

get_total()
get_rows()

$columns
$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

$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

get_total()

get_total(string  $search_term = ''): integer

Get total number of rows.

Obtains the total number of rows within the table, and is used to create the necessary pagination link.

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 = 'id asc'): array

Get table rows to display.

Gathers and formats the exact table rows to display within the web browser. This method is called when initially viewing the template, plus for AJAX based search, pagination, and sorting.

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.