Merge pull request neos#4629 from neos/iteratorRefactoring

Iterator refactoring
queoGmbH · Oct 20, 2023 · 3deee07 · 3deee07
2 parents a6d265d + 02fc7d0
commit 3deee07
Show file tree

Hide file tree

Showing 39 changed files with 183 additions and 264 deletions.
diff --git a/Neos.ContentGraph.PostgreSQLAdapter/src/Domain/Projection/NodeAggregateIds.php b/Neos.ContentGraph.PostgreSQLAdapter/src/Domain/Projection/NodeAggregateIds.php
@@ -64,9 +64,7 @@ public static function fromArray(array $array): self
     public static function fromCollection(
         NodeAggregateIdCollection $collection
     ): self {
-        return new self(
-            $collection->getIterator()->getArrayCopy()
-        );
+        return new self(iterator_to_array($collection));
     }
 
     public function add(
@@ -99,8 +97,11 @@ public function isEmpty(): bool
         return count($this->ids) === 0;
     }
 
+    /**
+     * @return \Traversable<string,NodeAggregateId>
+     */
     public function getIterator(): \Traversable
     {
-        return new \ArrayIterator($this->ids);
+        yield from $this->ids;
     }
 }
diff --git a/Neos.ContentGraph.PostgreSQLAdapter/src/Domain/Projection/NodeRelationAnchorPoints.php b/Neos.ContentGraph.PostgreSQLAdapter/src/Domain/Projection/NodeRelationAnchorPoints.php
@@ -17,24 +17,23 @@
 /**
  * The node relation anchor points value object collection
  *
- * @implements \IteratorAggregate<int,NodeRelationAnchorPoint>
+ * @implements \IteratorAggregate<NodeRelationAnchorPoint>
  * @internal
  */
-final class NodeRelationAnchorPoints implements \IteratorAggregate, \Countable
+final readonly class NodeRelationAnchorPoints implements \IteratorAggregate, \Countable
 {
     /**
-     * @var array<int,NodeRelationAnchorPoint>
+     * @var array<NodeRelationAnchorPoint>
      */
-    public readonly array $nodeRelationAnchorPoints;
+    public array $nodeRelationAnchorPoints;
 
     public function __construct(NodeRelationAnchorPoint ...$nodeRelationAnchorPoints)
     {
-        /** @var array<int,NodeRelationAnchorPoint> $nodeRelationAnchorPoints */
         $this->nodeRelationAnchorPoints = $nodeRelationAnchorPoints;
     }
 
     /**
-     * @param array<int|string,string|NodeRelationAnchorPoint> $array
+     * @param array<string|NodeRelationAnchorPoint> $array
      */
     public static function fromArray(array $array): self
     {
@@ -46,8 +45,6 @@ public static function fromArray(array $array): self
                 $values[] = $item;
             }
         }
-        /** @var array<int,NodeRelationAnchorPoint $values */
-
         return new self(...$values);
     }
 
