File/program/modules/sitemap/sitemap_view.php

Description

/program/modules/sitemap/sitemap_view.php - interface to the view-part of the sitemap module

This file defines the interface with the sitemap-module for viewing content. The interface consists of this function:

    sitemap_view(&$output,$area_id,$node_id,$module)

This function is called from /index.php when the node to display is connected to this module.

Functions
sitemap_tree_walk (line 155)

walk the tree and send to output in the form of nested unnumbered lists (uses recursion)

void sitemap_tree_walk (object &$theme, int $subtree_id, array &$tree, [string $m = ''])
  • object &$theme: collects the output
  • int $subtree_id: where to start walking the the tree
  • array &$tree: the structure that holds the tree
  • string $m: improves readability in output
sitemap_view (line 54)

display the content of the sitemap linked to node $node_id

there are three different variations (depends on configuration parameter 'scope'):

  • 0 (small): only show a map of the tree in the current area $area_id
  • 1 (medium): show a list of available areas followed by the map of the current area $area_id
  • 2 (large): show the maps of all available areas
The default is 0 (small).

  • return: TRUE on success + output via $theme, FALSE otherwise
bool sitemap_view (object &$theme, int $area_id, int $node_id, array $module)
  • object &$theme: collects the (html) output
  • int $area_id: identifies the area where $node_id lives
  • int $node_id: the node to which this module is connected
  • array $module: the module record straight from the database

Documentation generated on Tue, 28 Jun 2016 19:11:55 +0200 by phpDocumentor 1.4.0