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_TEXT
The page-link we are finding.
\?string
Callback function to send discovered page-links to (null: return).
\?array
List of node types we will return/recurse-through (null: no limit)
\?integer
Maximum number of children before we cut off all children (null: no limit).
\?integer
How deep to go from the Sitemap root (null: no limit).
integer
Our recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important]).
integer
A bitmask of SITEMAPGEN* options.
\ID_TEXT
The zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
integer
A bitmask of SITEMAPGATHER* constants, of extra data to include.
\?array
Database row (null: lookup).
boolean
Whether 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.
\?array
Node structure (null: working via callback / error).get_privilege_page(string $page_link) : \?ID_TEXT
The permission page is where privileges may be overridden against.
string
The page-link
\?ID_TEXT
The 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_TEXT
The page-link we are finding.
\?string
Callback function to send discovered page-links to (null: return).
\?array
List of node types we will return/recurse-through (null: no limit)
\?integer
Maximum number of children before we cut off all children (null: no limit).
\?integer
How deep to go from the Sitemap root (null: no limit).
integer
Our recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important]).
integer
A bitmask of SITEMAPGEN* options.
\ID_TEXT
The zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
integer
A bitmask of SITEMAPGATHER* constants, of extra data to include.
boolean
Whether 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.
\?array
List of node structures (null: working via callback).handles_page_link(\ID_TEXT $page_link) : integer
\ID_TEXT
The page-link.
integer
A SITEMAP_NODE_* constant.is_active() : boolean
boolean
Whether the hook is active._ameliorate_with_row(integer $options, array $struct, \?array $row, integer $meta_gather)
integer
A bitmask of SITEMAPGEN* options.
array
Structure.
\?array
Faked database row (null: we don't have row data).
integer
A bitmask of SITEMAPGATHER* constants, of extra data to include.
_get_sitemap_object(\ID_TEXT $hook) : object
\ID_TEXT
The hook, i.e. the Sitemap object type. Usually the same as a content type.
object
The Sitemap object._is_page_omitted_from_sitemap(\ID_TEXT $zone, \ID_TEXT $page) : boolean
\ID_TEXT
The zone the page is being loaded in
\ID_TEXT
The codename of the page to load
boolean
Whether 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
\?array
Faked database row (null: derive).
\ID_TEXT
The zone.
\ID_TEXT
The page.
\ID_TEXT
The type.
\?ID_TEXT
The ID (null: unknown).
\?array
Faked database row (null: derive)._make_zone_concrete(\ID_TEXT $zone, \ID_TEXT $page_link) : \ID_TEXT
\ID_TEXT
The zone in the recurse tree (replaced by reference).
\ID_TEXT
The page-link (replaced by reference).
\ID_TEXT
The page name (only returned because it could also be useful, saves some code)._request_page_details(\ID_TEXT $page, \ID_TEXT $zone) : \~array
\ID_TEXT
The codename of the page to load
\ID_TEXT
The zone the page is being loaded in
\~array
A list of details (false: page not found)