Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / PHP

PHP: foreach por referência e por valor

Usa `&$value` para alterar os elementos de um array e `unset($value)` para impedir que um ciclo posterior substitua o último elemento por engano.

Versão: PHP 8.3

Sintaxe

foreach ($items as $value) { /* ... */ }
foreach ($items as $key => $value) { /* ... */ }
foreach ($items as &$value) { /* ... */ }
unset($value);
foreach ($items as $key => &$value) { /* ... */ }
unset($value);

foreach ($items as $value) atribui o valor atual a $value em cada iteração. Se $value ainda não for uma referência, atribuir-lhe outro valor não substitui o elemento do array. Isto não é uma cópia profunda: se o elemento contiver um objeto, alterar uma propriedade através de $value afeta esse mesmo objeto.

Em foreach ($items as &$value), o sinal & torna $value um alias do elemento atual, pelo que uma atribuição a $value altera o próprio elemento. A forma opcional $key => &$value também atribui a chave a $key, mas não a associa por referência.

Ao sair de um ciclo por referência que executou pelo menos uma iteração, $value continua a referir-se ao último elemento percorrido. Coloca unset($value) imediatamente a seguir ao ciclo: elimina a ligação da variável, não o elemento do array. Caso contrário, um foreach posterior por valor que reutilize a mesma variável pode sobrescrever esse elemento mesmo com o corpo do ciclo vazio.

Exemplos

<?php
function demo(bool $detach): string
{
    $items = [1, 2, 3];
    foreach ($items as &$value) {
        $value *= 2;
    }
    if ($detach) {
        unset($value);
    }
    foreach ($items as $value) {
        // The assignment to $value happens even with an empty body.
    }
    return implode(', ', $items);
}

echo 'Without unset: ', demo(false), "\n";
echo 'With unset: ', demo(true), "\n";

Resultado

Without unset: 2, 4, 4
With unset: 2, 4, 6

As duas chamadas duplicam os números. Na primeira, o segundo ciclo altera o último elemento de `6` para `4`. Na segunda, `unset($value)` desfaz a ligação antes do segundo ciclo, pelo que `6` fica inalterado.

Lições relacionadas

  • PHP · Lição 80 · Avançado · Versão: 2

Fontes