Function Module_galleries->build_set_navigation
Definitions
site/pages/modules/galleries.php
- Sort out gallery back/next navigation.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $extra_where | string | No | No | required parameter | N/A | N/A | Where clause for doing set query |
| $join | string | No | No | required parameter | N/A | N/A | Join clause for doing set query |
| $category_name | string | No | No | required parameter | N/A | N/A | The actual title for the gallery we are using |
| $current_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the current entry of the type we are browsing in the gallery we are using (null: assume first) |
| $root | ID_TEXT | No | No | required parameter | N/A | N/A | The root gallery (the gallery we are considering as an ad hoc root, to allow gallery splitting-up) |
| $current_type | ?ID_TEXT | No | No | required parameter | image video | N/A | The current type being browsed (null: assume first) |
| $wide_high | BINARY | No | No | required parameter | N/A | N/A | If panels hidden |
| $start | integer | No | No | required parameter | N/A | N/A | Start position when returning to category |
| $max | integer | No | No | required parameter | N/A | N/A | Max to show when returning to category |
| $cat | ID_TEXT | No | No | required parameter | N/A | N/A | Category |
| $url_sort | string | No | No | required parameter | N/A | N/A | Sort parameter |
| $dir | string | No | No | required parameter | ASC DESC | N/A | Sort direction |
| $image_select | string | No | No | required parameter | N/A | N/A | Selectcode for limiting images displayed |
| $video_select | string | No | No | required parameter | N/A | N/A | Selectcode for limiting videos displayed |
| $days | ?integer | No | No | required parameter | N/A | N/A | Day limit for recency (null: no limit) |
Returns
- A tuple of the navigation bits
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Sort out gallery back/next navigation.
*
* @param string $extra_where Where clause for doing set query
* @param string $join Join clause for doing set query
* @param string $category_name The actual title for the gallery we are using
* @param ?AUTO_LINK $current_id The ID of the current entry of the type we are browsing in the gallery we are using (null: assume first)
* @param ID_TEXT $root The root gallery (the gallery we are considering as an ad hoc root, to allow gallery splitting-up)
* @param ?ID_TEXT $current_type The current type being browsed (null: assume first)
* @set image video
* @param BINARY $wide_high If panels hidden
* @param integer $start Start position when returning to category
* @param integer $max Max to show when returning to category
* @param ID_TEXT $cat Category
* @param string $url_sort Sort parameter
* @param string $dir Sort direction
* @set ASC DESC
* @param string $image_select Selectcode for limiting images displayed
* @param string $video_select Selectcode for limiting videos displayed
* @param ?integer $days Day limit for recency (null: no limit)
* @return array A tuple of the navigation bits
*/
public function build_set_navigation(string $extra_where, string $join, string $category_name, ?int $current_id, string $root, ?string $current_type, int $wide_high, int $start, int $max, string $cat, string $url_sort, string $dir, string $image_select, string $video_select, ?int $days) : array
* Sort out gallery back/next navigation.
*
* @param string $extra_where Where clause for doing set query
* @param string $join Join clause for doing set query
* @param string $category_name The actual title for the gallery we are using
* @param ?AUTO_LINK $current_id The ID of the current entry of the type we are browsing in the gallery we are using (null: assume first)
* @param ID_TEXT $root The root gallery (the gallery we are considering as an ad hoc root, to allow gallery splitting-up)
* @param ?ID_TEXT $current_type The current type being browsed (null: assume first)
* @set image video
* @param BINARY $wide_high If panels hidden
* @param integer $start Start position when returning to category
* @param integer $max Max to show when returning to category
* @param ID_TEXT $cat Category
* @param string $url_sort Sort parameter
* @param string $dir Sort direction
* @set ASC DESC
* @param string $image_select Selectcode for limiting images displayed
* @param string $video_select Selectcode for limiting videos displayed
* @param ?integer $days Day limit for recency (null: no limit)
* @return array A tuple of the navigation bits
*/
public function build_set_navigation(string $extra_where, string $join, string $category_name, ?int $current_id, string $root, ?string $current_type, int $wide_high, int $start, int $max, string $cat, string $url_sort, string $dir, string $image_select, string $video_select, ?int $days) : array