@@ -103,11 +100,11 @@ public function remove(NodeRelationAnchorPoint $nodeRelationAnchorPoint): self
     }
 
     /**
-     * @return \ArrayIterator<int,NodeRelationAnchorPoint>
+     * @return \Traversable<NodeRelationAnchorPoint>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return new \ArrayIterator($this->nodeRelationAnchorPoints);
+        yield from $this->nodeRelationAnchorPoints;
     }
 
     public function count(): int

diff --git a/Neos.ContentRepository.Core/Classes/Dimension/ConfigurationBasedContentDimensionSource.php b/Neos.ContentRepository.Core/Classes/Dimension/ConfigurationBasedContentDimensionSource.php
@@ -81,7 +81,7 @@ protected function initializeDimensions(): void
                 $this->contentDimensions[$rawDimensionId] = new ContentDimension(
                     $dimensionId,
                     new ContentDimensionValues($values),
-                    new ContentDimensionValueVariationEdges($variationEdges),
+                    new ContentDimensionValueVariationEdges(...$variationEdges),
                     $additionalConfiguration
                 );
             }

diff --git a/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionConstraintSet.php b/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionConstraintSet.php
@@ -56,11 +56,11 @@ public static function createEmpty(): self
     }
 
     /**
-     * @return \ArrayIterator<string,ContentDimensionConstraints>|ContentDimensionConstraints[]
+     * @return \Traversable<string,ContentDimensionConstraints>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return new \ArrayIterator($this->constraints);
+        yield from $this->constraints;
     }
 
     public function getConstraints(ContentDimensionId $dimensionId): ?ContentDimensionConstraints
@@ -72,8 +72,7 @@ public function allowsCombinationWith(
         ContentDimensionId $contentDimensionId,
         ContentDimensionValue $contentDimensionValue
     ): bool {
-        return isset($this->constraints[$contentDimensionId->value])
-            ? $this->constraints[$contentDimensionId->value]->allowsCombinationWith($contentDimensionValue)
-            : true;
+        return !isset($this->constraints[$contentDimensionId->value])
+            || $this->constraints[$contentDimensionId->value]->allowsCombinationWith($contentDimensionValue);
     }
 }
diff --git a/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionValueVariationEdges.php b/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionValueVariationEdges.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Neos.ContentRepository.DimensionSpace package.
+ * This file is part of the Neos.ContentRepository.Core package.
  *
  * (c) Contributors of the Neos Project - www.neos.io
  *
@@ -17,50 +17,32 @@
 /**
  * A set of content dimension value variation edges
  *
- * @implements \IteratorAggregate<int,ContentDimensionValueVariationEdge>
+ * @implements \IteratorAggregate<ContentDimensionValueVariationEdge>
  * @internal
  */
 final class ContentDimensionValueVariationEdges implements \IteratorAggregate
 {
     /**
-     * @var array<int,ContentDimensionValueVariationEdge>
+     * @var array<ContentDimensionValueVariationEdge>
      */
     private array $edges;
 
-    /**
-     * @var \ArrayIterator<int,ContentDimensionValueVariationEdge>
-     */
-    private \ArrayIterator $iterator;
-
-    /**
-     * @param array<int,ContentDimensionValueVariationEdge> $array
-     */
-    public function __construct(array $array)
+    public function __construct(ContentDimensionValueVariationEdge ...$edges)
     {
-        foreach ($array as $edge) {
-            if (!$edge instanceof ContentDimensionValueVariationEdge) {
-                throw new \InvalidArgumentException(
-                    'ContentDimensionValueVariationEdges may only contain ContentDimensionValueVariationEdge objects',
-                    1639661280
-                );
-            }
-        }
-
-        $this->edges = $array;
-        $this->iterator = new \ArrayIterator($this->edges);
+        $this->edges = $edges;
     }
 
     public static function createEmpty(): self
     {
-        return new self([]);
+        return new self();
     }
 
     /**
-     * @return \ArrayIterator<int,ContentDimensionValueVariationEdge>|ContentDimensionValueVariationEdge[]
+     * @return \Traversable<ContentDimensionValueVariationEdge>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return $this->iterator;
+        yield from $this->edges;
     }
 
     public function isEmpty(): bool

diff --git a/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionValues.php b/Neos.ContentRepository.Core/Classes/Dimension/ContentDimensionValues.php
@@ -22,15 +22,15 @@
  * @implements \IteratorAggregate<string,ContentDimensionValue>
  * @api because used as return value of Dimension Eel helper
  */
-final class ContentDimensionValues implements \IteratorAggregate
+final readonly class ContentDimensionValues implements \IteratorAggregate
 {
     /**
      * The actual values, indexed by string representation
      * @var array<string,ContentDimensionValue>
      */
-    public readonly array $values;
+    public array $values;
 
-    public readonly ContentDimensionValueSpecializationDepth $maximumDepth;
+    public ContentDimensionValueSpecializationDepth $maximumDepth;
 
     /**
      * @param array<string,ContentDimensionValue> $values
@@ -60,11 +60,11 @@ public function __construct(array $values)
     }
 
     /**
-     * @return \ArrayIterator<string,ContentDimensionValue>|ContentDimensionValue[]
+     * @return \Traversable<string,ContentDimensionValue>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return new \ArrayIterator($this->values);
+        yield from $this->values;
     }
 
     public function getValue(string $value): ?ContentDimensionValue

diff --git a/Neos.ContentRepository.Core/Classes/DimensionSpace/DimensionSpacePointSet.php b/Neos.ContentRepository.Core/Classes/DimensionSpace/DimensionSpacePointSet.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Neos.ContentRepository.DimensionSpace package.
+ * This file is part of the Neos.ContentRepository.Core package.
  *
  * (c) Contributors of the Neos Project - www.neos.io
  *
@@ -22,7 +22,7 @@
  * @implements \ArrayAccess<string,DimensionSpacePoint>
  * @api
  */
-final class DimensionSpacePointSet implements
+final readonly class DimensionSpacePointSet implements
     \JsonSerializable,
     \IteratorAggregate,
     \ArrayAccess,
@@ -31,12 +31,7 @@ final class DimensionSpacePointSet implements
     /**
      * @var array<string,DimensionSpacePoint>
      */
-    public readonly array $points;
-
-    /**
-     * @var \ArrayIterator<string,DimensionSpacePoint>
-     */
-    public readonly \ArrayIterator $iterator;
+    public array $points;
 
     /**
      * @param array<string|int,DimensionSpacePoint|array<string,string>> $pointCandidates
@@ -56,7 +51,6 @@ public function __construct(array $pointCandidates)
             $points[$pointCandidate->hash] = $pointCandidate;
         }
         $this->points = $points;
-        $this->iterator = new \ArrayIterator($this->points);
     }
 
     /**
@@ -150,11 +144,11 @@ public function equals(DimensionSpacePointSet $other): bool
     }
 
     /**
-     * @return \ArrayIterator<string,DimensionSpacePoint>|DimensionSpacePoint[]
+     * @return \Traversable<string,DimensionSpacePoint>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return $this->iterator;
+        yield from $this->points;
     }
 
     /**

diff --git a/Neos.ContentRepository.Core/Classes/DimensionSpace/OriginDimensionSpacePointSet.php b/Neos.ContentRepository.Core/Classes/DimensionSpace/OriginDimensionSpacePointSet.php
@@ -5,7 +5,7 @@
 namespace Neos\ContentRepository\Core\DimensionSpace;
 
 /*
- * This file is part of the Neos.ContentRepository package.
+ * This file is part of the Neos.ContentRepository.Core package.
  *
  * (c) Contributors of the Neos Project - www.neos.io
  *
@@ -31,11 +31,6 @@ final class OriginDimensionSpacePointSet implements \JsonSerializable, \Iterator
      */
     private array $points;
 
-    /**
-     * @var \ArrayIterator<string,OriginDimensionSpacePoint>
-     */
-    private \ArrayIterator $iterator;
-
     /**
      * @param array<int|string,OriginDimensionSpacePoint|array<string,string>> $points
      */
@@ -55,7 +50,6 @@ public function __construct(array $points)
             }
             $this->points[$point->hash] = $point;
         }
