Abschnitt 16 · Lektion 2
Eine Vorlagenfunktion
Die Vorlage nennt ihre Schleifenvariable $titel, und die Seite hält ihre Überschrift ebenfalls in
$titel. Nach dem Einbinden der Vorlage trägt die Seite plötzlich einen anderen Namen, obwohl an
keiner der beiden Dateien für sich etwas falsch ist.
Eine eingebundene Datei sieht alles
<ul>
<?php foreach ($notizen as $titel): ?>
<li><?= e($titel) ?></li>
<?php endforeach; ?>
</ul> <?php
declare(strict_types=1);
// Die Vorlage in ansichten/liste.php benutzt $titel als
// Schleifenvariable, dort voellig harmlos gemeint. Nur heisst hier eine
// Variable genauso, und nach der Schleife steht in ihr etwas anderes
// als vorher. Ueberschrift und letzter Absatz zeigen den Unterschied.
function e(?string $wert): string
{
return htmlspecialchars($wert ?? "", ENT_QUOTES, "UTF-8");
}
$titel = "Einkaufsliste";
$notizen = ["Milch", "Brot", "Zahnpasta"];
?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Kollision</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1><?= e($titel) ?></h1>
<?php require __DIR__ . "/ansichten/liste.php"; ?>
<p>Diese Seite heißt: <?= e($titel) ?></p>
</body>
</html> require fügt eine Datei an der Stelle ein, an der es steht, so als hätte man ihren Inhalt dort
hingeschrieben. Die eingebundene Datei sieht damit jede Variable, die es an dieser Stelle gerade
gibt. Auch die, mit denen sie gar nichts zu tun hat.
Im ersten Beispiel benutzt die Vorlage $titel als Schleifenvariable. Für sich genommen ist das
harmlos. In index.php steht in einer Variable mit demselben Namen aber der Name der Seite, und
nach der Schleife steht darin Zahnpasta. So steht es dann auch im letzten Absatz der Seite. Die
Überschrift stimmt noch, weil sie vor dem require ausgegeben wurde.
Eine Warnung gibt es dabei nicht, und auf dem Fehlerkanal steht auch nichts. Die Seite ist einfach falsch, und an dieser Stelle vermutet niemand den Grund. Mit jeder weiteren Vorlage wird es wahrscheinlicher, dass in zwei Dateien etwas gleich heißt.
Eine Funktion ist ein eigener Raum
<ul>
<?php foreach ($notizen as $titel): ?>
<li><?= e($titel) ?></li>
<?php endforeach; ?>
</ul> <?php
declare(strict_types=1);
// Dieselbe Vorlage, dieselben Daten, dieselbe Ausgabe. Nur laeuft die
// Vorlage diesmal in einer Funktion, und was dort passiert, bleibt
// dort. Die Ueberschrift und der letzte Absatz stimmen wieder ueberein.
function e(?string $wert): string
{
return htmlspecialchars($wert ?? "", ENT_QUOTES, "UTF-8");
}
function zeige(string $datei, array $daten): void
{
extract($daten);
require $datei;
}
$titel = "Einkaufsliste";
$notizen = ["Milch", "Brot", "Zahnpasta"];
?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Eigener Raum</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1><?= e($titel) ?></h1>
<?php zeige(__DIR__ . "/ansichten/liste.php", ["notizen" => $notizen]); ?>
<p>Diese Seite heißt: <?= e($titel) ?></p>
</body>
</html> Was in einer Funktion passiert, bleibt in der Funktion. Das kennst du aus Lektion 6.4. Eine Funktion sieht die Variablen ihres Aufrufers nicht, und der Aufrufer sieht hinterher nichts von dem, was drinnen entstanden ist.
Im zweiten Beispiel bindet deshalb eine Funktion die Vorlage ein, nämlich zeige(). Sie bekommt den
Pfad der Vorlage und ein Array mit den Daten. Die Vorlage läuft jetzt innerhalb der Funktion und
kann draußen nichts mehr anrichten. Überschrift und Absatz passen wieder zusammen, obwohl sich an
der Vorlage kein einziges Zeichen geändert hat und sie noch genau dieselbe Schleifenvariable benutzt
wie vorher.
extract($daten) macht aus dem Array einzelne Variablen. Aus ["notizen" => [...]] wird
$notizen. Das braucht es, damit in der Vorlage <?= e($notiz["titel"]) ?> stehen kann und nicht
<?= e($daten["notizen"][0]["titel"]) ?>. Mit fremden Daten ist extract gefährlich, denn es legt
Variablen an, deren Namen von außen kommen. Hier ist das Array aber deins, und im ganzen Projekt
steht der Aufruf in genau einer Zeile.
Die eine Falle, die bleibt
<p>Diese Vorlage kann sehen:</p>
<ul>
<li>$notizen: <?= isset($notizen) ? "ja" : "nein" ?></li>
<li>$titel (aus index.php): <?= isset($titel) ? "ja" : "nein" ?></li>
<li>$datei (Parameter von zeige): <?= isset($datei) ? "ja, " . basename($datei) : "nein" ?></li>
<li>$daten (Parameter von zeige): <?= isset($daten) ? "ja" : "nein" ?></li>
</ul> <?php
declare(strict_types=1);
// Ganz dicht ist die Abschirmung nicht. Was in index.php steht, bleibt
// draussen, was zeige() selbst dabei hat, seine eigenen beiden
// Parameter, ist drin. Und was die Vorlage ausgibt, faengt diesmal ein
// Puffer auf, bevor es auf die Seite kommt.
function zeige(string $datei, array $daten): void
{
extract($daten);
require $datei;
}
$titel = "Einkaufsliste";
$notizen = ["Milch", "Brot"];
ob_start();
zeige(__DIR__ . "/ansichten/spion.php", ["notizen" => $notizen]);
$bericht = ob_get_clean();
?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Wer sieht was</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1>Wer sieht was</h1>
<p>Aus dem Puffer kommen <?= mb_strlen($bericht) ?> Zeichen:</p>
<?= $bericht ?>
</body>
</html> Ganz dicht ist die Funktion nicht. $titel aus index.php sieht die Vorlage zwar nicht mehr, dafür
aber alles, was die Funktion selbst dabeihat, also ihre beiden Parameter $datei und $daten.
Benutzt eine Vorlage zufällig eine Variable $datei, steht darin ihr eigener Pfad. So passiert es
im dritten Beispiel.
Es geht auch andersherum. extract() überschreibt einen Parameter, wenn ein Schlüssel im Array
selbst datei heißt. Dann bindet zeige() die Datei ein, die in den Daten stand, und nicht die
verlangte. extract($daten, EXTR_SKIP) lässt vorhandene Variablen stehen und macht diesen Weg zu.
Gegen beides hilft meistens ein Name, den niemand aus Versehen benutzt, etwa $__vorlagenDatei
statt $datei. Verhält sich eine Vorlage einmal merkwürdig, suche ich als Erstes nach einem Namen,
den auch die Funktion um sie herum benutzt. In den Funktionen dieses Kurses stehen trotzdem die
lesbaren Namen $datei und $daten.
Aus der Ausgabe wird ein Text
Im dritten Beispiel steckt noch etwas, das zeige() allein nicht kann. Die Funktion schreibt die
Vorlage sofort hinaus, genau da, wo sie aufgerufen wird. Der Bericht soll aber erst gezählt und dann
eingesetzt werden. Dafür gibt es die Ausgabepufferung (englisch output buffering).
ob_start() schaltet sie ein. Alles, was danach ausgegeben wird, geht in einen Puffer statt zum
Browser. Aus „die Vorlage schreibt hinaus“ wird so „die Vorlage liefert einen Text“.
ob_get_clean() holt den Inhalt des Puffers ab, schaltet ihn wieder aus und gibt den Text zurück.
Im Beispiel liegt er danach in $bericht. Auf der Seite steht zuerst, wie viele Zeichen er hat, und
erst dann der Bericht selbst.
Liefert eine Vorlage einen Text, kannst du ihn in eine andere Vorlage einsetzen. Erst wird die Liste
gerendert, also aus Vorlage und Daten fertiges Markup gemacht. Dann kommt das Ergebnis in ein
Seitengerüst. So bauen Template-Engines ihre Layouts. Das sind Bibliotheken, die nichts anderes tun,
als Vorlagen mit Daten zu füllen. Eine Funktion, die den Puffer selbst um das Einbinden legt und den
Text zurückgibt, heißt in diesem Kurs rendere(), nach dem englischen render.
Das Maskieren gehört in die Vorlage
In der Vorlage steht e(), und zwar an jeder einzelnen Ausgabestelle, so wie in Lektion 15.2. Die
Vorlage gibt sonst nur aus. Also ist sie auch die einzige Stelle, an der man das Maskieren vergessen
kann. Eine kurze Datei liest du beim Nachsehen ganz.
In der Aufgabe sitzt rendere() schon zwischen der Notizliste und ihrer Vorlage. Nur der Rumpf
fehlt noch.
Zum Mitnehmen
Eine Vorlage, die mit require hereinkommt, sieht jede Variable der Seite und kann sie überschreiben. Eine Funktion mit extract, ob_start, require und ob_get_clean führt sie in einem eigenen Raum aus und gibt ihre Ausgabe als Text zurück. Sichtbar bleiben dort nur ihre eigenen Parameter, etwa datei.
Jetzt du
Basis Konto, kostenlosZu 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.