The UI to show a gallery.
tempcode
do_gallery
()
The UI for a "flow mode" gallery.
tempcode
do_gallery_flow_mode
(tempcode $rating_details, tempcode $comment_details, ID_TEXT $cat, ID_TEXT $root, tempcode $description, tempcode $children, boolean $may_download, tempcode $edit_url, tempcode $add_gallery_url, tempcode $submit_image_url, tempcode $submit_video_url, tempcode $title, URLPATH $rep_image, integer $start, integer $max, integer $num_galleries)
-
tempcode
$rating_details: Rating area
-
tempcode
$comment_details: Commenting area
-
ID_TEXT
$cat: Our gallery ID
-
ID_TEXT
$root: Virtual root gallery
-
tempcode
$description: The description of the gallery
-
tempcode
$children: The tempcode for our visible child galleries
-
boolean
$may_download: Whether may "download this gallery"
-
tempcode
$edit_url: The URL to "edit this gallery"
-
tempcode
$add_gallery_url: The URL to "add a gallery"
-
tempcode
$submit_image_url: The URL to "submit an image to this gallery"
-
tempcode
$submit_video_url: The URL to "submit a video to this gallery"
-
tempcode
$title: The title of the page (our of get_page_title)
-
URLPATH
$rep_image: The representative image for the gallery
-
integer
$start: The start position we are in browsing through child galleries
-
integer
$max: The maximum number of child galleries we can display per page
-
integer
$num_galleries: The number of child galleries we have
The UI for an "regular mode" gallery.
tempcode
do_gallery_regular_mode
(tempcode $rating_details, tempcode $comment_details, ID_TEXT $cat, ID_TEXT $root, tempcode $description, tempcode $children, boolean $may_download, tempcode $edit_url, tempcode $add_gallery_url, tempcode $submit_image_url, tempcode $submit_video_url, tempcode $title)
-
tempcode
$rating_details: Rating area
-
tempcode
$comment_details: Commenting area
-
ID_TEXT
$cat: Our gallery ID
-
ID_TEXT
$root: Virtual root gallery
-
tempcode
$description: The description of the gallery
-
tempcode
$children: The tempcode for our visible child galleries
-
boolean
$may_download: Whether may "download this gallery"
-
tempcode
$edit_url: The URL to "edit this gallery"
-
tempcode
$add_gallery_url: The URL to "add a gallery"
-
tempcode
$submit_image_url: The URL to "submit an image to this gallery"
-
tempcode
$submit_video_url: The URL to "submit a video to this gallery"
-
tempcode
$title: The title of the page (our of get_page_title)
Convert a page link to a category ID and category permission module type.
array
extract_page_link_permissions
(string $page_link)
-
string
$page_link: The page link
Standard modular entry-point finder function.
?array
get_entry_points
()
Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).
?array
get_page_links
([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
-
?integer
$max_depth: The number of tree levels to computer (NULL: no limit)
-
boolean
$require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
-
?string
$start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
-
boolean
$dont_care_about_categories: Whether to avoid returning categories.
Standard modular new-style deep page-link finder function (does not return the main entry-points).
void
get_sitemap_pagelinks
(string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub, [?string $parent_pagelink = NULL], [integer $recurse_level = 0], [?array $category_data = NULL], [?array $image_data = NULL], [?array $video_data = NULL])
-
string
$callback: Callback function to send discovered page-links to.
-
MEMBER
$member_id: The member we are finding stuff for (we only find what the member can view).
-
integer
$depth: Code for how deep we are tunnelling down, in terms of whether we are getting entries as well as categories.
-
string
$pagelink_stub: Stub used to create page-links. This is passed in because we don't want to assume a zone or page name within this function.
-
?string
$parent_pagelink: Where we're looking under (NULL: root of tree). We typically will NOT show a root node as there's often already an entry-point representing it.
-
integer
$recurse_level: Our recursion depth (used to calculate importance of page-link, used for instance by Google sitemap). Deeper is typically less important.
-
?array
$category_data: Non-standard for API [extra parameter tacked on] (NULL: yet unknown). Contents of database table for performance.
-
?array
$image_data: Non-standard for API [extra parameter tacked on] (NULL: yet unknown). Contents of database table for performance.
-
?array
$video_data: Non-standard for API [extra parameter tacked on] (NULL: yet unknown). Contents of database table for performance.
Standard modular info function.
?array
info
()
Standard modular install function.
void
install
([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
-
?integer
$upgrade_from: What version we're upgrading from (NULL: new install)
-
?integer
$upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)
The UI to list all galleries for browsing.
tempcode
list_galleries
()
Standard modular run function.
tempcode
run
()
The UI to show an image.
tempcode
show_image
()
Show gallery navigation bits used when viewing images/videos.
tempcode
show_nav
(tempcode $category_name, ID_TEXT $cat, AUTO_LINK $current_id, ?AUTO_LINK $back_id, ?AUTO_LINK $forward_id, ID_TEXT $root, integer $x, integer $n)
-
tempcode
$category_name: The actual title for the gallery we are using
-
ID_TEXT
$cat: The gallery we are using
-
AUTO_LINK
$current_id: The ID of the current entry of the type we are browsing in the gallery we are using
-
?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)
-
?AUTO_LINK
$forward_id: As above, except next entry (NULL: no next)
-
ID_TEXT
$root: The root gallery (the gallery we are considering as an adhoc root, to allow gallery splitting-up)
-
integer
$x: Position in collection
-
integer
$n: Total in collection
The UI to show a video.
tempcode
show_video
()
Standard modular uninstall function.
void
uninstall
()