int $_contextid (line 43)

The context ID we're accociated with.

• access: private

edit_current_page_url (line 469)

This function provides an interface to construct links like "Edit this page".

It takes the currently displayed content element (either a leaf or node) and constructs the respective URL relative to the root of the AIS instance as passed to the function.

• return: The full URL to the AIS element in question, null if there is no on-site representation, false on failure

• string $baseurl: The base url that leads to the root AIS page of the MidCOM site (without any /$id/data additions).

get_combined_toolbar (line 713)

Compute a toolbar out of the NAP information for a given leaf and its node. Merges both toolbars into one. Always based on a leaf.

You can either pass a leaf structure, a leaf id or null. I the last case the current leaf is used. If the current leaf is undefined, the class will return the current node toolbar instead.

The information from the component will be post-processed so that the URLs point to the right location in NAP.

It uses _check_toolbar_permission to ascertain if the user can edit the leaf/node.

• return: The created toolbar.
• see: midcom_helper_nav::_check_toolbar_permission()

• string $baseurl: The base url that leads to the root AIS page of the MidCOM site (without any /$id/data additions).
• mixed $leaf: The node to be processed, either a fetched leaf array, a leaf id or null for the current leaf.

get_current_node (line 72)

Retrieve the ID of the currently displayed node. Defined by the topic of the component that declared able to handle the request.

• return: The ID of the node in question.
• see: midcom_helper__basicnav::get_current_node()

get_leaf_toolbar (line 604)

Compute a toolbar out of the NAP information for a given leaf.

You can either pass a leaf structure, a leaf id or null. I the last case the current leaf is used. If the current leaf is undefined, the class will return null.

The information from the component will be post-processed so that the URLs point to the right location in NAP.

It uses _check_toolbar_permission to ascertain if the user can edit a leaf.

• return: The created toolbar or null if no current leaf toolbar is available.
• see: midcom_helper_nav::_check_toolbar_permission()

• string $baseurl: The base url that leads to the root AIS page of the MidCOM site (without any /$id/data additions).
• mixed $leaf: The node to be processed, either a fetched leaf array, a leaf id or null for the current leaf.

get_node (line 143)

This will give you a key-value pair describeing the node with the ID $node_id. The defined keys are described above in Node data interchange format. You will get false if the node ID is invalid.

• return: The node-data as outlined in the class introduction, false on failure
• see: midcom_helper__basicnav::get_node()

• int $node_id: The node-id to be retrieved.

get_node_uplink (line 180)

Returns the ID of the node to which $node_id is accociated to, false on failure. The root node's uplink is -1.

• return: The ID of the Node for which we have a match, -1 for the root node, or false on failure.
• see: midcom_helper__basicnav::get_node_uplink()

• int $node_id: The Leaf-ID to search an uplink for.

get_toolbar_definition (line 209)

This function returns the toolbar definition for the NAP object passed. This must superseed all calls to $nap_object[MIDCOM_NAV_TOOLBAR] as this information is not usable directly - it would result from the MidCOM cache and thus be out of date always (and especially not adapted to the current user).

Implementation note: This is a hotfix, that works around the current problem. It is not very performant if you query large numbers of NAP toolbars at this time. We have some basic caching in this function, but nevertheless we need a better solution here.

• return: Toolbar definition array as originally stored in the MIDCOM_NAV_TOOLBAR key (so this can be null as well).

• Array $nap_object: The NAP data structure of the object for which a toolbar should be retrieved.

list_child_elements (line 229)

List all child elements, nodes and leaves alike, of the node with ID $parent_node_id. For every child element, an array of ID and type (node/leaf) is given as

• MIDCOM_NAV_ID => 0,
• MIDCOM_NAV_TYPE => "node"

• return: A list of found elements, or false on failure.

• int $parent_node_id: The ID of the parent node.

list_nodes (line 113)

Lists all Sub-nodes of $parent_node. If there are no subnodes you will get an empty array, if there was an error (for instance an unkown parent node ID) you will get FALSE.

• return: An Array of Node IDs or false on failure.
• see: midcom_helper__basicnav::list_nodes()

• int $parent_node: The id of the node of which the subnodes are searched.
• bool $show_noentry: Show all objects on-site which have the noentry flag set. This parameter has no effect in AIS. This defaults to false.

render_leaf_toolbar (line 685)

Shortcut function, which creates a leaf-toolbar and renders it immediately.

• return: The rendered toolbar or null, if none was available.
• see: midcom_helper_nav::get_leaf_toolbar()

• string $baseurl: The base url that leads to the root AIS page of the MidCOM site (without any /$id/data additions).
• mixed $leaf: The node to be processed, either a fetched leaf array, a leaf id or null for the current leaf.

resolve_guid (line 293)

This function tries to resolve a guid into an NAP object.

The code is optimized trying to avoid a full-scan if possible. To do this it will treat topic and article guids specially: In both cases the system will translate it using the topic id into a node id and scan only that part of the tree non-recursivly.

A full scan of the NAP data is only done if another MidgardObject is used.

• return: Eitehr a node or leaf structure, distinguishable by MIDCOM_NAV_TYPE, or false on failure.

• string $guid: The GUID of the object to be looked up.

show_simple_nav (line 994)

Generate a fully automated navigation.

This method will print a simple navigation tree. It uses CSS both for line formatting and for indentation. This method starts automatically at the root node, the root node's leaves will not be shown.

Here is a configuration example that can be copy&pasted, everything is mandatory:

 <?php
 // These are CSS-classes, don't set them if you don't have any classes
// no class=... tags will be written out then
 
 $config["css_div_leaf_selected"]   = "nav_leaf_selected";
 $config["css_div_leaf_unselected"] = "nav_leaf_unselected";
 $config["css_div_node_selected"]   = "nav_node_selected";
 $config["css_div_node_unselected"] = "nav_node_unselected";
 $config["css_a_leaf_unselected"] = "nav_leaf_unselected";
 $config["css_a_node_unselected"] = "nav_node_unselected";
 
 // Prefix automatically prepended to any displayed leaves or nodes,
// leave empty if you don't want them.
 // It must include trailing spaces if you want them between prefix and element name!
 
 $config["leaf_prefix"] = "&raquo; ";
 $config["node_prefix"] = "";
 
 // These are css lenght's used to build up the indentation
 $config["indent_size"]    = "15";
 $config["indent_linewrap"] = "5";
 $config["indent_unit"]     = "px";
 
 // other Miscellaneous configuration parameters
// This one controls wether leaves or subnodes are displayed first
 
 $config["leaves_first"] = true;
 ?>

• see: midcom_helper_nav::show_combined_nav()

• Array $config: Configuration as outlined above

_check_toolbar_permissions (line 813)

Checks for the toolbar permissions, uses the cache variables $_user and $_admin to cache the data against repeated calls.

• int $topic_id: The topic id to check against.