Function Module_galleries->do_gallery_carousel_mode

Definitions

site/pages/modules/galleries.php

  • The UI for a "carousel mode" gallery.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$rating_details Tempcode No No required parameter N/A N/A Rating area
$comment_details Tempcode No No required parameter N/A N/A Commenting area
$cat ID_TEXT No No required parameter N/A N/A Our gallery ID
$root ID_TEXT No No required parameter N/A N/A Virtual root gallery
$description Tempcode No No required parameter N/A N/A The description of the gallery
$may_download boolean No No required parameter N/A N/A Whether may "download this gallery"
$edit_url Tempcode No No required parameter N/A N/A The URL to "edit this gallery"
$add_gallery_url Tempcode No No required parameter N/A N/A The URL to "add a gallery"
$submit_image_url Tempcode No No required parameter N/A N/A The URL to "submit an image to this gallery"
$submit_video_url Tempcode No No required parameter N/A N/A The URL to "submit a video to this gallery"
$title Tempcode No No required parameter N/A N/A The title of the page (our of get_screen_title)
$rep_image URLPATH No No required parameter N/A N/A The representative image for the gallery
$start integer No No required parameter N/A N/A The start position we are in browsing through child galleries
$max integer No No required parameter N/A N/A The maximum number of child galleries we can display per page
$fullname string No No required parameter N/A N/A The gallery title
$sorting Tempcode No No required parameter N/A N/A Sorting UI
$gallery_row array No No required parameter N/A N/A The gallery row

Returns

  • The UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * The UI for a "carousel mode" gallery.
 *
 * @param  Tempcode $rating_details Rating area
 * @param  Tempcode $comment_details Commenting area
 * @param  ID_TEXT $cat Our gallery ID
 * @param  ID_TEXT $root Virtual root gallery
 * @param  Tempcode $description The description of the gallery
 * @param  boolean $may_download Whether may "download this gallery"
 * @param  Tempcode $edit_url The URL to "edit this gallery"
 * @param  Tempcode $add_gallery_url The URL to "add a gallery"
 * @param  Tempcode $submit_image_url The URL to "submit an image to this gallery"
 * @param  Tempcode $submit_video_url The URL to "submit a video to this gallery"
 * @param  Tempcode $title The title of the page (our of get_screen_title)
 * @param  URLPATH $rep_image The representative image for the gallery
 * @param  integer $start The start position we are in browsing through child galleries
 * @param  integer $max The maximum number of child galleries we can display per page
 * @param  string $fullname The gallery title
 * @param  Tempcode $sorting Sorting UI
 * @param  array $gallery_row The gallery row
 * @return Tempcode The UI
 */
public function do_gallery_carousel_mode(object $rating_details, object $comment_details, string $cat, string $root, object $description, bool $may_download, object $edit_url, object $add_gallery_url, object $submit_image_url, object $submit_video_url, object $title, string $rep_image, int $start, int $max, string $fullname, object $sorting, array $gallery_row) : object