src/site/xdoc/docs/layouts/xml.xml - logging-log4php - Git at Google

 <?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>LoggerLayoutXml</title>
 	</properties>

 	<body>
 		<section name="LoggerLayoutXml">

 			<p><code>LoggerLayoutXml</code> formats the messages as an XML document.</p>

 			<subsection name="Parameters" id="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>locationInfo</td>
 							<td>boolean</td>
 							<td>No</td>
 							<td>true</td>
 							<td>If set to true, adds the file name and line number at which the log statement originated.</td>
 						</tr>
 						<tr>
 							<td>log4jNamespace</td>
 							<td>boolean</td>
 							<td>No</td>
 							<td>false</td>
 							<td>If set to true then log4j XML namespace will be used instead of the log4php namespace.
 							This can be usefull when using log viewers which can only parse the log4j namespace such as
 							Apache Chainsaw.</td>
 						</tr>
 					</tbody>
 				</table>
 			</subsection>

 			<subsection name="Examples">

 				<h4>Default configuration example</h4>

 				<p>The default configuration of <code>LoggerLayoutXml</code> will use the log4php XML namespace and
 				include the location information.</p>

 				<p>Configuration file:</p>

 				<div class="auto-tabs">
 					<ul>
 						<li>XML</li>
 						<li>PHP</li>
 					</ul>

 					<div class="tab-content" >
 						<div class="tab-pane">
 <pre class="prettyprint linenums"><![CDATA[
 <configuration xmlns="http://logging.apache.org/log4php/">
     <appender name="default" class="LoggerAppenderEcho">
         <layout class="LoggerLayoutXml" />
     </appender>
     <root>
         <appender_ref ref="default" />
     </root>
 </configuration>
 ]]></pre>
 						</div>
 						<div class="tab-pane">
 <pre class="prettyprint linenums"><![CDATA[
 array(
     'appenders' => array(
         'default' => array(
             'class' => 'LoggerAppenderEcho',
             'layout' => array(
                 'class' => 'LoggerLayoutXml',
             )
         )
     ),
     'rootLogger' => array(
         'appenders' => array('default')
     ),
 )
 ]]></pre>
 						</div>
 					</div>
 				</div>


 				<p>Running the following code:</p>

 <pre class="prettyprint linenums">
 Logger::configure("config.xml");
 $logger = Logger::getLogger('myLogger');
 $logger->info("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
 $logger->debug("Donec a diam lectus.");
 $logger->warn("Sed sit amet ipsum mauris.");
 </pre>

 				<p>Produces the following output:</p>

 <pre class="prettyprint"><![CDATA[
 <log4php:eventSet xmlns:log4php="http://logging.apache.org/log4php/" version="0.3" includesLocationInfo="true">

 <log4php:event logger="myLogger" level="INFO" thread="4464" timestamp="1317215164482">
 <log4php:message><![CDATA[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
 <log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="5" method="main" />
 </log4php:event>

 <log4php:event logger="myLogger" level="DEBUG" thread="4464" timestamp="1317215164513">
 <log4php:message><![CDATA[Donec a diam lectus.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
 <log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="6" method="main" />
 </log4php:event>

 <log4php:event logger="myLogger" level="WARN" thread="4464" timestamp="1317215164514">
 <log4php:message><![CDATA[Sed sit amet ipsum mauris.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
 <log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="7" method="main" />
 </log4php:event>

 </log4php:eventSet>
 ]]></pre>


 				<h4>Overriding default options</h4>

 				<p>This example show how to configure <code>LoggerLayoutXml</code> to exclude the location information
 				and use the log4j XML namespace.</p>

 				<p>Configuration file:</p>

 <pre class="prettyprint"><![CDATA[
 <configuration xmlns="http://logging.apache.org/log4php/">
     <appender name="default" class="LoggerAppenderEcho">
         <layout class="LoggerLayoutXml">
         	<param name="locationInfo" value="false" />
         	<param name="log4jNamespace" value="true" />
         </layout>
     </appender>
     <root>
         <appender_ref ref="default" />
     </root>
 </configuration>
 ]]></pre>
 				<p>Using this configuration will produce the following output:</p>

 <pre class="prettyprint"><![CDATA[
 <log4j:eventSet xmlns:log4j="http://jakarta.apache.org/log4j/" version="0.3" includesLocationInfo="false">
 <log4j:event logger="myLogger" level="INFO" thread="3156" timestamp="1317216571470">
 <log4j:message><![CDATA[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
 </log4j:event>

 <log4j:event logger="myLogger" level="DEBUG" thread="3156" timestamp="1317216571471">
 <log4j:message><![CDATA[Donec a diam lectus.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
 </log4j:event>

 <log4j:event logger="myLogger" level="WARN" thread="3156" timestamp="1317216571471">
 <log4j:message><![CDATA[Sed sit amet ipsum mauris.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
 </log4j:event>

 </log4j:eventSet>
 ]]></pre>

 			</subsection>
 		</section>
 	</body>
 </document>
	<?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>LoggerLayoutXml</title>
	</properties>

	<body>
	<section name="LoggerLayoutXml">

	<p><code>LoggerLayoutXml</code> formats the messages as an XML document.</p>

	<subsection name="Parameters" id="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>locationInfo</td>
	<td>boolean</td>
	<td>No</td>
	<td>true</td>
	<td>If set to true, adds the file name and line number at which the log statement originated.</td>
	</tr>
	<tr>
	<td>log4jNamespace</td>
	<td>boolean</td>
	<td>No</td>
	<td>false</td>
	<td>If set to true then log4j XML namespace will be used instead of the log4php namespace.
	This can be usefull when using log viewers which can only parse the log4j namespace such as
	Apache Chainsaw.</td>
	</tr>
	</tbody>
	</table>
	</subsection>

	<subsection name="Examples">

	<h4>Default configuration example</h4>

	<p>The default configuration of <code>LoggerLayoutXml</code> will use the log4php XML namespace and
	include the location information.</p>

	<p>Configuration file:</p>

	<div class="auto-tabs">
	<ul>
	<li>XML</li>
	<li>PHP</li>
	</ul>

	<div class="tab-content" >
	<div class="tab-pane">
	<pre class="prettyprint linenums"><![CDATA[
	<configuration xmlns="http://logging.apache.org/log4php/">
	<appender name="default" class="LoggerAppenderEcho">
	<layout class="LoggerLayoutXml" />
	</appender>
	<root>
	<appender_ref ref="default" />
	</root>
	</configuration>
	]]></pre>
	</div>
	<div class="tab-pane">
	<pre class="prettyprint linenums"><![CDATA[
	array(
	'appenders' => array(
	'default' => array(
	'class' => 'LoggerAppenderEcho',
	'layout' => array(
	'class' => 'LoggerLayoutXml',
	)
	)
	),
	'rootLogger' => array(
	'appenders' => array('default')
	),
	)
	]]></pre>
	</div>
	</div>
	</div>


	<p>Running the following code:</p>

	<pre class="prettyprint linenums">
	Logger::configure("config.xml");
	$logger = Logger::getLogger('myLogger');
	$logger->info("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
	$logger->debug("Donec a diam lectus.");
	$logger->warn("Sed sit amet ipsum mauris.");
	</pre>

	<p>Produces the following output:</p>

	<pre class="prettyprint"><![CDATA[
	<log4php:eventSet xmlns:log4php="http://logging.apache.org/log4php/" version="0.3" includesLocationInfo="true">

	<log4php:event logger="myLogger" level="INFO" thread="4464" timestamp="1317215164482">
	<log4php:message><![CDATA[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
	<log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="5" method="main" />
	</log4php:event>

	<log4php:event logger="myLogger" level="DEBUG" thread="4464" timestamp="1317215164513">
	<log4php:message><![CDATA[Donec a diam lectus.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
	<log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="6" method="main" />
	</log4php:event>

	<log4php:event logger="myLogger" level="WARN" thread="4464" timestamp="1317215164514">
	<log4php:message><![CDATA[Sed sit amet ipsum mauris.]]]]><![CDATA[>]]><![CDATA[</log4php:message>
	<log4php:locationInfo class="main" file="D:\Temp\log4php\layout_pattern.php" line="7" method="main" />
	</log4php:event>

	</log4php:eventSet>
	]]></pre>


	<h4>Overriding default options</h4>

	<p>This example show how to configure <code>LoggerLayoutXml</code> to exclude the location information
	and use the log4j XML namespace.</p>

	<p>Configuration file:</p>

	<pre class="prettyprint"><![CDATA[
	<configuration xmlns="http://logging.apache.org/log4php/">
	<appender name="default" class="LoggerAppenderEcho">
	<layout class="LoggerLayoutXml">
	<param name="locationInfo" value="false" />
	<param name="log4jNamespace" value="true" />
	</layout>
	</appender>
	<root>
	<appender_ref ref="default" />
	</root>
	</configuration>
	]]></pre>
	<p>Using this configuration will produce the following output:</p>

	<pre class="prettyprint"><![CDATA[
	<log4j:eventSet xmlns:log4j="http://jakarta.apache.org/log4j/" version="0.3" includesLocationInfo="false">
	<log4j:event logger="myLogger" level="INFO" thread="3156" timestamp="1317216571470">
	<log4j:message><![CDATA[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
	</log4j:event>

	<log4j:event logger="myLogger" level="DEBUG" thread="3156" timestamp="1317216571471">
	<log4j:message><![CDATA[Donec a diam lectus.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
	</log4j:event>

	<log4j:event logger="myLogger" level="WARN" thread="3156" timestamp="1317216571471">
	<log4j:message><![CDATA[Sed sit amet ipsum mauris.]]]]><![CDATA[>]]><![CDATA[</log4j:message>
	</log4j:event>

	</log4j:eventSet>
	]]></pre>

	</subsection>
	</section>
	</body>
	</document>