PHP Класс Neos\Neos\TypoScript\MenuImplementation

Наследование: extends AbstractMenuImplementation
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$lastLevel integer Internal cache for the lastLevel value.
$maximumLevels integer Internal cache for the maximumLevels tsValue.
$startingPoint Neos\ContentRepository\Domain\Model\NodeInterface Internal cache for the startingPoint tsValue.

Открытые методы

Метод Описание
getEntryLevel ( ) : integer The last navigation level which should be rendered.
getFilter ( ) : string NodeType filter for nodes displayed in menu
getItemCollection ( ) : array
getLastLevel ( ) : integer Return evaluated lastLevel value.
getMaximumLevels ( ) : integer Maximum number of levels which should be rendered in this menu.
getStartingPoint ( ) : Neos\ContentRepository\Domain\Model\NodeInterface

Защищенные методы

Метод Описание
buildItems ( ) : array Builds the array of menu items containing those items which match the configuration set for this Menu object.
buildMenuItemRecursive ( Neos\ContentRepository\Domain\Model\NodeInterface $currentNode ) : array Prepare the menu item with state and sub items if this isn't the last menu level.
buildMenuLevelRecursive ( array $menuLevelCollection ) : array
calculateNodeDepthFromRelativeLevel ( integer $relativeLevel, Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode ) : integer Calculates an absolute depth value for a relative level given.
findMenuStartingPoint ( ) : Neos\ContentRepository\Domain\Model\NodeInterface Find the starting point for this menu. depending on given startingPoint If startingPoint is given, this is taken as starting point for this menu level, as a fallback the TypoScript context variable node is used.
findParentNodeInBreadcrumbPathByLevel ( integer $givenSiteLevel, Neos\ContentRepository\Domain\Model\NodeInterface $startingPoint ) : Neos\ContentRepository\Domain\Model\NodeInterface Finds the node in the current breadcrumb path between current site node and current node whose level matches the specified entry level.
isOnLastLevelOfMenu ( Neos\ContentRepository\Domain\Model\NodeInterface $menuItemNode ) : boolean Checks if the given menuItem is on the last level for this menu, either defined by maximumLevels or lastLevels.

Описание методов

buildItems() защищенный Метод

Builds the array of menu items containing those items which match the configuration set for this Menu object.
protected buildItems ( ) : array
Результат array An array of menu items and further information

buildMenuItemRecursive() защищенный Метод

Prepare the menu item with state and sub items if this isn't the last menu level.
protected buildMenuItemRecursive ( Neos\ContentRepository\Domain\Model\NodeInterface $currentNode ) : array
$currentNode Neos\ContentRepository\Domain\Model\NodeInterface
Результат array

buildMenuLevelRecursive() защищенный Метод

protected buildMenuLevelRecursive ( array $menuLevelCollection ) : array
$menuLevelCollection array
Результат array

calculateNodeDepthFromRelativeLevel() защищенный Метод

Calculates an absolute depth value for a relative level given.
protected calculateNodeDepthFromRelativeLevel ( integer $relativeLevel, Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode ) : integer
$relativeLevel integer
$referenceNode Neos\ContentRepository\Domain\Model\NodeInterface
Результат integer

findMenuStartingPoint() защищенный Метод

If entryLevel is configured this will be taken into account as well.
protected findMenuStartingPoint ( ) : Neos\ContentRepository\Domain\Model\NodeInterface
Результат Neos\ContentRepository\Domain\Model\NodeInterface

findParentNodeInBreadcrumbPathByLevel() защищенный Метод

Finds the node in the current breadcrumb path between current site node and current node whose level matches the specified entry level.
protected findParentNodeInBreadcrumbPathByLevel ( integer $givenSiteLevel, Neos\ContentRepository\Domain\Model\NodeInterface $startingPoint ) : Neos\ContentRepository\Domain\Model\NodeInterface
$givenSiteLevel integer The site level child nodes of the to be found parent node should have. See $this->entryLevel for possible values.
$startingPoint Neos\ContentRepository\Domain\Model\NodeInterface
Результат Neos\ContentRepository\Domain\Model\NodeInterface The parent node of the node at the specified level or NULL if none was found

getEntryLevel() публичный Метод

1 = first level of the site 2 = second level of the site ... 0 = same level as the current page -1 = one level above the current page -2 = two levels above the current page ...
public getEntryLevel ( ) : integer
Результат integer

getFilter() публичный Метод

NodeType filter for nodes displayed in menu
public getFilter ( ) : string
Результат string

getItemCollection() публичный Метод

public getItemCollection ( ) : array
Результат array

getLastLevel() публичный Метод

Return evaluated lastLevel value.
public getLastLevel ( ) : integer
Результат integer

getMaximumLevels() публичный Метод

Maximum number of levels which should be rendered in this menu.
public getMaximumLevels ( ) : integer
Результат integer

getStartingPoint() публичный Метод

public getStartingPoint ( ) : Neos\ContentRepository\Domain\Model\NodeInterface
Результат Neos\ContentRepository\Domain\Model\NodeInterface

isOnLastLevelOfMenu() защищенный Метод

Checks if the given menuItem is on the last level for this menu, either defined by maximumLevels or lastLevels.
protected isOnLastLevelOfMenu ( Neos\ContentRepository\Domain\Model\NodeInterface $menuItemNode ) : boolean
$menuItemNode Neos\ContentRepository\Domain\Model\NodeInterface
Результат boolean

Описание свойств

$lastLevel защищенное свойство

Internal cache for the lastLevel value.
protected int $lastLevel
Результат integer

$maximumLevels защищенное свойство

Internal cache for the maximumLevels tsValue.
protected int $maximumLevels
Результат integer

$startingPoint защищенное свойство

Internal cache for the startingPoint tsValue.
protected NodeInterface,Neos\ContentRepository\Domain\Model $startingPoint
Результат Neos\ContentRepository\Domain\Model\NodeInterface