src/site/xdoc/docs/appenders/file.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>LoggerAppenderFile</title>
 	</properties>

 	<body>
 		<section name="LoggerAppenderFile">

 			<p><code>LoggerAppenderFile</code> writes logging events to a file.</p>

 			<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>file</td>
 							<td>string</td>
 							<td><strong>Yes</strong></td>
 							<td>-</td>
 							<td>Path to the target file. Relative paths are resolved based on the working directory.</td>
 						</tr>
 						<tr>
 							<td>append</td>
 							<td>boolean</td>
 							<td>No</td>
 							<td>true</td>
 							<td>If set to true, the appender will append to the file, otherwise the file contents will be
 							overwritten.</td>
 						</tr>
 					</tbody>
 				</table>

 			</subsection>

 			<subsection name="Examples">

 				<p>This example shows how to configure <code>LoggerAppenderFile</code> to write to <code>file.log</code>
 				and to overwrite any content present in the file. The target file will be created in the current
 				working directory.</p>

 				<p>It is also possible to specify an absolute path to the target file, such as
 				<code>/var/log/file.log</code> or <code>D:/logs/file.log</code></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="LoggerAppenderFile">
         <layout class="LoggerLayoutSimple" />
         <param name="file" value="file.log" />
         <param name="append" value="false" />
     </appender>
     <root>
         <appender_ref ref="default" />
     </root>
 </configuration>
 ]]></pre>
 						</div>
 						<div class="tab-pane">
 <pre class="prettyprint"><![CDATA[
 array(
     'appenders' => array(
         'default' => array(
             'class' => 'LoggerAppenderFile',
             'layout' => array(
                 'class' => 'LoggerLayoutSimple',
             ),
             'params' => array(
                 'file' => 'file.log',
                 'append' => false
             ),
         ),
     ),
     'rootLogger' => array(
         'appenders' => array('default'),
     ),
 );
 ]]></pre>
 						</div>
 					</div>
 				</div>
 			</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>LoggerAppenderFile</title>
	</properties>

	<body>
	<section name="LoggerAppenderFile">

	<p><code>LoggerAppenderFile</code> writes logging events to a file.</p>

	<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>file</td>
	<td>string</td>
	<td><strong>Yes</strong></td>
	<td>-</td>
	<td>Path to the target file. Relative paths are resolved based on the working directory.</td>
	</tr>
	<tr>
	<td>append</td>
	<td>boolean</td>
	<td>No</td>
	<td>true</td>
	<td>If set to true, the appender will append to the file, otherwise the file contents will be
	overwritten.</td>
	</tr>
	</tbody>
	</table>

	</subsection>

	<subsection name="Examples">

	<p>This example shows how to configure <code>LoggerAppenderFile</code> to write to <code>file.log</code>
	and to overwrite any content present in the file. The target file will be created in the current
	working directory.</p>

	<p>It is also possible to specify an absolute path to the target file, such as
	<code>/var/log/file.log</code> or <code>D:/logs/file.log</code></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="LoggerAppenderFile">
	<layout class="LoggerLayoutSimple" />
	<param name="file" value="file.log" />
	<param name="append" value="false" />
	</appender>
	<root>
	<appender_ref ref="default" />
	</root>
	</configuration>
	]]></pre>
	</div>
	<div class="tab-pane">
	<pre class="prettyprint"><![CDATA[
	array(
	'appenders' => array(
	'default' => array(
	'class' => 'LoggerAppenderFile',
	'layout' => array(
	'class' => 'LoggerLayoutSimple',
	),
	'params' => array(
	'file' => 'file.log',
	'append' => false
	),
	),
	),
	'rootLogger' => array(
	'appenders' => array('default'),
	),
	);
	]]></pre>
	</div>
	</div>
	</div>
	</subsection>
	</section>
	</body>
	</document>