Was Referenzen leisten

Es können grundsätzlich drei Operationen mit Referenzen durchgeführt werden: Referenzzuweisung, Referenzübergabe und Referenzrückgabe. Dieser Abschnitt enthält eine Einführung zu diesen Operationen mit Links zu weiteren Informationen.

Referenzzuweisung

PHP Referenzen erlauben es, zwei Variablennamen, sich auf den gleichen Variableninhalt beziehen zu lassen. Zum Beispiel:

<?php
$a =& $b
?>
Das bedeutet, dass $a und $b auf denselben Inhalt zeigen.

Hinweis:

$a und $b sind hier gleichwertig, und $a ist nicht nur ein Zeiger auf $b oder umgekehrt, sondern $a und $b zeigen auf denselben Platz.

Hinweis:

Wenn man eine undefinierte Variable per Referenz zuweist, übergibt oder zurückgibt, wird sie erstellt.

Beispiel #1 Referenzen mit undefinierten Variablen benutzen

<?php
function foo(&$var) { }

foo($a); // $a wird "erstellt" mit dem Wert null

$b = array();
foo($b['b']);
var_dump(array_key_exists('b', $b)); // bool(true)

$c = new StdClass;
foo($c->d);
var_dump(property_exists($c, 'd')); // bool(true)
?>

Diese Syntax kann auch mit Funktionen, die Referenzen zurückgeben, benutzt werden:

<?php
$foo =& find_var($bar);
?>
Seit PHP 5 gibt new automatisch eine Referenz zurück, so dass die Verwendung von =& in diesem Zusammenhang missbilligt ist, und von PHP 5.3 an einen E_DEPRECATED Fehler erzeugt, und einen E_STRICT Fehler in früheren Versionen. Von PHP 7.0 an ist dies syntaktisch ungültig. (Technisch gesehen ist der Unterschied, dass in PHP 5 Objektvariablen, ganz ähnlich wie Ressourcen, lediglich ein Zeiger auf die eigentlichen Objektdaten sind, so dass diese Objektreferenzen keine "Referenzen" in dem obigen Sinne (Aliase) sind. Weitere Informationen können Objekte und Referenzen entnommen werden.)

Warnung

Wird eine Referenz auf eine Variable, die in einer Funktion als global deklariert wurde, zugewiesen wird, dann ist die Referenz nur innerhalb der Funktion sichtbar. Das kann vermieden werden, indem das $GLOBALS-Array verwendet wird.

Beispiel #2 Referenzieren globaler Variablen innerhalb von Funktionen

<?php
$var1 = "Beispiel-Variable";
$var2 = "";

function global_references($use_globals)
{
    global $var1, $var2;
    if (!$use_globals) {
        $var2 =& $var1; // nur innerhalb der Funktion sichtbar
    } else {
        $GLOBALS["var2"] =& $var1; // ebenso im globalen Kontext sichtbar
    }
}

global_references(false);
echo "Der Wert von var2 ist '$var2'\n"; // Der Wert von var2 ist ''
global_references(true);
echo "Der Wert von var2 ist '$var2'\n"; // Der Wert von var2 ist 'Beispiel-Variable'
?>
global $var; kann als Abkürzung für $var =& $GLOBALS['var']; angesehen werden. Daher ändert die Zuweisung einer anderen Referenz zu $var nur die Referenz der lokalen Variable.

Hinweis:

Wenn man einer Variable einen Wert per Referenz in einer foreach-Anweisung zuweist, werden auch die Referenzen geändert.

Beispiel #3 Referenzen und die foreach-Anweisung

<?php
$ref = 0;
$row =& $ref;
foreach (array(1, 2, 3) as $row) {
    // mach was
}
echo $ref; // 3 - letztes Element des durchlaufenen Arrays
?>

Obgleich keine Referenzzuweisung im engeren Sinne, können Ausdrücke, die mit dem Sprachkonstrukt array() erstellt werden, sich ebenso verhalten, wenn dem hinzuzufügenden Array-Element & vorangestellt wird. Beispiel:

<?php
$a = 1;
$b = array(2, 3);
$arr = array(&$a, &$b[0], &$b[1]);
$arr[0]++; $arr[1]++; $arr[2]++;
/* $a == 2, $b == array(3, 4); */
?>

Es ist allerdings zu beachten, dass Referenzen in Array potentiell gefährlich sind. Eine normale (also nicht Referenz-) Zuweisung mit einer Referenz auf der rechten Seite wandelt die linke Seite nicht in eine Referenz, aber Referenzen innerhalb von Arrays bleiben bei solchen normalen Zuweisungen erhalten. Dies gilt ebenso für Funktionsaufrufe, bei denen das Array als Wertübergabe entgegengenommen wird. Beispiel:

<?php
/* Zuweisung skalarer Variablen */
$a = 1;
$b =& $a;
$c = $b;
$c = 7; //$c ist keine Referenz; keine Änderung an $a oder $b

/* Zuweisung von Array-Variablen */
$arr = array(1);
$a =& $arr[0]; //$a und $arr[0] sind in derselben Referenzmenge
$arr2 = $arr; //keine Referenzzuweisung!
$arr2[0]++;
/* $a == 2, $arr == array(2) */
/* Der Inhalt von $arr hat sich geändert, obwohl es keine Referenz ist! */
?>
Anders ausgedrückt, ist das Referenzverhalten von Array auf einer Element-für-Element-Basis definiert; das Referenzverhalten einzelner Elemente ist getrennt vom Referenzzustand des Array-Behälters.

Referenzübergabe

Eine weitere Einsatzmöglichkeit von Referenzen ist die Übergabe von Parametern an eine Funktion mit pass-by-reference. Hierbei beziehen sich der lokale Variablenname als auch der Variablenname der aufrufenden Instanz auf denselben Variableninhalt:

<?php
function foo(&$var) {
    $var++;
}

$a=5;
foo($a);
?>
Nach der Ausführung hat $a den Wert 6, da sich in der Funktion foo der Variablenname $var auf denselben Variableninhalt bezieht wie $a. Weitere Information hierzu sind dem Abschnitt Referenzübergabe zu entnehmen.

Referenzrückgabe

Daneben besteht die Möglichkeit aus Funktionen heraus Werte mit return by-reference zurückzugeben.