!!! TASK: Replace Node::getLabel with NodeLabelRenderer and `Neos…

….Node.renderLabel(node)`
neos · Apr 30, 2024 · 299a579 · 299a579
1 parent 15034ab
commit 299a579
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 33 deletions.
diff --git a/Neos.ContentRepository.Core/Classes/Projection/ContentGraph/Node.php b/Neos.ContentRepository.Core/Classes/Projection/ContentGraph/Node.php
@@ -101,17 +101,6 @@ public function hasProperty(string $propertyName): bool
         return $this->properties->offsetExists($propertyName);
     }
 
-    /**
-     * Returns the node label as generated by the configured node label generator
-     *
-     * @return string
-     */
-    public function getLabel(): string
-    {
-        // todo REMOVE ME!!!!!!!!!!!!
-        return $this->nodeType?->getNodeLabelGenerator()->getLabel($this) ?: $this->nodeTypeName->value;
-    }
-
     public function equals(Node $other): bool
     {
         return $this->subgraphIdentity->equals($other->subgraphIdentity)

diff --git a/Neos.Neos/Classes/Domain/NodeLabel/ExpressionBasedNodeLabelGenerator.php b/Neos.Neos/Classes/Domain/NodeLabel/ExpressionBasedNodeLabelGenerator.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Neos\Neos\Domain\NodeLabel;
 
 /*
@@ -18,7 +19,6 @@
 
 /**
  * The expression based node label generator that is used as default if a label expression is configured.
- *
  */
 class ExpressionBasedNodeLabelGenerator implements NodeLabelGeneratorInterface
 {

diff --git a/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRenderer.php b/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRenderer.php
@@ -5,16 +5,36 @@
 namespace Neos\Neos\Domain\NodeLabel;
 
 use Neos\ContentRepository\Core\NodeType\NodeType;
+use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
+use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Neos\Fusion\Helper\NodeHelper;
+use Neos\Neos\Utility\NodeTypeWithFallbackProvider;
 
-class NodeLabelRenderer
+/**
+ * @api For PHP, in Fusion one can use ${Neos.Node.renderLabel(node)} {@see NodeHelper::renderLabel()}
+ */
+final readonly class NodeLabelRenderer
 {
+    use NodeTypeWithFallbackProvider;
+
     public function __construct(
-        private readonly ObjectManagerInterface $objectManager
+        private ContentRepositoryRegistry $contentRepositoryRegistry,
+        private ObjectManagerInterface $objectManager
     ) {
     }
 
-    public function create(NodeType $nodeType): NodeLabelGeneratorInterface
+    public function renderNodeLabel(Node $node): string
+    {
+        $nodeType = $this->getNodeType($node);
+        $generator = $this->getNodeLabelGeneratorForNodeType($nodeType);
+        return $generator->getLabel($node);
+    }
+
+    /**
+     * @internal
+     */
+    public function getNodeLabelGeneratorForNodeType(NodeType $nodeType): NodeLabelGeneratorInterface
     {
         if ($nodeType->hasConfiguration('label.generatorClass')) {
             $nodeLabelGeneratorClassName = $nodeType->getConfiguration('label.generatorClass');

diff --git a/Neos.Neos/Classes/Fusion/DimensionsMenuItemsImplementation.php b/Neos.Neos/Classes/Fusion/DimensionsMenuItemsImplementation.php
@@ -9,6 +9,8 @@
 use Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePoint;
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
+use Neos\Flow\Annotations as Flow;
+use Neos\Neos\Domain\NodeLabel\NodeLabelRenderer;
 
 /**
  * Fusion implementation for a dimensions menu.
@@ -27,6 +29,9 @@
  */
 class DimensionsMenuItemsImplementation extends AbstractMenuItemsImplementation
 {
+    #[Flow\Inject()]
+    protected NodeLabelRenderer $nodeLabelRenderer;
+
     /**
      * @return array<mixed>
      */
@@ -209,7 +214,7 @@ protected function determineLabel(?Node $variant = null, array $metadata = []):
         if ($this->getContentDimensionIdentifierToLimitTo()) {
             return $metadata[$this->getContentDimensionIdentifierToLimitTo()->value]['label'] ?: '';
         } elseif ($variant) {
-            return $variant->getLabel() ?: '';
+            return $this->nodeLabelRenderer->renderNodeLabel($variant) ?: '';
         } else {
             return array_reduce($metadata, function ($carry, $item) {
                 return $carry . (empty($carry) ? '' : '-') . $item['label'];

diff --git a/Neos.Neos/Classes/Fusion/Helper/NodeHelper.php b/Neos.Neos/Classes/Fusion/Helper/NodeHelper.php
@@ -25,6 +25,7 @@
 use Neos\Eel\ProtectedContextAwareInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Neos\Domain\Exception;
+use Neos\Neos\Domain\NodeLabel\NodeLabelRenderer;
 use Neos\Neos\Domain\Service\NodeTypeNameFactory;
 use Neos\Neos\FrontendRouting\NodeAddressFactory;
 use Neos\Neos\Presentation\VisualNodePath;
@@ -42,6 +43,9 @@ class NodeHelper implements ProtectedContextAwareInterface
     #[Flow\Inject]
     protected ContentRepositoryRegistry $contentRepositoryRegistry;
 
+    #[Flow\Inject]
+    protected NodeLabelRenderer $nodeLabelRenderer;
+
     /**
      * Check if the given node is already a collection, find collection by nodePath otherwise, throw exception
      * if no content collection could be found
@@ -96,13 +100,25 @@ public function nearestContentCollection(Node $node, string $nodePath): Node
     }
 
     /**
-     * Generate a label for a node with a chaining mechanism. To be used in nodetype definitions.
+     * Generate a label for a node with a chaining mechanism. To be used in NodeType definition:
+     *
+     *     'Vendor.Site:MyContent':
+     *       label: "${Neos.Node.labelForNode(node).prefix('foo')}"
+     *
      */
     public function labelForNode(Node $node): NodeLabelToken
     {
         return new NodeLabelToken($node);
     }
 
+    /**
+     * Renders the actual node label based on the NodeType definition in Fusion.
+     */
+    public function renderLabel(Node $node): string
+    {
+        return $this->nodeLabelRenderer->renderNodeLabel($node);
+    }
+
     /**
      * @param Node $node
      * @return int

diff --git a/Neos.Neos/Classes/Fusion/MenuItemsImplementation.php b/Neos.Neos/Classes/Fusion/MenuItemsImplementation.php
@@ -24,7 +24,9 @@
 use Neos\ContentRepository\Core\Projection\ContentGraph\Subtree;
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateIds;
+use Neos\Flow\Annotations as Flow;
 use Neos\Fusion\Exception as FusionException;
+use Neos\Neos\Domain\NodeLabel\NodeLabelRenderer;
 use Neos\Neos\Domain\Service\NodeTypeNameFactory;
 
 /**
@@ -62,6 +64,9 @@ class MenuItemsImplementation extends AbstractMenuItemsImplementation
      */
     protected ?NodeTypeCriteria $nodeTypeCriteria = null;
 
+    #[Flow\Inject()]
+    protected NodeLabelRenderer $nodeLabelRenderer;
+
     /**
      * The last navigation level which should be rendered.
      *
@@ -215,7 +220,7 @@ protected function buildMenuItemFromNode(Node $node): MenuItem
         return new MenuItem(
             $node,
             $this->isCalculateItemStatesEnabled() ? $this->calculateItemState($node) : null,
-            $node->getLabel(),
+            $this->nodeLabelRenderer->renderNodeLabel($node),
             0,
             [],
             $this->buildUri($node)
@@ -239,7 +244,7 @@ protected function buildMenuItemFromSubtree(Subtree $subtree, int $startLevel =
         return new MenuItem(
             $node,
             $this->isCalculateItemStatesEnabled() ? $this->calculateItemState($node) : null,
-            $node->getLabel(),
+            $this->nodeLabelRenderer->renderNodeLabel($node),
             $subtree->level + $startLevel,
             $children,
             $this->buildUri($node)

diff --git a/Neos.Neos/Classes/Utility/NodeUriPathSegmentGenerator.php b/Neos.Neos/Classes/Utility/NodeUriPathSegmentGenerator.php
@@ -18,6 +18,7 @@
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\I18n\Locale;
+use Neos\Neos\Domain\NodeLabel\NodeLabelRenderer;
 use Neos\Neos\Exception;
 use Neos\Neos\Service\TransliterationService;
 
@@ -30,6 +31,9 @@ class NodeUriPathSegmentGenerator
     #[Flow\Inject]
     protected TransliterationService $transliterationService;
 
+    #[Flow\Inject]
+    protected NodeLabelRenderer $nodeLabelRenderer;
+
     /**
      * Generates a URI path segment for a given node taking its language dimension value into account
      *
@@ -40,7 +44,7 @@ public function generateUriPathSegment(?Node $node = null, ?string $text = null)
     {
         $language = null;
         if ($node) {
-            $text = $text ?: $node->getLabel() ?: ($node->nodeName?->value ?? '');
+            $text = $text ?: $this->nodeLabelRenderer->renderNodeLabel($node) ?: ($node->nodeName?->value ?? '');
             $languageDimensionValue = $node->originDimensionSpacePoint->coordinates['language'] ?? null;
             if (!is_null($languageDimensionValue)) {
                 $locale = new Locale($languageDimensionValue);

diff --git a/Neos.Neos/Classes/ViewHelpers/Link/NodeViewHelper.php b/Neos.Neos/Classes/ViewHelpers/Link/NodeViewHelper.php
@@ -20,6 +20,7 @@
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
 use Neos\ContentRepository\Core\Projection\ContentGraph\NodePath;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
+use Neos\Neos\Domain\NodeLabel\NodeLabelRenderer;
 use Neos\Neos\Domain\Service\NodeTypeNameFactory;
 use Neos\Neos\FrontendRouting\NodeAddress;
 use Neos\Neos\FrontendRouting\NodeAddressFactory;
@@ -149,6 +150,12 @@ class NodeViewHelper extends AbstractTagBasedViewHelper
      */
     protected $throwableStorage;
 
+    /**
+     * @Flow\Inject
+     * @var NodeLabelRenderer
+     */
+    protected $nodeLabelRenderer;
+
     /**
      * Initialize arguments
      *
@@ -341,7 +348,7 @@ public function render(): string
         $this->templateVariableContainer->remove($this->arguments['nodeVariableName']);
 
         if ($content === null && $resolvedNode !== null) {
-            $content = $resolvedNode->getLabel();
+            $content = $this->nodeLabelRenderer->renderNodeLabel($resolvedNode);
         }
 
         $this->tag->setContent($content);

diff --git a/Neos.Neos/Resources/Private/Fusion/Prototypes/NodeLink.fusion b/Neos.Neos/Resources/Private/Fusion/Prototypes/NodeLink.fusion
@@ -33,5 +33,5 @@ prototype(Neos.Neos:NodeLink) < prototype(Neos.Fusion:Tag) {
     }
   }
 
-  content = ${node.label}
+  content = ${Neos.Node.renderLabel(node)}
 }
diff --git a/Neos.Neos/Resources/Private/Fusion/Prototypes/Shortcut.fusion b/Neos.Neos/Resources/Private/Fusion/Prototypes/Shortcut.fusion
@@ -53,7 +53,7 @@ prototype(Neos.Neos:Shortcut.Link) < prototype(Neos.Fusion:Component) {
                 resource = ${props.targetConverted.resource}
               }
             }
-            content = ${props.targetConverted.label}
+            content = ${Type.className(props.targetConverted) == 'Neos\ContentRepository\Core\Projection\ContentGraph\Node' ? Neos.Node.renderLabel(props.targetConverted) : ''}
           }
           value = ${props.i18n.id('shortcut.clickToContinueToAsset').arguments([this.targetUriTag]).translate()}
         }

diff --git a/Neos.Neos/Resources/Private/Fusion/RawContent/NodeHeader.fusion b/Neos.Neos/Resources/Private/Fusion/RawContent/NodeHeader.fusion
@@ -11,7 +11,7 @@ prototype(Neos.Neos:RawContent.NodeHeader) < prototype(Neos.Fusion:Component) {
   renderer = afx`
     <header>
       <i class={'fas fa-' + props.icon + ' ' + props.icon} @if={props.icon}></i>&nbsp;
-      {(node.tethered || q(node).is('[instanceof Neos.Neos:Document]')) ? node.label : Translation.translate(props.labelParts[2], node.nodeType.label, [], props.labelParts[1], props.labelParts[0])}
+      {(node.tethered || q(node).is('[instanceof Neos.Neos:Document]')) ? Neos.Node.renderLabel(node) : Translation.translate(props.labelParts[2], node.nodeType.label, [], props.labelParts[1], props.labelParts[0])}
       <span @if={props.visibilityInformations}> - {props.visibilityInformations}</span>
     </header>
   `

diff --git a/Neos.TimeableNodeVisibility/Classes/Command/TimeableNodeVisibilityCommandController.php b/Neos.TimeableNodeVisibility/Classes/Command/TimeableNodeVisibilityCommandController.php
@@ -28,21 +28,19 @@ public function executeCommand(string $contentRepository = 'default', bool $quie
             $this->output->outputLine(sprintf('Enabled %d nodes with exceeded timed dates.', $handlingResult->countByType(ChangedVisibilityType::NODE_WAS_ENABLED)));
             foreach ($handlingResult->getByType(ChangedVisibilityType::NODE_WAS_ENABLED) as $result) {
                 $this->output->outputLine(sprintf(
-                        '- NodeAggregateId: %s, DimensionSpacePoint: %s, Label: %s',
+                        '- NodeAggregateId: %s, DimensionSpacePoint: %s',
                         $result->node->nodeAggregateId->value,
-                        join(',', $result->node->originDimensionSpacePoint->coordinates),
-                        $result->node->getLabel()
+                        join(',', $result->node->originDimensionSpacePoint->coordinates)
                     )
                 );
             }
 
             $this->output->outputLine(sprintf('Disabled %d nodes with exceeded timed dates.', $handlingResult->countByType(ChangedVisibilityType::NODE_WAS_DISABLED)));
             foreach ($handlingResult->getByType(ChangedVisibilityType::NODE_WAS_DISABLED) as $result) {
                 $this->output->outputLine(sprintf(
-                        '- NodeAggregateId: %s, DimensionSpacePoint: %s, Label: %s',
+                        '- NodeAggregateId: %s, DimensionSpacePoint: %s',
                         $result->node->nodeAggregateId->value,
-                        join(',', $result->node->originDimensionSpacePoint->coordinates),
-                        $result->node->getLabel()
+                        join(',', $result->node->originDimensionSpacePoint->coordinates)
                     )
                 );
             }

diff --git a/Neos.TimeableNodeVisibility/Classes/Service/TimeableNodeVisibilityService.php b/Neos.TimeableNodeVisibility/Classes/Service/TimeableNodeVisibilityService.php
@@ -163,11 +163,11 @@ private function needsDisabling(Node $node, \DateTimeImmutable $now): bool
     private function logResult(ChangedVisibility $result): void
     {
         $this->logger->info(
-            sprintf('Timed node visibility: %s node [NodeAggregateId: %s, DimensionSpacePoints: %s]: %s',
+            sprintf('Timed node visibility: %s node [NodeAggregateId: %s, DimensionSpacePoints: %s]',
                 $result->type->value,
                 $result->node->nodeAggregateId->value,
-                join(',', $result->node->originDimensionSpacePoint->coordinates),
-                $result->node->getLabel())
+                join(',', $result->node->originDimensionSpacePoint->coordinates)
+            )
         );
     }
 }