Programmer's Reference Guide
| Übersicht |
Writer
Ein Writer ist ein Objekt das von Zend_Log_Writer_Abstract abstammt. Die Aufgabe eines Writer's
ist es Log Daten in ein Speicher-Backend aufzunehmen.
In Streams schreiben
Zend_Log_Writer_Stream sendet Log Daten in einen
» PHP Stream.
Um Log Daten in den PHP Ausgabebuffer zu schreiben, muß die URL php://output verwendet werden.
Alternativ kann es gewünscht sein Log Daten direkt an einen Stream zu senden wie z.B. STDERR
(php://stderr).
$writer = new Zend_Log_Writer_Stream('php://output');
$logger = new Zend_Log($writer);
$logger->info('Informational message');
Um Daten in eine Datei zu schreiben, muß eine der » Dateisystem URLs verwendet werden:
$writer = new Zend_Log_Writer_Stream('/path/to/logfile');
$logger = new Zend_Log($writer);
$logger->info('Informative Nachricht');
"a"). Um Ihn in einem anderen Modus
zu öffnen, akzeptiert der Zend_Log_Writer_Stream Konstruktor einen optionalen zweiten Parameter für den
Modus.
Der Konstruktor von Zend_Log_Writer_Stream akzeptiert auch eine existierende Stream Ressource:
$stream = @fopen('/path/to/logfile', 'a', false);
if (! $stream) {
throw new Exception('Stream konnte nicht geöffnet werden');
}
$writer = new Zend_Log_Writer_Stream($stream);
$logger = new Zend_Log($writer);
$logger->info('Informative Nachricht');
Zend_Log_Exception geworfen.
In Datenbanken schreiben
Zend_Log_Writer_Db schreibt Log Informationen in eine Datenbank Tabelle wobei Zend_Db
verwendet wird. Der Konstrukor von Zend_Log_Writer_Db benötigt eine Zend_Db_Adapter
Instanz, einen Tabellennamen, und ein Abbild der Datenbankspalten zu den Elementen der Eventdaten:
$params = array ('host' => '127.0.0.1',
'username' => 'malory',
'password' => '******',
'dbname' => 'camelot');
$db = Zend_Db::factory('PDO_MYSQL', $params);
$columnMapping = array('lvl' => 'priority', 'msg' => 'message');
$writer = new Zend_Log_Writer_Db($db, 'log_table_name', $columnMapping);
$logger = new Zend_Log($writer);
$logger->info('Informative Nachricht');
log_table_name Tabelle benannt wird. Die Datenbankspalte welche lvl benannt ist
empfängt die Nummer der Priorität und die Spalte welche msg benannt ist empfängt die Log Nachricht.
An Firebox schreiben
Zend_Log_Writer_Firebug sendet Logdaten an die
» Firebug
» Console.

