mitmario.dev

Werfen statt zurückgeben

PHP Sandbox 3 Min Lesezeit 4 BeispieleLektion 4 von 6

Viele eingebaute Funktionen von PHP melden einen Fehlschlag mit false. Das sieht harmlos aus, bis eine Funktion auch 0 liefern kann oder jemand vergisst nachzusehen, was zurückkam. Eine eigene Funktion hat die Wahl. Entweder gibt sie einen besonderen Wert zurück, an dem der Aufrufer den Fehlschlag erkennt, oder sie wirft eine Ausnahme. Und die Wahl hat Folgen.

Die Falle, die PHP selbst mitbringt

false und 0 sehen im if gleich aus
<?php

declare(strict_types=1);

$satz = "Apfel und Birne";

// strpos gibt die Position zurueck, an der das Wort anfaengt.
var_dump(strpos($satz, "Apfel"));
var_dump(strpos($satz, "Birne"));
var_dump(strpos($satz, "Kirsche"));

// Und jetzt die Falle:
if (!strpos($satz, "Apfel")) {
    echo "Apfel kommt angeblich nicht vor.\n";
}

// Mit === stimmt es wieder:
if (strpos($satz, "Apfel") !== false) {
    echo "Apfel kommt vor, und zwar an Stelle 0.\n";
}

strpos() liefert die Position, an der ein Wort anfängt, und false, wenn es nicht vorkommt. Das klingt vernünftig, bis das gesuchte Wort ganz am Anfang steht. Dann ist die Position 0, und eine 0 liest ein if als falsch.

if (!strpos(...)) hält also den besten Treffer, den es gibt, für einen Fehlschlag. Das Programm läuft durch, meldet nichts, und die Antwort ist falsch.

Beheben lässt sich das mit !== false. Der dreifache Vergleich sieht nicht nur auf den Wert, sondern auch auf den Typ, und 0 ist nun mal eine Zahl und kein false. Dieselbe Falle steckt in array_search() und in jeder anderen Funktion, die false als Fehlerzeichen benutzt und auch 0 oder einen leeren Text liefern kann.

Kein Ergebnis ist kein Fehler

Kein Treffer ist normal, eine kaputte Frage nicht
<?php

declare(strict_types=1);

$kunden = [
    ["nr" => 1001, "ort" => "Kiel"],
    ["nr" => 1002, "ort" => "Ulm"],
];

// Kein Treffer ist normal und bekommt eine leere Liste.
// Ein leerer Ort ist kein Ergebnis, sondern ein Fehler.
function kundenInOrt(string $ort, array $kunden): array
{
    if (trim($ort) === "") {
        throw new InvalidArgumentException("Ort ist leer");
    }

    return array_values(array_filter($kunden, fn(array $k): bool => $k["ort"] === $ort));
}

foreach (["Kiel", "Bonn", " "] as $ort) {
    try {
        $treffer = kundenInOrt($ort, $kunden);
        echo count($treffer), " Kunden gefunden\n";
    } catch (InvalidArgumentException $fehler) {
        echo "Nicht gesucht: ", $fehler->getMessage(), "\n";
    }
}

Eine Suche, die nichts findet, ist kein Fehler. Das ist ein ganz normales Ergebnis, mit dem jeder rechnet, und die ehrliche Antwort darauf ist eine leere Liste. Der Aufrufer schreibt dann 0 Kunden gefunden hin und macht weiter.

Bei einem leeren Suchbegriff ist das anders. Da hat jemand eine Frage gestellt, die keine ist. Die Funktion kann darauf nicht sinnvoll antworten, also wirft sie.

Warum eine Ausnahme sicherer ist

Was vergessen werden kann, wird vergessen
<?php

declare(strict_types=1);

// Version mit false: der Aufrufer kann die Pruefung weglassen.
function alterAusJahrOderFalse(string $jahr): int|false
{
    if (!ctype_digit($jahr)) {
        return false;
    }

    return 2026 - (int) $jahr;
}

echo "Mit false, ohne Prüfung: ";
echo alterAusJahrOderFalse("neunzehn") + 0, "\n";

// Version mit Ausnahme: weglassen geht nicht.
function alterAusJahr(string $jahr): int
{
    if (!ctype_digit($jahr)) {
        throw new InvalidArgumentException("Kein Jahr: " . $jahr);
    }

    return 2026 - (int) $jahr;
}

echo "Mit Ausnahme: ";
try {
    echo alterAusJahr("neunzehn"), "\n";
} catch (InvalidArgumentException $fehler) {
    echo $fehler->getMessage(), "\n";
}

Beide Funktionen im Beispiel machen dasselbe, und beide behandeln den Fehlerfall. Der Unterschied zeigt sich erst, wenn der Aufrufer nicht aufpasst.

Bei der false-Version rechnet PHP mit dem false einfach weiter. false + 0 ergibt 0, ohne Warnung, ohne Meldung, mit Exit-Code 0. Aus einem nicht erkannten Jahr ist ein Alter von null Jahren geworden. Gemerkt hat es niemand.

Bei der Ausnahme geht das nicht. Fängt der Aufrufer sie nicht, bricht sein Programm ab, und zwar laut. Das klingt erst mal nach dem schlechteren Angebot, ist aber das bessere, denn einen lauten Abbruch bemerkt jemand sofort und das stille false + 0 womöglich erst Wochen später.

Alte Funktionen an der Grenze übersetzen

Eine alte Funktion übersetzen
<?php

declare(strict_types=1);

// So antworten die alten Funktionen: mit false und einer Warnung.
$inhalt = file_get_contents("preise.csv");
var_dump($inhalt);
echo "Und das Programm läuft weiter.\n";

// So uebersetzt man das in eine Ausnahme:
function liesDatei(string $pfad): string
{
    if (!is_readable($pfad)) {
        throw new RuntimeException("Datei nicht lesbar: " . $pfad);
    }

    return (string) file_get_contents($pfad);
}

try {
    echo liesDatei("preise.csv");
} catch (RuntimeException $fehler) {
    echo "Abgebrochen: ", $fehler->getMessage(), "\n";
}

Die eingebauten Funktionen wirst du nicht los. file_get_contents() antwortet auch morgen noch mit false und einer Warnung, und im Beispiel lautet sie file_get_contents(preise.csv): Failed to open stream: No such file or directory. Übersetzt heißt das, die Datei ließ sich nicht öffnen, weil es sie nicht gibt. Einpacken kannst du die Funktion aber, und zwar ein einziges Mal.

Die kleine liesDatei() prüft vorher und wirft eine Ausnahme mit einer brauchbaren Meldung. Ab da gilt in deinem Code nur noch eine Regel. Das ist derselbe Gedanke wie beim Aufteilen von Funktionen in Abschnitt 6. Ein Detail gehört an eine Stelle, und dahinter arbeitest du mit dem, was dir besser gefällt. Bei den Dateien in Abschnitt 8 brauchst du diesen Handgriff gleich wieder.

In der Aufgabe antwortet eine Suchfunktion auf zwei ganz verschiedene Fälle mit demselben false.

Zum Mitnehmen

Ein Ergebnis, auch ein leeres, gehört in den Rückgabewert, ein Unfall in eine Ausnahme. false als Fehlerzeichen lässt sich übersehen, und ein if verwechselt es mit 0, einem leeren Text und einer leeren Liste. Eine alte Funktion, die mit false antwortet, packst du einmal ein und wirfst dort.

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.