Nextcloud PHP API (stable18)

INavigationManager

Manages the ownCloud navigation

Tags
since
6.0.0

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
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
since
16.0.0

TYPE_GUEST

Navigation entries for public page footer navigation

public mixed TYPE_GUEST = 'guest'
Tags
since
16.0.0

TYPE_SETTINGS

Navigation entries of the settings navigation

public mixed TYPE_SETTINGS = 'settings'
Tags
since
16.0.0

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
since
6.0.0

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
since
14.0.0
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)

Tags
since
6.0.0

Search results