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
?>
Traversable インターフェイス
(PHP 5, PHP 7, PHP 8)
はじめに
そのクラスの中身が foreach を使用してたどれるかどうかを検出するインターフェイスです。
これは抽象インターフェイスであり、単体で実装することはできません。 IteratorAggregate あるいは Iterator を実装しなければなりません。
インターフェイス概要
interface Traversable {
}このインターフェイスにはメソッドがありません。 traverse 可能なすべてのクラス用の基底インターフェイスとしてのみ存在しています。
変更履歴
| バージョン | 説明 |
|---|---|
| 7.4.0 | Traversable インターフェイスは、抽象クラスによって実装できるようになりました。 これを拡張するには、 Iterator あるいは IteratorAggregate を実装しなければなりません。 |
注意
注意:
このインターフェイスを実装した内部（組み込み）クラスは、 foreach の中で使うことができます。 IteratorAggregate や Iterator を実装する必要はありません。
注意:
PHP 7.4.0 より前のバージョンでは、 この内部的なエンジンのインターフェイスは PHP スクリプトが実装できませんでした。 代わりに、 IteratorAggregate か Iterator を使わなければなりませんでした。
add a note
User Contributed Notes 5 notes
kevinpeno at gmail dot com ¶
14 years ago
cobaltbluedw ¶
8 years ago
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
three
douglas at reith dot com dot au ¶
7 years ago
The 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.php
ajf at ajf dot me ¶
10 years ago
Note 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.
alan dot bem at gmail dot com ¶
6 years ago
Actually you can use `Traversable` within your php scripts - you can use it to enforce iterability on user-land objects.
<?php
interface Stream implements \Traversable {}
class InMemoryStream implements IteratorAggregate, Stream
{
public function getIterator() {}
}
$stream = new InMemoryStream();
?>
In case you'd forgot about implementing `IteratorAggregate` or `Iterator` interfaces, fatal error will be raised when instantiating objects in question.
<?php
interface Stream implements \Traversable {}
class InMemoryStream implements Stream {}
$stream = new InMemoryStream(); // Fatal error: Class InMemoryStream must implement interface Traversable as part of either Iterator or IteratorAggregate in Unknown on line 0
?>
