Zend_Log-Writers.xml 6.4 KB

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