highlight_file()

In diesem Artikel konzentrieren wir uns auf die PHP-Funktion highlight_file(). Wir geben Ihnen einen Überblick über die Funktion, ihre Funktionsweise und Beispiele für ihre Verwendung.

Einführung in die highlight_file()-Funktion

Die Funktion highlight_file() ist eine eingebaute PHP-Funktion, die eine PHP-Quelldatei mit farblich hervorgehobener Syntax als HTML ausgibt. Sie ist praktisch, wenn Sie den Inhalt eines Skripts auf einer Webseite anzeigen möchten – zum Beispiel in einem Tutorial, einer Code-Snippet-Galerie oder einer einfachen Dokumentation – ohne einen eigenen Highlighter schreiben zu müssen.

Syntax

highlight_file(string $filename, bool $return = false): string|bool

• $filename — der Pfad zur PHP-Datei, die Sie anzeigen möchten.
• $return — wenn false (Standard) wird das hervorgehobene HTML direkt an den Ausgabepuffer gesendet und die Funktion gibt true zurück. Wenn true, wird das HTML als string zurückgegeben anstatt ausgegeben zu werden.

Intern tokenisiert PHP die Datei und umschließt jedes Token (Schlüsselwörter, strings, Kommentare usw.) mit <span>-Elementen, deren Inline-Farben aus den highlight.*-Direktiven in php.ini stammen.

Sicherheitshinweis: highlight_file() gibt den Rohquellcode einer Datei preis, einschließlich etwaiger Zugangsdaten, API-Schlüssel oder Datenbankpasswörter. Zeigen Sie niemals auf eine Datei, die auf nicht validierter Benutzereingabe basiert, und setzen Sie die Funktion nie für Dateien ein, die Geheimnisse enthalten.

Verwendung der highlight_file()-Funktion

Die Verwendung der Funktion highlight_file() ist sehr einfach. Sie müssen lediglich die Funktion aufrufen und den Dateinamen der PHP-Datei übergeben, die Sie hervorheben möchten. Hier ist ein Beispiel:

Wie verwendet man die highlight_file()-Funktion?

<?php
$file = 'example.php';
highlight_file($file);
?>

In diesem Beispiel enthält $file den Pfad des Skripts, das wir anzeigen möchten. Wenn example.php Folgendes enthält:

<?php
$name = "World";
echo "Hello, $name!";

gibt highlight_file($file) ein HTML ähnlich wie dieses aus (Farben kommen von Inline-style-Attributen, hier zur besseren Lesbarkeit gekürzt):

<pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$name </span><span style="color: #007700">= </span><span style="color: #DD0000">"World"</span><span style="color: #007700">;
echo </span><span style="color: #DD0000">"Hello, $name!"</span><span style="color: #007700">;</span></code></pre>

Die Funktion umschließt alles bereits in einem <pre><code>-Block, sodass die ursprünglichen Zeilenumbrüche und Einrückungen im Browser erhalten bleiben, ohne dass Sie zusätzliche Markup-Elemente hinzufügen müssen.

Anpassung der Ausgabe

Die Funktion highlight_file() bietet begrenzte eingebaute Anpassungsmöglichkeiten. Sie akzeptiert nur einen zweiten booleschen Parameter $return. Wenn dieser auf true gesetzt wird, gibt die Funktion das hervorgehobene HTML als string zurück, anstatt es direkt an den Browser auszugeben.

Dies ist nützlich, wenn Sie das Markup nachverarbeiten, zwischenspeichern oder in eine größere Vorlage einbetten möchten, anstatt es sofort auszugeben. Hier ist ein Beispiel, wie Sie die Ausgabe erfassen können:

Beispiel zur Erfassung der Ausgabe

<?php
$file = 'example.php';
$highlighted = highlight_file($file, true);

// $highlighted is already a complete <pre><code>...</code></pre> block,
// so you can store it, insert it into a template, or echo it directly.
echo $highlighted;
?>

Sie können die Farben global ändern, indem Sie die Direktiven highlight.comment, highlight.default, highlight.html, highlight.keyword und highlight.string in php.ini (oder zur Laufzeit mit ini_set()) setzen, aber die Funktion gibt immer Inline-Stile aus — es gibt keine Möglichkeit, CSS-Klassen zu erzeugen.

Wenn Sie eine erweiterte Anpassung benötigen (benutzerdefinierte CSS-Klassen, Zeilennummern oder andere Farbschemata), ist highlight_file() nicht das richtige Werkzeug:

• Um Code, der in einer string-Variable und nicht in einer Datei steht, hervorzuheben, verwenden Sie highlight_string().
• Um den Inhalt einer Datei zu lesen ohne Hervorhebung, verwenden Sie readfile() oder file_get_contents().
• Für vollständige Kontrolle über die Ausgabe erstellen Sie einen eigenen Highlighter auf Basis von PHPs token_get_all() oder verwenden Sie eine Drittanbieter-Bibliothek wie highlight.js oder Prism im Frontend.

Fazit

Zusammenfassend lässt sich sagen, dass die Funktion highlight_file() ein unkompliziertes Werkzeug zur Erzeugung von formatiertem PHP-Code mit Syntaxhervorhebung ist. Wenn Sie die tatsächlichen Parameter und Einschränkungen kennen, können Sie sie effektiv für die grundlegende Syntaxanzeige nutzen oder mit externen Tools für erweiterte Formatierungsanforderungen kombinieren.

Übung