.. _classes-couldbeiterable:

.. _this-could-be-iterable:

This Could Be Iterable
++++++++++++++++++++++

  An argument that is both array and `traversable <https://www.php.net/`traversable <https://www.php.net/traversable>`_>`_ may be typed iterable. Iterable is a more generic type than array, and allows the usage of iterators too.

.. code-block:: php
   
   <?php
   
   // parameter and return type might be iterable
   function foo($a) {
       foreach($a as $b) {
       	// do something
       }
       
       return $a;
   }
   
   class x {
   	private $b;
   	
   	function foo() {
       	foreach($this->b as $c) {
       		// do something
   	    }
   	}
   }
   
   ?>

See also `iterable <https://www.php.net/manual/en/language.types.iterable.php>`_.

Connex PHP features
-------------------

  + `iterable <https://php-dictionary.readthedocs.io/en/latest/dictionary/iterable.ini.html>`_


Suggestions
___________

* Add the iterable typehint




Specs
_____

+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Short name   | Classes/CouldBeIterable                                                                                                                                        |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Rulesets     | :ref:`All <ruleset-All>`, :ref:`Changed Behavior <ruleset-Changed-Behavior>`, :ref:`Suggestions <ruleset-Suggestions>`, :ref:`Typechecks <ruleset-Typechecks>` |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Exakat since | 2.3.3                                                                                                                                                          |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| PHP Version  | With PHP 7.1 and more recent                                                                                                                                   |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Severity     | Minor                                                                                                                                                          |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Time To Fix  | Quick (30 mins)                                                                                                                                                |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Precision    | High                                                                                                                                                           |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Available in | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_                                        |
+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+