Fuman
\

\Fuman_Navigation_Caller

Navigation caller

Summary

Methods
Properties
Constants
__construct()
getActionDescriptor()
getTable()
getRecordId()
getActionUniqueName()
getTabName()
getArray()
getUriParams()
addParam()
hasParam()
getParam()
removeParam()
getCallerForCurrentAction()
getCallerStringForCurrentAction()
createCallerString()
getCallerStringFromRequest()
pushCaller()
popCaller()
getCallers()
getCallerData()
createCaller()
No public properties found
No constants found
No protected methods found
$_actionDescriptor
$_table
$_recordId
$_actionUniqueName
$_tabName
$_params
$_callerData
$_callerDataStack
N/A
No private methods found
No private properties found
N/A

Properties

$_recordId

$_recordId :

Type

$_actionUniqueName

$_actionUniqueName :

Type

$_tabName

$_tabName :

Type

$_params

$_params : \stdClass

Type

\stdClass

Methods

__construct()

__construct(\Fuman_Action_Descriptor  $actionDescriptor, \Fuman_Table|null  $table = null, integer|null  $recordId = null, string|null  $actionUniqueName = null, string|null  $tabName = null, \stdClass|null  $params = null)

Constructor

Parameters

\Fuman_Action_Descriptor $actionDescriptor
\Fuman_Table|null $table
integer|null $recordId
string|null $actionUniqueName
string|null $tabName
\stdClass|null $params

getActionDescriptor()

getActionDescriptor() : \Fuman_Action_Descriptor

Gets action descriptor

Returns

\Fuman_Action_Descriptor

getTable()

getTable() : \Fuman_Table|null

Gets table

Returns

\Fuman_Table|null

getRecordId()

getRecordId() : integer|null

Gets record id

Returns

integer|null

getActionUniqueName()

getActionUniqueName() : null

Gets action unique name

Returns

null

getTabName()

getTabName() : null

Gets tab name

Returns

null

getArray()

getArray() : array

Gets array

Returns

array

getUriParams()

getUriParams() : \stdClass

Gets URI parameters

Returns

\stdClass

addParam()

addParam(string  $key, mixed  $value)

Add param

Parameters

string $key
mixed $value

hasParam()

hasParam(string  $key) : boolean

Has param

Parameters

string $key

Returns

boolean

getParam()

getParam(string  $key) : null|mixed

Get param

Parameters

string $key

Returns

null|mixed

removeParam()

removeParam(string  $key)

Remove param

Parameters

string $key

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

createCallerString()

createCallerString(array<mixed,\Fuman_Navigation_Caller>  $callers, boolean  $encodeForUrl = true) : string

Creates caller string from an array of callers

Parameters

array<mixed,\Fuman_Navigation_Caller> $callers
boolean $encodeForUrl

Returns

string

getCallerStringFromRequest()

getCallerStringFromRequest(boolean  $encodeForUrl = true) : string

Returns the current caller string from the request

Parameters

boolean $encodeForUrl

Returns

string

popCaller()

popCaller()

changes the $callerData to the last of the stack

getCallers()

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

Gets the current callers

Parameters

boolean $addCurrent

Returns

array<mixed,\Fuman_Navigation_Caller>

createCaller()

createCaller(array  $callerPart) : \Fuman_Navigation_Caller|null

Parses caller part

Parameters

array $callerPart

Returns

\Fuman_Navigation_Caller|null