FirePHP verwenden, eine Einführung

Das Firefox Add on Firebug kann mittels weiterer Add ons erweitert werden, ein seht nützlich für PHP-Entwickler und Nutzer kann Firebug sein. Allerdings muss man dazu einiges an Anpassungen vornehmen und da es in diesem Zusammenhang wohl Bedarf gibt, hier eine kurze Einführung, wie man Firebug verwendet und wo die Werte dann zu finden sind.

Mit PHP gibt es eine ganze Reihe von Möglichkeiten um die Ausgabe von Variablen während des Entwickeln zu gestalten, print_r() und var_dump() sind sicher die meist genutzten. Diese Möglichkeiten geben die Inhalte als HTML aus, direkt and er Stelle, wo sie eingebunden sind. Das hat den Nachteil, dass das Layout eventuell zerstört ist, dass die Ausgabe unübersichtlich wird und wenn man in einem Livebetrieb diese Möglichkeiten nutzt, dann is tdas nur schwer vor den anderen Usern zu verbergen. Mit dem Add on FirePHP bekommt der Entwickler ein Werkzeug, ohne Entwicklungsumgebung, welches diese Arbeit erleichtern kann und direkt im Browser verfügbar ist.
Nun aber in wenigen Schritten, wie man zur Integration des Firebug und der Ausgabe der Werte kommt.

Installation

Das Add on benötigt ein weiters Add on und ist nur im Browser Firefox verfügbar. Wer also nicht mit diesem Browser unterwegs ist, darum kommt man beim Entwickeln aktuell nicht dran vorbei, auch wenn sich andere Hersteller redlich bemühen. Installiert also den Browser Firefox und das Add on Firebug. Wer Firebug noch nicht kennt - damit kann man im Standard HTML, CSS und JavaScritp debuggen, analysieren und live editieren. Ist das abgeschlossen, so kann die Erweiterung FirePHP installiert werden. Die einzelnen Links führen euch zu den Installationen, welche einfach und schnell erledigt sind.

Ein Hinweis, FirePHP und dessen Library funktioniert nur mit PHP 5.

Nach dem alles installiert ist, findet man die Tools in der Systemleiste des Browser (zu erkennen am kleinen Käfer), per Klick oder F12 kann der Firebug aufgerufen werden. Nun kann schon mit den Standard-Tools gearbeitet werden; für die Verwendung von FirePHP muss man noch das PEAR-Paket bereit stellen. Die wenigsten Nutzer werden wohl einen eigenen Server haben, so dass die Umgebung für das Entwickeln von PHP-Anwendungen eher ein lokaler Server sein wird. Daher erkläre ich mal am Beispiel XAMPP, wie man FirePHP zum reden bringt.

1. Als erstes muss die Code-Libarary herunter geladen werden, zu finden auf der Webseite von FirePHP.
2. In diesem Download-Paket gibt es einen Ordner FirePHPCore, den man nach …\xampp\php\PEAR kopiert.
3. Hat man dies erledigt, dann muss man lediglich den Server starten bzw. neu starten, falls er schon lief.

Vorbereitung der Ausgabe

Nach dem nun die Bibliothek beriet steht, können wir sie in das Projekt implementieren. Dazu inkludet man die Datei und schon steht die wichtigste Funktion fb() bereit.

require('FirePHPCore/fb.php');

Nun empfiehlt sich noch das Puffern der Ausgabe und dann kann es schon los gehen. Aktuell steht also im Projekt die folgenden Zeilen.

<?php
require('FirePHPCore/fb.php');
ob_start();
?>

Die erste Ausgabe „Hello World“

Als erstes soll das gewohnte Neuland betreten werden, in dem wir „Hello World“ im FireBug ausgeben. Dazu erweitert man die obigen Zeilen um ein einfache Ausgabe mit der Funktion fb() von FirePHP.

<?php
require('FirePHPCore/fb.php');
ob_start();
fb('Hello World');
?>

Mit F12 den Firebug aktivieren und die Seite neu laden, dann sollte es ähnlich dem folgendem Screenshot bei euch aussehen.

Log Meldungen gestalten

Firebug kann aber mehr als pur die Meldungen ausgeben; dabei gibt es verschiedene Design-Möglichkeiten, die das Lesen der Ausgabe von Meldungen erleichtern und so verschiedene Typen für unterschiedliche Ausgaben zulassen.
Dazu den Code wieder ein wenig erweitern:

<?php
require('FirePHPCore/fb.php');
ob_start();
fb('Hello World');

fb('Log Mitteilung', FirePHP::LOG);
fb('Info Mitteilung', FirePHP::INFO);
fb('Warn Mitteilung', FirePHP::WARN);
fb('Error Mitteilung', FirePHP::ERROR);
?>

Array ausgaben

Nun aber weg von den kleinen Spielereien, zu einem sehr mächtigen Werkzeug, die Ausgabe von Arrays. Die Ausgabe soll an einer bekannten Variable gezeigt werden - $_SERVER.

$_SERVER ist ein Array, das Informationen wie Header, Pfade und die verschiedenen Wege, das Skript anzusprechen. Die Einträge in diesem Array werden vom Webserver erstellt.

Diese Variable wird nun mittels der Funktion fb() in FirePHP geloggt und kann daher inhaltlich gelesen werden. Bisher wurde die Funktion lediglich mit Text gefüttert und dieser wurde dann ausgeben, dass ändert sich nur soweit, dass man anstatt Text nun die Variable übergibt.
Der Syntax wird wieder erweitet:

<?php
require('FirePHPCore/fb.php');
ob_start();

fb($_SERVER, FirePHP::LOG);
?>

Nun wird im Firebug ein Array angezeigt, mit dem Wert 36. Ein MouseOver zeigt die Inhalte des Array in einem Extra Fenster, ein Klick stellt das Fenster permanent dar.

Erstellt man später mehrere Ausgaben, so ist es sinnvoll, wenn man eine Zuordnung hat. Daher lässt die Funktion fb() auch dafür einen Parameter zu.

fb($_SERVER, 'Server Variables', FirePHP::LOG);

Trace loggen

Als nächstes soll ein Trace erfolgen, so dass man alle Verbindungen sehen kann. Die WordPress-Nutzer sehen spätestens jetzt, dass ich für das Beispiel in einem WordPress-Theme debugge, was eigentlich schön zeigt, wie gut sich FirePHP integrieren lässt.

Dafür die folgende Erweiterung in den Code übernehmen.

<?php
require('FirePHPCore/fb.php');
ob_start();

fb('Backtrace to here', FirePHP::TRACE);
?>

Sehr schön kann man nun die Verbindungen sehen, die tabellarische Sicht gibt sehr schnell Auskunft und macht die Analyse zum Kinderspiel.

Fazit

Dieser kleine Einstieg zeigt die für mich wichtigsten Funktionen. FirePHP kann mehr und informiert darüber ausführlich auf der zugehörigen Website.
Ebenso lohnend ist das Tutorial von Dirk Henn „PHP mit Firebug debuggen“.