minor #19036 add docblock type elements to support newly added IteratorAggregate::getIterator PhpStorm support (Haehnchen)

This PR was merged into the 2.7 branch.

Discussion
----------

add docblock type elements to support newly added IteratorAggregate::getIterator PhpStorm support

| Q             | A
| ------------- | ---
| Branch       | 2.7
| Bug fix      | no
| New feature  | no
| BC breaks    | no
| Deprecations | no
| Tests pass   | yes
| License       | MIT

In additional to #16965 PhpStorm supports `IteratorAggregate::getIterator` now. see https://blog.jetbrains.com/phpstorm/2016/06/phpstorm-2016-2-eap-162-844/

example
```
$collection  = new \Symfony\Component\Routing\RouteCollection();
foreach ($collection as $route) {
    $route->getHost();
}
```

Commits
-------

ede3556 add docblock type elements to support newly added IteratorAggregate::getIterator PhpStorm support

Author: nicolas-grekas

src/Symfony/Component/Console/Helper/HelperSet.php

@@ -20,6 +20,9 @@
  */
 class HelperSet implements \IteratorAggregate
 {
+    /**
+     * @var Helper[]
+     */
     private $helpers = array();
     private $command;
 
@@ -109,6 +112,9 @@ public function getCommand()
         return $this->command;
     }
 
+    /**
+     * @return Helper[]
+     */
     public function getIterator()
     {
         return new \ArrayIterator($this->helpers);

src/Symfony/Component/Finder/Finder.php

@@ -646,7 +646,7 @@ public function in($dirs)
      *
      * This method implements the IteratorAggregate interface.
      *
-     * @return \Iterator An iterator
+     * @return \Iterator|SplFileInfo[] An iterator
      *
      * @throws \LogicException if the in() method has not been called
      */

src/Symfony/Component/Form/ChoiceList/View/ChoiceGroupView.php

@@ -47,6 +47,8 @@ public function __construct($label, array $choices = array())
 
     /**
      * {@inheritdoc}
+     *
+     * @return ChoiceGroupView[]|ChoiceView[]
      */
     public function getIterator()
     {

src/Symfony/Component/Form/Form.php

@@ -1022,7 +1022,7 @@ public function offsetUnset($name)
     /**
      * Returns the iterator for this group.
      *
-     * @return \Traversable
+     * @return \Traversable|FormInterface[]
      */
     public function getIterator()
     {

src/Symfony/Component/Form/FormBuilder.php

@@ -231,6 +231,8 @@ public function getForm()
 
     /**
      * {@inheritdoc}
+     *
+     * @return FormBuilderInterface[]
      */
     public function getIterator()
     {

src/Symfony/Component/Form/FormView.php

@@ -143,7 +143,7 @@ public function offsetUnset($name)
     /**
      * Returns an iterator to iterate over children (implements \IteratorAggregate).
      *
-     * @return \ArrayIterator The iterator
+     * @return \ArrayIterator|FormView[] The iterator
      */
     public function getIterator()
     {

src/Symfony/Component/Routing/Matcher/Dumper/DumperCollection.php

@@ -26,7 +26,7 @@ class DumperCollection implements \IteratorAggregate
     private $parent;
 
     /**
-     * @var (DumperCollection|DumperRoute)[]
+     * @var DumperCollection[]|DumperRoute[]
      */
     private $children = array();
 
@@ -38,7 +38,7 @@ class DumperCollection implements \IteratorAggregate
     /**
      * Returns the children routes and collections.
      *
-     * @return (DumperCollection|DumperRoute)[] Array of DumperCollection|DumperRoute
+     * @return DumperCollection[]|DumperRoute[] Array of DumperCollection|DumperRoute
      */
     public function all()
     {
@@ -76,7 +76,7 @@ public function setAll(array $children)
     /**
      * Returns an iterator over the children.
      *
-     * @return \Iterator The iterator
+     * @return \Iterator|DumperCollection[]|DumperRoute[] The iterator
      */
     public function getIterator()
     {

src/Symfony/Component/Routing/RouteCollection.php

@@ -49,7 +49,7 @@ public function __clone()
      *
      * @see all()
      *
-     * @return \ArrayIterator An \ArrayIterator object for iterating over routes
+     * @return \ArrayIterator|Route[] An \ArrayIterator object for iterating over routes
      */
     public function getIterator()
     {

src/Symfony/Component/Validator/ConstraintViolationList.php

@@ -107,6 +107,8 @@ public function remove($offset)
 
     /**
      * {@inheritdoc}
+     *
+     * @return \ArrayIterator|ConstraintViolationInterface[]
      */
     public function getIterator()
     {