mitmario.dev

CSV

PHP Sandbox 4 Min Lesezeit 4 BeispieleLektion 4 von 7

CSV ist das Format, in dem eine Tabelle die Tabellenkalkulation als Text verlässt. Eine Zeile je Datensatz, ein Trennzeichen zwischen den Feldern. Das sieht so einfach aus, dass man es mit explode zerlegen möchte, und das geht eine Weile gut. Dann nicht mehr.

Warum explode nicht reicht

Warum explode hier scheitert
<?php

declare(strict_types=1);

echo "Mit explode:\n";
foreach (file("komma.csv", FILE_IGNORE_NEW_LINES) as $zeile) {
    $felder = explode(",", $zeile);
    echo count($felder), " Felder: ", implode(" | ", $felder), "\n";
}

echo "\nMit fgetcsv:\n";
$datei = fopen("komma.csv", "r");
while (($felder = fgetcsv($datei, escape: "")) !== false) {
    echo count($felder), " Felder: ", implode(" | ", $felder), "\n";
}
fclose($datei);

Ein CSV-Feld darf das Trennzeichen enthalten. Es muss dann in Anführungszeichen stehen, und die gehören zur Schreibweise und nicht zum Inhalt.

Im Beispiel steht "Kaffee, gemahlen" als ein Feld. explode(",") weiß davon nichts. Es macht daraus zwei und liefert für diese Zeile vier Felder statt drei, und die Anführungszeichen bleiben obendrein stehen.

fgetcsv() kennt die Regel und liefert drei Felder, mit dem Komma im ersten und ohne Anführungszeichen. Das ist schon der ganze Unterschied. Und er ist der Grund, warum man CSV nicht selbst zerlegt.

fgetcsv arbeitet auf einem offenen Zeiger

fopen() öffnet die Datei, das "r" dahinter heißt zum Lesen. Zurück kommt ein Zeiger (englisch file pointer), der sich merkt, wo gerade gelesen wird. fgetcsv() liest an dieser Stelle eine Zeile und rückt den Zeiger weiter, und fclose() gibt ihn am Ende wieder frei. Deshalb steht der Aufruf in einer while-Schleife, die so lange läuft, wie noch etwas kommt.

Am Dateiende gibt fgetcsv false zurück, und darauf prüft !== false. Schluss ist also beim Dateiende und nicht dann, wenn eine Zeile zufällig nach nichts aussieht. Eine leere Zeile mitten in der Datei liefert ein Array mit einem einzigen null darin, und das ist ein Ergebnis wie jedes andere.

Das deutsche Semikolon

Semikolon, weil die Preise Kommas haben
<?php

declare(strict_types=1);

$datei = fopen("bestellungen.csv", "r");

while (($felder = fgetcsv($datei, separator: ";", escape: "")) !== false) {
    echo implode(" | ", $felder), "\n";
}

fclose($datei);

In Deutschland trennt meist ein Semikolon, weil das Komma in jeder Preisspalte schon das Dezimaltrennzeichen ist. Eine Datei, in der 12,45 steht und das Komma zugleich Felder trennt, könnte niemand lesen.

Welches Zeichen gilt, sagst du fgetcsv mit separator. Das Semikolon trennt jetzt die Felder, also darf das Komma einfach im Text stehen, ganz ohne Anführungszeichen.

Mit 12,45 rechnen geht erst nach einem Umweg. (float) vor einem Text macht eine Kommazahl daraus, so wie (bool) einen Wahrheitswert. Es liest aber nur bis zum Komma, und (float) "12,45" ist deshalb nur 12. Mit einem Punkt statt des Kommas stimmt die Zahl. Für Cent macht (int) daraus eine ganze Zahl und schneidet dabei ab, und 1.15 * 100 ist als Kommazahl 114.99999999999999. Ohne round() davor kämen 114 Cent heraus.

Warum überall escape steht

Neben separator steht in diesem Kurs immer escape: "". Das braucht eine Erklärung, denn in älteren Anleitungen findest du es nicht.

PHP kennt neben den Anführungszeichen noch einen zweiten Weg zum Maskieren, mit dem Backslash. Das Handbuch nennt ihn selbst einen PHP-eigenen Mechanismus, und kein Tabellenprogramm erzeugt so etwas. Ein Backslash am Feldende verschluckt damit die nächsten Zeichen. Ein leerer Text als escape schaltet ihn ab, und so steht es in jedem Aufruf dieses Kurses.

