mitmario.dev

Eine Datei lesen

PHP Sandbox 4 Min Lesezeit 5 BeispieleLektion 1 von 7

Solange die Zahlen im Code stehen, rechnet ein Programm jeden Tag mit denselben. Für neue muss jemand den Code ändern. Liegen die Daten dagegen in einer Datei, änderst du die Datei, und das Programm bleibt, wie es ist. Zum Lesen bringt PHP zwei Funktionen mit. Die eine liefert die Datei als einen Text, die andere als Liste von Zeilen.

file_get_contents holt alles auf einmal

Die ganze Datei in einem Rutsch
<?php

declare(strict_types=1);

$inhalt = file_get_contents("fluesse.txt");

echo "Typ:    ", get_debug_type($inhalt), "\n";
echo "Bytes:  ", strlen($inhalt), "\n";
echo "Inhalt:\n";
echo $inhalt;
echo "[hier endet die Datei]\n";

file_get_contents() gibt dir den kompletten Inhalt als einen Text zurück, mit allen Zeilenumbrüchen darin. Das passt, wenn dich die Datei als Ganzes interessiert, etwa ein Text zum Ausgeben oder eine JSON-Datei in der übernächsten Lektion.

In der Bytezahl im Beispiel sind die Zeilenumbrüche mitgezählt, denn die stehen wirklich in der Datei. Ein Zeilenumbruch ist ein Zeichen wie jedes andere. Sichtbar wird er mit cat -A fluesse.txt im Terminal, als $ an jedem Zeilenende. Und wc -c fluesse.txt kommt auf dieselben 17 Bytes wie strlen.

file liefert eine Liste von Zeilen

Zeile für Zeile statt am Stück
<?php

declare(strict_types=1);

echo "So kommt es roh zurück:\n";
var_dump(file("fluesse.txt"));

