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

CKTIS / PHP

Parâmetro do tipo array passado por referência: `array &$product`

`array &$product` exige um array na chamada e permite que a função altere a variável do código que a chama sem devolver o array.

Versão: PHP 8.3; extension availability may vary

Sintaxe

function restock(array &$product): void { $product['stock'] += 2; }
// Call with an array variable containing a numeric 'stock' value, without &:
$item = ['stock' => 3];
restock($item);

Em function restock(array &$product): void, array declara o tipo de entrada, & indica a passagem por referência e $product é o nome local do parâmetro. A referência aplica-se à variável que contém o array inteiro; não transforma os seus elementos em referências.

Antes de chamares restock($item), atribui a $item um array com um valor numérico associado à chave stock, por exemplo ['stock' => 3]. O símbolo & fica na declaração, não na chamada. Um literal de array não é um argumento válido para este parâmetro, mas uma função que devolva um array por referência pode fornecer um argumento válido.

$product e $item referem-se ao mesmo valor. A função pode alterar um elemento ou substituir o array inteiro, e a alteração continua visível após a chamada. : void significa que não há valor devolvido, não que não haja efeitos secundários. Sem &, a passagem é feita por valor e a mesma alteração a um elemento normal fica limitada à função; os elementos que já são referências podem continuar a ser partilhados.

O PHP verifica o tipo array à entrada da função e lança um TypeError se a variável fornecida não contiver um array. Não verifica as chaves nem os tipos dos elementos e não volta a verificar o tipo do parâmetro à saída. Assim, um array vazio passa a verificação do tipo, mas o PHP 8.3 emite um aviso quando += tenta ler a chave stock, que não existe. Ao alterares uma variável normal, garante que esta continua a conter um array se o código que chama a função contar com isso.

Exemplos

<?php

function restock(array &$product): void
{
    $product['stock'] += 2;
}

$item = ['stock' => 3];
echo $item['stock'], "\n";
restock($item);
echo $item['stock'], "\n";

Resultado

3
5

A saída apresenta `3` e depois `5`. A função soma `2` a `$product['stock']`, pelo que `$item['stock']` vale `5` após a chamada, mesmo sem a função devolver qualquer valor.

Lições relacionadas

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

Fontes