Seit PHP 8.4 verlangt PHP, dass du das Argument ausdrücklich angibst. Sonst schreibt es bei jedem Aufruf eine Deprecated-Meldung auf den Fehlerkanal. In der Sandbox dieses Kurses läuft PHP 8.5. Die Meldung steht also sofort da, und in der Prüfliste der Aufgabe zählt sie mit. Ohne Umbau einer Datei siehst du sie mit php -r '$d = fopen("bestellungen.csv", "r"); var_dump(fgetcsv($d));' aus der Befehlsleiste. Die Meldung steht dort vor dem Ergebnis, und das Ergebnis ist obendrein eine einzige Spalte, weil auch separator fehlt. Dasselbe escape: "" gehört an fputcsv(), das eine Zeile schreibt und die Anführungszeichen selbst setzt, wo ein Feld sie braucht.

Geschrieben ist das hier mit benannten Argumenten aus Abschnitt 6. Sonst müsstest du zwei Parameter, die dich nicht interessieren, in der richtigen Reihenfolge mitschleppen.

Die Spaltennamen

Die Spaltennamen werden zum Schlüssel
<?php

declare(strict_types=1);

$datei = fopen("bestellungen.csv", "r");
$kopf = fgetcsv($datei, separator: ";", escape: "");

echo "Die Spaltennamen: ", implode(", ", $kopf), "\n\n";

while (($felder = fgetcsv($datei, separator: ";", escape: "")) !== false) {
    $zeile = array_combine($kopf, $felder);
    echo $zeile["artikel"], " kostet ", $zeile["einzelpreis"], "\n";
}

fclose($datei);

echo "\nUnd so sieht so eine Zeile aus:\n";
var_dump(array_combine($kopf, ["Tee", "1", "4,20"]));

Die erste Zeile einer CSV enthält meistens die Spaltennamen. Liest du sie einmal getrennt ein, bevor die Schleife anfängt, hast du sie als Liste in der Hand.

Damit wird aus jeder folgenden Zeile eine Zuordnung. array_combine() nimmt die Spaltennamen als Schlüssel und die Datenzeile als Werte. Statt $felder[2] schreibst du dann $zeile["einzelpreis"], und in einem halben Jahr weißt du immer noch, was gemeint war.

Das klappt nur, wenn beide Listen gleich lang sind. Sonst wirft array_combine einen ValueError, und das ist richtig so, denn eine Zeile mit der falschen Spaltenzahl ist kaputt.

Manche Programme schreiben beim Speichern als UTF-8 drei unsichtbare Bytes an den Anfang der Datei, eine BOM (englisch byte order mark), und mit bloßem Auge siehst du davon nichts. fgetcsv hält sie für einen Teil des ersten Spaltennamens. Der Schlüssel heißt dann "\u{FEFF}artikel", und statt $zeile["artikel"] gibt es nur eine Warnung. Weg ist sie mit $kopf[0] = str_replace("\u{FEFF}", "", $kopf[0]); gleich nach dem Einlesen der Spaltennamen.

Die CSV als Tabelle im Browser

Eine CSV, die zur Tabelle wird
<?php

declare(strict_types=1);

$datei = fopen("bestellungen.csv", "r");
$kopf = fgetcsv($datei, separator: ";", escape: "");

echo "<style>";
echo "body{font-family:system-ui;padding:1rem}";
echo "table{border-collapse:collapse}";
echo "th,td{border:1px solid #999;padding:.35rem .6rem;text-align:left}";
echo "td.zahl{text-align:right}";
echo "</style>\n";

echo "<table>\n";
echo "  <tr><th>", implode("</th><th>", $kopf), "</th></tr>\n";

while (($felder = fgetcsv($datei, separator: ";", escape: "")) !== false) {
    echo "  <tr>";
    echo "<td>", $felder[0], "</td>";
    echo "<td class=\"zahl\">", $felder[1], "</td>";
    echo "<td class=\"zahl\">", $felder[2], " Euro</td>";
    echo "</tr>\n";
}

echo "</table>\n";
fclose($datei);

Dieses Beispiel gibt Markup aus statt reinem Text, deshalb läuft dafür ein Server. Im Reiter Browser steht die Tabelle, im Terminal nach php index.php das Markup dazu, mit <tr> und <td>.

Tabellendaten als Tabelle zeigen ist der Alltagsfall dieser Lektion. Ab Abschnitt 10 entstehen so Seiten, die ein Browser anfragt. Das <style> steht gleich mit in der Ausgabe, damit alles in einer Datei bleibt. Eine stil.css daneben würde der Server genauso ausliefern, wie in Abschnitt 10.

In der Aufgabe rechnest du drei Bestellungen aus einer CSV zusammen, in ganzen Cent.

Zum Mitnehmen

Weil ein Feld das Trennzeichen in Anführungszeichen enthalten darf, zerlegt fgetcsv die Zeilen und nicht explode. Das Trennzeichen ist in Deutschland meist ein Semikolon, escape bleibt leer, und array_combine macht aus der ersten Zeile die Schlüssel. Gerechnet wird mit einem Preis erst, wenn aus seinem Komma ein Punkt geworden ist.

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.