SproutCMS

class Navigation

Provides navigation functions

• File: /sprout/Helpers/Navigation.php
• Namespace: Sprout\Helpers

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-16
**/
class NewClassName extends Navigation {
    
    /**
    * Returns an array of all pages.
    **/
    public function getAllPages ($parent, $indent) {
        // Method code goes here
    }
    
    /**
    * Returns the filename to use for a banner image, or NULL if no appropriate banner was found
    **/
    public function banner () {
        // Method code goes here
    }
    
    /**
    * Returns the name of this section, or the site name if no reasonable section can be determined.
    **/
    public function sectionName () {
        // Method code goes here
    }
    
    /**
    * Finds the node in the page tree which matched the specified {@see TreenodeMatcher}.
    **/
    public function matchedNode () {
        // Method code goes here
    }
    
    /**
    * Alias for {@see Navigation::matchedNode}()
    **/
    public function getMatchedNode () {
        // Method code goes here
    }
    
    /**
    * Returns a simple menu
    **/
    public function simpleMenu () {
        // Method code goes here
    }
    
    /**
    * Private node drawing function for SuperFish menu.
    **/
    private function simpleMenuDrawnode ($node, $depth, $pmm_max_depth) {
        // Method code goes here
    }
    
    public function getCrumbs (array|null $post_crumbs) {
        // Method code goes here
    }
    
    /**
    * Draws a current-reveal menu.
    * This is a menu where the top level items all get shown, but the children
    * only get shown for active items.
    * 
    * Uses the same HTML as the pmm2 menu, just because that HTML has plenty of
    * classes and ids, and I already had the code for that menu :)
    * 
    * See http://www.rymill.com.au/ for an example of this type of menu.
    **/
    public function currentReveal () {
        // Method code goes here
    }
    
    /**
    * Builds the title that gets put into TITLE tags in the head of the page
    * Just glues the site title onto the end of the page title
    **/
    public function buildBrowserTitle (string $page_title) {
        // Method code goes here
    }
    
    /**
    * Generates a menu which does not have dropdowns, but just has the top-level items
    **/
    public function nonDropdown () {
        // Method code goes here
    }
    
    /**
    * Renders a custom breadcrumb based on an array of crumbs.
    * This includes a home tag.
    **/
    public function customBreadcrumb (array $crumbs, string $seperator_front, string $seperator_back) {
        // Method code goes here
    }
    
    /**
    * Renders a custom breadcrumb based on an array of crumbs
    **/
    public function renderCrumbs (array $crumbs, string $seperator_front, string $seperator_back) {
        // Method code goes here
    }
    
    /**
    * Draws a UL of children for a zippmenu
    **/
    public function zippmenuChildren ($page_url) {
        // Method code goes here
    }
    
    /**
    * Renders breadcrumbs for the current page
    **/
    public function breadcrumb (string $seperator_front, array $post_crumbs, string $seperator_back) {
        // Method code goes here
    }
    
    /**
    * Draws a single item, and its sub-items
    **/
    private function currentRevealDrawnode (PageNode $node, int $depth) {
        // Method code goes here
    }
    
    /**
    * Private node drawing function for SuperFish menu.
    **/
    private function superfishDrawnode ($node, $depth, $pmm_max_depth) {
        // Method code goes here
    }
    
    /**
    * Draws a superfish menu, with the current page highlighted in the menu
    **/
    public function superfish () {
        // Method code goes here
    }
    
    /**
    * Draws a single item, and its sub-items
    **/
    private function pmm2Drawnode (PageNode $node, int $depth, $pmm_max_depth, $pmm_nav_limit) {
        // Method code goes here
    }
    
    /**
    * Gets the matcher that is used to get the current page
    **/
    public function getPageNodeMatcher () {
        // Method code goes here
    }
    
    /**
    * Sets a matcher that should be used to find the current page in the tree
    **/
    public function setPageNodeMatcher (TreeNodeMatcher $page_node_matcher) {
        // Method code goes here
    }
    
    /**
    * Draws a pmm2 menu, with the current page highlighted in the menu
    **/
    public function pmm2 () {
        // Method code goes here
    }
    
    /**
    * Nuke the navigation from the cache.
    * Assumes the user is logged into the admin
    **/
    public function clearCache () {
        // Method code goes here
    }
    
    /**
    * Alias for Navigation::getRootNode()
    **/
    public function rootNode () {
        // Method code goes here
    }
    
    /**
    * Gets the root node of the currently loaded navigation tree
    **/
    public function getRootNode () {
        // Method code goes here
    }
    
    /**
    * Loads the page tree from the database
    **/
    public function loadPageTree (int $subsite_id, bool $is_admin, bool $set_root) {
        // Method code goes here
    }
    
}
?>