abstract class AbstractMenuItemsImplementation extends AbstractFusionObject (View source)

Base class for MenuItems and DimensionsMenuItems

Main Options:

  • renderHiddenInIndex: if true, hidden-in-index nodes will be shown in the menu. false by default.

Constants

STATE_NORMAL

STATE_CURRENT

STATE_ACTIVE

STATE_ABSENT

Properties

protected Runtime $runtime from  AbstractFusionObject
protected string $path

The Fusion path currently being rendered

from  AbstractFusionObject
protected string $fusionObjectName

Name of this Fusion object, like Neos.Neos:Text

from  AbstractFusionObject
protected array $tsValueCache from  AbstractFusionObject
protected array $items

An internal cache for the built menu items array.

protected NodeInterface $currentNode
protected int $currentLevel

Internal cache for the currentLevel tsValue.

protected bool $renderHiddenInIndex

Internal cache for the renderHiddenInIndex property.

protected NodeInterface[] $currentNodeRootline

Rootline of all nodes from the current node to the site root node, keys are depth of nodes.

Methods

__construct(Runtime $runtime, string $path, string $fusionObjectName)

Constructor

mixed
evaluate()

Returns the items as result of the fusion object.

getRuntime()

Get the Fusion runtime this object was created in.

mixed
fusionValue(string $path)

Return the Fusion value relative to this Fusion object (with processors etc applied).

bool
offsetExists(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

mixed
offsetGet(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

void
offsetSet(mixed $offset, mixed $value)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

void
offsetUnset(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

bool
getRenderHiddenInIndex()

Should nodes that have "hiddenInIndex" set still be visible in this menu.

array
getItems()

Main API method which sends the to-be-rendered data to Fluid

array
buildItems()

Builds the array of menu items containing those items which match the configuration set for this Menu object.

string
calculateItemState(NodeInterface $node = null)

Helper Method: Calculates the state of the given menu item (node) depending on the currentNode.

bool
isNodeHidden(NodeInterface $node)

Return true/false if the node is currently hidden or not in the menu; taking the "renderHiddenInIndex" configuration of the Menu Fusion object into account.

array
getCurrentNodeRootline()

Get the rootline from the current node up to the site node.

int
getNodeLevelInSite(NodeInterface $node)

Node Level relative to site root node.

Details

__construct(Runtime $runtime, string $path, string $fusionObjectName)

Constructor

Parameters

Runtime $runtime
string $path
string $fusionObjectName

mixed evaluate()

Returns the items as result of the fusion object.

Return Value

mixed

Runtime getRuntime()

Get the Fusion runtime this object was created in.

Return Value

Runtime

protected mixed fusionValue(string $path)

Return the Fusion value relative to this Fusion object (with processors etc applied).

Note that subsequent calls of tsValue() with the same Fusion path will return the same values since the first evaluated value will be cached in memory.

Parameters

string $path

Return Value

mixed

bool offsetExists(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

bool

mixed offsetGet(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

mixed

void offsetSet(mixed $offset, mixed $value)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset
mixed $value

Return Value

void

void offsetUnset(mixed $offset)

Dummy implementation of ArrayAccess to allow this.XXX access in processors.

Parameters

mixed $offset

Return Value

void

bool getRenderHiddenInIndex()

Should nodes that have "hiddenInIndex" set still be visible in this menu.

Return Value

bool

array getItems()

Main API method which sends the to-be-rendered data to Fluid

Return Value

array

abstract protected array buildItems()

Builds the array of menu items containing those items which match the configuration set for this Menu object.

Must be overridden in subclasses.

Return Value

array

An array of menu items and further information

Exceptions

Exception

protected string calculateItemState(NodeInterface $node = null)

Helper Method: Calculates the state of the given menu item (node) depending on the currentNode.

This method needs to be called inside buildItems() in the subclasses.

Parameters

NodeInterface $node

Return Value

string

protected bool isNodeHidden(NodeInterface $node)

Return true/false if the node is currently hidden or not in the menu; taking the "renderHiddenInIndex" configuration of the Menu Fusion object into account.

This method needs to be called inside buildItems() in the subclasses.

Parameters

NodeInterface $node

Return Value

bool

protected array getCurrentNodeRootline()

Get the rootline from the current node up to the site node.

Return Value

array

protected int getNodeLevelInSite(NodeInterface $node)

Node Level relative to site root node.

0 = Site root node

Parameters

NodeInterface $node

Return Value

int