mitmario.dev

Eine eigene Funktion

PHP Sandbox 3 Min Lesezeit 4 BeispieleLektion 1 von 8

Zehn Prozent Rabatt auf drei Preise sind drei Zeilen mit derselben Rechnung. Werden aus den zehn Prozent irgendwann fünfzehn, musst du alle drei finden. Übersiehst du eine, merkt es niemand. Bei count(), number_format() und array_filter() gibt es dieses Problem nicht. Ihre Arbeit steht an einer Stelle, und du rufst sie nur auf. Mit einer eigenen Funktion geht dasselbe für deinen Rechenweg.

Ein Name für einen Rechenweg

Dreimal derselbe Weg, einmal geschrieben
<?php

// Zehn Prozent Rabatt auf drei Preise in Cent, von Hand:
echo 1200 - intdiv(1200 * 10, 100), " Cent\n";
echo 3500 - intdiv(3500 * 10, 100), " Cent\n";
echo 4800 - intdiv(4800 * 10, 100), " Cent\n";

// Mit einer Funktion steht der Weg einmal da:
function mitRabatt($cent)
{
    return $cent - intdiv($cent * 10, 100);
}

echo mitRabatt(1200), " Cent\n";
echo mitRabatt(3500), " Cent\n";
echo mitRabatt(4800), " Cent\n";

Das Wort function, ein Name, die Klammern mit den Parametern und dazwischen der Rumpf (englisch body). Ein Parameter ist eine Variable, die es nur innerhalb der Funktion gibt. Ihren Wert bekommt sie beim Aufruf. return beendet die Funktion sofort und schickt einen Wert an die Stelle zurück, an der sie aufgerufen wurde, den Rückgabewert (englisch return value).

Beide Hälften des Beispiels geben dasselbe aus. Oben steht der Rabatt dreimal da, unten einmal. Beim nächsten Rabatt änderst du unten eine einzige Zeile.

Eine Sache gehört an eine Stelle, so wie bei den Konstanten in Lektion 2.6. Nur ging es dort um einen Wert und hier um einen Weg.

Zurückgeben ist etwas anderes als ausgeben

Sagen oder zurückgeben
<?php

function sagHallo($name)
{
    echo "Hallo $name!\n";
}

function baueHallo($name)
{
    return "Hallo $name!";
}

$a = sagHallo("Mia");
var_dump($a);

$b = baueHallo("Ben");
var_dump($b);

// Nur das Zurueckgegebene laesst sich weiterverwenden:
echo mb_strtoupper($b), "\n";

Beide Funktionen im Beispiel machen auf den ersten Blick dasselbe. Der Unterschied steckt in dem, was in $a und in $b landet.

sagHallo() schreibt den Text direkt auf die Ausgabe und gibt nichts zurück. Fehlt das return, kommt immer null zurück. Ein return; ohne Wert macht es genauso. In $a steht deshalb NULL. Damit kannst du nichts mehr anfangen, der Satz ist ja schon draußen.

baueHallo() gibt den Text zurück. In $b liegt ein echter Text, und den kannst du weiterreichen, verändern oder erst später ausgeben wie in der letzten Zeile des Beispiels.

Eine Funktion, die selbst etwas ausgibt, schreibe ich fast nie. Sie legt fest, wann und wo der Text erscheint, und prüfen lässt sie sich nur auf Umwegen. Ab Abschnitt 10 entstehen Seiten, bei denen die Reihenfolge der Ausgabe wirklich zählt, und dort willst du selbst bestimmen, wann und wo ein Stück Text erscheint. In Abschnitt 17 vergleichen Tests einen Rückgabewert, und eine Funktion, die nur redet, hat dort nichts zu bieten.

Warum man diesen Unterschied sehen kann

Aus drei Rückgaben wird eine Liste
<?php

function listenEintrag($name, $cent)
{
    return "<li>" . $name . ": " . number_format($cent / 100, 2, ",", ".") . " Euro</li>";
}

$waren = ["Kabel" => 990, "Maus" => 2490, "Tastatur" => 4365];

$eintraege = [];
foreach ($waren as $name => $cent) {
    $eintraege[] = listenEintrag($name, $cent);
}

echo "<ul>\n";
echo implode("\n", $eintraege), "\n";
echo "</ul>\n";

listenEintrag() gibt ein <li> zurück, statt es auszugeben. Deshalb lassen sich die drei Rückgaben erst einsammeln und danach zwischen <ul> und </ul> setzen. Mit einem echo in der Funktion ginge das nicht. Die drei Einträge wären längst draußen, bevor der Listenanfang geschrieben wird, und im Browser stünde kaputtes Markup.

Im Reiter Browser kommen die drei Einträge als fertige Liste an.

Zwei Regeln für den Namen

Der Aufruf ist unempfindlich, der Variablenname nicht
<?php

function mitRabatt($cent)
{
    return $cent - intdiv($cent * 10, 100);
}

// Alle drei rufen dieselbe Funktion auf:
echo mitRabatt(1000), "\n";
echo MitRabatt(1000), "\n";
echo MITRABATT(1000), "\n";

// Bei Variablen ist das anders:
$preis = 100;
$Preis = 200;
echo $preis, " und ", $Preis, "\n";

Eine Funktion tut etwas, deshalb steht in ihrem Namen ein Verb. mitRabatt() geht gerade noch durch, weil das Ergebnis so heißt. preisberechnung() klingt schon nach einem Bericht und nicht nach einer Anweisung. Gut sind berechneBrutto(), baueHallo() und findeKunde().

Beim Aufruf ist PHP die Schreibweise egal. MITRABATT(1000) findet dieselbe Funktion wie mitRabatt(1000), ganz ohne Warnung. Bei Variablen ist es umgekehrt. $preis und $Preis sind zwei verschiedene Behälter, wie in Lektion 2.1.

Der Name steht trotzdem überall so, wie er definiert ist. Sonst findest du mit einer Textsuche nach mitRabatt irgendwann nur die Hälfte der Aufrufe.

In der Aufgabe wird aus drei kopierten Rechnungen eine Funktion brutto().

Zum Mitnehmen

Eine Funktion schreibt einen Rechenweg einmal unter einem Namen auf, und jeder Aufruf gibt ihr über die Parameter andere Werte. Was sie mit return zurückgibt, lässt sich weiterverwenden und prüfen, was sie selbst ausgibt, nur auf Umwegen. Ohne return liefert sie null.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 4 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.