PHP Class Neos\Neos\Fusion\DimensionsMenuImplementation

The items generated by this menu will be all possible variants (according to the configured dimensions and presets) of the given node (including the given node). If a 'dimension' is configured via TypoScript, only the possible variants for that dimension will be included in the menu, any other dimensions will be kept from the current context. Main Options: - dimension (optional, string): name of the dimension which this menu should be limited to. Example: "language". - presets (optional, array): If set, the presets are not loaded from the Settings, but instead taken from this property. Must be used with "dimension" set.
Inheritance: extends AbstractMenuImplementation
Show file Open project: neos/neos

Protected Properties

Property Type Description
$configurationContentDimensionPresetSource Neos\Neos\Domain\Service\ConfigurationContentDimensionPresetSource
$contentDimensionCombinator Neos\ContentRepository\Domain\Service\ContentDimensionCombinator

Public Methods

Method Description
getDimension ( ) : string
getIncludeAllPresets ( ) : array
getPresets ( ) : array

Protected Methods

Method Description
buildItems ( ) Builds the array of Menu items for this variant menu
calculateTargetDimensionsForCombination ( array $dimensionCombination ) : array Calculates the target dimensions for a given dimension combination.
findAcceptableNode ( array $allowedCombination, array $allDimensionPresets ) : null | Neos\ContentRepository\Domain\Model\NodeInterface
getNodeInDimensions ( array $dimensions, array $targetDimensions ) : Neos\ContentRepository\Domain\Model\NodeInterface | null Get the current node in the given dimensions.

Method Details

buildItems() protected method

Builds the array of Menu items for this variant menu
protected buildItems ( )

calculateTargetDimensionsForCombination() protected method

Calculates the target dimensions for a given dimension combination.
protected calculateTargetDimensionsForCombination ( array $dimensionCombination ) : array
$dimensionCombination array
return array

findAcceptableNode() protected method

protected findAcceptableNode ( array $allowedCombination, array $allDimensionPresets ) : null | Neos\ContentRepository\Domain\Model\NodeInterface
$allowedCombination array
$allDimensionPresets array
return null | Neos\ContentRepository\Domain\Model\NodeInterface

getDimension() public method

public getDimension ( ) : string
return string

getIncludeAllPresets() public method

public getIncludeAllPresets ( ) : array
return array

getNodeInDimensions() protected method

If it doesn't exist the method returns null.
protected getNodeInDimensions ( array $dimensions, array $targetDimensions ) : Neos\ContentRepository\Domain\Model\NodeInterface | null
$dimensions array
$targetDimensions array
return Neos\ContentRepository\Domain\Model\NodeInterface | null

getPresets() public method

public getPresets ( ) : array
return array

Property Details

$configurationContentDimensionPresetSource protected property

protected ConfigurationContentDimensionPresetSource,Neos\Neos\Domain\Service $configurationContentDimensionPresetSource
return Neos\Neos\Domain\Service\ConfigurationContentDimensionPresetSource

$contentDimensionCombinator protected property

protected ContentDimensionCombinator,Neos\ContentRepository\Domain\Service $contentDimensionCombinator
return Neos\ContentRepository\Domain\Service\ContentDimensionCombinator