PHP.de Wissenssammlung

Parameterübergabe

Information:
Dieser Artikel behandelt nicht die Parameterübergabe an ein PHP-Script. Diese Informationen sind in den Artikeln Request und GPC zu finden.

Die Parameterübergabe bezeichnet die Übergabe von Werten an eine Funktion oder Methode, welche die weitere Verarbeitung dieser Daten übernimmt. In aller Regel wird eine feste Anzahl von Parametern übergeben, die bei der Funktionsdeklaration bestimmt wird. Diese festgelegte Parameteranzahl nennt man Funktions- bzw. Methodensignatur. In vielen Hochsprachen stellen die Datentypen der einzelnen Parameter einen Teil der Signatur dar. Weil jedoch PHP eine schwach getypte Sprache ist, ist die Festlegung der Datentypen nur beschränkt möglich.

Festlegung der Parameter

Die Signatur wird bei der Funktionsdeklaration innerhalb der Klammern angegeben. Die verwendeten Variablennamen sind irrelevant, sollten allerdings die Art des zu übergebenden Wertes erklären.

function func($param1, $param2) {
}

Dies deklariert eine Funktion, die zwei Parameter fordert. Übergeben werden diese Parameter beim Aufruf der Funktion:

func('Wert1', 'Wert2');

Optionale Parameter

Es ist auch möglich, optionale Parameter festzulegen, indem in der Signatur gleich ein Wert zugewiesen wird. Dieser Standardwert wird benutzt, wenn der entsprechende Parameter beim Funktionsaufruf nicht definiert wird.

function func($param1, $param2 = 'Standardwert2') {
    echo $param1 . ' - ' . $param2;
}

func('Wert1', 'Wert2');
func('Wert1');

Ausgabe:

Wert1 - Wert2
Wert1 - Standardwert2

Beim zweiten Funktionsaufruf wird der zweite Parameter nicht übergeben, stattdessen wird der Standardwert benutzt.

Achtung! Häufig gemachter Fehler:
Nach einem optionalen Parameter sollten nur noch weitere optionale Parameter folgen. Denn PHP bietet keine Möglichkeit, optionale Parameter zu überspringen.
function func($param1, $param2 = 'xyz', $param3) {
    echo $param1 . ' - ' . $param2 . ' - ' . $param3;
}

// Keine Möglichkeit, den Standardwert des zweiten Parameter zu benutzen
// Es müssen drei Argumente übergeben werden
func('Wert1', 'Wert2', 'Wert3');

Ausgabe:

Wert1 - Wert2 - Wert3

Variable Parameter

Es ist in PHP auch möglich, auf die explizite Festlegung der Signatur zu verzichten und die Parameterübergabe dynamisch zu gestalten. Dies kann in manchen Fällen ganz praktisch sein (vgl. array()), sollte aber aus Gründen der Übersichtlichkeit eher sparsam eingesetzt werden.

Um dennoch auf die Parameter zugreifen zu können, bietet PHP die Funktion func_get_args().

// Keine explizit angegebenen Parameter
function func() {
    // Ggf. übergebene Parameter ausgeben
    echo '<pre>' . print_r(func_get_args(), true) . '</pre>';
}

Type Hinting

Type Hinting bezeichnet die Festlegung des Datentyps in der Signatur, indem der Datentyp vor dem Parameternamen notiert wird. Übergebene Parameter müssen diesem Datentyp entsprechen, ansonsten wird eine Fehlermeldung von Typ Catchable fatal error geworfen. Type Hinting ist nicht mit skalaren (primitiven) Datentypen möglich!

// Der Parameter muss ein Array sein
func1(array $array) {
}

// Der Parameter muss vom Typ MyInterface sein
func2(MyInterface) {
}

Wird ein Klassenname angegeben, so muss der Parameter eine Instanz dieser Klasse oder einer ihrer Kindklassen sein. Handelt es sich um eine Schnittstelle, muss der übergebene Parameter diese implementieren.

Art der Übergabe

Die Parameter lassen sich auf zwei Arten übergeben. Zum einen durch Call by Value, welches einer normalen Übergabe entspricht und zum anderen durch Call by Reference.

Bei der Call by Value-Übergabe wird eine Kopie des Wertes im lokalen Namensraum der Funktion bekannt gemacht. Dieser ist gekapselt und hat keine Verbindung mehr zur Ursprungsvariablen. Änderungen am Parameterwert wirken sich also nicht auf Variablen des globalen Namensraumes aus. Die Parameterübergaben aus den Beispielen zuvor sind allesamt Call by Value-Übergaben.

Call by Reference-Übergaben liefern keine Kopie des Wertes, sondern eine Referenz auf die übergebene Variable. Änderungen am Parameter wirken sich also direkt auf die übergebene Variable des aufrufenden Namensraumes aus. Um einen Parameter als Referenz zu deklarieren, wird der Referenz-Operator & benutzt.

function func(&$param) {
    $param = 6;
}

$var = 5;
echo $var . '<br>';
func($var);
echo $var;

Die Ausgabe:

5
6

Aus diesem Verhalten ergibt sich auch, dass weder Funktionsrückgabewerte noch Literalwerte übergeben werden können:

function func(&$param) {
    $param = 6;
}

// fehlerhafte Übergaben:
func(123);
func('abc')
func(foobar());

Copy on write

Ein beliebtes Missverständnis besteht darin, Funktionsparameter auch dann als Referenz zu übergeben, wenn die Werte während des Durchlaufs der Funktion nicht verändert werden. Der Gedanke dahinter ist, PHP auf diese Weise besonders bei umfangreichem Variableninhalt den vermeintlich aufwendigen Kopiervorgang des Inhalts in den Geltungsbereich der Funktion zu ersparen. Tatsächlich nimmt PHP diese Optimierung jedoch selbstständig vor und erstellt nach dem Copy on write-Prinzip nur dann eine Kopie des Variableninhalts, wenn dieser innerhalb des Funktionscodes verändert wird.

Übergabe von Objekten

Die Übergabe von Objekten an Funktionen folgt ebenfalls den Prinzipien Call by Value und Call by Reference. Dies lässt sich an einem Beispiel verdeutlichen:

// Call by Value
function a($obj) {
    $obj = null;
}

// Call by Reference
function b(&$obj) {
    $obj = null;
}

$x = new stdClass();

var_dump($x);
a($x);
var_dump($x);
b($x);
var_dump($x);

Ausgabe:

object(stdClass)#1 (0) {
}
object(stdClass)#1 (0) {
}
NULL

Nach dem Aufruf von Funktion a ändert sich nichts am Inhalt der Variablen $x. Erst nach dem Aufruf von b wird sie im globalen Geltungsbereich mit dem Wert null überschrieben.

Eine Objektvariable in PHP enthält als Wert nicht etwa eine Referenz, sondern einen object identifier (entspricht einer eindeutigen ID-Nummer), über den der Speicherbereich der tatsächlichen Instanzdaten bestimmt werden kann. Dieser object identifier verhält sich bei Übergabe by Value oder by Reference genau wie ein normaler Skalarwert. Die Übergabe eines Objekts an eine Funktion ist also üblicherweise die Übergabe by Value des jeweiligen object identifiers.

Dieser Beitrag ist fertiggestellt und wurde zuletzt von Trainmaster bearbeitet.

An diesem Beitrag waren bisher beteiligt: Manko10, nikosch, mermshaus, hausl, Trainmaster