Function Module_galleries->show_nav
Definitions
site/pages/modules/galleries.php
- Show gallery navigation bits used when viewing images/videos.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $category_name | string | No | No | required parameter | N/A | N/A | The actual title for the gallery we are using |
| $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 |
| $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 |
| $first_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the first entry of the type we are browsing in the gallery we are using (null: no first) |
| $back_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the previous entry of the type we are browsing in the gallery we are using (null: no previous) |
| $next_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | As above, except next entry (null: no next) |
| $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) |
| $x | integer | No | No | required parameter | N/A | N/A | Position in collection |
| $n | integer | No | No | required parameter | N/A | N/A | Total in collection |
| $current_type | ID_TEXT | No | No | required parameter | image video | N/A | The first type being browsed |
| $first_type | ID_TEXT | No | No | required parameter | image video | N/A | The current type being browsed |
| $back_type | ID_TEXT | No | No | required parameter | image video | N/A | The type for the back link |
| $next_type | ID_TEXT | No | No | required parameter | image video | N/A | The type for the next link |
| $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 (null: not in 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
- The navigation bits
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Show gallery navigation bits used when viewing images/videos.
*
* @param string $category_name The actual title for the gallery we are using
* @param string $extra_where Where clause for doing set query
* @param string $join Join clause for doing set query
* @param AUTO_LINK $current_id The ID of the current entry of the type we are browsing in the gallery we are using
* @param ?AUTO_LINK $first_id The ID of the first entry of the type we are browsing in the gallery we are using (null: no first)
* @param ?AUTO_LINK $back_id The ID of the previous entry of the type we are browsing in the gallery we are using (null: no previous)
* @param ?AUTO_LINK $next_id As above, except next entry (null: no next)
* @param ID_TEXT $root The root gallery (the gallery we are considering as an ad hoc root, to allow gallery splitting-up)
* @param integer $x Position in collection
* @param integer $n Total in collection
* @param ID_TEXT $current_type The first type being browsed
* @set image video
* @param ID_TEXT $first_type The current type being browsed
* @set image video
* @param ID_TEXT $back_type The type for the back link
* @set image video
* @param ID_TEXT $next_type The type for the next link
* @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 (null: not in a 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 Tempcode The navigation bits
*/
public function show_nav(string $category_name, string $extra_where, string $join, int $current_id, ?int $first_id, ?int $back_id, ?int $next_id, string $root, int $x, int $n, string $current_type, string $first_type, string $back_type, string $next_type, int $wide_high, int $start, int $max, ?string $cat, string $url_sort, string $dir, string $image_select, string $video_select, ?int $days) : object
* Show gallery navigation bits used when viewing images/videos.
*
* @param string $category_name The actual title for the gallery we are using
* @param string $extra_where Where clause for doing set query
* @param string $join Join clause for doing set query
* @param AUTO_LINK $current_id The ID of the current entry of the type we are browsing in the gallery we are using
* @param ?AUTO_LINK $first_id The ID of the first entry of the type we are browsing in the gallery we are using (null: no first)
* @param ?AUTO_LINK $back_id The ID of the previous entry of the type we are browsing in the gallery we are using (null: no previous)
* @param ?AUTO_LINK $next_id As above, except next entry (null: no next)
* @param ID_TEXT $root The root gallery (the gallery we are considering as an ad hoc root, to allow gallery splitting-up)
* @param integer $x Position in collection
* @param integer $n Total in collection
* @param ID_TEXT $current_type The first type being browsed
* @set image video
* @param ID_TEXT $first_type The current type being browsed
* @set image video
* @param ID_TEXT $back_type The type for the back link
* @set image video
* @param ID_TEXT $next_type The type for the next link
* @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 (null: not in a 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 Tempcode The navigation bits
*/
public function show_nav(string $category_name, string $extra_where, string $join, int $current_id, ?int $first_id, ?int $back_id, ?int $next_id, string $root, int $x, int $n, string $current_type, string $first_type, string $back_type, string $next_type, int $wide_high, int $start, int $max, ?string $cat, string $url_sort, string $dir, string $image_select, string $video_select, ?int $days) : object
