Text_Highlighter

Einführung

Mit dem Package Text_Highlighter können von verschiedene Dateiformate Syntax-Hervorhebungen erzeugt werden.

Derzeit werden folgende Formate unterstützt

• ABAP

• C++

• CSS

• Ausgabe des diff(1)-Programmes

• DTD

• HTML

• Java

• Javascript

• MySQL

• Perl

• PHP

• Python

• Ruby

• sh

• SQL

• VBScript

• XML

Es stehen verschiedene Renderer verwenden, um die Hervorhebungen darzustellen:

• Array

• Console

• HTML - es werden <span>-Tags mit CSS-Klassennamen verwendet, das ist der Standard-Renderer

• HTMLTags - es werden einfache Tags benutzt, (<B>, <I> und <U>, sinnvoll für Geräte mit nur geringer HTML-Unterstützung

• JSON

• XML

Verwendung

Die Klasse Text_Highlighter enthält alle notwendigen Funktionen um Text hervorzuheben mit Ausnahme der tatsächlichen Hervorhebungs-Regeln für die verschiedenen Formate. Diese Regeln sind in Unterklassen von Text_Highlighter definiert. Die Unterklassen werden nicht direkt vom Anwender aufgerufen, stattdessen wird über eine Factory-Methode die entsprechende Klasse aufgrund des gewählten Formates herangezogen:

<?php
require_once "Text/Highlighter.php";

$hlSQL =& Text_Highlighter::factory("SQL");
echo $hlSQL->highlight("SELECT * FROM some_table WHERE id = 12");
?>

Für andere Formate muss der SQL-Parameter in der Methode Text_Highlighter::factory durch einen entsprechend anderen ersetzt werden: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, oder XML.

Anpassung der Ausgabe

Normalerweise fügt Text_Highlighter HTML-Code in die ursprüngliche Eingabe ein, um die Hervorhebung um zu setzen.

Andere Ausgabeformate sind aber möglich, z.B. werden auch farb-taugliche Kommandozeilenkonsolen unterstützt wie xterm oder über less(1). Dazu muss Text_Highlighter angewiesen werden einen anderen Renderer zu verwenden:

<?php
require_once "Text/Highlighter.php";
require_once "Text/Highlighter/Renderer/Console.php";

$hlSQL =& Text_Highlighter::factory("SQL");
$hlSQL->setRenderer(new Text_Highlighter_Renderer_Console);
echo $hlSQL->highlight("SELECT * FROM some_table WHERE id = 12");
?>

Es ist gleichfalls möglich die Ausgabe des HTML- und Konsolen-Renders anzupassen. Dazu kann im Konstruktor des Renderers ein assoziatives Array übergeben werden, dass entsprechende Optionen enthält:

<?php
require_once "Text/Highlighter.php";
require_once "Text/Highlighter/Renderer/Html.php";

$renderer = new Text_Highlighter_Renderer_Html(array("numbers" => HL_NUMBERS_IL, "tabsize" => 4));

$hlJava =& Text_Highlighter::factory("JAVA");
$hlJava->setRenderer($renderer);

echo $hlJava->highlight('class JavaProgram {
    public static void main(String args[]) {
        System.out.println("Hello World!");
    }
}');
?>

Folgende Optionen werden derzeit unterstützt: