docs: iterator type for Crawler (#620)

* Document iterator type for Crawler

* Add updated PHPDoc to changelog

Author: PrinsFrank

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+2.1.2
+-----
+
+* Updated PHPDoc: getIterator method on Crawler returns an ArrayIterator of WebDriverElements
+
 2.1.1
 -----
 

phpstan.neon

@@ -18,3 +18,4 @@ parameters:
 		# Require a redesign of the underlying Symfony components
 		- '#Call to an undefined method DOMNode::getTagName\(\)\.#'
 		- '#Return type \(void\) of method Symfony\\Component\\Panther\\DomCrawler\\Crawler::clear\(\) should be compatible with return type \(Facebook\\WebDriver\\WebDriverElement\) of method Facebook\\WebDriver\\WebDriverElement::clear\(\)#'
+		- '#Return type \(ArrayIterator<int, Facebook\\WebDriver\\WebDriverElement>\) of method Symfony\\Component\\Panther\\DomCrawler\\Crawler::getIterator\(\) should be compatible with return type \(ArrayIterator<int, DOMNode>\) of method Symfony\\Component\\DomCrawler\\Crawler::getIterator\(\)#'

src/DomCrawler/Crawler.php

@@ -365,6 +365,9 @@ public function count(): int
         return \count($this->elements);
     }
 
+    /**
+     * @return \ArrayIterator<int, WebDriverElement>
+     */
     public function getIterator(): \ArrayIterator
     {
         return new \ArrayIterator($this->elements);