Sitemap node type base class.
| package | core |
|---|
get_node(\ID_TEXT $page_link, \?string $callback= null, \?array $valid_node_types= null, \?integer $child_cutoff= null, \?integer $max_recurse_depth= null, integer $recurse_level= 0, integer $options= 0, \ID_TEXT $zone= '_SEARCH', integer $meta_gather= 0, \?array $row= null, boolean $return_anyway= false) : \?array
\ID_TEXTThe page-link we are finding.
\?stringCallback function to send discovered page-links to (null: return).
\?arrayList of node types we will return/recurse-through (null: no limit)
\?integerMaximum number of children before we cut off all children (null: no limit).
\?integerHow deep to go from the Sitemap root (null: no limit).
integerOur recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important]).
integerA bitmask of SITEMAPGEN* options.
\ID_TEXTThe zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
integerA bitmask of SITEMAPGATHER* constants, of extra data to include.
\?arrayDatabase row (null: lookup).
booleanWhether to return the structure even if there was a callback. Do not pass this setting through via recursion due to memory concerns, it is used only to gather information to detect and prevent parent/child duplication of default entry points.
\?arrayNode structure (null: working via callback / error).get_privilege_page(string $page_link) : \?ID_TEXT
The permission page is where privileges may be overridden against.
stringThe page-link
\?ID_TEXTThe permission page (null: none)get_virtual_nodes(\ID_TEXT $page_link, \?string $callback= null, \?array $valid_node_types= null, \?integer $child_cutoff= null, \?integer $max_recurse_depth= null, integer $recurse_level= 0, integer $options= 0, \ID_TEXT $zone= '_SEARCH', integer $meta_gather= 0, boolean $return_anyway= false) : \?array
May be a single node (i.e. a category root) or multiple nodes (if there's a flat structure).
\ID_TEXTThe page-link we are finding.
\?stringCallback function to send discovered page-links to (null: return).
\?arrayList of node types we will return/recurse-through (null: no limit)
\?integerMaximum number of children before we cut off all children (null: no limit).
\?integerHow deep to go from the Sitemap root (null: no limit).
integerOur recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important]).
integerA bitmask of SITEMAPGEN* options.
\ID_TEXTThe zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
integerA bitmask of SITEMAPGATHER* constants, of extra data to include.
booleanWhether to return the structure even if there was a callback. Do not pass this setting through via recursion due to memory concerns, it is used only to gather information to detect and prevent parent/child duplication of default entry points.
\?arrayList of node structures (null: working via callback).handles_page_link(\ID_TEXT $page_link) : integer
\ID_TEXTThe page-link.
integerA SITEMAP_NODE_* constant.is_active() : boolean
booleanWhether the hook is active._ameliorate_with_row(integer $options, array $struct, \?array $row, integer $meta_gather)
integerA bitmask of SITEMAPGEN* options.
arrayStructure.
\?arrayFaked database row (null: we don't have row data).
integerA bitmask of SITEMAPGATHER* constants, of extra data to include.
_get_sitemap_object(\ID_TEXT $hook) : object
\ID_TEXTThe hook, i.e. the Sitemap object type. Usually the same as a content type.
objectThe Sitemap object._is_page_omitted_from_sitemap(\ID_TEXT $zone, \ID_TEXT $page) : boolean
\ID_TEXTThe zone the page is being loaded in
\ID_TEXTThe codename of the page to load
booleanWhether the page should be omitted._load_row_from_page_groupings(\?array $row, \ID_TEXT $zone, \ID_TEXT $page, \ID_TEXT $type= 'browse', \?ID_TEXT $id= null) : \?array
\?arrayFaked database row (null: derive).
\ID_TEXTThe zone.
\ID_TEXTThe page.
\ID_TEXTThe type.
\?ID_TEXTThe ID (null: unknown).
\?arrayFaked database row (null: derive)._make_zone_concrete(\ID_TEXT $zone, \ID_TEXT $page_link) : \ID_TEXT
\ID_TEXTThe zone in the recurse tree (replaced by reference).
\ID_TEXTThe page-link (replaced by reference).
\ID_TEXTThe page name (only returned because it could also be useful, saves some code)._request_page_details(\ID_TEXT $page, \ID_TEXT $zone) : \~array
\ID_TEXTThe codename of the page to load
\ID_TEXTThe zone the page is being loaded in
\~arrayA list of details (false: page not found)