mitmario.dev

Die Anwendung zusammensetzen

PHP Sandbox 3 Min Lesezeit 3 BeispieleLektion 7 von 8

Für eine Notizliste mit Formular, Sitzung und Token reichen gut sechzig Zeilen in einer einzigen Datei. Nach diesem Abschnitt liegt dieselbe Anwendung in acht Dateien und kann trotzdem nicht mehr als in Abschnitt 15. Ob sich das lohnt, merkst du erst, wenn etwas nicht stimmt und du die Stelle suchen musst.

Ein Ort für jede Sorte Datei

Wohin welche Datei gehört
<?php

declare(strict_types=1);

// Die Struktur, die am Ende dieses Abschnitts steht, mit einer
// Begruendung je Ordner. In Frameworks heissen die Ordner englisch,
// die Aufteilung folgt derselben Frage.

$ordner = [
    ["oeffentlich/", "index.php, stil.css, Bilder", "Das Einzige, was der Browser erreichen darf. Eine einzige PHP-Datei."],
    ["src/", "Klassen, Seitenfunktionen, Routen", "Dein Code. Von außen nicht erreichbar."],
    ["ansichten/", "Vorlagen, also Markup mit Lücken", "Ausgabe, sonst nichts. Keine Abfrage, keine Rechnung."],
    ["privat/", "die Datenbankdatei, Uploads, Protokolle", "Daten, die entstehen. Nie im öffentlichen Ordner."],
    ["konfiguration.php", "Pfade, Titel, Betriebsart", "Was sich zwischen Rechner und Server unterscheidet."],
    [".env", "Passwörter, Schlüssel", "Geheimnisse. Bleibt aus der Versionsverwaltung draußen."],
];

?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Struktur</title>
<style>body{font-family:system-ui,sans-serif;max-width:44rem;margin:2rem auto}
td,th{border:1px solid #ccc;padding:.35rem .6rem;text-align:left;vertical-align:top}
code{white-space:nowrap}</style></head>
<body>
    <h1>Wohin welche Datei gehört</h1>
    <table>
        <tr><th>Ort</th><th>Was dort liegt</th><th>Warum</th></tr>
<?php foreach ($ordner as $zeile): ?>
        <tr>
            <td><code><?= $zeile[0] ?></code></td>
            <td><?= $zeile[1] ?></td>
            <td><?= $zeile[2] ?></td>
        </tr>
<?php endforeach; ?>
    </table>
</body>
</html>

Im ersten Beispiel sind die Ordner nach einer einzigen Frage getrennt, nämlich wer eine Datei sehen darf. In Frameworks, also fertigen Gerüsten für eine ganze Anwendung, haben sie englische Namen, und der öffentliche heißt dort oft public.

oeffentlich/ ist der einzige Ordner, den der Browser erreicht, und darin liegt eine einzige PHP-Datei. Alles andere liegt außerhalb der Dokumentwurzel. Das liefert der Server nicht aus, auch wenn jemand die Adresse kennt. Code liegt in src/ und Markup in ansichten/, also keine Datenbankabfrage in einer Vorlage und kein Markup in einer Klasse.

In privat/ landet, was im Betrieb entsteht, also die Datenbankdatei, hochgeladene Dateien und Protokolle. Passwörter und Schlüssel stehen in .env. Das ist der einzige Ort für Werte, die auch in konfiguration.php nichts zu suchen haben.

Der Weg einer Anfrage

Der Weg einer Anfrage
<?php

declare(strict_types=1);

// Eine einzelne Anfrage auf /, von der ersten bis zur letzten Zeile.
// Jeder Schritt schreibt sich in die Liste, in der Reihenfolge, in
// der er im Front Controller laeuft. Konfiguration, Speicher und
// Daten sind hier nur angedeutet, die echten stehen in der Aufgabe.

$weg = [];
$weg[] = "Der Server nimmt GET / entgegen und startet oeffentlich/index.php.";

$konfig = [
    "titel" => "Notizbuch von Mia",
    "modus" => "entwicklung",
];
$weg[] = "Die Konfiguration wird geladen. Betriebsart: " . $konfig["modus"] . ".";

$weg[] = "Der Speicher wird gebaut. In der Anwendung öffnet er hier die Datenbank.";

$routen = [
    ["GET", "/", "seiteStart"],
    ["POST", "/notiz", "aktionAnlegen"],
];
$pfad = "/";
$methode = "GET";

$ziel = null;
foreach ($routen as $route) {
    if ($route[0] === $methode && $route[1] === $pfad) {
        $ziel = $route[2];
        break;
    }
}
$weg[] = "Der Front Controller sucht eine Route für " . $methode . " " . $pfad . " und findet " . $ziel . ".";

$notizen = ["Milch", "Brot"];
$weg[] = "Die Seitenfunktion holt ihre Daten: " . count($notizen) . " Notizen.";

ob_start();
echo "<ul>";
foreach ($notizen as $notiz) {
    echo "<li>" . htmlspecialchars($notiz, ENT_QUOTES, "UTF-8") . "</li>";
}
echo "</ul>";
$inhalt = ob_get_clean();
$weg[] = "Die Vorlage wird gerendert und liefert " . mb_strlen($inhalt) . " Zeichen zurück.";

$weg[] = "Ganz unten steht das einzige echo der Anwendung. Erst hier geht etwas hinaus.";

?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Der Weg einer Anfrage</title>
<style>body{font-family:system-ui,sans-serif;max-width:40rem;margin:2rem auto}
li{margin:.3rem 0}</style></head>
<body>
    <h1>Der Weg einer Anfrage</h1>
    <ol>
<?php foreach ($weg as $schritt): ?>
        <li><?= $schritt ?></li>
<?php endforeach; ?>
    </ol>

    <h2>Und das kommt dabei heraus</h2>
    <?= $inhalt ?>
</body>
</html>

Im zweiten Beispiel wird eine Anfrage auf / nachgespielt, Schritt für Schritt und in der Reihenfolge, in der sie im Front Controller läuft. Konfiguration, Speicher und Daten sind nur angedeutet. Die echten stehen in der Aufgabe.

Der Server nimmt die Anfrage entgegen und startet oeffentlich/index.php, bei / als Indexdatei des Ordners. Die Konfiguration wird geladen, und danach steht fest, wo die Datenbank liegt und in welcher Betriebsart die Anwendung läuft. Der Speicher wird gebaut. Der Front Controller sucht in der Routentabelle eine Zeile, die zu Methode und Pfad passt, und ruft die zugehörige Funktion auf. Die holt ihre Daten, lässt eine Vorlage rendern und gibt das Ergebnis als Text zurück. Ganz unten steht das einzige echo der ganzen Anwendung.

Bis zu diesem echo ist nichts hinausgegangen. So lange kannst du an jeder Stelle davor noch einen Statuscode setzen, eine Kopfzeile schicken oder weiterleiten. Deshalb hat das http_response_code(404) in den Aufgaben dieses Abschnitts funktioniert, und deshalb geht überhaupt die Weiterleitung nach dem Absenden aus Lektion 11.3. Ohne Ausgabepuffer, wie in der Sandbox mit output_buffering = 0, ist es damit vorbei, sobald irgendwo mitten in der Anwendung ein echo steht.

Dieselbe Anwendung in einer Datei

Dieselbe Anwendung in einer Datei
<?php

declare(strict_types=1);

// Dieselbe Notizliste, alles in einer Datei. Sie ist kuerzer als die
// acht Dateien der Aufgabe, sie funktioniert genauso, und fuer ein
// Wochenendprojekt waere sie die richtige Wahl. Im Reiter Browser
// laesst sie sich wirklich bedienen. Steht die Liste einmal in der
// falschen Reihenfolge, beginnt die Suche in diesen sechzig Zeilen
// irgendwo zwischen Formular und Schleife.

session_start();
if (empty($_SESSION["token"])) {
    $_SESSION["token"] = bin2hex(random_bytes(16));
}

$db = new PDO("sqlite:" . __DIR__ . "/../daten.db", null, null, [
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
]);
$db->exec("CREATE TABLE IF NOT EXISTS notizen (id INTEGER PRIMARY KEY, titel TEXT NOT NULL, erledigt INTEGER NOT NULL DEFAULT 0)");
$db->exec("INSERT OR IGNORE INTO notizen (id, titel, erledigt) VALUES (1, 'Milch', 0), (2, 'Brot', 0), (3, 'Zahnpasta', 1)");

$pfad = parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH) ?: "";

