(PHP 5, PHP 7, PHP 8)
Interface permettant de détecter si une classe peut être parcourue en utilisant foreach.
L'interface de base est abstraite et ne peut être implémentée seule. Elle doit être implémentée par soit IteratorAggregate, soit Iterator.
Cette interface n'a pas de méthode ; son seul but est d'être l'interface de base pour toutes les classes permettant de parcourir des objets.
| Version | Description |
|---|---|
| 7.4.0 | L'interface Traversable peut désormais être implémenté par des classes abstraites. Les classes étendant cele-ci doivent implémenter soit Iterator ou IteratorAggregate. |
Note:
Les classes internes qui implémentent cette interface peuvent être utilisées dans un constructeur foreach et n'ont pas besoin d'implémenter IteratorAggregate ou Iterator.
Note:
Antérieur à PHP 7.4.0, cette interface interne au moteur ne pouvait pas être implémentée dans des scripts PHP. Soit IteratorAggregate ou Iterator doit être utilisé à la place.
While you cannot implement this interface, you can use it in your checks to determine if something is usable in for each. Here is what I use if I'm expecting something that must be iterable via foreach.
<?php
if( !is_array( $items ) && !$items instanceof Traversable )
//Throw exception here
?>NOTE: While objects and arrays can be traversed by foreach, they do NOT implement "Traversable", so you CANNOT check for foreach compatibility using an instanceof check.
Example:
$myarray = array('one', 'two', 'three');
$myobj = (object)$myarray;
if ( !($myarray instanceof \Traversable) ) {
print "myarray is NOT Traversable";
}
if ( !($myobj instanceof \Traversable) ) {
print "myobj is NOT Traversable";
}
foreach ($myarray as $value) {
print $value;
}
foreach ($myobj as $value) {
print $value;
}
Output:
myarray is NOT Traversable
myobj is NOT Traversable
one
two
three
one
two
threeThe PHP7 iterable pseudo type will match both Traversable and array. Great for return type-hinting so that you do not have to expose your Domain to Infrastructure code, e.g. instead of a Repository returning a Cursor, it can return hint 'iterable':
<?php
UserRepository::findUsers(): iterable
?>
Link: http://php.net/manual/en/migration71.new-features.php#migration71.new-features.iterable-pseudo-type
Also, instead of:
<?php
if( !is_array( $items ) && !$items instanceof Traversable )
//Throw exception here
?>
You can now do with the is_iterable() method:
<?php
if ( !is_iterable( $items ))
//Throw exception here
?>
Link: http://php.net/manual/en/function.is-iterable.phpNote that all objects can be iterated over with foreach anyway and it'll go over each property. This just describes whether or not the class implements an iterator, i.e. has custom behaviour.