Function __global->results_table

Definitions

sources/templates_results_table.php

  • Get the Tempcode for a results table.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$text_id mixed required parameter N/A N/A Some text/word describing what is being browsed (string or Tempcode)
$start integer required parameter N/A N/A The result number our table starts at (x of n)
$start_name ID_TEXT required parameter N/A N/A The parameter name used to store our position in the results (usually, 'start')
$max integer required parameter N/A N/A The total number of results to show per-page
$max_name ID_TEXT required parameter N/A N/A The parameter name used to store the total number of results to show per-page (usually, 'max')
$max_rows integer required parameter N/A N/A The maximum number of rows in the entire dataset
$header_row Tempcode required parameter N/A N/A The titles of the fields we are showing in our table, presented in pre-prepared Tempcode
$result_entries Tempcode required parameter N/A N/A The entry rows we are showing in our table
$sortables array [] N/A N/A A map of sortable code (usually, db field names), to strings giving the human name for the sort order
$sortable ?ID_TEXT Null N/A N/A The current sortable (null: none)
$sort_order ?ID_TEXT Null N/A N/A The order we are sorting in (null: none)
$sort_name ?ID_TEXT sort N/A N/A The parameter name used to store our sortable (usually 'sort') (null: none)
$message ?Tempcode Null N/A N/A Message to show; you want to set this to new Tempcode() if you do not want any message to show (null: auto)
$widths array [] N/A N/A Widths to specify to the table (strings, ending 'px')
$tpl_set ?string Null N/A N/A The template set to use (null: default)
$max_pagination_links ?integer Null N/A N/A The maximum number of quick-jump pagination-links to show (null: configured default)
$guid string 1c8645bc2a3ff5bec2e003142185561f N/A N/A GUID to pass to template
$skip_sortables_form boolean False N/A N/A Whether to skip showing a sort form (useful if there is another form wrapped around this)
$hash ?ID_TEXT Null N/A N/A URL hash component without the # (null: none)
$interactive boolean False N/A N/A Whether to allow interactive sorting and filtering
$responsive boolean True N/A N/A Whether the table should be responsive
$footer_row ?Tempcode Null N/A N/A The footer row of the fields we are showing in our table, presented in pre-prepared Tempcode (null: do not show a footer)

Return

  • The results table
  • Type: Tempcode
  • Set: N/A
  • Range: N/A