Replace ArrayObjects with IteratorAggregate implementations

Author: Bernhard Schmitt

Classes/Domain/AbstractImmutableArrayObject.php

@@ -123,46 +123,33 @@ public function getComponentArrayContent(): string
 ' . $this->name->renderClassComment() . '
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
 
 /**
  * @Flow\Proxy(false)
  */
-final class ' . $this->name->getSimpleComponentArrayName() . ' extends AbstractComponentArray
+final class ' . $this->name->getSimpleComponentArrayName() . ' implements \IteratorAggregate
 {
+    /**
+     * @var array<int,' . $this->name->getSimpleInterfaceName() . '>|' . $this->name->getSimpleInterfaceName() . '[]
+     */
+    private array $' . $this->name->getSimpleComponentArrayPropertyName() . ';
+
     public function __construct($array)
     {
         foreach ($array as $element) {
             if (!$element instanceof ' . $this->name->getSimpleInterfaceName() . ') {
                 throw new \InvalidArgumentException(self::class . \' can only consist of \' . ' . $this->name->getSimpleInterfaceName() . '::class);
             }
         }
-        parent::__construct($array);
-    }
-
-    /**
-     * @param mixed $key
-     * @return ' . $this->name->getSimpleInterfaceName() . '|false
-     */
-    public function offsetGet($key)
-    {
-        return parent::offsetGet($key);
-    }
-
-    /**
-     * @return array|'. $this->name->getSimpleInterfaceName() . '[]
-     */
-    public function getArrayCopy(): array
-    {
-        return parent::getArrayCopy();
+        $this->' . $this->name->getSimpleComponentArrayPropertyName() . ' = $array;
     }
 
     /**
-     * @return \ArrayIterator|' . $this->name->getSimpleInterfaceName() . '[]
+     * @return \ArrayIterator<int,' . $this->name->getSimpleInterfaceName() . '>|' . $this->name->getSimpleInterfaceName() . '[]
      */
     public function getIterator(): \ArrayIterator
     {
-        return parent::getIterator();
+        return new \ArrayIterator($this->' . $this->name->getSimpleComponentArrayPropertyName() . ');
     }
 }
 ';

Classes/Domain/Component/AbstractComponentArray.php

@@ -175,6 +175,11 @@ public function getSimpleComponentArrayName(): string
         return PluralName::forName($this->name);
     }
 
+    public function getSimpleComponentArrayPropertyName(): string
+    {
+        return lcfirst(PluralName::forName($this->name));
+    }
+
     /**
      * @return class-string<mixed>
      */

Classes/Domain/Component/Component.php

@@ -6,9 +6,6 @@
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\AbstractImmutableArrayObject;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
-use PackageFactory\AtomicFusion\PresentationObjects\Fusion\ComponentPresentationObjectInterface;
 
 /**
  * The specification for component array classes
@@ -24,6 +21,6 @@ public static function isSatisfiedByInputString(string $input): bool
     public static function isSatisfiedByClassName(string $className): bool
     {
         return class_exists($className)
-            && is_subclass_of($className, AbstractComponentArray::class);
+            && is_subclass_of($className, \Traversable::class);
     }
 }

Classes/Domain/Component/ComponentName.php

@@ -415,46 +415,33 @@ public function testGetComponentArrayContent(): void
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
 
 /**
  * @Flow\Proxy(false)
  */
