Remove iterator support from docblock and description

Author: SerafimArts

Diff for: composer.json

@@ -17,10 +17,10 @@
         }
     },
     "require-dev": {
-        "type-lang/parser": "^1.0",
         "friendsofphp/php-cs-fixer": "^3.42",
         "phpunit/phpunit": "^10.5",
         "rector/rector": "^1.0",
+        "type-lang/parser": "^1.0",
         "vimeo/psalm": "^5.18"
     },
     "autoload-dev": {

Diff for: src/DocBlock.php

@@ -15,13 +15,11 @@
  * This class represents structure containing a description and a set of tags
  * that describe an arbitrary DocBlock Comment in the code.
  *
- * @template-implements \IteratorAggregate<int<0, max>, TagInterface>
  * @template-implements \ArrayAccess<int<0, max>, TagInterface|null>
  */
 final class DocBlock implements
     OptionalDescriptionProviderInterface,
     TagsProviderInterface,
-    \IteratorAggregate,
     \ArrayAccess
 {
     use TagsProvider;

Diff for: src/Tag/Description.php

@@ -5,10 +5,9 @@
 namespace TypeLang\PHPDoc\Tag;
 
 /**
- * @template-implements \IteratorAggregate<int<0, max>, TagInterface>
  * @template-implements \ArrayAccess<int<0, max>, TagInterface|null>
  */
-class Description implements DescriptionInterface, \IteratorAggregate, \ArrayAccess
+class Description implements DescriptionInterface, \ArrayAccess
 {
     use TagsProvider;
 

Diff for: src/Tag/TagsProvider.php

@@ -6,11 +6,9 @@
 
 /**
  * @mixin TagsProviderInterface
- * @mixin \IteratorAggregate
  * @mixin \ArrayAccess
  *
  * @psalm-require-implements TagsProviderInterface
- * @psalm-require-implements \IteratorAggregate
  * @psalm-require-implements \ArrayAccess
  *
  * @internal This is an internal library trait, please do not use it in your code.
@@ -81,28 +79,4 @@ public function offsetUnset(mixed $offset): void
 
         throw new \BadMethodCallException(self::class . ' objects are immutable');
     }
-
-    /**
-     * @return \Traversable<int<0, max>, TagInterface>
-     */
-    public function getIterator(): \Traversable
-    {
-        foreach ($this->tags as $tag) {
-            yield $tag;
-
-            $description = $tag->getDescription();
-
-            if ($description instanceof TagsProviderInterface) {
-                yield from $description;
-            }
-        }
-    }
-
-    /**
-     * @return int<0, max>
-     */
-    public function count(): int
-    {
-        return \count($this->tags);
-    }
 }

Diff for: src/Tag/TagsProviderInterface.php

@@ -5,12 +5,10 @@
 namespace TypeLang\PHPDoc\Tag;
 
 /**
- * @template-extends \Traversable<int<0, max>, TagInterface>
- *
  * @internal This is an internal library interface, please do not use it in your code.
  * @psalm-internal TypeLang\PHPDoc\Tag
  */
-interface TagsProviderInterface extends \Traversable, \Countable
+interface TagsProviderInterface
 {
     /**
      * Returns the tags for this object.
@@ -20,11 +18,4 @@ interface TagsProviderInterface extends \Traversable, \Countable
      * @return iterable<array-key, TagInterface>
      */
     public function getTags(): iterable;
-
-    /**
-     * @psalm-immutable Each call to the method must return the same value.
-     *
-     * @return int<0, max>
-     */
-    public function count(): int;
 }