INavigationManager
in
Manages the ownCloud navigation
Tags
Table of Contents
Constants
- 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
Methods
- add() : void
- Creates a new navigation entry
- getActiveEntry() : string
- Get the current navigation entry of the currently running app
- getAll() : array<string|int, mixed>
- Get a list of navigation entries
- setActiveEntry() : void
- Sets the current navigation entry of the currently running app
- setUnreadCounter() : void
- Set an unread counter for navigation entries
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(mixed $entry) : void
Parameters
- $entry : mixed
Tags
getActiveEntry()
Get the current navigation entry of the currently running app
public
getActiveEntry() : string
Tags
Return values
stringgetAll()
Get a list of navigation entries
public
getAll([string $type = self::TYPE_APPS ]) : array<string|int, mixed>
Parameters
- $type : string = self::TYPE_APPS
-
type of the navigation entries
Tags
Return values
array<string|int, mixed>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)
Tags
setUnreadCounter()
Set an unread counter for navigation entries
public
setUnreadCounter(string $id, int $unreadCounter) : void
Parameters
- $id : string
-
id of the navigation entry
- $unreadCounter : int
-
Number of unread entries (0 to hide the counter which is the default)