Fuman
\

\Fuman_Navigation_Backend

Standard/Default navigation for backend based on ACL

Summary

Methods
Properties
Constants
invalidateCache()
setName()
getName()
init()
reset()
onApplicationReady()
onApplicationFinish()
addItem()
addItemAt()
addItems()
removeItem()
registerItem()
deregisterItem()
hasItems()
getItems()
getItemIndex()
getItemRegistry()
getItem()
hasItem()
getActiveItem()
hasItemIndex()
getItemFromIndex()
addItemToIndex()
isInitialized()
getUriBuilder()
buildUri()
createActionItem()
findItemByCaller()
setActiveItem()
_storeToCache()
parseTable()
No public properties found
SESSION_CONTAINER_NAME
NAVIGATION_SETTING
_init()
_build()
_createItem()
_determineActiveItems()
_checkIfItemActive()
_checkUriParam()
_buildFromCache()
_parseNavigation()
$_name
$_items
$_itemRegistry
$_callerLookup
$_itemIndex
$_uriParams
$_activeItem
$_defaultIcon
$_initialized
$_sessionContainer
N/A
No private methods found
$_rootColors
$_rootColorCounter
N/A

Constants

SESSION_CONTAINER_NAME

SESSION_CONTAINER_NAME

Session container name

NAVIGATION_SETTING

NAVIGATION_SETTING

Properties

$_name

$_name : string

Type

string

$_items

$_items : array<mixed,\Fuman_Navigation_Item>

All top level(without parent) items.

Type

array<mixed,\Fuman_Navigation_Item>

$_itemRegistry

$_itemRegistry : array<mixed,\Fuman_Navigation_Item>

All navigation items.

Type

array<mixed,\Fuman_Navigation_Item>

$_callerLookup

$_callerLookup :

Type

$_itemIndex

$_itemIndex : array

Type

array

$_uriParams

$_uriParams : object

Current params of uri

Type

object

$_activeItem

$_activeItem : \Fuman_Navigation_item

Type

\Fuman_Navigation_item

$_defaultIcon

$_defaultIcon : string

Type

string

$_initialized

$_initialized : boolean

Type

boolean

$_sessionContainer

$_sessionContainer : object

Type

object

$_rootColors

$_rootColors :

Type

$_rootColorCounter

$_rootColorCounter :

Type

Methods

invalidateCache()

invalidateCache()

Deletes internal caches if any

setName()

setName(string  $name)

Sets name which was used to register the navigation on application

Parameters

string $name

getName()

getName() : string

Gets name which was used to register the navigation on application

Returns

string

init()

init()

init the navigation if possible or register on application ready event

reset()

reset()

Reset

onApplicationReady()

onApplicationReady() : void

Listener for application ready

onApplicationFinish()

onApplicationFinish() : void

Listener for application finished

addItemAt()

addItemAt(\Fuman_Navigation_Item  $item, \Fuman_Navigation_Item  $reference = null, boolean  $before = false) : void

Add Item

Parameters

\Fuman_Navigation_Item $item
\Fuman_Navigation_Item $reference
boolean $before

removeItem()

removeItem(\Fuman_Navigation_Item  $item)

Removes item from navigation

Parameters

\Fuman_Navigation_Item $item

registerItem()

registerItem(\Fuman_Navigation_Item  $item)

Registers item

Parameters

\Fuman_Navigation_Item $item

hasItems()

hasItems() : boolean

Has items

Returns

boolean

getItems()

getItems(boolean  $onlyVisible = false) : array<mixed,\Fuman_Navigation_Item>

Returns all Fuman_Navigation_Item in hierarchy

Parameters

boolean $onlyVisible

Returns

array<mixed,\Fuman_Navigation_Item>

getItemIndex()

getItemIndex() : array<mixed,\Fuman_Navigation_Item>

Gets item index

Returns

array<mixed,\Fuman_Navigation_Item>

getItemRegistry()

getItemRegistry() : array<mixed,\Fuman_Navigation_Item>

Gets item registry

Returns

array<mixed,\Fuman_Navigation_Item>

getItem()

getItem(string  $key) : \Fuman_Navigation_Item

Gets item

Parameters

string $key

Returns

\Fuman_Navigation_Item

hasItem()

hasItem(string  $index) : boolean

Has item

Parameters

string $index

Returns

boolean

hasItemIndex()

hasItemIndex(string  $indexKey) : boolean

Has item in index

Parameters

string $indexKey

Returns

boolean

getItemFromIndex()

getItemFromIndex(string  $indexKey) : \Fuman_Navigation_Item

Gets item from index

Parameters

string $indexKey

Returns

\Fuman_Navigation_Item

addItemToIndex()

addItemToIndex(string  $indexKey, \Fuman_Navigation_Item  $item)

Adds item to index

Parameters

string $indexKey
\Fuman_Navigation_Item $item

isInitialized()

isInitialized() : boolean

Is initialized

Returns

boolean

buildUri()

buildUri(\Fuman_Navigation_Item  $item, boolean  $recursiveCall = false, null|string  $language = null) : string

Generates uri for Fuman_Navigation_Item

Parameters

\Fuman_Navigation_Item $item
boolean $recursiveCall

used for pretty url; if true, you can append more stuff to the url
null|string $language

Returns

string

createActionItem()

createActionItem(\Fuman_Action_Descriptor  $actionDescriptor, string|null  $translationName = null, string|null  $iconPath = null, \stdClass|null  $uriParams = null, boolean  $cacheInSession = true) : \Fuman_Navigation_Item

Generates action item

Parameters

\Fuman_Action_Descriptor $actionDescriptor
string|null $translationName
string|null $iconPath
\stdClass|null $uriParams
boolean $cacheInSession

Returns

\Fuman_Navigation_Item

findItemByCaller()

findItemByCaller(\Fuman_Navigation_Caller|null  $caller = null) : \Fuman_Navigation_Item|null

Finds item by URI caller argument

Parameters

\Fuman_Navigation_Caller|null $caller

Returns

\Fuman_Navigation_Item|null

setActiveItem()

setActiveItem(\Fuman_Navigation_item  $item) : void

Sets active item

Parameters

\Fuman_Navigation_item $item

_storeToCache()

_storeToCache()

Write Navigation Structure (Items) to cache

parseTable()

parseTable(\Fuman_Table  $table, \Fuman_Navigation_Item|null  $parentItem = null) : void

Parses table

Parameters

\Fuman_Table $table
\Fuman_Navigation_Item|null $parentItem

_init()

_init()

Init

_build()

_build() : void

Build

_determineActiveItems()

_determineActiveItems() : boolean

Determines active item

Returns

boolean

_checkIfItemActive()

_checkIfItemActive(\Fuman_Navigation_Item  $item) : boolean

Checks if given item is active

Parameters

\Fuman_Navigation_Item $item

Returns

boolean

_checkUriParam()

_checkUriParam(string  $name, string  $itemValue) : boolean

Checks if given uri param is set and does match given itemVar

Parameters

string $name
string $itemValue

Returns

boolean

_buildFromCache()

_buildFromCache() : boolean

Throws

\Fuman_Exception

Returns

boolean

_parseNavigation()

_parseNavigation(\stdClass  $navigation, \stdClass  $lookUp, array  $actionLookUp, array  $tableLookUp, null|\Fuman_Navigation_Item  $parentItem = null)

Parses given navigation into navigation tree

Parameters

\stdClass $navigation
\stdClass $lookUp
array $actionLookUp
array $tableLookUp
null|\Fuman_Navigation_Item $parentItem