PHP Highlighter

[steffenk]

Um PHP Quelltext in HTML-Seiten darzustellen, gibt es eine eigene PHP-Funktion, die das für einen erledigt.
Die Funktion heisst highlight_string. Sie wandelt den Quelltext um - die htmlentities werden maskiert und die Farbinformationen werden mittels der in der php.ini angegebenen Farben umgewandelt.

Leider benutzt die Funktion die veraltete Font-Funktion (bei PHP-Versionen < 5)
(<font color="#ff0000">...</font>)

Hat man ein CSS-Design, so stören diese veralteten Tags.

Aus diesem Grund habe ich eine kleine Funktion geschrieben, die diese Tags durch spans ersetzt. Die Funktion zum highlighten ist integriert, so das man einfach diese Funktion statt der Standarfunktion aufrufen kann. Der Syntax ist genau der gleiche:

php_highlight($source);
oder
$var=php_highlight($source,true);

Die Font-Angaben werden in spans mit Klassenangaben umgewandelt. Dadurch ist man sogar in der Lage, ein eigenes Farbschema zu benutzen.
Möchte man die Standardfarben benutzen, so muss man nur vorher die Funktion GetHighlightCSS() auszugeben, es wird die CSS-Definition geschrieben.

Natürlich kann man das auch in seine CSS auslagern.

Zusätzlich habe ich noch die Zeichen <br /> und &nbsp; ersetzt, wer es anders möchte, kann es leicht ändern.

function php_highlight($source,$no_echo=false) {
    $search=Array('<font color="'.ini_get('highlight.bg').'">',
              '<font color="'.ini_get('highlight.html').'">',
              '<font color="'.ini_get('highlight.default').'">',
              '<font color="'.ini_get('highlight.keyword').'">',
              '<font color="'.ini_get('highlight.string').'">',
              '<font color="'.ini_get('highlight.comment').'">',
              '</font>',
              '&nbsp;',
              '<br />');
    $replace=Array('<span class="highlight-bg">',
               '<span class="highlight-html">',
               '<span class="highlight-default">',
               '<span class="highlight-keyword">',
               '<span class="highlight-string">',
               '<span class="highlight-comment">',
               '</span>',
               ' ',
               "\n");
    
    $highlightstring=str_replace($search, $replace, highlight_string($source,true));
    if($no_echo) 
        return $highlightstring;
    else echo $highlightstring;
}

function GetHighlightCSS() {
    $linebreak="\n";
    $s="/* Highlight Definition for Inline-Elements */$linebreak
.highlight-bg {color: ".ini_get('highlight.bg').";}$linebreak
.highlight-html {color: ".ini_get('highlight.html').";}$linebreak
.highlight-default {color: ".ini_get('highlight.default').";}$linebreak
.highlight-keyword {color: ".ini_get('highlight.keyword').";}$linebreak
.highlight-string {color: ".ini_get('highlight.string').";}$linebreak
.highlight-comment {color: ".ini_get('highlight.comment').";}$linebreak
$linebreak";
    return $s;
} 

Und hier die Ersetzung für PHP >= 5 :

function php_highlight($source,$no_echo=false) {
    $search=Array('style="color: '.ini_get('highlight.bg').'"',
              'style="color: '.ini_get('highlight.html').'"',
              'style="color: '.ini_get('highlight.default').'"',
              'style="color: '.ini_get('highlight.keyword').'"',
              'style="color: '.ini_get('highlight.string').'"',
              'style="color: '.ini_get('highlight.comment').'"',
              ' ',
              '<br />');
    $replace=Array('class="highlight-bg"',
               'class="highlight-html"',
               'class="highlight-default"',
               'class="highlight-keyword"',
               'class="highlight-string"',
               'class="highlight-comment"',
               ' ',
               "\n");
    
    $highlightstring=str_replace($search, $replace, highlight_string($source,true));
    if($no_echo) 
        return $highlightstring;
    else echo $highlightstring;
}

function GetHighlightCSS() {
    $linebreak="\n";
    $s="/* Highlight Definition for Inline-Elements */$linebreak
.highlight-bg {color: ".ini_get('highlight.bg').";}$linebreak
.highlight-html {color: ".ini_get('highlight.html').";}$linebreak
.highlight-default {color: ".ini_get('highlight.default').";}$linebreak
.highlight-keyword {color: ".ini_get('highlight.keyword').";}$linebreak
.highlight-string {color: ".ini_get('highlight.string').";}$linebreak
.highlight-comment {color: ".ini_get('highlight.comment').";}$linebreak
$linebreak";
    return $s;
} 

