CKTIS / PHP
Referenzparameter `&$res`
Das `&` vor `$res` erlaubt einer Funktion, die übergebene Variable zu ändern, statt ihren neuen Wert zurückzugeben.
Version: PHP 8.3; extension availability may vary
Syntax
function writeSum(int $left, int $right, int &$res): void { /* ... */ }
$total = 0;
writeSum(2, 3, $total);In einer Funktionssignatur kennzeichnet &$res einen Referenzparameter. Während des Aufrufs ist der lokale Name $res ein Alias für die Variable des Aufrufers. Anders als bei der normalen Wertübergabe ändert eine Zuweisung an $res diese Variable. res ist ein gewöhnlicher Name, kein Schlüsselwort; & steht hier weder für einen Zeiger noch für eine Rückgabe als Referenz.
Schreibe & in die Deklaration, nicht in den Aufruf: writeSum(2, 3, $total). Übergib für den Referenzparameter eine Variable, kein Literal wie 0 und keinen berechneten Ausdruck wie 2 + 3. Auch eine Referenz, die eine entsprechend deklarierte Funktion zurückgibt, kann übergeben werden.
In PHP 8.3 wird der Typ in int &$res beim Eintritt in die Funktion geprüft, nicht erneut bei der Rückkehr. Die Deklaration allein garantiert also nicht, dass die Variable danach noch einen int enthält. unset($res) innerhalb der Funktion entfernt nur die lokale Bindung, nicht die Variable des Aufrufers.
Dokumentiere, welche Argumente die Funktion überschreiben kann. Wenn du nur ein Ergebnis liefern und die Variable des Aufrufers nicht ändern musst, ist ein gewöhnliches return meist klarer. Die Syntax gehört zur Sprache PHP und benötigt keine zusätzliche Erweiterung.
Beispiele
<?php
declare(strict_types=1);
function writeSum(int $left, int $right, int &$res): void
{
$res = $left + $right;
}
$total = 0;
echo "before: ", $total, "\n";
writeSum(2, 3, $total);
echo "after: ", $total, "\n";
Ergebnis
before: 0 after: 5
`$total` hat zunächst den Wert `0`. Die Zuweisung über `$res` ändert ihn auf `5`, obwohl `writeSum()` den Rückgabetyp `void` hat und kein Ergebnis zurückgibt.
Zugehörige Lektionen
- PHP · Lektion 70 · Fortgeschritten · Version: 2