PHP/Instrukcja foreach

Z Wikibooks, biblioteki wolnych podręczników.
< PHP
Przejdź do nawigacji Przejdź do wyszukiwania
Poprzedni rozdział: Instrukcja do while
Spis treści
Następny rozdział: Funkcje

Instrukcja foreach[edytuj]

Ostatnią pętlą jest foreach. Ma ona specyficzne zastosowanie, ponieważ służy wyłącznie do przeglądania zawartości typów złożonych: tablic oraz obiektów. Kod wewnątrz niej jest powtarzany dla każdego z elementów tablicy, a on sam jest na ten czas przenoszony do tworzonej przez pętlę zmiennej. Wróćmy do naszego przykładu z pętlą for odczytującego zawartość pliku. Przepiszemy go z wykorzystaniem foreach:

1 <?php
2 $plik = file("plik.txt");
3  	
4 echo '<ul>';
5 foreach($plik as $linia)
6 {
7 	echo '<li>'.trim($linia).'</li>';	
8 }
9 echo '</ul>';

Teraz skrypt ma o wiele bardziej przejrzystą budowę. Przyjrzyjmy się deklaracji pętli:

5 foreach($plik as $linia)

Mówi nam ona, że pętla ma analizować tablicę $plik, a aktualnie przetwarzany element ma być zapisany w zmiennej $linia.

Foreach umożliwia nam także zwracanie nazw indeksów elementów:

1 <?php
2 $plik = file('plik.txt');
3  	
4 echo '<ul>';
5 foreach($plik as $numer => $linia)
6 {
7 	echo '<li>Linia #'.$numer.': '.trim($linia).'</li>';	
8 }
9 echo '</ul>';

Foreach ma tę przewagę nad innymi pętlami, że wie, jakie elementy należą do tablicy i zawsze przetworzy tylko je. Gdybyśmy przed wyświetleniem pliku usunęli z niego np. linijkę 1, pętla for nie dałaby rady, próbując przetworzyć nieistniejący element. Nie robi oczywiście tego dla złośliwości, lecz dlatego, że operuje na liczniku i nie wie, do czego jest on przez nas dalej wykorzystywany.

1 <?php
2 $plik = file('plik.txt');
3 unset($plik[1]); // usuwamy linijkę o indeksie 1
4 echo '<ul>';
5 foreach($plik as $numer => $linia)
6 {
7 	echo '<li>Linia #'.$numer.': '.trim($linia).'</li>';	
8 }
9 echo '</ul>';

Tworzone przez foreach zmienne są jedynie kopiami oryginalnych wartości, dlatego próba ich modyfikacji wewnątrz pętli w żaden sposób nie wpłynie na zawartość tablicy:

 1 <?php
 2 $plik = file('plik.txt');
 3  
 4 foreach($plik as $linia)
 5 {
 6 	$linia = 'Próba skasowania';
 7 }
 8   	
 9 echo '<pre>';
10 var_dump($plik);
11 echo '</pre>';

Wewnątrz pętli próbujemy przypisać wartość do zmiennej $linia. Owszem, udaje nam się to, ale nowa treść nie trafia w ogóle do tablicy i systemowe wyświetlenie jej zawartości ukazuje brak jakiejkolwiek reakcji. Czy zatem możliwe jest dokonywanie przypisań wewnątrz foreach? Oczywiście. Są dwie sztuczki. Pierwsza polega na wykorzystaniu zwracanego przez pętlę indeksu. Pousuwajmy z tablicy zbędne białe znaki:

 1 <?php
 2 $plik = file('plik.txt');
 3  
 4 foreach($plik as $i => $linia)
 5 {
 6 	// jeszcze jakiś napis sobie doklejmy
 7 	$plik[$i] = trim($linia).' [OK]';
 8 }
 9   	
10 echo '<pre>';
11 var_dump($plik);
12 echo '</pre>';

Rozwiązanie to jest nieco trikowe, ale działa. Możemy jednak zastosować coś innego. PHP posiada pewien element zwany referencją. Ogólnie rzecz biorąc jest to odnośnik do zmiennej, który zachowuje się tak, jak ona. Modyfikacja referencji powoduje także modyfikację oryginalnego elementu. Począwszy od PHP 5, referencje można używać w pętli foreach. Wystarczy poprzedzić w jej deklaracji zmienną $linia znakiem &:

 1 <?php
 2 $plik = file('plik.txt');
 3  
 4 foreach($plik as &$linia)
 5 {
 6 	$linia = trim($linia).' [OK]';
 7 }
 8   	
 9 echo '<pre>';
10 var_dump($plik);
11 echo '</pre>';

Teraz modyfikacja zmiennej $linia jest równoznaczna z modyfikacją aktualnego elementu w tablicy $plik, ponieważ zmienna jest takim właśnie odnośnikiem. O referencjach szerzej powiemy w rozdziale Inne elementy składni.