Fuman
\

\Fuman_Navigation_Item

Represents an item in the navigation. used by navigation, breadcrumb, overview action.

Summary

Methods
Properties
Constants
__construct()
setCacheInSession()
cacheInSession()
setNavigation()
hasNavigation()
getNavigation()
setKey()
getKey()
hasKey()
setActivationUriPattern()
getActivationUriPattern()
hasActivationUriPattern()
addChild()
addChildBefore()
addChildren()
hasChildren()
removeChild()
getChildren()
getPrevItem()
getNextItem()
getNeighbour()
isActive()
isDescendantActive()
setActive()
setDescendantActive()
getUri()
setUri()
getLabel()
setLabel()
getHtmlLabel()
setHtmlLabel()
getIconPath()
setIconPath()
setBigIconColorName()
getBigIconColorName()
getActionApp()
setActionApp()
setActionName()
getActionName()
getUriParams()
setUriParams()
setParent()
getParent()
hasParent()
isVisible()
setVisible()
isOnline()
setOnline()
setTarget()
getTarget()
setProperty()
hasProperty()
getProperty()
addProperties()
getProperties()
__get()
__isset()
__sleep()
__clone()
No public properties found
PARENT_KEY_PROPERTY
No protected methods found
$_navigation
$_children
$_parent
$_active
$_descendantActive
$_app
$_action
$_uriParams
$_label
$_htmlLabel
$_iconPath
$_bigIconColorName
$_uri
$_visible
$_online
$_key
$_activationUriPattern
$_target
$_properties
$_cacheInSession
$_getters
N/A
No private methods found
No private properties found
N/A

Constants

PARENT_KEY_PROPERTY

PARENT_KEY_PROPERTY

Properties

$_active

$_active : boolean

Is active

Type

boolean

$_descendantActive

$_descendantActive : boolean

Is any descendant active

Type

boolean

$_app

$_app : string

Type

string

$_action

$_action : string

Type

string

$_uriParams

$_uriParams : \stdClass

Type

\stdClass

$_label

$_label : string

Label which does not contain tags

Type

string

$_htmlLabel

$_htmlLabel : string

Label which can contain tags

Type

string

$_iconPath

$_iconPath : string

Type

string

$_bigIconColorName

$_bigIconColorName :

Big icon color name

Type

$_uri

$_uri : string

Type

string

$_visible

$_visible : boolean

Type

boolean

$_online

$_online : boolean

Type

boolean

$_key

$_key : string

Type

string

$_activationUriPattern

$_activationUriPattern : string

Type

string

$_target

$_target : string

Type

string

$_properties

$_properties : object

Type

object

$_cacheInSession

$_cacheInSession :

Type

$_getters

$_getters :

Type

Methods

__construct()

__construct(string  $app, string  $action, string  $label, string|null  $htmlLabel = null, string|null  $iconPath = null, \stdClass|null  $uriParams = null)

Constructor

Parameters

string $app
string $action
string $label
string|null $htmlLabel
string|null $iconPath
\stdClass|null $uriParams

setCacheInSession()

setCacheInSession(boolean  $flag)

Sets cache in session

Parameters

boolean $flag

cacheInSession()

cacheInSession() : boolean

Returns true if it should be cached

Returns

boolean

setNavigation()

setNavigation(\Fuman_Navigation  $navigation)

Sets navigation

Parameters

\Fuman_Navigation $navigation

hasNavigation()

hasNavigation() : \Fuman_Navigation

Has navigation

Returns

\Fuman_Navigation

setKey()

setKey(string  $key)

Sets key

Parameters

string $key

getKey()

getKey() : string

Gets key

Returns

string

hasKey()

hasKey() : boolean

Has key

Returns

boolean

setActivationUriPattern()

setActivationUriPattern(string  $pattern)

Sets activation pattern

Parameters

string $pattern

getActivationUriPattern()

getActivationUriPattern() : string

Gets activation URI pattern

Returns

string

hasActivationUriPattern()

hasActivationUriPattern() : boolean

Has activation URI pattern

Returns

boolean

addChild()

addChild(\Fuman_Navigation_Item  $child) : void

Add child

Parameters

\Fuman_Navigation_Item $child

addChildren()

addChildren(array<mixed,\Fuman_Navigation_Item>  $children)

Adds children

Parameters

array<mixed,\Fuman_Navigation_Item> $children

hasChildren()

hasChildren() : boolean

Has children

Returns

boolean

removeChild()

removeChild(\Fuman_Navigation_Item  $child)

Remove Child

Parameters

\Fuman_Navigation_Item $child

getChildren()

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

Get children

Parameters

boolean $onlyVisible

Returns

array<mixed,\Fuman_Navigation_Item>

getPrevItem()

getPrevItem() : \Fuman_Navigation_Item|null

Gets previous item

Returns

\Fuman_Navigation_Item|null

getNextItem()

getNextItem(boolean  $recursive = true) : \Fuman_Navigation_Item|null

Gets next item

Parameters

boolean $recursive

Returns

\Fuman_Navigation_Item|null

getNeighbour()

getNeighbour(integer  $direction = 1) : \Fuman_Navigation_Item|null

Gets neigbour

Parameters

integer $direction

Returns

\Fuman_Navigation_Item|null

isActive()

isActive() : boolean

Is active

Returns

boolean

isDescendantActive()

isDescendantActive() : boolean

Is descendant active

Returns

boolean

setActive()

setActive(boolean  $active = true) : void

Set active

Parameters

boolean $active

setDescendantActive()

setDescendantActive(boolean  $active)

Sets descendants active

Parameters

boolean $active

getUri()

getUri(null|string  $language = null, boolean  $rebuild = false) : string

Get URI

Parameters

null|string $language
boolean $rebuild

Returns

string

setUri()

setUri(string  $uri)

Sets URI

Parameters

string $uri

getLabel()

getLabel() : string

Get label

Returns

string

setLabel()

setLabel(string  $label) : void

Set label

Parameters

string $label

getHtmlLabel()

getHtmlLabel() : string

Get html label (may include html tags)

Returns

string

setHtmlLabel()

setHtmlLabel(string  $htmlLabel) : void

Set html label (may include html tags)

Parameters

string $htmlLabel

getIconPath()

getIconPath() : string

Get icon path

Returns

string

setIconPath()

setIconPath(string  $path) : void

Set icon path

Parameters

string $path

setBigIconColorName()

setBigIconColorName(string  $colorName)

Set big icon color name

Parameters

string $colorName

getBigIconColorName()

getBigIconColorName()

Gets big icon color name

getActionApp()

getActionApp() : string

Gets app name of action

Returns

string

setActionApp()

setActionApp(string  $app) : string

Gets app name of action

Parameters

string $app

Returns

string

setActionName()

setActionName(string  $action) : string

Gets action name

Parameters

string $action

Returns

string

getActionName()

getActionName() : string

Gets action name

Returns

string

getUriParams()

getUriParams() : \stdClass

Get URI params

Returns

\stdClass

setUriParams()

setUriParams(\stdClass  $uriParams) : void

Sets URI params

Parameters

\stdClass $uriParams

setParent()

setParent(\Fuman_Navigation_Item  $parent = null) : void

Set parent

Parameters

\Fuman_Navigation_Item $parent

hasParent()

hasParent() : boolean

Has parent

Returns

boolean

isVisible()

isVisible() : boolean

Is visible

Returns

boolean

setVisible()

setVisible(boolean  $visible) : void

Set visible

Parameters

boolean $visible

isOnline()

isOnline(boolean  $checkParents = false) : boolean

Is online

Parameters

boolean $checkParents

Returns

boolean

setOnline()

setOnline(boolean  $online) : void

Set online

Parameters

boolean $online

setTarget()

setTarget(string  $target)

Sets target

Parameters

string $target

getTarget()

getTarget() : string

Gets target

Returns

string

setProperty()

setProperty(string  $key, mixed  $value)

Sets property

Parameters

string $key
mixed $value

hasProperty()

hasProperty(string  $key) : boolean

Has property

Parameters

string $key

Returns

boolean

getProperty()

getProperty(string  $key) : mixed

Gets property

Parameters

string $key

Returns

mixed

addProperties()

addProperties(array  $properties) : void

Adds properties

Parameters

array $properties

getProperties()

getProperties() : object

Gets properties

Returns

object

__get()

__get(string  $name) : boolean|array<mixed,\Fuman_Navigation_Item>|null|string

Get

Parameters

string $name

Returns

boolean|array<mixed,\Fuman_Navigation_Item>|null|string

__isset()

__isset(string  $name) : boolean

Isset

Parameters

string $name

Returns

boolean

__sleep()

__sleep() : array

__sleep

Returns

array

__clone()

__clone()

__clone