API Documentation

DocumentationSidebar extends BaseNavigationMenu
in package

Table of Contents

Properties

$items  : Collection<string, NavItem>

Methods

create()  : static
getGroups()  : array<string|int, string>
getItems()  : Collection<string|int, NavItem>
getItemsInGroup()  : Collection<string|int, NavItem>
hasGroups()  : bool
isGroupActive()  : bool
makeGroupTitle()  : string
__construct()  : mixed
canAddRoute()  : bool
generate()  : void
removeDuplicateItems()  : void
sortByPriority()  : void
isPageIndexPage()  : bool
shouldIndexPageBeActive()  : bool

Properties

Methods

getGroups()

public getGroups() : array<string|int, string>
Return values
array<string|int, string>

getItemsInGroup()

public getItemsInGroup(string|null $group) : Collection<string|int, NavItem>
Parameters
$group : string|null
Return values
Collection<string|int, NavItem>

isGroupActive()

public isGroupActive(string $group) : bool
Parameters
$group : string
Return values
bool

makeGroupTitle()

public makeGroupTitle(string $group) : string
Parameters
$group : string
Return values
string

shouldIndexPageBeActive()

private shouldIndexPageBeActive(string $group) : bool
Parameters
$group : string
Return values
bool

        
On this page

Search results