if ($_SERVER["REQUEST_METHOD"] === "POST" && $pfad === "/notiz") {
    if (!hash_equals($_SESSION["token"], $_POST["token"] ?? "")) {
        http_response_code(403);
        echo "Ungültiges Token.";
        exit;
    }
    $text = trim($_POST["text"] ?? "");
    if ($text !== "") {
        $db->prepare("INSERT INTO notizen (titel) VALUES (:t)")->execute([":t" => $text]);
    }
    header("Location: /", true, 302);
    exit;
}

$notizen = $db->query("SELECT id, titel, erledigt FROM notizen ORDER BY id DESC")->fetchAll();
$offen = 0;
foreach ($notizen as $notiz) {
    if ($notiz["erledigt"] === 0) {
        $offen++;
    }
}

?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Notizbuch von Mia</title></head>
<body>
    <h1>Notizbuch von Mia</h1>
    <form method="post" action="/notiz">
        <input type="hidden" name="token" value="<?= htmlspecialchars($_SESSION["token"], ENT_QUOTES, "UTF-8") ?>">
        <p><label>Neue Notiz: <input type="text" name="text" size="30"></label> <button type="submit">Anlegen</button></p>
    </form>
    <p>Offen: <?= $offen ?> von <?= count($notizen) ?></p>
    <ul>
<?php foreach ($notizen as $notiz) { ?>
        <li><?= htmlspecialchars($notiz["titel"], ENT_QUOTES, "UTF-8") ?></li>
<?php } ?>
    </ul>
    <footer><p>Alle Notizen an einem Ort.</p></footer>
</body>
</html>

Im dritten Beispiel steht dieselbe Notizliste in einer einzigen Datei. Gut sechzig Zeilen, und sie tut dasselbe. Für ein Wochenendprojekt wäre sie die richtige Wahl.

Den Unterschied merkst du, wenn eine zweite Seite dazukommt, wenn zwei Leute gleichzeitig daran arbeiten, wenn jemand nur das Aussehen ändern soll oder wenn in einem halben Jahr eine Zahl nicht stimmt. In der einen Datei suchst du die Zahl dann zwischen Formular und Liste. In der Struktur liegt die Rechnung in src/ und das Markup in ansichten/.

Was ein Framework hier noch dazutut

Router, Vorlagenfunktion, Konfiguration und Front Controller aus diesem Abschnitt bringen die großen Frameworks alle mit, dazu mehr:

  • einen Autoloader, der Klassen anhand ihres Namens findet, statt sie mit require einzusammeln, wie in Lektion 9.5; in dieser Anwendung fehlt er mit Absicht, damit die require-Zeilen sichtbar bleiben,
  • ein Request- und ein Response-Objekt statt $_GET, $_POST und header(), was das Testen leichter macht,
  • Middleware, eine Kette von Schritten vor und nach der eigentlichen Funktion, für Anmeldung, Protokoll und Sitzung,
  • fertige Antworten auf Fragen, die hier noch gar nicht aufgekommen sind: Formularvalidierung, Übersetzungen, Migrationen für die Datenbank, Befehle für die Konsole.

Ein Framework lohnt sich, sobald du anfängst, diese Dinge selbst nachzubauen. In seiner Ordnerstruktur findest du dann wieder, was hier von Hand entstanden ist.

In der Aufgabe setzt du die Notizanwendung aus allen Ordnern zusammen, mit Formular, Sitzung und Token aus Abschnitt 15.

Zum Mitnehmen

Jede Sorte Datei hat ihren Ort: die Konfiguration, die Klassen unter src, die Vorlagen unter ansichten und im öffentlichen Ordner nur der Front Controller. Jede Anfrage nimmt denselben Weg durch diese Teile. Diesen Weg nimmt einem später ein Framework ab.

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

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.