-        $this->iterator = new \ArrayIterator($this->points);
     }
 
     public static function fromDimensionSpacePointSet(DimensionSpacePointSet $dimensionSpacePointSet): self
@@ -135,11 +129,11 @@ public function count(): int
     }
 
     /**
-     * @return \ArrayIterator<string,OriginDimensionSpacePoint>
+     * @return \Traversable<string,OriginDimensionSpacePoint>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return $this->iterator;
+        yield from $this->points;
     }
 
     /**

diff --git a/Neos.ContentRepository.Core/Classes/EventStore/Events.php b/Neos.ContentRepository.Core/Classes/EventStore/Events.php
@@ -36,9 +36,12 @@ public static function fromArray(array $events): self
         return new self(...$events);
     }
 
+    /**
+     * @return \Traversable<EventInterface|DecoratedEvent>
+     */
     public function getIterator(): \Traversable
     {
-        return new \ArrayIterator($this->events);
+        yield from $this->events;
     }
 
     /**

diff --git a/Neos.ContentRepository.Core/Classes/Feature/NodeDuplication/Dto/NodeReferencesSnapshot.php b/Neos.ContentRepository.Core/Classes/Feature/NodeDuplication/Dto/NodeReferencesSnapshot.php
@@ -18,7 +18,7 @@
 
 /**
  * @implements \IteratorAggregate<string,NodeReferenceSnapshot>
- * @internal not yet finished
+ * @internal todo not yet finished
  */
 final class NodeReferencesSnapshot implements \IteratorAggregate, \Countable, \JsonSerializable
 {
@@ -27,18 +27,12 @@ final class NodeReferencesSnapshot implements \IteratorAggregate, \Countable, \J
      */
     private array $references;
 
-    /**
-     * @var \ArrayIterator<string,NodeReferenceSnapshot>
-     */
-    protected \ArrayIterator $iterator;
-
     /**
      * @param array<string,NodeReferenceSnapshot> $references
      */
     private function __construct(array $references)
     {
         $this->references = $references;
-        $this->iterator = new \ArrayIterator($references);
     }
 
     public function merge(self $other): self
@@ -80,6 +74,7 @@ public static function fromArray(array $nodeReferences): self
 
     /**
      * @todo what is this supposed to do?
+     * Good question.
      */
     public static function fromReferences(References $nodeReferences): self
     {
@@ -89,11 +84,11 @@ public static function fromReferences(References $nodeReferences): self
     }
 
     /**
-     * @return \ArrayIterator<string,NodeReferenceSnapshot>
+     * @return \Traversable<string,NodeReferenceSnapshot>
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): \Traversable
     {
-        return $this->iterator;
+        yield from $this->references;
     }
 
     public function count(): int