TASK: Make single-field Value Objects stringable

Neos.ContentRepository.BehavioralTests/Classes/PhpstanRules/NoStringCastingRule.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\ContentRepository\BehavioralTests\PhpstanRules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+/**
+ * @implements Rule<\PhpParser\Node\Expr\Cast\String_>
+ */
+class NoStringCastingRule implements Rule
+{
+    /**
+     * @var string[]
+     */
+    private array $namespacePrefixesWhichShouldBeEnforced = [
+        'Neos\\ContentRepository\\Core',
+        'Neos\\ContentGraph',
+    ];
+
+    public function getNodeType(): string
+    {
+        return \PhpParser\Node\Expr\Cast\String_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof \PhpParser\Node\Expr\Cast\String_);
+        $expressionType = $scope->getType($node->expr);
+        if (!$expressionType instanceof ObjectType || !$this->classNameIsWithinConfiguredNamespaces($expressionType->getClassName())) {
+            return [];
+        }
+        return [
+            RuleErrorBuilder::message("Casting objects of class {$expressionType->getClassName()} to string is not allowed.")->build(),
+        ];
+    }
+
+    private function classNameIsWithinConfiguredNamespaces(string $className): bool
+    {
+        foreach ($this->namespacePrefixesWhichShouldBeEnforced as $namespacePrefix) {
+            if (str_starts_with($className, $namespacePrefix . '\\')) {
+                return true;
+            }
+        }
+        return false;
+    }
+}

Neos.ContentRepository.Core/Classes/Feature/SubtreeTagging/Dto/SubtreeTag.php

@@ -61,4 +61,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/NodeType/NodeTypeName.php

@@ -55,4 +55,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/Projection/ContentGraph/AbsoluteNodePath.php

@@ -178,4 +178,9 @@ public function jsonSerialize(): string
     {
         return $this->serializeToString();
     }
+
+    public function __toString(): string
+    {
+        return $this->serializeToString();
+    }
 }

Neos.ContentRepository.Core/Classes/Projection/ContentGraph/Filter/Ordering/OrderingFieldName.php

@@ -32,4 +32,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/Projection/ContentGraph/NodePath.php

@@ -147,4 +147,9 @@ public function jsonSerialize(): string
     {
         return $this->serializeToString();
     }
+
+    public function __toString(): string
+    {
+        return $this->serializeToString();
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/ContentRepository/ContentRepositoryId.php

@@ -52,4 +52,9 @@ public function jsonSerialize(): mixed
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Node/NodeAggregateId.php

@@ -69,4 +69,9 @@ private static function hasValidFormat(string $value): bool
     {
         return preg_match(self::PATTERN, $value) === 1;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Node/NodeName.php

@@ -100,4 +100,9 @@ public function equals(NodeName $other): bool
     {
         return $this->value === $other->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Node/PropertyName.php

@@ -36,4 +36,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Node/ReferenceName.php

@@ -36,4 +36,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/User/UserId.php

@@ -70,4 +70,9 @@ public function jsonSerialize(): string
     {
         return $this->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/ContentStreamId.php

@@ -70,4 +70,9 @@ public function equals(self $other): bool
     {
         return $this === $other;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php

@@ -43,4 +43,9 @@ public function equals(self $other): bool
     {
         return $this->value === $other->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php

@@ -114,4 +114,9 @@ private static function hasValidFormat(string $value): bool
     {
         return preg_match(self::PATTERN, $value) === 1;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php

@@ -43,4 +43,9 @@ public function equals(self $other): bool
     {
         return $this->value === $other->value;
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

Neos.Neos/Classes/FrontendRouting/DimensionResolution/Resolver/UriPathResolver/Separator.php

@@ -23,4 +23,9 @@ public static function fromString(string $value): self
         }
         return new self($value);
     }
+
+    public function __toString(): string
+    {
+        return $this->value;
+    }
 }

phpstan.neon.dist

@@ -29,3 +29,4 @@ rules:
     - Neos\ContentRepository\BehavioralTests\PhpstanRules\ApiOrInternalAnnotationRule
     - Neos\ContentRepository\BehavioralTests\PhpstanRules\InternalMethodsNotAllowedOutsideContentRepositoryRule
     - Neos\ContentRepository\BehavioralTests\PhpstanRules\DeclareStrictTypesRule
+    - Neos\ContentRepository\BehavioralTests\PhpstanRules\NoStringCastingRule