mitmario.dev

Eine Datei schreiben

PHP Sandbox 3 Min Lesezeit 5 BeispieleLektion 2 von 7

Was dein Programm ausrechnet, ist nach dem letzten echo weg. Soll es den Lauf überdauern, muss es in eine Datei. Und dort löscht eine einzige Zeile ohne den richtigen Schalter alles, was vorher drinstand.

file_put_contents ersetzt den Inhalt

Schreiben legt neu an und überschreibt
<?php

declare(strict_types=1);

file_put_contents("notiz.txt", "Erster Satz.\n");
echo "Nach dem ersten Schreiben:\n";
echo file_get_contents("notiz.txt");

file_put_contents("notiz.txt", "Zweiter Satz.\n");
echo "\nNach dem zweiten Schreiben:\n";
echo file_get_contents("notiz.txt");

echo "\nVom ersten Satz ist nichts übrig.\n";

file_put_contents() nimmt zwei Dinge, wohin und was. Gibt es die Datei noch nicht, wird sie angelegt. Gibt es sie schon, wird ihr Inhalt ersetzt. Ohne Rückfrage, ohne Papierkorb, ohne Warnung.

Meistens ist das auch gewollt, etwa beim Zurückschreiben einer JSON-Datei in der nächsten Lektion. Man muss es nur wissen, bevor man es an der falschen Datei ausprobiert.

FILE_APPEND hängt an, statt zu ersetzen

Anhängen mit FILE_APPEND
<?php

declare(strict_types=1);

file_put_contents("notiz.txt", "Erster Satz.\n");
file_put_contents("notiz.txt", "Zweiter Satz.\n", FILE_APPEND);
file_put_contents("notiz.txt", "Dritter Satz.\n", FILE_APPEND);

echo file_get_contents("notiz.txt");

$zeilen = file("notiz.txt", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
echo "\n", count($zeilen), " Zeilen stehen jetzt drin.\n";

Das dritte Argument ist ein Schalter, und der wichtigste davon heißt FILE_APPEND. Damit landet dein Text hinter dem, was schon dasteht.

Für ein Protokoll ist das die richtige Form. Jede Zeile kommt dazu, keine geht verloren, und vorher muss niemand die Datei lesen.

Was file_put_contents zurückgibt

Der Rückgabewert sagt, ob es geklappt hat
<?php

declare(strict_types=1);

$geschrieben = file_put_contents("notiz.txt", "Hallo\n");
echo "Erster Versuch:  ";
var_dump($geschrieben);

echo "Zweiter Versuch: ";
$misslungen = file_put_contents("gibtsnicht/notiz.txt", "Hallo\n");
var_dump($misslungen);

echo "\nUnd so fängt man das ab:\n";
if ($misslungen === false) {
    echo "Konnte nicht geschrieben werden.\n";
}

file_put_contents() gibt die Zahl der geschriebenen Bytes zurück und im Fehlerfall false. Das ist die Art Rückgabe aus dem Abschnitt über Fehler, eine alte Funktion, die mit einem Wert antwortet, den man leicht übersieht.

Im Beispiel scheitert der zweite Aufruf, weil es das Verzeichnis nicht gibt. PHP schreibt dazu eine Warnung auf den Fehlerkanal und liefert false. Das Programm läuft trotzdem munter weiter, als hätte es die Datei geschrieben, und am Ende fehlt sie einfach.

Geprüft wird mit ===. Eine leere Datei zu schreiben ist nämlich erlaubt und liefert 0, und 0 ist in einem if falsch. Prüfst du mit if (!$geschrieben), hältst du den geglückten Schreibvorgang für einen Fehlschlag. Das ist dieselbe Falle wie bei strpos() im Abschnitt über Fehler.

Rechte und Verzeichnisse

Auf deinem eigenen Rechner klappt Schreiben fast immer. Auf einem gemieteten Server scheitert es, wenn eins von zwei Dingen fehlt.

Das Verzeichnis muss es geben, denn PHP legt keine Ordner nebenbei an. Willst du nach daten/log.txt schreiben, brauchst du vorher ein daten. Anlegen geht mit mkdir("daten"), und mit mkdir("a/b/c", recursive: true) auch über mehrere Stufen.

Und der Webserver muss dort schreiben dürfen. Deine Dateien gehören dir, der PHP-Prozess läuft aber unter einem eigenen Nutzer. Deshalb gibt es auf gemieteten Servern meist eigene Verzeichnisse, in die der PHP-Prozess schreiben darf, und die liegen außerhalb dessen, was ein Besucher im Browser aufrufen kann. Warum das keine Schikane ist, steht in Abschnitt 15.

Der vergessene Zeilenumbruch

Der vergessene Zeilenumbruch
<?php

declare(strict_types=1);

foreach (["Milch", "Brot", "Kaffee"] as $ware) {
    file_put_contents("liste.txt", $ware, FILE_APPEND);
}

echo "So sieht die Datei aus:\n";
echo file_get_contents("liste.txt"), "\n";

$zeilen = file("liste.txt", FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
echo "\nUnd so viele Zeilen zählt PHP: ", count($zeilen), "\n";

Drei Wörter werden angehängt, und in der Datei steht MilchBrotKaffee. PHP hat alles richtig gemacht. Es hat Zeichen für Zeichen geschrieben, was dastand.

Ein Zeilenumbruch ist ein Zeichen und entsteht nicht von selbst. Wenn du Zeilen anhängst, schreibst du das \n mit. Und zwar ans Ende, nicht an den Anfang, sonst fängt die Datei mit einer Leerzeile an.

wc -l liste.txt zählt Zeilenumbrüche und sagt 0. Im Beispiel wird angehängt, also steht nach einem zweiten php index.php der Text zweimal hintereinander in der Datei.

Löschen

Wieder wegräumen
<?php

declare(strict_types=1);

file_put_contents("temp.txt", "Nur kurz.\n");
echo "Da:  ", var_export(file_exists("temp.txt"), true), "\n";

echo "Löschen sagt: ", var_export(unlink("temp.txt"), true), "\n";
echo "Da:  ", var_export(file_exists("temp.txt"), true), "\n";

echo "\nUnd noch einmal löschen:\n";
echo "Löschen sagt: ", var_export(@unlink("temp.txt"), true), "\n";

unlink() löscht eine Datei und gibt true oder false zurück. Auf eine Datei, die es nicht gibt, antwortet es mit false und einer Warnung, wie das Lesen in der letzten Lektion.

Das @ im letzten Aufruf unterdrückt die Meldung und nicht das Problem. Hier ist es vertretbar, weil das Ergebnis danach wirklich ausgegeben wird. Sauberer ist es trotzdem, vorher mit file_exists() zu fragen.

Im Reiter Praxis steht ein Protokoll mit drei Zeilen, und zwei sollen noch dazukommen.

Zum Mitnehmen

file_put_contents legt eine Datei an oder ersetzt ihren Inhalt ohne Rückfrage, mit FILE_APPEND hängt es an. Der Rückgabewert ist die Zahl der Bytes oder false, und ein Zeilenumbruch steht nur da, wenn du ihn mitschreibst.

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.