SproutCMS

class NavigationGroups

Menu groups for front end main navigation

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

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-11-25
**/
class NewClassName extends NavigationGroups {
    
    /**
    * Return an array of extra menu details for a top-level nav items
    * 
    * Return keys:
    *    text    Description
    *    image   Image filename
    **/
    public function getExtras (int $page_id) {
        // Method code goes here
    }
    
    /**
    * Get all extras, grouped by top parent page id
    * ADMIN ONLY METHOD
    **/
    public function getAllExtrasAdmin () {
        // Method code goes here
    }
    
    /**
    * Return an array of Treenode instances for the items in this group
    **/
    public function getItems ($page_id, $position, $limit) {
        // Method code goes here
    }
    
    /**
    * Return the group name for a given page and position
    **/
    public function getName ($page_id, $position) {
        // Method code goes here
    }
    
    /**
    * Return the group id for a given page and position
    **/
    public function getId ($page_id, $position) {
        // Method code goes here
    }
    
    /**
    * Get all group names, grouped by top parent page id
    * ADMIN ONLY METHOD
    **/
    public function getAllNamesAdmin () {
        // Method code goes here
    }
    
    /**
    * Returns an array of position -&gt; name for all groups for a page
    **/
    public function getAllNames ($page_id) {
        // Method code goes here
    }
    
    /**
    * Get all group details, grouped by top parent page id
    * ADMIN ONLY METHOD
    **/
    public function getAllGroupsAdmin () {
        // Method code goes here
    }
    
    private function loadGroupNames ($subsite_id) {
        // Method code goes here
    }
    
    /**
    * Return an array of group names to use for a given top parent
    * ADMIN ONLY METHOD
    **/
    public function getGroupsAdmin (TreeNode $page_id) {
        // Method code goes here
    }
    
}
?>