NavigationService
in package
Navigation Service Handles navigation-related business logic and integrates with NavigationRegistry
Table of Contents
Methods
- buildNavItemClasses() : string
- Build navigation item classes
- getDebugInfo() : array<string|int, mixed>
- Get debug information about registered navigation
- getNavigationItems() : array<string|int, mixed>
- Get all navigation items for a user from the registry
- getNavigationItemsFromSource() : array<string|int, mixed>
- Get navigation items from a specific source
- processBadgeValue() : int
- Process badge value configuration
- processNavBarState() : array<string|int, mixed>
- Process navigation state from session/cookies
- shouldDisplayNavItem() : bool
- Check if navigation item should be displayed
Methods
buildNavItemClasses()
Build navigation item classes
public
buildNavItemClasses(array<string|int, mixed> $item[, bool $isActive = false ]) : string
Parameters
- $item : array<string|int, mixed>
- $isActive : bool = false
Return values
stringgetDebugInfo()
Get debug information about registered navigation
public
getDebugInfo() : array<string|int, mixed>
Return values
array<string|int, mixed> —Debug information
getNavigationItems()
Get all navigation items for a user from the registry
public
getNavigationItems(Member $user[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $user : Member
-
Current user
- $params : array<string|int, mixed> = []
-
Request parameters
Return values
array<string|int, mixed> —All navigation items
getNavigationItemsFromSource()
Get navigation items from a specific source
public
getNavigationItemsFromSource(string $source, Member $user[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $source : string
-
Source identifier
- $user : Member
-
Current user
- $params : array<string|int, mixed> = []
-
Request parameters
Return values
array<string|int, mixed> —Navigation items from the specified source
processBadgeValue()
Process badge value configuration
public
processBadgeValue(mixed $badgeConfig) : int
Parameters
- $badgeConfig : mixed
Return values
intprocessNavBarState()
Process navigation state from session/cookies
public
processNavBarState(array<string|int, mixed>|null $navBarState) : array<string|int, mixed>
Parameters
- $navBarState : array<string|int, mixed>|null
Return values
array<string|int, mixed>shouldDisplayNavItem()
Check if navigation item should be displayed
public
shouldDisplayNavItem(array<string|int, mixed> $navItem, Member $user) : bool
Parameters
- $navItem : array<string|int, mixed>
- $user : Member