-final class MyNewComponents extends AbstractComponentArray
+final class MyNewComponents implements \IteratorAggregate
 {
+    /**
+     * @var array<int,MyNewComponentInterface>|MyNewComponentInterface[]
+     */
+    private array $myNewComponents;
+
     public function __construct($array)
     {
         foreach ($array as $element) {
             if (!$element instanceof MyNewComponentInterface) {
                 throw new \InvalidArgumentException(self::class . \' can only consist of \' . MyNewComponentInterface::class);
             }
         }
-        parent::__construct($array);
-    }
-
-    /**
-     * @param mixed $key
-     * @return MyNewComponentInterface|false
-     */
-    public function offsetGet($key)
-    {
-        return parent::offsetGet($key);
-    }
-
-    /**
-     * @return array|MyNewComponentInterface[]
-     */
-    public function getArrayCopy(): array
-    {
-        return parent::getArrayCopy();
+        $this->myNewComponents = $array;
     }
 
     /**
-     * @return \ArrayIterator|MyNewComponentInterface[]
+     * @return \ArrayIterator<int,MyNewComponentInterface>|MyNewComponentInterface[]
      */
     public function getIterator(): \ArrayIterator
     {
-        return parent::getIterator();
+        return new \ArrayIterator($this->myNewComponents);
     }
 }
 ',

Classes/Domain/Component/PropType/IsComponentArray.php

@@ -6,45 +6,32 @@ namespace Vendor\Site\Presentation\Component\NewText;
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
 
 /**
  * @Flow\Proxy(false)
  */
-final class NewTexts extends AbstractComponentArray
+final class NewTexts implements \IteratorAggregate
 {
+    /**
+     * @var array<int,NewTextInterface>|NewTextInterface[]
+     */
+    private array $newTexts;
+
     public function __construct($array)
     {
         foreach ($array as $element) {
             if (!$element instanceof NewTextInterface) {
                 throw new \InvalidArgumentException(self::class . ' can only consist of ' . NewTextInterface::class);
             }
         }
-        parent::__construct($array);
-    }
-
-    /**
-     * @param mixed $key
-     * @return NewTextInterface|false
-     */
-    public function offsetGet($key)
-    {
-        return parent::offsetGet($key);
-    }
-
-    /**
-     * @return array|NewTextInterface[]
-     */
-    public function getArrayCopy(): array
-    {
-        return parent::getArrayCopy();
+        $this->newTexts = $array;
     }
 
     /**
-     * @return \ArrayIterator|NewTextInterface[]
+     * @return \ArrayIterator<int,NewTextInterface>|NewTextInterface[]
      */
     public function getIterator(): \ArrayIterator
     {
-        return parent::getIterator();
+        return new \ArrayIterator($this->newTexts);
     }
 }

Tests/Unit/Domain/Component/ComponentTest.php

@@ -6,46 +6,34 @@
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
 
 /**
- * A text component array
+ * A list of texts
  * @Flow\Proxy(false)
  */
-final class Texts extends AbstractComponentArray
+final class Texts implements \IteratorAggregate
 {
+    /**
+     * @var array<int,TextInterface>|TextInterface[]
+     */
+    private array $texts;
+
     public function __construct($array)
     {
         foreach ($array as $element) {
             if (!$element instanceof TextInterface) {
                 throw new \InvalidArgumentException(self::class . ' can only consist of ' . TextInterface::class);
             }
         }
-        parent::__construct($array);
-    }
-
-    /**
-     * @param mixed $key
-     * @return TextInterface|false
-     */
-    public function offsetGet($key)
-    {
-        return parent::offsetGet($key);
-    }
 
-    /**
-     * @return array|TextInterface[]
-     */
-    public function getArrayCopy(): array
-    {
-        return parent::getArrayCopy();
+        $this->texts = $array;
     }
 
     /**
-     * @return \ArrayIterator|TextInterface[]
+     * @return \ArrayIterator<int,TextInterface>|TextInterface[]
      */
     public function getIterator(): \ArrayIterator
     {
-        return parent::getIterator();
+        return new \ArrayIterator($this->texts);
     }
 }

Tests/Unit/Domain/Component/__snapshots__/ComponentGeneratorTest__generatesComponents with data set textWithArray__2.txt

@@ -6,21 +6,33 @@
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\AbstractComponentArray;
 
 /**
- * A dummy component array
+ * A list of anotherComponents
  * @Flow\Proxy(false)
  */
-final class AnotherComponents extends AbstractComponentArray
+final class AnotherComponents implements \IteratorAggregate
 {
+    /**
+     * @var array<int,AnotherComponentInterface>|AnotherComponentInterface[]
+     */
+    private array $anotherComponents;
+
     public function __construct($array)
     {
         foreach ($array as $element) {
-            if (!$element instanceof AnotherComponent) {
+            if (!$element instanceof AnotherComponentInterface) {
                 throw new \InvalidArgumentException(self::class . ' can only consist of ' . AnotherComponentInterface::class);
             }
         }
-        parent::__construct($array);
+        $this->anotherComponents = $array;
+    }
+
+    /**
+     * @return \ArrayIterator<int,AnotherComponentInterface>|AnotherComponentInterface[]
+     */
+    public function getIterator(): \ArrayIterator
+    {
+        return new \ArrayIterator($this->anotherComponents);
     }
 }