[steffenk]

Hier ein kleiner Zusatz, wenn man auch HTML-Schnipsel einfärben will.
Das Script ist nicht perfekt, es kann keine komplexen Verschachtelungen. Für einfache Schnipsel reicht es allemal.

Zuerst die nötige CSS-Definition:

.html-highlight-bg {color: #000080;}
.html-highlight-comment {color: #808080;}
.html-highlight-string {color: #0000ff;}
.html-highlight-img {color: #800080;}
.html-highlight-object {color: #808000}
.html-highlight-table {color: #008080;}
.html-highlight-form {color: #ff8000;}
.html-highlight-text {color: #000000;}

und die Funktion, die das Highlighting übernimmt:

function HTML_Highlight($source,$no_echo=false) {
    $tmp=htmlentities($source);
    //text
    $tmp=preg_replace("/&gt;(.*)&lt;/Ui", "&gt;<span class=\"html-highlight-text\">\\1</span>&lt;",$tmp);
    //Strings
    $tmp=preg_replace("/&quot;(.*)&quot;/Ui", "<span class=\"html-highlight-string\">&quot;\\1&quot;</span>",$tmp);
    //Kommentare
    $tmp=preg_replace("/&lt;!--(.*)--&gt;/Ui", "<span class=\"html-highlight-comment\">&lt;!--\\1--&gt;</span>",$tmp);
    //table,form,img
    $tmp=preg_replace("/&lt;input(.*)&gt;/Ui", "<span class=\"html-highlight-form\">&lt;input\\1&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;select(.*)&gt;/Ui", "<span class=\"html-highlight-form\">&lt;select\\1&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;option(.*)&gt;/Ui", "<span class=\"html-highlight-form\">&lt;option\\1&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;textarea(.*)&gt;/Ui", "<span class=\"html-highlight-form\">&lt;textarea\\1&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;img(.*)&gt;/Ui", "<span class=\"html-highlight-img\">&lt;img\\1&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;map(.*)\/map&gt;/Ui", "<span class=\"html-highlight-img\">&lt;map\\1/map&gt;</span>",$tmp);
    $tmp=preg_replace("/&lt;object(.*)\/object&gt;/Ui", "<span class=\"html-highlight-object\">&lt;object\\1/object&gt;</span>",$tmp);
    $search=Array('&lt;table',
                  '&lt;/table&gt;',
                  '&lt;form',
                  '&lt;/form&gt;');
    $replace=Array('<span class="html-highlight-table">&lt;table',
                  '&lt;/table&gt;</span>',
                  '<span class="html-highlight-form">&lt;form',
                  '&lt;/form&gt;</span>');
    $tmp=str_replace($search, $replace,$tmp);
    $highlightstring='<code><span class="html-highlight-bg">'.$tmp.'</span></code>';
    if($no_echo) 
        return $highlightstring;
    else echo $highlightstring;
} 

[Jakob]

So ein Ding ist gut. Danke.
Es hat mich nämlich schon irre gestört da PHP doch schon überall XML konforme Tags verwendet und dann mit font kommt ...

Wenn ich aber jetzt "gemischten" Code habe, also php und html, dann muss ich zuerst die php Bereiche mit RegExp ausfindeig machen, oder wie kann man das Multi-Highlighten?

[fettmme]

Danke

[steffenk]

@Jacob: Multihighlighten können die Routinen nicht. Aber man kann die Strings ja zerlegen, es gibt ja die PHP Start- und Endtags. Das sollte kein Problem sein.

[Jakob]

Ja, das hab ich eben gemacht. Und es klappt gut.

[hero-master]

Hi Steffen
Ich verstehe nun einige Dinge noch nicht ganz
Der Code wird angezeigt und wiedergegebn, soweit alles gut

Frage1:
Wie mache ich das mit dem GetHighlightCSS() ?
Das klappt bei mir noch nicht so wirklich

Frage2 (Schönheitsfrage ):
Kann man die <span>s auch untereinander anordnen lassen?
Danke

[steffenk]

Hi Nico,

zu 1: das sind nur die CSS-Definitionen.
Aufgerufen wird das z.B. so:

echo '<style type="text/css">'.GetHighlightCSS().'</style>'; 

Man kann sich das auch kopieren und in eine CSS auslagern. Bei dieser Funktion werden halt die Standardfarben aus der php.ini ausgelesen.

zu 2: das kannst Du natürlich ergänzen, dazu brauchst Du lediglich hinter </span> einen Umbruch zufügen, also z.B. "</span>\n"

[steffenk]

Und hier noch der Code für einen CSS-Highlighter.

Der Einfachheit halber hier die CSS-Anweisung:

.css-highlight-bg {color: #800080;}
.css-highlight-comment {color: #808080;}
.css-highlight-keywords {color: #0000ff;}
.css-highlight-elements {color: #ff0000;}
.css-highlight-values {color: #804040;}

und die Funktion zum Highlighten:

function CSS_Highlight($source,$no_echo=false) {
    $tmp=str_replace('"','"',htmlentities($source));    //comments
    $tmp=preg_replace('/\/\*(.*)\*\//Uis', '<span class="css-highlight-comment">/*\\1*/</span>',$tmp);
    //keywords
    $tmp=preg_replace('/\{(.*)\}/Uis', '{<span class="css-highlight-keywords">\\1</span>}',$tmp);
    //elements
    $tmp=preg_replace("/([^a]):(.*);/Uis", "\\1:<span class=\"css-highlight-elements\">\\2</span>;",$tmp);
    //values
    $tmp=preg_replace('/#(([0-9a-f]){6}|([0-9a-f]){3})/i','<span class="css-highlight-values">#\\1</span>',$tmp);
    $tmp=preg_replace('/(\d+)(px|em|pt|;)/Uis','<span class="css-highlight-values">\\1</span>\\2',$tmp);
    
    $highlightstring='<code><span class="css-highlight-bg">'.$tmp.'</span></code>';
    if($no_echo) 
        return $highlightstring;
    else echo $highlightstring;
} 

An dieser Stelle nochmal herzlichen Dank an StuckMojo für die Unterstützung bei den Echsen

[hero-master]

zu 1: das sind nur die CSS-Definitionen.
Aufgerufen wird das z.B. so:

echo '<style type="text/css">'.GetHighlightCSS().'</style>'; 

Danke

zu 2: das kannst Du natürlich ergänzen, dazu brauchst Du lediglich hinter </span> einen Umbruch zufügen, also z.B. "</span>\n"

Das hatte ich auch mal probiert und hat irgendwie nicht geklappt, hab wohl das Zeichen verkehrt herum reingeschrieben

     $replace=Array('<span class="highlight-bg">',
                '<span class="highlight-html">',
                '<span class="highlight-default">',
                '<span class="highlight-keyword">',
                '<span class="highlight-string">',
                '<span class="highlight-comment">',
                '</span>\n', 

Und noch ne Kleinigkeit:
Kann man irgendwie das <code> durch <pre> erstezen?

[steffenk]

ersetze '</span>\n' durch "</span>\n", sonst wird das nicht interpretiert.

Das <code> kann man im PHP-Highlighter nicht ersetzen, man kann es aber hinterher machen.
Beim HTML- und CSS-Highlighter ist es in der Funktion, da kannst Du es ersetzen.

Aber warum ? Du kannst das ganze doch zusätzlich in ein pre packen.

[hero-master]

ersetze '</span>\n' durch "</span>\n", sonst wird das nicht interpretiert.

Jop, danke
Habs aber nun doch so belassen, wegen dem pre

Aber warum ? Du kannst das ganze doch zusätzlich in ein pre packen.

Reine Neugierde

[steffenk]

Noch eine Anmerkung, die ich erst später festgestellt habe.

- Die CSS-Funktion erwartet hinter jeder Element-Zuweisung ein ;

Die PHP Version 4 reagiert anders als die PHP Version 5:

- Beim PHP highlight_string braucht die 4er-Version die Tags <?php und ?> , bei der 5er können die weggelassen werden.
- In der 4er-Version gehen die Einrückungen verloren, wenn man '&nbsp;' durch ' ' ersetzt.

Wer die Routinen in Aktion sehen möchte, kann sich das im dislabs-Labor anschauen.

[Dome]

jetzt hab ichs auch geblickt

[Dome]

ich wollt noch fragen, wie ich textbereiche auch farbig machen kann...
also ich mein sowas hier:

<?php
echo "Das wird hier Farbig angezeigt!";
?>