PHP Class Neos\Neos\TypoScript\AbstractMenuImplementation

Main Options: - renderHiddenInIndex: if TRUE, hidden-in-index nodes will be shown in the menu. FALSE by default.
Inheritance: extends Neos\Fusion\TypoScriptObjects\TemplateImplementation
Afficher le fichier Open project: neos/neos-development-collection

Protected Properties

Свойство Type Description
$currentLevel integer Internal cache for the currentLevel tsValue.
$currentNode Neos\ContentRepository\Domain\Model\NodeInterface
$currentNodeRootline array Rootline of all nodes from the current node to the site root node, keys are depth of nodes.
$items array An internal cache for the built menu items array.
$renderHiddenInIndex boolean Internal cache for the renderHiddenInIndex property.

Méthodes publiques

Méthode Description
getItems ( ) : array Main API method which sends the to-be-rendered data to Fluid
getRenderHiddenInIndex ( ) : boolean Should nodes that have "hiddenInIndex" set still be visible in this menu.

Méthodes protégées

Méthode Description
buildItems ( ) : array Builds the array of menu items containing those items which match the configuration set for this Menu object.
calculateItemState ( Neos\ContentRepository\Domain\Model\NodeInterface $node = null ) : string Helper Method: Calculates the state of the given menu item (node) depending on the currentNode.
getCurrentNodeRootline ( ) : array Get the rootline from the current node up to the site node.
getNodeLevelInSite ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : integer Node Level relative to site root node.
isNodeHidden ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : boolean Return TRUE/FALSE if the node is currently hidden or not in the menu; taking the "renderHiddenInIndex" configuration of the Menu TypoScript object into account.

Method Details

buildItems() abstract protected méthode

Must be overridden in subclasses.
abstract protected buildItems ( ) : array
Résultat array An array of menu items and further information

calculateItemState() protected méthode

This method needs to be called inside buildItems() in the subclasses.
protected calculateItemState ( Neos\ContentRepository\Domain\Model\NodeInterface $node = null ) : string
$node Neos\ContentRepository\Domain\Model\NodeInterface
Résultat string

getCurrentNodeRootline() protected méthode

Get the rootline from the current node up to the site node.
protected getCurrentNodeRootline ( ) : array
Résultat array

getItems() public méthode

Main API method which sends the to-be-rendered data to Fluid
public getItems ( ) : array
Résultat array

getNodeLevelInSite() protected méthode

0 = Site root node
protected getNodeLevelInSite ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : integer
$node Neos\ContentRepository\Domain\Model\NodeInterface
Résultat integer

getRenderHiddenInIndex() public méthode

Should nodes that have "hiddenInIndex" set still be visible in this menu.
public getRenderHiddenInIndex ( ) : boolean
Résultat boolean

isNodeHidden() protected méthode

This method needs to be called inside buildItems() in the subclasses.
protected isNodeHidden ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : boolean
$node Neos\ContentRepository\Domain\Model\NodeInterface
Résultat boolean

Property Details

$currentLevel protected_oe property

Internal cache for the currentLevel tsValue.
protected int $currentLevel
Résultat integer

$currentNode protected_oe property

protected NodeInterface,Neos\ContentRepository\Domain\Model $currentNode
Résultat Neos\ContentRepository\Domain\Model\NodeInterface

$currentNodeRootline protected_oe property

Rootline of all nodes from the current node to the site root node, keys are depth of nodes.
protected array $currentNodeRootline
Résultat array

$items protected_oe property

An internal cache for the built menu items array.
protected array $items
Résultat array

$renderHiddenInIndex protected_oe property

Internal cache for the renderHiddenInIndex property.
protected bool $renderHiddenInIndex
Résultat boolean