(PHP 5, PHP 7, PHP 8)
Interface, um herauszufinden, ob eine Klasse mittels foreach durchlaufen
werden kann.
Das abstrakte Interface kann nicht direkt implementiert werden. Stattdessen muss es entweder mittels IteratorAggregate oder Iterator implementiert werden.
Dieses Interface besitzt keine Methoden, sein einziger Sinn ist es, als Basisinterface für alle traversierbaren Klassen zu dienen.
| Version | Beschreibung |
|---|---|
| 7.4.0 | Das Traversable-Interface kann nun von abstrakten Klassen implementiert werden. Erweiternde Klassen müssen Iterator oder IteratorAggregate implementieren. |
Hinweis:
Interne (eingebaute) Klassen, die dieses Interface implementieren, können in
foreach-Konstrukten verwendet werden und benötigen keine explizite Implementierung von IteratorAggregate oder Iterator.
Hinweis:
Vor PHP 7.4.0 kann dieses interne Interface der Engine nicht in PHP-Skripten implementiert werden. Stattdessen müssen IteratorAggregate oder Iterator verwendet werden.
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.