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 $entry_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
$entry_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 show a list of catalogues to choose from.
tempcode
list_catalogues
()
Standard modular run function.
tempcode
run
()
The UI to view a catalogue category tree.
tempcode
tree_view_screen
()
Standard modular uninstall function.
void
uninstall
()
The UI to show a catalogue category.
tempcode
view_catalogue_category
()
The UI to show a catalogue A-Z screen.
tempcode
view_catalogue_category_entries
()
The UI to show a catalogue entry.
tempcode
view_catalogue_entry
()
The UI to show the index of a catalogue.
tempcode
view_catalogue_index
()