Zend_Log-Writers.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 19493 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.log.writers" xmlns:xi="http://www.w3.org/2001/XInclude">
  5. <title>Writer</title>
  6. <para>
  7. Ein Writer ist ein Objekt das von <classname>Zend_Log_Writer_Abstract</classname> abstammt. Die
  8. Aufgabe eines Writer's ist es Log Daten in ein Speicher-Backend aufzunehmen.
  9. </para>
  10. <sect2 id="zend.log.writers.stream">
  11. <title>In Streams schreiben</title>
  12. <para>
  13. <classname>Zend_Log_Writer_Stream</classname> sendet Log Daten in einen
  14. <ulink url="http://www.php.net/stream">PHP Stream</ulink>.
  15. </para>
  16. <para>
  17. Um Log Daten in den PHP Ausgabebuffer zu schreiben, muß die URL <code>php://output</code>
  18. verwendet werden. Alternativ können Log Daten direkt an einen Stream wie z.B.
  19. <constant>STDERR</constant> (<code>php://stderr</code>) gesendet werden.
  20. <programlisting language="php"><![CDATA[
  21. $writer = new Zend_Log_Writer_Stream('php://output');
  22. $logger = new Zend_Log($writer);
  23. $logger->info('Informational message');
  24. ]]></programlisting>
  25. </para>
  26. <para>
  27. Um Daten in eine Datei zu schreiben, muß eine der
  28. <ulink url="http://www.php.net/manual/de/wrappers.php#wrappers.file">Dateisystem
  29. URLs</ulink> verwendet werden:
  30. <programlisting language="php"><![CDATA[
  31. $writer = new Zend_Log_Writer_Stream('/path/to/logfile');
  32. $logger = new Zend_Log($writer);
  33. $logger->info('Informative Nachricht');
  34. ]]></programlisting>
  35. Standardmäßig wird der Stream im Anhänge-Modus geöffnet (<code>"a"</code>). Um Ihn in einem
  36. anderen Modus zu öffnen, akzeptiert der <classname>Zend_Log_Writer_Stream</classname>
  37. Konstruktor einen optionalen zweiten Parameter für den Modus.
  38. </para>
  39. <para>
  40. Der Konstruktor von <classname>Zend_Log_Writer_Stream</classname> akzeptiert auch eine
  41. existierende Stream Ressource:
  42. <programlisting language="php"><![CDATA[
  43. $stream = @fopen('/path/to/logfile', 'a', false);
  44. if (! $stream) {
  45. throw new Exception('Stream konnte nicht geöffnet werden');
  46. }
  47. $writer = new Zend_Log_Writer_Stream($stream);
  48. $logger = new Zend_Log($writer);
  49. $logger->info('Informative Nachricht');
  50. ]]></programlisting>
  51. Der Modus kann für existierende Stream Ressourcen nicht definiert werden. Wenn das gemacht
  52. versucht wird, wird eine <classname>Zend_Log_Exception</classname> geworfen.
  53. </para>
  54. </sect2>
  55. <sect2 id="zend.log.writers.database">
  56. <title>In Datenbanken schreiben</title>
  57. <para>
  58. <classname>Zend_Log_Writer_Db</classname> schreibt Log Informationen in eine Datenbank Tabelle
  59. wobei <classname>Zend_Db</classname> verwendet wird. Der Konstrukor von
  60. <classname>Zend_Log_Writer_Db</classname> benötigt eine <classname>Zend_Db_Adapter</classname>
  61. Instanz, einen Tabellennamen, und ein Abbild der Datenbankspalten zu den Elementen der
  62. Eventdaten:
  63. <programlisting language="php"><![CDATA[
  64. $params = array ('host' => '127.0.0.1',
  65. 'username' => 'malory',
  66. 'password' => '******',
  67. 'dbname' => 'camelot');
  68. $db = Zend_Db::factory('PDO_MYSQL', $params);
  69. $columnMapping = array('lvl' => 'priority', 'msg' => 'message');
  70. $writer = new Zend_Log_Writer_Db($db, 'log_table_name', $columnMapping);
  71. $logger = new Zend_Log($writer);
  72. $logger->info('Informative Nachricht');
  73. ]]></programlisting>
  74. Das obige Beispiel schreibt eine einzelne Zeile von Log Daten in einem Datenbanktabelle welche
  75. <code>log_table_name</code> Tabelle benannt wird. Die Datenbankspalte welche <code>lvl</code>
  76. benannt ist empfängt die Nummer der Priorität und die Spalte welche <code>msg</code> benannt
  77. ist empfängt die Log Nachricht.
  78. </para>
  79. </sect2>
  80. <xi:include href="Zend_Log-Writers-Firebug.xml" />
  81. <xi:include href="Zend_Log-Writers-Mail.xml" />
  82. <xi:include href="Zend_Log-Writers-Syslog.xml" />
  83. <xi:include href="Zend_Log-Writers-ZendMonitor.xml" />
  84. <sect2 id="zend.log.writers.null">
  85. <title>Einen Writer abstumpfen</title>
  86. <para>
  87. <classname>Zend_Log_Writer_Null</classname> ist ein Stumpf der keine Log Daten irgendwohin
  88. schreibt. Er ist nützlich um die Protokollierung auszuschalten oder wärend Tests abzustumpfen:
  89. <programlisting language="php"><![CDATA[
  90. $writer = new Zend_Log_Writer_Null;
  91. $logger = new Zend_Log($writer);
  92. // geht nirgendwohin
  93. $logger->info('Informative Nachricht');
  94. ]]></programlisting>
  95. </para>
  96. </sect2>
  97. <sect2 id="zend.log.writers.mock">
  98. <title>Mit der Attrappe testen</title>
  99. <para>
  100. <classname>Zend_Log_Writer_Mock</classname> ist ein sehr einfacher Writer der die rohen Daten
  101. die er empfängt aufnimmt und in einem Array als öffentliche Eigenschaft zur Verfügung stellt.
  102. <programlisting language="php"><![CDATA[
  103. $mock = new Zend_Log_Writer_Mock;
  104. $logger = new Zend_Log($mock);
  105. $logger->info('Informative Nachricht');
  106. var_dump($mock->events[0]);
  107. // Array
  108. // (
  109. // [timestamp] => 2007-04-06T07:16:37-07:00
  110. // [message] => Informative Nachricht
  111. // [priority] => 6
  112. // [priorityName] => INFO
  113. // )
  114. ]]></programlisting>
  115. </para>
  116. <para>
  117. Um die Events die von der Attrappe protokolliert wurden zu entfernen, muß einfach
  118. <code>$mock->events = array()</code> gesetzt werden.
  119. </para>
  120. </sect2>
  121. <sect2 id="zend.log.writers.compositing">
  122. <title>Gemischte Writer</title>
  123. <para>
  124. Es gibt kein gemischtes Writer Objekt. Trotzdem kann eine Log Instanz in jede beliebige Anzahl
  125. von Writern schreiben. Um das zu tun, muß die <methodname>addWriter()</methodname> Methode
  126. verwendet werden:
  127. <programlisting language="php"><![CDATA[
  128. $writer1 = new Zend_Log_Writer_Stream('/path/to/first/logfile');
  129. $writer2 = new Zend_Log_Writer_Stream('/path/to/second/logfile');
  130. $logger = new Zend_Log();
  131. $logger->addWriter($writer1);
  132. $logger->addWriter($writer2);
  133. // Geht zu beiden Writern
  134. $logger->info('Informative Nachricht');
  135. ]]></programlisting>
  136. </para>
  137. </sect2>
  138. </sect1>