| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed with | |
| this work for additional information regarding copyright ownership. | |
| The ASF licenses this file to You under the Apache License, Version 2.0 | |
| (the "License"); you may not use this file except in compliance with | |
| the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| --> | |
| <document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> | |
| <properties> | |
| <title>LoggerAppenderFirePHP</title> | |
| </properties> | |
| <body> | |
| <section name="LoggerAppenderFirePHP"> | |
| <p><code>LoggerAppenderFirePHP</code> logs events via the | |
| <a href="http://www.firephp.org/" class="external">FirePHP</a> serverside library. The messages are | |
| logged in HTTP headers and can be viewed using the <a class="external" | |
| href="http://developercompanion.com/">Developer compainion</a> plugin for Firefox.</p> | |
| <p>Requires the FirePHP server-side library 1.0 or greater. Download it from <a class="external" | |
| href="http://sourcemint.com/github.com/firephp/firephp/1:1.0.0b1rc6/-docs/Welcome">here</a>.</p> | |
| <div class="alert"> | |
| <strong>Warning!</strong> This appender is still experimental. Behaviour may change in future versions | |
| without notification. | |
| </div> | |
| <subsection name="Layout"> | |
| <p>This appender requires a layout. If no layout is specified in configuration, | |
| <code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code> will be used by default.</p> | |
| </subsection> | |
| <subsection name="Parameters"> | |
| <p>The following parameters are available:</p> | |
| <table> | |
| <thead> | |
| <tr> | |
| <th>Parameter</th> | |
| <th>Type</th> | |
| <th>Required</th> | |
| <th>Default</th> | |
| <th>Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td>target</td> | |
| <td>string</td> | |
| <td>No</td> | |
| <td>page</td> | |
| <td>The target to which messages will be sent. Possible options are 'page' (default), | |
| 'request', 'package' and 'controller'. For more details, see FirePHP | |
| documentation.</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </subsection> | |
| <subsection name="Examples"> | |
| <p>Sample configuration:</p> | |
| <div class="auto-tabs"> | |
| <ul> | |
| <li>XML</li> | |
| <li>PHP</li> | |
| </ul> | |
| <div class="tab-content" > | |
| <div class="tab-pane"> | |
| <pre class="prettyprint"><![CDATA[ | |
| <configuration xmlns="http://logging.apache.org/log4php/"> | |
| <appender name="default" class="LoggerAppenderFirePHP"> | |
| <layout class="LoggerLayoutSimple" /> | |
| </appender> | |
| <root> | |
| <appender_ref ref="default" /> | |
| </root> | |
| </configuration> | |
| ]]></pre> | |
| </div> | |
| <div class="tab-pane"> | |
| <pre class="prettyprint"><![CDATA[ | |
| array( | |
| 'appenders' => array( | |
| 'default' => array( | |
| 'class' => 'LoggerAppenderFirePHP', | |
| 'layout' => array( | |
| 'class' => 'LoggerLayoutSimple', | |
| ), | |
| ), | |
| ), | |
| 'rootLogger' => array( | |
| 'appenders' => array('default'), | |
| ), | |
| ); | |
| ]]></pre> | |
| </div> | |
| </div> | |
| </div> | |
| </subsection> | |
| </section> | |
| </body> | |
| </document> |