TASK: Introduce NodeLabel value object

neos · May 13, 2024 · 8482288 · 8482288
1 parent 14802e8
commit 8482288
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 12 deletions.
diff --git a/Neos.ContentRepository.NodeAccess/Classes/FlowQueryOperations/LabelOperation.php b/Neos.ContentRepository.NodeAccess/Classes/FlowQueryOperations/LabelOperation.php
@@ -77,6 +77,6 @@ public function evaluate(FlowQuery $flowQuery, array $arguments)
         if (!$node instanceof Node) {
             return null;
         }
-        return $this->nodeLabelRenderer->renderNodeLabel($node);
+        return $this->nodeLabelRenderer->renderNodeLabel($node)->value;
     }
 }
diff --git a/Neos.Neos/Classes/Domain/NodeLabel/ExpressionBasedNodeLabelGenerator.php b/Neos.Neos/Classes/Domain/NodeLabel/ExpressionBasedNodeLabelGenerator.php
@@ -57,11 +57,12 @@ public function setExpression(string $expression): void
      * Render a node label based on an eel expression or return the expression if it is not valid eel.
      * @throws \Neos\Eel\Exception
      */
-    public function getLabel(Node $node): string
+    public function getLabel(Node $node): NodeLabel
     {
         if (Utility::parseEelExpression($this->getExpression()) === null) {
-            return $this->getExpression();
+            return NodeLabel::fromString($this->getExpression());
         }
-        return (string)Utility::evaluateEelExpression($this->getExpression(), $this->eelEvaluator, ['node' => $node], $this->defaultContextConfiguration);
+        $value = Utility::evaluateEelExpression($this->getExpression(), $this->eelEvaluator, ['node' => $node], $this->defaultContextConfiguration);
+        return NodeLabel::fromString((string)$value);
     }
 }
diff --git a/Neos.Neos/Classes/Domain/NodeLabel/NodeLabel.php b/Neos.Neos/Classes/Domain/NodeLabel/NodeLabel.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\Neos\Domain\NodeLabel;
+
+final readonly class NodeLabel
+{
+    private function __construct(
+        public string $value
+    ) {
+    }
+
+    public static function fromString(string $value): self
+    {
+        return new self($value);
+    }
+}
diff --git a/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelGeneratorInterface.php b/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelGeneratorInterface.php
@@ -27,5 +27,5 @@ interface NodeLabelGeneratorInterface
      * Render a node label
      * @api
      */
-    public function getLabel(Node $node): string;
+    public function getLabel(Node $node): NodeLabel;
 }
diff --git a/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRenderer.php b/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRenderer.php
@@ -25,7 +25,7 @@ public function __construct(
     ) {
     }
 
-    public function renderNodeLabel(Node $node): string
+    public function renderNodeLabel(Node $node): NodeLabel
     {
         $nodeType = $this->getNodeType($node);
         $generator = $this->getNodeLabelGeneratorForNodeType($nodeType);

diff --git a/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRendererInterface.php b/Neos.Neos/Classes/Domain/NodeLabel/NodeLabelRendererInterface.php
@@ -9,5 +9,5 @@
  */
 interface NodeLabelRendererInterface
 {
-    public function renderNodeLabel(Node $node): string;
+    public function renderNodeLabel(Node $node): NodeLabel;
 }
diff --git a/Neos.Neos/Classes/Fusion/DimensionsMenuItemsImplementation.php b/Neos.Neos/Classes/Fusion/DimensionsMenuItemsImplementation.php
@@ -220,7 +220,7 @@ protected function determineLabel(?Node $variant = null, array $metadata = []):
         if ($this->getContentDimensionIdentifierToLimitTo()) {
             return $metadata[$this->getContentDimensionIdentifierToLimitTo()->value]['label'] ?: '';
         } elseif ($variant) {
-            return $this->nodeLabelRenderer->renderNodeLabel($variant) ?: '';
+            return $this->nodeLabelRenderer->renderNodeLabel($variant)->value ?: '';
         } else {
             return array_reduce($metadata, function ($carry, $item) {
                 return $carry . (empty($carry) ? '' : '-') . $item['label'];

diff --git a/Neos.Neos/Classes/Fusion/MenuItemsImplementation.php b/Neos.Neos/Classes/Fusion/MenuItemsImplementation.php
@@ -220,7 +220,7 @@ protected function buildMenuItemFromNode(Node $node): MenuItem
         return new MenuItem(
             $node,
             $this->isCalculateItemStatesEnabled() ? $this->calculateItemState($node) : null,
-            $this->nodeLabelRenderer->renderNodeLabel($node),
+            $this->nodeLabelRenderer->renderNodeLabel($node)->value,
             0,
             [],
             $this->buildUri($node)
@@ -244,7 +244,7 @@ protected function buildMenuItemFromSubtree(Subtree $subtree, int $startLevel =
         return new MenuItem(
             $node,
             $this->isCalculateItemStatesEnabled() ? $this->calculateItemState($node) : null,
-            $this->nodeLabelRenderer->renderNodeLabel($node),
+            $this->nodeLabelRenderer->renderNodeLabel($node)->value,
             $subtree->level + $startLevel,
             $children,
             $this->buildUri($node)

diff --git a/Neos.Neos/Classes/Utility/NodeUriPathSegmentGenerator.php b/Neos.Neos/Classes/Utility/NodeUriPathSegmentGenerator.php
@@ -44,7 +44,7 @@ public function generateUriPathSegment(?Node $node = null, ?string $text = null)
     {
         $language = null;
         if ($node) {
-            $text = $text ?: $this->nodeLabelRenderer->renderNodeLabel($node) ?: ($node->nodeName?->value ?? '');
+            $text = $text ?: $this->nodeLabelRenderer->renderNodeLabel($node)->value ?: ($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
@@ -347,7 +347,7 @@ public function render(): string
         $this->templateVariableContainer->remove($this->arguments['nodeVariableName']);
 
         if ($content === null && $resolvedNode !== null) {
-            $content = $this->nodeLabelRenderer->renderNodeLabel($resolvedNode);
+            $content = $this->nodeLabelRenderer->renderNodeLabel($resolvedNode)->value;
         }
 
         $this->tag->setContent($content);