results_entry (line 126)
Get the tempcode for a results entry. You would gather together the outputs of several of these functions, then put them in as the $fields in a results_table function call.
tempcode
results_entry
(array $values, [boolean $auto_escape = false], [?string $tplset = NULL])
-
array
$values: The array of values that make up this entry (of tempcode or string, or mixture)
-
boolean
$auto_escape: Whether to automatically escape each entry so that it cannot contain HTML
-
?string
$tplset: The template set to use (NULL: default)
results_field_title (line 147)
Get the tempcode for a results table title row. You would take the output of this, and feed it in as $fields_title, in a results_table function call.
tempcode
results_field_title
(array $values, [?array $sortables = NULL], [ID_TEXT $order_param = 'sort'], [ID_TEXT $current_ordering = ''])
-
array
$values: The array of field titles that define the entries in the results table
-
?array
$sortables: A map of sortable code (usually, db field names), to strings giving the human name for the sort order (NULL: no sortables)
-
ID_TEXT
$order_param: The parameter name used to store our sortable
-
ID_TEXT
$current_ordering: The current ordering
results_table (line 43)
Get the tempcode for a results table.
tempcode
results_table
(mixed $text_id, integer $start, ID_TEXT $start_name, integer $max, ID_TEXT $max_name, integer $max_rows, tempcode $fields_title, tempcode $fields, [?array $sortables = NULL], [?ID_TEXT $sortable = NULL], [?ID_TEXT $sort_order = NULL], [?ID_TEXT $sort_name = NULL], [?tempcode $message = NULL], [?array $widths = NULL], [?string $tplset = NULL], [integer $max_page_links = 10])
-
mixed
$text_id: Some text/word describing what is being browsed (Tempcode or string)
-
integer
$start: The result number our table starts at (x of n)
-
ID_TEXT
$start_name: The parameter name used to store our position in the results (usually, 'start')
-
integer
$max: The total number of results to show per-page
-
ID_TEXT
$max_name: The parameter name used to store the total number of results to show per-page (usually, 'max')
-
integer
$max_rows: The maximum number of rows in the entire dataset
-
tempcode
$fields_title: The titles of the fields we are showing in our table, presented in preprepared tempcode
-
tempcode
$fields: The values of the fields we are showing in our table
-
?array
$sortables: A map of sortable code (usually, db field names), to strings giving the human name for the sort order (NULL: no sortables)
-
?ID_TEXT
$sortable: The current sortable (NULL: none)
-
?ID_TEXT
$sort_order: The order we are sorting in (NULL: none)
-
?ID_TEXT
$sort_name: The parameter name used to store our sortable (usually 'sort') (NULL: none)
-
?tempcode
$message: Message to show (NULL: auto)
-
?array
$widths: Widths to specify to the table (NULL: none sent)
-
?string
$tplset: The template set to use (NULL: default)
-
integer
$max_page_links: The maximum number of quick-jump page links to show