WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

Array-Parameter per Referenz: `array &$product`

`array &$product` verlangt beim Aufruf ein Array und erlaubt der Funktion, die Variable des Aufrufers zu ändern, ohne das Array zurückzugeben.

Version: PHP 8.3; extension availability may vary

Syntax

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

In function restock(array &$product): void gibt array den Eingabetyp an, & steht für die Übergabe per Referenz und $product ist der lokale Parametername. Die Referenz gilt für die Variable, die das gesamte Array enthält. Sie macht die Array-Elemente nicht zu Referenzen.

Weise $item vor dem Aufruf von restock($item) ein Array mit einem numerischen Wert unter dem Schlüssel stock zu, zum Beispiel ['stock' => 3]. Das & steht in der Deklaration, nicht beim Aufruf. Ein Array-Literal ist für diesen Parameter kein gültiges Argument. Eine Funktion, die ein Array per Referenz zurückgibt, kann dagegen ein gültiges Argument liefern.

$product und $item beziehen sich auf denselben Wert. Die Funktion kann ein Element ändern oder das ganze Array ersetzen; die Änderung bleibt nach dem Aufruf sichtbar. : void bedeutet, dass es keinen Rückgabewert gibt, nicht dass es keine Seiteneffekte gibt. Ohne & erfolgt die Übergabe per Wert, und dieselbe Änderung an einem gewöhnlichen Element bleibt lokal. Elemente, die bereits Referenzen sind, können dennoch gemeinsam genutzt werden.

PHP prüft beim Eintritt in die Funktion den Typ array und löst einen TypeError aus, wenn die übergebene Variable kein Array enthält. PHP prüft weder Schlüssel noch Elementtypen und prüft den Parametertyp beim Verlassen der Funktion nicht erneut. Ein leeres Array besteht daher die Typprüfung. Wenn += den fehlenden Schlüssel stock liest, gibt PHP 8.3 jedoch eine Warnung aus. Änderst du eine gewöhnliche Variable, sollte sie weiterhin ein Array enthalten, wenn der aufrufende Code das erwartet.

Beispiele

<?php

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

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

Ergebnis

3
5

Die Ausgabe zeigt erst `3`, dann `5`. Die Funktion addiert `2` zu `$product['stock']`. Daher ist `$item['stock']` nach dem Aufruf `5`, obwohl die Funktion keinen Wert zurückgibt.

Zugehörige Lektionen

  • PHP · Lektion 20 · Fortgeschritten · Version: 2

Quellen