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

CKTIS / PHP

Retorno por referência: `function &getSession`

Uma função que devolve por referência permite ao código que a chama criar um alias para uma variável. `=&` cria essa ligação; `=` atribui o valor sem criar o alias.

Versão: PHP 8.3; extension availability may vary

Sintaxe

function &getSession(): array { static $state = []; return $state; }
$alias = &getSession(); // Bind an alias to the returned variable.
$copy = getSession();   // Assign the array by value.

Em PHP 8.3, o & antes do nome em function &getSession(): array indica um retorno por referência. array especifica o tipo de retorno. Usa return $state; para indicar a variável, sem acrescentar & após return. Um literal ou o resultado de um cálculo não é uma variável e não pode ser devolvido validamente por referência.

$alias = &getSession(); associa outro nome à mesma variável. Alterar $alias['visits'] modifica o array armazenado. Em contrapartida, $copy = getSession(); atribui o array por valor, pelo que alterar $copy['visits'] não modifica o original. Não se trata de passar um argumento por referência: o & na declaração aplica-se ao resultado e =& estabelece a ligação no código que chama a função.

getSession() é definida no exemplo e não faz parte da API de sessões do PHP. A variável local static mantém o valor entre chamadas na mesma execução, mas não guarda dados entre pedidos. O exemplo não precisa da extensão de sessões. Para iniciar ou retomar manualmente uma sessão real do PHP, o suporte de sessões tem de estar disponível e a chamada a session_start() tem de ser bem-sucedida; os dados da sessão estão disponíveis em $_SESSION.

Devolve uma referência apenas quando o código que chama a função deve poder alterar diretamente o estado subjacente, não para melhorar o desempenho. Se for preciso validar as alterações, disponibiliza uma função de atualização separada em vez de um alias que permita escrever.

Exemplos

<?php
function &getSession(): array
{
    static $state = ['visits' => 1];
    return $state;
}

$copy = getSession();
$alias = &getSession();

$alias['visits']++;
$copy['visits'] += 10;

$current = getSession();
echo 'Stored: ', $current['visits'], "\n";
echo 'Copy: ', $copy['visits'], "\n";

Resultado

Stored: 2
Copy: 11

A alteração através do alias aumenta o valor armazenado de `visits` para `2`. A cópia foi obtida antes, por isso somar-lhe `10` dá `11` sem alterar o original.

Lições relacionadas

  • PHP · Lição 25 · Intermédio · Versão: 3

Fontes