foreach

PHP 4 introduit une commande foreach, comme en Perl ou d'autres langages. C'est un moyen simple de passer en revue un tableau. foreach fonctionne uniquement sur les tableaux, et retournera une erreur si vous tentez de l'utiliser sur une variable d'un autre type ou non initialis�e. Il y a deux syntaxes possibles : la seconde est une extension mineure mais pratique de la premi�re.

foreach (array_expression as $value)
    commandes
foreach (array_expression as $key => $value)
    commandes

La premi�re forme passe en revue le tableau array_expression. � chaque it�ration, la valeur de l'�l�ment courant est assign�e � $value et le pointeur interne de tableau est avanc� d'un �l�ment (ce qui fait qu'� la prochaine it�ration, on acc�dera � l'�l�ment suivant).

La deuxi�me forme fait exactement la m�me chose, mais c'est la cl� de l'�l�ment courant qui est assign� � la variable $key.

Depuis PHP 5, il est possible d' it�rer �galement des objets.

Note: Lorsque foreach d�marre, le pointeur interne de fichier est automatiquement ramen� au premier �l�ment du tableau. Cela signifie que vous n'aurez pas � faire appel � reset() avant foreach.

Note: A moins que le tableau soit une r�f�rence, foreach op�re sur une copie du tableau sp�cifi� et non sur le tableau lui-m�me. foreach affecte le pointeur interne du tableau. Ne l'utilisez pas sans le remettre � z�ro avant.

Depuis PHP 5, vous pouvez modifier facilement les �l�ments d'un tableau en pr�c�dent $value d'un &. Ceci assignera une r�f�rence au lieu de copier la valeur.

<?php
$arr 
= array(1234);
foreach (
$arr as &$value) {
    
$value $value 2;
}
// $arr vaut maintenant array(2, 4, 6, 8)
unset($value); // Stop la r�f�rence sur le dernier �l�ment
?>

Ceci n'est possible que si le tableau it�r� peut �tre r�f�renc� (i.e. est une variable), ce qui signifie que le code suivant ne fonctionne pas :

<?php
foreach (array(1234) as &$value) {
    
$value $value 2;
}

?>

Avertissement

La r�f�rence de $value et le dernier �l�ment du tableau sont conserv�s apr�s l'ex�cution de la boucle foreach. Il est recommand� de les d�truire en utilisant la fonction unset().

Note: foreach n'accepte pas l'op�rateur de suppression des erreurs @.

Vous pouvez remarquer que les exemples suivants fonctionnent de mani�re identique :

<?php
$arr 
= array("un""deux""trois");
reset($arr);
while (list(, 
$value) = each($arr)) {
    echo 
"Valeur : $value<br />\n";
}

foreach (
$arr as $value) {
    echo 
"Valeur : $value<br />\n";
}
?>

Les exemples suivants sont aussi fonctionnellement identiques :

<?php
$arr 
= array("un""deux""trois");
reset($arr);
while (list(
$key$value) = each($arr)) {
    echo 
"Cl� : $key; Valeur : $value<br />\n";
}

foreach (
$arr as $key => $value) {
    echo 
"Cl� : $key; Valeur : $value<br />\n";
}
?>

Voici quelques exemples de plus :

<?php
/* exemple foreach 1 : la valeur seulement */

$a = array(12317);

foreach (
$a as $v) {
    echo 
"Valeur courante de \$a: $v.\n";
}

/* exemple foreach 2 : la valeur et sa cl� d'index */

$a = array(12317);

$i 0/* uniquement pour l'illustration */

foreach ($a as $v) {
    echo 
"\$a[$i] => $v.\n";
    
$i++;
}

/* exemple foreach 3 : la cl� et la valeur */

$a = array(
    
"un" => 1,
    
"deux" => 2,
    
"trois" => 3,
    
"dix-sept" => 17
);

foreach (
$a as $k => $v) {
    echo 
"\$a[$k] => $v.\n";
}

/* exemple foreach 4 : tableaux multidimensionnels */
$a = array();
$a[0][0] = "a";
$a[0][1] = "b";
$a[1][0] = "y";
$a[1][1] = "z";

foreach (
$a as $v1) {
    foreach (
$v1 as $v2) {
        echo 
"$v2\n";
    }
}

/* exemple foreach 5 : tableaux dynamiques */

foreach (array(12345) as $v) {
    echo 
"$v\n";
}
?>