CKTIS / PHP
Paramètre de type tableau passé par référence : `array &$product`
`array &$product` exige un tableau à l’appel et permet à la fonction de modifier la variable de l’appelant sans renvoyer le tableau.
Version : PHP 8.3; extension availability may vary
Syntaxe
function restock(array &$product): void { $product['stock'] += 2; }
// Call with an array variable containing a numeric 'stock' value, without &:
$item = ['stock' => 3];
restock($item);Dans function restock(array &$product): void, array déclare le type attendu en entrée, & indique le passage par référence et $product est le nom local du paramètre. La référence porte sur la variable qui contient le tableau entier ; elle ne transforme pas ses éléments en références.
Avant d’appeler restock($item), affectez à $item un tableau qui contient une valeur numérique pour la clé stock, par exemple ['stock' => 3]. Le & figure dans la déclaration, pas dans l’appel. Un littéral de tableau n’est pas un argument valide pour ce paramètre, mais une fonction qui renvoie un tableau par référence peut en fournir un.
$product et $item désignent la même valeur. La fonction peut modifier un élément ou remplacer le tableau entier, et la modification reste visible après l’appel. : void indique l’absence de valeur de retour, pas l’absence d’effets de bord. Sans &, le passage se fait par valeur et la même modification d’un élément ordinaire reste locale ; les éléments qui sont déjà des références peuvent toutefois rester partagés.
PHP vérifie le type array à l’entrée dans la fonction et déclenche une TypeError si la variable fournie ne contient pas de tableau. Il ne vérifie ni les clés ni les types des éléments et ne contrôle pas à nouveau le type du paramètre à la sortie. Un tableau vide passe donc la vérification du type, mais PHP 8.3 émet un avertissement lorsque += tente de lire la clé stock absente. Si vous modifiez une variable ordinaire, veillez à ce qu’elle contienne toujours un tableau si le code appelant s’y attend.
Exemples
<?php
function restock(array &$product): void
{
$product['stock'] += 2;
}
$item = ['stock' => 3];
echo $item['stock'], "\n";
restock($item);
echo $item['stock'], "\n";
Résultat
3 5
La sortie affiche `3`, puis `5`. La fonction ajoute `2` à `$product['stock']` : après l’appel, `$item['stock']` vaut donc `5`, même si la fonction ne renvoie aucune valeur.
Leçons associées
- PHP · Leçon 20 · Avancé · Version : 2