echo "\nUnd so aufgeräumt:\n";
$zeilen = file("fluesse.txt", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
var_dump($zeilen);

echo "\nDamit lässt sich zählen: ", count($zeilen), " Zeilen\n";

file() liest dieselbe Datei und gibt dir eine Liste zurück, einen Eintrag je Zeile. Damit funktioniert alles aus Abschnitt 5, also count(), foreach und array_filter.

Im ersten var_dump kleben die Zeilenumbrüche allerdings noch an den Einträgen, Rhein\n statt Rhein. Wenn du damit vergleichst, suchst du lange. Dagegen gibt es zwei Schalter (englisch flags), und meistens stehen sie zusammen:

  • FILE_IGNORE_NEW_LINES schneidet den Umbruch am Zeilenende ab.
  • FILE_SKIP_EMPTY_LINES wirft leere Zeilen weg, etwa eine Leerzeile am Dateiende. Allein wirkt es nicht, denn ohne FILE_IGNORE_NEW_LINES besteht auch eine leere Zeile noch aus ihrem Umbruch.

Der senkrechte Strich dazwischen heißt schlicht „und dieser auch“. Bei JSON kommt er wieder.

Die Datei, die es nicht gibt

Wenn es die Datei gar nicht gibt
<?php

declare(strict_types=1);

echo "Erster Versuch, ungeprüft:\n";
$inhalt = file_get_contents("gibtsnicht.txt");
var_dump($inhalt);
echo "Das Programm läuft trotzdem weiter.\n";

echo "\nZweiter Versuch, vorher gefragt:\n";
if (is_readable("gibtsnicht.txt")) {
    echo file_get_contents("gibtsnicht.txt");
} else {
    echo "Die Datei gibt es nicht, oder sie ist nicht lesbar.\n";
}

Fehlt die Datei, liefert file_get_contents nur ein false, und das Programm macht damit weiter. Dazu gibt es eine Warnung, von den drei Sorten Fehler die unangenehmste. Ihre Zeile auf dem Fehlerkanal fängt so an:

PHP Warning: file_get_contents(gibtsnicht.txt): Failed to open stream: No such file or directory

Gemeint ist, dass sich die Datei nicht öffnen ließ, weil es unter diesem Namen weder eine Datei noch einen Ordner gibt.

Abgestürzt ist nichts, der Exit-Code bleibt 0. Dein Programm rechnet mit false weiter, und beim Aneinanderhängen von Text benimmt sich false wie ein leerer Text. Am Ende steht eine leere Ausgabe da, auf einem Server eine leere Seite. Und niemand weiß, warum.

Vorher fragen kannst du mit zwei Funktionen, und die beantworten zwei verschiedene Fragen:

  • file_exists() sagt, ob dort etwas liegt.
  • is_readable() sagt, ob du es auch aufmachen darfst.

Auch ein Verzeichnis zählt bei beiden als „ja“.

Für den Alltag ist is_readable() die bessere Frage, denn lesen willst du die Datei ja. Und wenn es ohne den Inhalt nicht weitergehen kann, ist das der Moment, selbst eine Ausnahme zu werfen. Mehr als ein if und darin ein throw new RuntimeException("Die Datei fehlt: " . $pfad); braucht es dafür nicht.

Relative Pfade und __DIR__

Wo dein Skript zu Hause ist
<?php

declare(strict_types=1);

echo "Die Datei liegt in:      ", __DIR__, "\n";
echo "Gearbeitet wird gerade in: ", getcwd(), "\n";

echo "\nBeide Wege führen hier zum Ziel:\n";
echo "relativ: ", strlen(file_get_contents("fluesse.txt")), " Bytes\n";
echo "sicher:  ", strlen(file_get_contents(__DIR__ . "/fluesse.txt")), " Bytes\n";

"fluesse.txt" ist ein relativer Pfad (englisch relative path). Er bezieht sich auf das Verzeichnis, in dem der PHP-Prozess gerade arbeitet, das Arbeitsverzeichnis (englisch working directory). Das muss nicht der Ordner der Datei sein, in der die Zeile steht. Auf der Kommandozeile ist es der Ordner, aus dem heraus du php aufgerufen hast. Ein Webserver wechselt vorher in den Ordner des aufgerufenen Skripts. In diesem Kurs liegt das Skript in dem Ordner, aus dem es gestartet wird, deshalb funktioniert der kurze Weg hier immer.

Gemein wird es, sobald eine Datei aus einem anderen Ordner eingebunden wird oder ein Cronjob das Skript von woanders startet, und dann zeigt der kurze Weg plötzlich ins Leere.

__DIR__ hängt nicht davon ab. Die magische Konstante bezeichnet das Verzeichnis der Datei, in der sie steht, und PHP setzt es beim Einlesen ein. Mit einem Schrägstrich zusammengeklebt ergibt das einen Pfad, der immer stimmt, egal von wo aus gestartet wird.

Zeichen sind nicht Bytes

Zeichen zählen, nicht Bytes
<?php

declare(strict_types=1);

$zeilen = file("woerter.txt", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($zeilen as $wort) {
    echo str_pad($wort, 12), " strlen: ", strlen($wort);
    echo "   mb_strlen: ", mb_strlen($wort), "\n";
}

strlen() zählt Bytes, mb_strlen() zählt Zeichen, wie bei Text in Abschnitt 3. Ein Umlaut braucht in UTF-8 zwei Bytes. Das siehst du auch mit cat -A woerter.txt im Terminal, wo aus dem ä in Kapitän zwei Zeichenpaare werden, M-CM-$, eines je Byte.

Nebenbei stehen die Spalten im Beispiel nicht sauber untereinander. str_pad rechnet nämlich ebenfalls in Bytes, und die Wörter mit Umlaut bekommen zu wenig Auffüllung. Dieselbe Verschiebung gab es schon beim Formatieren von Text.

In der Aufgabe sagt ein Skript in drei Zeilen, was in einer Datei mit zwölf Wörtern steht.

Zum Mitnehmen

file_get_contents liefert den ganzen Inhalt in einem Stück, file eine Liste mit einer Zeile je Eintrag, mit den beiden Schaltern ohne Umbrüche. Eine fehlende Datei ergibt false und eine Warnung, aber keinen Abbruch. Mit __DIR__ hängt ein Pfad nicht mehr davon ab, von wo das Skript gestartet wird.

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 5 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.