Parcours d'objets

PHP 5 fournit une fa�on de d�finir les objets de mani�re � ce qu'on puisse parcourir une liste de membres avec une structure foreach. Par d�faut, toutes les propri�t�s visibles seront utilis�es pour le parcours.

Exemple #1 Parcours d'objet simple

<?php
class MyClass 
{
  public 
$var1 'valeur 1';
  public 
$var2 'valeur 2';
  public 
$var3 'valeur 3';

  protected 
$protected 'variable prot�g�e';
  private   
$private   'variable priv�e';

  function 
iterateVisible() {
     echo 
"MyClass::iterateVisible:\n";
     foreach(
$this as $key => $value) {
         print 
"$key => $value\n";
     }
  }
}

$class = new MyClass();

foreach(
$class as $key => $value) {
    print 
"$key => $value\n";
}
echo 
"\n";


$class->iterateVisible();

L'exemple ci-dessus va afficher :

var1 => valeur 1
var2 => valeur 2
var3 => valeur 3

MyClass::iterateVisible:
var1 => valeur 1
var2 => valeur 2
var3 => valeur 3
protected => variable prot�g�e
private => variable priv�e

Comme nous le montre l'affichage, l'it�ration foreach affiche toutes les variables visibles disponibles. Pour aller plus loin, vous pouvez impl�menter l'interface interne de PHP 5 nomm�e Iterator. Ceci permet de d�terminer comment l'objet doit �tre parcouru.

Exemple #2 It�ration d'un objet impl�mentant un it�rateur

<?php
class MyIterator implements Iterator 
{
  private 
$var = array();

  public function 
__construct($array
  {
    if (
is_array($array) ) {
      
$this->var $array;
    }
  }

  public function 
rewind() {
    echo 
"rembobinage\n";
    
reset($this->var);
  }

  public function 
current() {
    
$var current($this->var);
    echo 
"actuel : $var\n";
    return 
$var;
  }

  public function 
key() {
    
$var key($this->var);
    echo 
"cl� : $var\n";
    return 
$var;
  }

  public function 
next() {
    
$var next($this->var);
    echo 
"suivant : $var\n";
    return 
$var;
  }

  public function 
valid() {
    
$var $this->current() !== false;
    echo 
"valide : {$var}\n";
    return 
$var;
  }
}

$values = array(1,2,3);
$it = new MyIterator($values);

foreach (
$it as $a => $b) {
    print 
"$a$b\n";
}

L'exemple ci-dessus va afficher :

rembobinage
actuel : 1
valide : 1
actuel : 1
cl� : 0
0: 1
suivant : 2
actuel : 2
valide : 1
actuel : 2
cl� : 1
1: 2
suivant : 3
actuel : 3
valide : 1
actuel : 3
cl� : 2
2: 3
suivant :
actuel :
valide :

Vous pouvez �galement d�finir votre classe de fa�on � ce qu'elle n'ait pas besoin de d�finir toutes les fonctions Iterator en impl�mentant simplement l'interface PHP 5 IteratorAggregate.

Exemple #3 It�ration d'un objet impl�mentant IteratorAggregate

<?php
class MyCollection implements IteratorAggregate 
{
  private 
$items = array();
  private 
$count 0;

  
// D�finition requise de l'interface IteratorAggregate
  
public function getIterator() {
    return new 
MyIterator($this->items);
  }

  public function 
add($value) {
    
$this->items[$this->count++] = $value;
  }
}

$coll = new MyCollection();
$coll->add('valeur 1');
$coll->add('valeur 2');
$coll->add('valeur 3');

foreach (
$coll as $key => $val) {
    echo 
"cl�/valeur : [$key -> $val]\n\n";
}
?>

L'exemple ci-dessus va afficher :

rembobinage
actuel : valeur 1
valide : 1
actuel : valeur 1
cl� : 0
cl�/valeur : [0 -> valeur 1]

suivant : valeur 2
actuel : valeur 2
valide : 1
actuel : valeur 2
cl� : 1
cl�/valeur : [1 -> valeur 2]

suivant : valeur 3
actuel : valeur 3
valide : 1
actuel : valeur 3
cl� : 2
cl�/valeur : [2 -> valeur 3]

suivant :
actuel :
valide :

Note: Pour plus d'exemples sur le parcours d'objets, lisez la section sur l'extension SPL.