Function __global->results_launcher
Definitions
sources/templates_result_launcher.php
- Get the Tempcode for a results launcher.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $title | Tempcode | No | No | required parameter | N/A | N/A | The title/name of the resource we are browsing through |
| $page | ID_TEXT | No | No | required parameter | N/A | N/A | The page name we are launching into |
| $category_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The category ID we are browsing in |
| $max | integer | No | No | required parameter | N/A | N/A | The maximum number of rows to show per browser page |
| $max_rows | integer | No | No | required parameter | N/A | N/A | The maximum number of rows in the entire dataset |
| $type | ID_TEXT | No | No | required parameter | N/A | N/A | The page type this browser is browsing through (e.g. 'category') |
| $max_pagination_links | ?integer | No | No | Null | N/A | N/A | The maximum number of quick-jump pagination-links to show (null: configured default) |
| $start_name | string | No | No | start | N/A | N/A | GET parameter for start position |
Returns
- The results launcher
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the Tempcode for a results launcher.
*
* @param Tempcode $title The title/name of the resource we are browsing through
* @param ID_TEXT $page The page name we are launching into
* @param AUTO_LINK $category_id The category ID we are browsing in
* @param integer $max The maximum number of rows to show per browser page
* @param integer $max_rows The maximum number of rows in the entire dataset
* @param ID_TEXT $type The page type this browser is browsing through (e.g. 'category')
* @param ?integer $max_pagination_links The maximum number of quick-jump pagination-links to show (null: configured default)
* @param string $start_name GET parameter for start position
* @return Tempcode The results launcher
*/
function results_launcher(object $title, string $page, int $category_id, int $max, int $max_rows, string $type, ?int $max_pagination_links = null, string $start_name = 'start') : object
* Get the Tempcode for a results launcher.
*
* @param Tempcode $title The title/name of the resource we are browsing through
* @param ID_TEXT $page The page name we are launching into
* @param AUTO_LINK $category_id The category ID we are browsing in
* @param integer $max The maximum number of rows to show per browser page
* @param integer $max_rows The maximum number of rows in the entire dataset
* @param ID_TEXT $type The page type this browser is browsing through (e.g. 'category')
* @param ?integer $max_pagination_links The maximum number of quick-jump pagination-links to show (null: configured default)
* @param string $start_name GET parameter for start position
* @return Tempcode The results launcher
*/
function results_launcher(object $title, string $page, int $category_id, int $max, int $max_rows, string $type, ?int $max_pagination_links = null, string $start_name = 'start') : object
