Function __global->pagination
Definitions
sources/templates_pagination.php
- Get the Tempcode for pagination.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $title | Tempcode | required parameter | N/A | N/A | The title/name of the resource we are browsing through |
| $start | integer | required parameter | N/A | N/A | The current position in the browser |
| $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 maximum number of rows to show per browser 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 |
| $keep_post | boolean | False | N/A | N/A | Whether to keep POST data when browsing through and relay it as GET |
| $max_pagination_links | ?integer | Null | N/A | N/A | The maximum number of quick-jump pagination-links to show (null: configured default) |
| $_selectors | ?array | Null | N/A | N/A | List of per-page selectors to show (null: show hard-coded ones) |
| $hash | ID_TEXT | Blank (empty string) | N/A | N/A | Hash component to URL |
| $keyset_value | ?mixed | Null | N/A | N/A | Keyset-pagination reference value for the 'next' page of results (null: no keyset pagination) |
Return
- The pagination
- Type: Tempcode
- Set: N/A
- Range: N/A