Fuman
\

\Fuman_Navigation_Caller_State

Navigation caller data

Summary

Methods
Properties
Constants
__construct()
getCallerForCurrentAction()
getCallerStringForCurrentAction()
getCallers()
No public properties found
No constants found
No protected methods found
$_callers
$_currentCaller
$_currentCallerString
$_isRoot
N/A
No private methods found
No private properties found
N/A

Properties

$_currentCallerString

$_currentCallerString : string

Type

string

$_isRoot

$_isRoot : boolean

Type

boolean

Methods

__construct()

__construct(array|null  $callers = null, \Fuman_Navigation_Caller|null  $currentCaller = null)

Parameters

array|null $callers
\Fuman_Navigation_Caller|null $currentCaller

getCallerForCurrentAction()

getCallerForCurrentAction(null|string  $tabName = null) : \Fuman_Navigation_Caller

Gets caller object for current request

Parameters

null|string $tabName

Returns

\Fuman_Navigation_Caller

getCallerStringForCurrentAction()

getCallerStringForCurrentAction(null|string  $tabName = null, boolean  $encodeForUrl = true) : null|string

Creates a caller string for the current action.

Callers from request will be prepended

Parameters

null|string $tabName
boolean $encodeForUrl

Returns

null|string

getCallers()

getCallers(boolean  $addCurrent = false) : array<mixed,\Fuman_Navigation_Caller>

Parameters

boolean $addCurrent

Returns

array<mixed,\Fuman_Navigation_Caller>