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

CKTIS / PHP

Capturar uma variável por referência numa closure PHP: `use (&$carry)`

Com `use (&$carry)`, uma closure e o âmbito em que foi definida podem ler e alterar a mesma variável. Sem `&`, a closure captura o valor no momento da sua criação.

Versão: PHP 8.3; extension availability may vary

Sintaxe

$carry = 0;
$add = function (int $item) use (&$carry): void {
    $carry += $item;
};

Em PHP 8.3, use (&$carry) é escrito após a lista de parâmetros de uma função anónima e antes do tipo de retorno, se existir. Com &, as duas ocorrências de $carry referem-se ao mesmo conteúdo. Uma atribuição de um lado é visível do outro. A captura é feita no âmbito da definição, não no da chamada. $carry é um nome de variável comum, não uma palavra-chave.

use ($carry) captura o valor no momento da criação: uma atribuição posterior à variável inteira externa não altera o que a closure lê. Uma função de seta (fn) captura automaticamente por valor. Esta cláusula use não importa nomes de um espaço de nomes. Também não é um parâmetro por referência (function (&$carry)) nem um retorno por referência (function &()). A lista use não admite $this, variáveis superglobais nem nomes já usados como parâmetros.

Inicializa $carry antes de criar a closure. A closure pode manter o acesso ao estado capturado depois de terminar a função que a criou. Fora da closure, unset($carry) remove a ligação externa, não o estado a que a closure ainda tem acesso; voltar a atribuir um valor àquele nome não restabelece a ligação. Usa referências quando a partilha de estado mutável for intencional: a expressão de chamada, por si só, não indica que a closure altera $carry, mas após a chamada é possível ler o valor atualizado da variável externa $carry.

O parâmetro $carry da função de callback de array_reduce() é diferente: recebe primeiro o valor inicial e, nas iterações seguintes, o valor devolvido pela função na iteração anterior. Numa redução simples, devolve o acumulador atualizado em vez de capturar uma variável externa. A sintaxe use (&$carry) não requer extensões adicionais.

Exemplos

<?php
$carry = 0;
$snapshot = function () use ($carry): int {
    return $carry;
};
$add = function (int $item) use (&$carry): void {
    $carry += $item;
};

$add(2);
echo $carry, "\n";
$carry += 10;
$add(3);
echo $snapshot(), "\n", $carry, "\n";

Resultado

2
0
15

`$add(2)` altera o `$carry` externo para `2`. Depois de o código externo somar `10`, `$add(3)` lê `12` e escreve `15`. `$snapshot()` continua a devolver `0` porque capturou o valor no momento da criação.

Lições relacionadas

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

Fontes