Alle Daten werden über die Zend_Wildfire_Channel_HttpHeaders Komponente gesendet welche
HTTP Header verwendet um sicherzustellen das der Seiteninhlat nicht verändert wird. Das Debuggen
von AJAX Anfragen die klare JSON und XML Antworten benötigen ist mit diesem Vorgehen möglich.
Notwendigkeiten:
-
Ein Firefox Browser idealerweise Version 3 aber auch Version 2 wird unterstützt.
-
Die Firebug Firefox Erweiterung welche unter » https://addons.mozilla.org/en-US/firefox/addon/1843 heruntergeladen werden kann.
-
Die FirePHP Filefox Erweiterung welche unter » https://addons.mozilla.org/en-US/firefox/addon/6149 heruntergeladen werden kann.
Beispiel #1 Loggen mit Zend_Controller_Front
// Platziere das in der Bootstrap Datei bevor der Frontcontroller ausgeführt wird
$writer = new Zend_Log_Writer_Firebug();
$logger = new Zend_Log($writer);
// Verwende das in den Modell, View, und Controller Dateien
$logger->log('Das ist eine Lognachricht!', Zend_Log::INFO);
Beispiel #2 Loggen ohne Zend_Controller_Front
$writer = new Zend_Log_Writer_Firebug();
$logger = new Zend_Log($writer);
$request = new Zend_Controller_Request_Http();
$response = new Zend_Controller_Response_Http();
$channel = Zend_Wildfire_Channel_HttpHeaders::getInstance();
$channel->setRequest($request);
$channel->setResponse($response);
// Ausgabe buffering starten
ob_start();
// Jetzt können Aufrufe an den Logger durchgeführt werden
$logger->log('Das ist eine Lognachricht!', Zend_Log::INFO);
// Logdaten an den Browser senden
$channel->flush();
$response->sendHeaders();
Setzen von Stilen für Prioritäten
Eingebaute und Benutzerdefinierte Prioritäten können mit der
setPriorityStyle() Methode angepasst werden.
$logger->addPriority('FOO', 8);
$writer->setPriorityStyle(8, 'TRACE');
$logger->foo('Foo Nachricht');
Der Standardstil für Benutzerdefinierte Prioritäten kann mit der
setDefaultPriorityStyle() Methode gesetzt werden.
$writer->setDefaultPriorityStyle('TRACE');
Die unterstützten Stile sind wie folgt:
| Stil | Beschreibung |
|---|---|
LOG |
Zeigt eine reine Lognachricht an |
INFO |
Zeigt eine Info Lognachricht an |
WARN |
Zeigt eine Warnungs Lognachricht an |
ERROR |
Zeigt eine Fehler Lognachricht an die den Fehlerzählen von Firebug erhöht |
TRACE |
Zeigt eine Lognachricht mit einem erweiterbaren Stack Trace an |
EXCEPTION |
Zeigt eine lange Fehlernachicht mit erweiterbarem Stack Trace an |
TABLE |
Zeigt eine Lognachricht mit erweiterbarer Tabelle an |
Daten für das Loggen vorbereiten
Wärend jede PHP Variable mit den eingebauten Prioritäten geloggt werden kann, ist eine etwas spezielle Formatierung notwendig wenn einige der spezialisierteren Logstile verwendet werden.
Die LOG, INFO, WARN, ERROR und TRACE
Stile benötigen keine spezielle Formatierung.
Loggen von Ausnahmen
Um eine Zend_Exception zu loggen muß einfach das Exceptionobjekt an den Logger
übergeben werden. Es ist egal welche Priorität oder welcher Stil gesetzt wurde, da die Ausnahme
automatisch erkannt wird.
$exception = new Zend_Exception('Test Ausnahme');
$logger->err($exception);
Tabellen loggen
Man kann auch Daten loggen und diese in einem Table Stil formatieren. Spalten werden automatisch erkannt und die erste Zeile der Daten wird automatisch der Header.
$writer->setPriorityStyle(8, 'TABLE');
$logger->addPriority('TABLE', 8);
$table = array('Summary line for the table',
array(
array('Spalte 1', 'Spalte 2'),
array('Zeile 1 c 1','Zeile 1 c 2'),
array('Zeile 2 c 1',' Zeile 2 c 2')
)
);
$logger->table($table);
Einen Writer abstumpfen
Zend_Log_Writer_Null ist ein Stumpf der keine Log Daten irgendwohin schreibt. Er ist nützlich um
die Protokollierung auszuschalten oder wärend Tests abzustumpfen:
$writer = new Zend_Log_Writer_Null;
$logger = new Zend_Log($writer);
// geht nirgendwohin
$logger->info('Informative Nachricht');
Mit der Attrappe testen
Zend_Log_Writer_Mock ist ein sehr einfacher Writer der die rohen Daten die er empfängt aufnimmt
und in einem Array als öffentliche Eigenschaft zur Verfügung stellt.
$mock = new Zend_Log_Writer_Mock;
$logger = new Zend_Log($mock);
$logger->info('Informative Nachricht');
var_dump($mock->events[0]);
// Array
// (
// [timestamp] => 2007-04-06T07:16:37-07:00
// [message] => Informative Nachricht
// [priority] => 6
// [priorityName] => INFO
// )
Um die Events die von der Attrappe protokolliert wurden zu entfernen, muß einfach
$mock->events = array() gesetzt werden.
Gemischte Writer
Es gibt kein gemischtes Writer Objekt. Trotzdem kann eine Log Instanz in jede beliebige Anzahl von Writern
schreiben. Um das zu tun, muß die addWriter() Methode verwendet werden:
$writer1 = new Zend_Log_Writer_Stream('/path/to/first/logfile');
$writer2 = new Zend_Log_Writer_Stream('/path/to/second/logfile');
$logger = new Zend_Log();
$logger->addWriter($writer1);
$logger->addWriter($writer2);
// Geht zu beiden Writern
$logger->info('Informative Nachricht');
| Übersicht |
