NavigationGroups class - Documentation for SproutCMS

Info Page:

Page options:

class NavigationGroups

Menu groups for front end main navigation

Name	Visibility	Description
getAllExtrasAdmin	public (static)	Get all extras, grouped by top parent page id
getAllGroupsAdmin	public (static)	Get all group details, grouped by top parent page id
getAllNames	public (static)	Returns an array of position -> name for all groups for a page
getAllNamesAdmin	public (static)	Get all group names, grouped by top parent page id
getExtras	public (static)	Return an array of extra menu details for a top-level nav items
getGroupsAdmin	public (static)	Return an array of group names to use for a given top parent
getId	public (static)	Return the group id for a given page and position
getItems	public (static)	Return an array of Treenode instances for the items in this group
getName	public (static)	Return the group name for a given page and position
loadGroupNames	private (static)

unknown NavigationGroups::getAllExtrasAdmin ( );

Get all extras, grouped by top parent page id
ADMIN ONLY METHOD

unknown NavigationGroups::getAllGroupsAdmin ( );

Get all group details, grouped by top parent page id
ADMIN ONLY METHOD

unknown NavigationGroups::getAllNames ( mixed $page_id );

Returns an array of position -> name for all groups for a page

unknown NavigationGroups::getAllNamesAdmin ( );

Get all group names, grouped by top parent page id
ADMIN ONLY METHOD

array NavigationGroups::getExtras ( int $page_id );

Return an array of extra menu details for a top-level nav items

Return keys:
   text    Description
   image   Image filename

array NavigationGroups::getGroupsAdmin ( TreeNode $page_id );

Return an array of group names to use for a given top parent
ADMIN ONLY METHOD

unknown NavigationGroups::getId ( mixed $page_id , mixed $position );

Return the group id for a given page and position

unknown NavigationGroups::getItems ( mixed $page_id , mixed $position [, mixed $limit ] );

Return an array of Treenode instances for the items in this group

unknown NavigationGroups::getName ( mixed $page_id , mixed $position );

Return the group name for a given page and position

unknown NavigationGroups::loadGroupNames ( [ mixed &$subsite_id ] );

This function does not have a description