INavigationManager
in
Manages the ownCloud navigation
Tags
Table of Contents
- TYPE_APPS = 'link'
- Navigation entries of the app navigation
- TYPE_GUEST = 'guest'
- Navigation entries for public page footer navigation
- TYPE_SETTINGS = 'settings'
- Navigation entries of the settings navigation
- add() : void
- Creates a new navigation entry
- getActiveEntry() : string
- Get the current navigation entry of the currently running app
- getAll() : array
- Get a list of navigation entries
- setActiveEntry() : void
- Sets the current navigation entry of the currently running app
Constants
TYPE_APPS
Navigation entries of the app navigation
public
mixed
TYPE_APPS
= 'link'
Tags
TYPE_GUEST
Navigation entries for public page footer navigation
public
mixed
TYPE_GUEST
= 'guest'
Tags
TYPE_SETTINGS
Navigation entries of the settings navigation
public
mixed
TYPE_SETTINGS
= 'settings'
Tags
Methods
add()
Creates a new navigation entry
public
add(array|Closure $entry) : void
Parameters
- $entry : array|Closure
-
Array containing: id, name, order, icon and href key The use of a closure is preferred, because it will avoid loading the routing of your app, unless required.
Tags
getActiveEntry()
Get the current navigation entry of the currently running app
public
getActiveEntry() : string
Tags
Return values
string —getAll()
Get a list of navigation entries
public
getAll([string $type = self::TYPE_APPS ]) : array
Parameters
- $type : string = self::TYPE_APPS
-
type of the navigation entries
Tags
Return values
array —setActiveEntry()
Sets the current navigation entry of the currently running app
public
setActiveEntry(string $appId) : void
Parameters
- $appId : string
-
id of the app entry to activate (from added $entry)