Forum PHP 2017

L'interface Traversable

(PHP 5 >= 5.0.0, PHP 7)

Introduction

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.

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:

Ceci est une interface du moteur interne qui ne peut être implémentée dans des scripts PHP. Vous devez utiliser à la place IteratorAggregate ou Iterator. Lors de l'implémentation d'une interface qui étend Traversable, assurez-vous de lister IteratorAggregate ou Iterator avant son nom dans la clause d'implémentation.

Sommaire de l'Interface

Traversable {
}

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.

add a note add a note

User Contributed Notes 4 notes

up
111
kevinpeno at gmail dot com
6 years ago
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
?>
up
35
cobaltbluedw
1 year 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
up
36
ajf at ajf dot me
2 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.
up
0
douglas at reith dot com dot au
12 hours 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
To Top