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
  • Return: object

Parameters

Name Type Default Set Range Description
$category_name string required parameter N/A N/A The actual title for the gallery we are using
$extra_where string required parameter N/A N/A Where clause for doing set query
$join string required parameter N/A N/A Join clause for doing set query
$current_id AUTO_LINK 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 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 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 required parameter N/A N/A As above, except next entry (null: no next)
$root ID_TEXT 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 required parameter N/A N/A Position in collection
$n integer required parameter N/A N/A Total in collection
$current_type ID_TEXT required parameter N/A N/A The first type being browsed
$first_type ID_TEXT required parameter N/A N/A The current type being browsed
$back_type ID_TEXT required parameter N/A N/A The type for the back link
$next_type ID_TEXT required parameter N/A N/A The type for the next link
$wide_high BINARY required parameter N/A N/A If panels hidden
$start integer required parameter N/A N/A Start position when returning to category
$max integer required parameter N/A N/A Max to show when returning to category
$cat ?ID_TEXT required parameter N/A N/A Category (null: not in a category)
$url_sort string required parameter N/A N/A Sort parameter
$dir string required parameter N/A N/A Sort direction
$image_select string required parameter N/A N/A Selectcode for limiting images displayed
$video_select string required parameter N/A N/A Selectcode for limiting videos displayed
$days ?integer required parameter N/A N/A Day limit for recency (null: no limit)

Return

  • The navigation bits
  • Type: Tempcode
  • Set: N/A
  • Range: N/A