$columns
$columns :
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.
| string | $search_term | Only applicable if the AJAX search box has been submitted, and is the term being searched for. |
The total number of rows available for this table.
get_rows(integer $start,string $search_term = '',string $order_by = 'order_num 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.
| 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. |
An array of associative arrays giving key-value pairs of the rows to display.
format_row(array $row): array
Formats a single row for display within the web browser.
Has one database table row passed to it, an associative array, which can then be formatted as necessary for display within the web brwoser. This takes the raw contents from the database and converts it to displable format.
| array | $row | The row from the database. |
The resulting array that should be displayed to the browser.