WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

Rückgabe per Referenz: `function &getSession`

Bei einer Rückgabe per Referenz kann der Aufrufer einen Alias für eine Variable binden. Dazu dient `=&`; mit einfachem `=` wird der Wert ohne diese Bindung zugewiesen.

Version: PHP 8.3; extension availability may vary

Syntax

function &getSession(): array { static $state = []; return $state; }
$alias = &getSession(); // Bind an alias to the returned variable.
$copy = getSession();   // Assign the array by value.

In PHP 8.3 kennzeichnet das & vor dem Namen in function &getSession(): array eine Rückgabe per Referenz. array gibt den Rückgabetyp an. Mit return $state; gibst du die Variable an; hinter return steht kein &. Ein Literal oder ein Berechnungsergebnis ist keine Variable und lässt sich nicht gültig per Referenz zurückgeben.

$alias = &getSession(); bindet einen weiteren Namen an dieselbe Variable. Eine Änderung an $alias['visits'] verändert das gespeicherte Array. Dagegen weist $copy = getSession(); das Array als Wert zu. Eine Änderung an $copy['visits'] verändert daher das Original nicht. Das ist keine Argumentübergabe per Referenz: Das & in der Deklaration betrifft das Ergebnis, und =& bindet beim Aufrufer den Alias.

getSession() ist im Beispiel definiert und keine eingebaute Sitzungs-API. Die lokale static-Variable behält ihren Wert zwischen Aufrufen im selben Programmlauf, speichert aber keine Daten über mehrere Anfragen hinweg. Das Beispiel benötigt keine Sitzungserweiterung. Um eine echte PHP-Sitzung manuell zu starten oder fortzusetzen, sind Sitzungsunterstützung und ein erfolgreicher Aufruf von session_start() nötig; die Sitzungsdaten stehen in $_SESSION.

Gib eine Referenz nur zurück, wenn der Aufrufer den zugrunde liegenden Zustand direkt ändern dürfen soll, nicht um den Code zu beschleunigen. Müssen Änderungen geprüft werden, biete statt eines beschreibbaren Alias eine eigene Aktualisierungsfunktion an.

Beispiele

<?php
function &getSession(): array
{
    static $state = ['visits' => 1];
    return $state;
}

$copy = getSession();
$alias = &getSession();

$alias['visits']++;
$copy['visits'] += 10;

$current = getSession();
echo 'Stored: ', $current['visits'], "\n";
echo 'Copy: ', $copy['visits'], "\n";

Ergebnis

Stored: 2
Copy: 11

Die Änderung über den Alias erhöht das gespeicherte `visits` auf `2`. Die Kopie wurde vorher erstellt, deshalb ergibt die Addition von `10` dort `11`, ohne das Original zu ändern.

Zugehörige Lektionen

  • PHP · Lektion 25 · Mittlere Stufe · Version: 3

Quellen