init__sitemap (line 31)
Standard code module initialisation function.
void
init__sitemap
()
pagelink_to_sitemapsxml (line 357)
Callback for writing a page-link into the Sitemaps XML file.
void
pagelink_to_sitemapsxml
(string $pagelink, string $parent_pagelink, ?TIME $add_date, ?TIME $edit_date, float $priority, string $title, [boolean $accessible = true])
-
string
$pagelink: The page-link.
-
string
$parent_pagelink: The parent page-link in the ocPortal site tree.
-
?TIME
$add_date: When the node was added (NULL: unknown).
-
?TIME
$edit_date: When the node was last edited (NULL: unknown/never).
-
float
$priority: The priority of this for spidering, 0.0-1.0.
-
string
$title: The title of the node.
-
boolean
$accessible: Whether the category is accessible by the user the sitemap is being generated for (Guest for a Sitemaps XML file).
sitemaps_build (line 47)
Top level function to (re)generate a Sitemap (xml file, Google-style).
void
sitemaps_build
()
sitemaps_xml_finished (line 329)
Finalise the writing to a Sitemaps XML file.
void
sitemaps_xml_finished
()
sitemaps_xml_initialise (line 299)
Initialise the writing to a Sitemaps XML file. You can only call one of these functions per time as it uses global variables for tracking.
void
sitemaps_xml_initialise
(PATH $file_path)
-
PATH
$file_path: Where we will save to.
spawn_page_crawl (line 96)
Start up a search for page-links, writing results into the callback. Usually we pass a callback that builds a Sitemap XML file, but we don't need to- it can be anything.
void
spawn_page_crawl
(string $callback, MEMBER $member_id, [?array $extra_filters = NULL], [integer $depth = 1])
-
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).
-
?array
$extra_filters: Page-links to skip (NULL: none). Currently this only works on pages, but may be expanded in the future.
-
integer
$depth: Code for how deep we are tunnelling down, in terms of what kinds of things we'll go so far as to collect. Use DEPTH__* constants for the values.