Debugging

Der Debug Modus ist das wichtigste Tool zum Debuggen von Projekten. Wann immer Probleme mit einem Projekte auftauchen sollte immer zuerst der Debug-Mode aufgerufen werden! Das Monitoring erlaubt es, Websites im Browser auszuführen und so auch AJAX Code und weitere Dateiaufrufe zu testen. Der Systemcheck dient dazu, Fatal Errors sichtbar zu machen.

Der Debug-Modus ist das wichtigste Tool zum Debuggen eines Projekts und besonders hilfreich bei der Übernahme der Arbeit eines anderen Entwicklers. Wann immer Probleme mit einem Projekte auftreten sollte immer zuerst der Debug-Modus für die betreffende Seite aufgerufen werden! Er steht ausschließlich Usern mit Administrator-Rechten zur Verfügung und zeigt eine Liste aller verwendeten Templates und mögliche Programmfehler die bei der Erstellung einer Seite aufgetreten sind. Sollten keine Zugangsdaten vorhanden sein besteht für Entwickler die Möglichkeit, sich als SUPERADMIN anzumelden. Die Debug-Query wird einfach an den zu untersuchenden Link im Frontend angehängt:

http://www.meine-seite.de/?debug
http://www.meine-seite.de/impressum.html?debug

Das Monitoring dient zum Testen aller Dateien die im Zusammenhang mit einer Seite aufgerufen wurden. Im Gegensatz zum Debug Modus wird die aktuelle Seite während des Monitorings tatsächlich im Client-Browser ausgeführt. Das beinhaltet interne Weiterleitungen ebenso wie Ajax Code und sämtliche Javascript Anweisungen. Durch Click eines Links innerhalb des Monitorings gelangt man direkt in den Debug Modus dieser Seite. Nach dem START des Monitorings werden alle Seiten erfasst die bis zum ENDE des Monitorings aufgerufen wurde. Der START erfolgt durch die im Backend hinterlegte URL Query nach folgendem Muster:

http://www.meine-seite.de/?monitor
http://www.meine-seite.de/impressum.html?monitor

An der unteren Bildschirmkante befindet sich eine Icon-Leiste zur Steuerung des Monitorings. Das ENDE und die Auswertung des Monitorings kann mittels des Buttons Show Result aufgerufen werden. Für den Fall dass das Monitoring für andere Dateitypen als HTML aufgerufen wird oder für den Fall dass es während des Monitorings zu einer Weiterleitung kommt (wie z.B. auch beim Absenden eines Formulars) und die Icon-Leiste in Folge dessen nicht sichtbar ist, kann das Ergebnis mit diesem Link manuell aufgerufen werden:

http://www.meine-seite.de/?monitor=show

Für den Fall dass ein FATAL ERROR zur Ausgabe einer blanken Seite führt, hilft der Systemcheck, den Fehler zu lokalisieren. Er aktiviert die Fehlerausgabe und macht mögliche Programm-Fehler sichtbar. Sollten keine schweren Fehler vorhanden sein wird die aktuelle Seite in ihrer bisherigen Form angezeigt. Der Aufruf erfolgt über folgenden Link:

http://www.meine-seite.de/?system

Innerhalb der Anwendung können folgende Funktionen genutzt werden, um Testwerte auszugeben.

VAL()

Funktion zur Ausgabe von Testwerten innerhalb des Programmcodes. Es können bis zu sieben Werte übergeben werden. Die Ausgabe erfolgt im Debug-Modus und gibt neben den zu testenden Werten auch Informationen zum Typ der Werte zurück.

VAL(1, "testwert", array(1, 2, 3));

ERR()

Mittels der Error-Funktion besteht die Möglichkeit, eigene Fehlermeldungen in das Error-Reporting einfließen zu lassen. Wird die Funktion innerhalb eines Templates aufgerufen erfolgt ein Eintrag in das Errorlog.

ERR("Zu viele Aufrufe der Fehlerseite");

XXX()

Diese Funktion kann genutzt werden, um innerhalb von Templates Kommentare einzufügen. Die Kommentare werden dann auch innerhalb des Debug-Modus ausgegeben und sorgen so zur besseren Verständlichkeit des Seitenaufbaus. Zum Beispiel:

XXX("Initialisierung der Module");

Es gibt verschiedene Stufen, Programmfehler und System-Warnungen auszugeben. Die Ausgabe erfolgt nur für angemeldete User mit Administrator-Rechten. Diese Meldungen können entweder unterdrückt werden oder es erfolgt die sofortige Ausgabe jedes Fehlers. Per Default werden Warnungen nur auf der Seite ausgegeben auf der der Fehler aufgetreten ist. Zusätzlich werden die Meldungen in einer Logdatei gespeichert. Die Einstellungen können in der System-Konfiguration geändert werden. Der Aufruf der Logdatei erfolgt über die Startseite des Backends (nur möglich wenn tatsächlich Fehler aufgetreten sind) oder manuell über folgenden Link:

http://www.meine-seite.de/?error

Gelegentlich treten Programmfehler nur in Zusammenhang mit bestimmten Browsern auf. Die Konfiguration des Client-Browsers kann mit Hilfe des folgenden Aufrufs abgefragt werden. Um die Lokalisierung eines Fehlers auf jedem Computer zu ermöglichen ist diese Funktion dauerhaft aktiviert. Die URL-Query kann jedoch in den System-Einstellungen geändert werden.

http://meine-seite.de/?client
http://meine-seite.de/impressum.html?client