WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

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

`array &$items` verlangt beim Aufruf ein Array und erlaubt der Funktion, die Variable des Aufrufers ohne Rückgabewert zu ändern.

Version: PHP 8.3; extension availability may vary

Syntax

function markReady(array &$items): void { $items[0] = 'ready'; }
$cart = ['draft'];
markReady($cart);

In function markReady(array &$items): void legt array den Eingabetyp fest, $items ist der lokale Parametername und & steht für die Übergabe per Referenz. Der Parameter ist ein Alias für die Variable des Aufrufers: Sowohl ein Schreibzugriff auf $items[0] als auch die Zuweisung eines neuen Werts an $items sind für den Aufrufer sichtbar, auch mit : void.

Initialisiere eine Variable mit einem Array und rufe markReady($cart) auf. Das & steht in der Deklaration, nicht beim Aufruf. Übergib kein Array-Literal wie ['draft'] und kein per Wert zurückgegebenes Funktionsergebnis direkt; ein per Referenz zurückgegebenes Ergebnis ist zulässig. Enthält die übergebene Variable kein Array, löst PHP beim Eintritt in die Funktion einen TypeError aus. Bei der Rückkehr wird der Typ nicht erneut geprüft. Eine Zuweisung über $items kann daher bei einer gewöhnlichen Variable des Aufrufers sogar den Typ ändern.

Ohne & wird array $items per Wert übergeben: Das Ersetzen eines gewöhnlichen String-Elements wie im Beispiel ändert das Array des Aufrufers nicht. Das ist keine tiefe Kopie: Bereits vorhandene Referenzen in Array-Elementen können weiterhin dieselben Werte teilen. Wenn Änderungen am Argument nicht zum Vertrag der Funktion gehören, übergib das Array per Wert und gib das Ergebnis ausdrücklich zurück.

unset($items) löst die lokale Bindung, ohne die Variable des Aufrufers zu entfernen. foreach ($items as &$item) erzeugt dagegen eine eigene Referenz auf ein Element. Verwende nach einer solchen Schleife unset($item), damit eine spätere Zuweisung an $item das zuletzt besuchte Element nicht überschreibt.

Beispiele

<?php
function markReadyCopy(array $items): void
{
    $items[0] = 'ready';
}

function markReady(array &$items): void
{
    $items[0] = 'ready';
}

$cart = ['draft'];
markReadyCopy($cart);
echo $cart[0], "\n";

markReady($cart);
echo $cart[0], "\n";

Ergebnis

draft
ready

Beide Funktionen schreiben `ready` an Index `0`. Nach der Übergabe per Wert enthält `$cart[0]` weiterhin `draft`, nach der Übergabe per Referenz enthält es `ready`.

Zugehörige Lektionen

  • PHP · Lektion 19 · Fortgeschritten · Version: 2

Quellen