Fuman
\

\Fuman_Frontend_Sitemap_Navigation

The frontend-navigation fills its items from Fuman_Table_Page

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()
setTreeName()
getTreeName()
getPageItem()
hasPageItem()
checkUriByDefaultPattern()
addItemsFromFumanPage()
getShortUri()
getRelatedRecordFromNavigationItem()
No public properties found
SESSION_CONTAINER_NAME
PAGE_ID_KEY
_init()
_build()
_createItem()
_determineActiveItems()
_checkIfItemActive()
_checkUriParam()
_buildFromCache()
$_name
$_items
$_itemRegistry
$_callerLookup
$_itemIndex
$_uriParams
$_activeItem
$_defaultIcon
$_initialized
$_sessionContainer
$_treeName
$_acl
$_responseData
N/A
No private methods found
No private properties found
N/A

Constants

SESSION_CONTAINER_NAME

SESSION_CONTAINER_NAME

Session container name

PAGE_ID_KEY

PAGE_ID_KEY

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

$_treeName

$_treeName : string

Type

string

$_responseData

$_responseData : null

Type

null

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

Build URI

Parameters

\Fuman_Navigation_Item $item
boolean $recursiveCall

used for pretty url; if true, you can append more stuff to the uri
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

setTreeName()

setTreeName(string  $treeName)

Sets tree name

Parameters

string $treeName

getTreeName()

getTreeName() : string

Gets tree name

Returns

string

getPageItem()

getPageItem(integer|string  $pageId) : \Fuman_Navigation_Item

Gets item for given page id

Parameters

integer|string $pageId

Returns

\Fuman_Navigation_Item

hasPageItem()

hasPageItem(integer|string  $pageId) : boolean

Has page item for given page id

Parameters

integer|string $pageId

Returns

boolean

checkUriByDefaultPattern()

checkUriByDefaultPattern(string  $uri) : array

Checks uri by default frontend uri pattern

Parameters

string $uri

Returns

array

addItemsFromFumanPage()

addItemsFromFumanPage(string  $tableUniqueName, null|string  $parentKey = null, array  $recordIds = array(), boolean  $visible = true) : array<mixed,\Fuman_Navigation_Item>

Adds item from fuman page

Parameters

string $tableUniqueName
null|string $parentKey
array $recordIds
boolean $visible

Returns

array<mixed,\Fuman_Navigation_Item>

getShortUri()

getShortUri(\Fuman_Navigation_Item  $item, boolean  $addHost = false) : string

Gets short URI

Parameters

\Fuman_Navigation_Item $item
boolean $addHost

Returns

string

getRelatedRecordFromNavigationItem()

getRelatedRecordFromNavigationItem(\Fuman_Navigation_Item  $item) : \Fuman_Db_Record|null

Parameters

\Fuman_Navigation_Item $item

Returns

\Fuman_Db_Record|null

_init()

_init()

Init (internally called before any getter will be executed)

_build()

_build() : void

Builds navigation

_determineActiveItems()

_determineActiveItems() : boolean

Determine active items

Returns

boolean

_checkIfItemActive()

_checkIfItemActive(\Fuman_Navigation_Item  $item) : boolean

Check if item 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