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

 	<body>
 		<section name="LoggerAppenderPhp">

 			<p><code>LoggerAppenderPhp</code> logs events by creating a PHP user-level message using the PHP's
 			<code><a href="http://www.php.net/manual/en/function.trigger-error.php"
 			class="external">trigger_error()</a></code>function.</p>

 			<p>The message type depends on the event's severity level:</p>
 			<ul>
 				<li><code>E_USER_NOTICE</code> when the event's level is equal to or less than INFO</li>
 				<li><code>E_USER_WARNING</code> when the event's level is equal to WARN</li>
 				<li><code>E_USER_ERROR</code> when the event's level is equal to or greater than ERROR</li>
 			</ul>

 			<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>This appender has no configurable parameters.</p>
 			</subsection>

 			<subsection name="Examples">

 				<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="LoggerAppenderPhp">
         <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' => 'LoggerAppenderPhp',
             'layout' => array(
                 'class' => 'LoggerLayoutSimple',
             ),
         ),
     ),
     '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>LoggerAppenderPhp</title>
	</properties>

	<body>
	<section name="LoggerAppenderPhp">

	<p><code>LoggerAppenderPhp</code> logs events by creating a PHP user-level message using the PHP's
	<code><a href="http://www.php.net/manual/en/function.trigger-error.php"
	class="external">trigger_error()</a></code>function.</p>

	<p>The message type depends on the event's severity level:</p>
	<ul>
	<li><code>E_USER_NOTICE</code> when the event's level is equal to or less than INFO</li>
	<li><code>E_USER_WARNING</code> when the event's level is equal to WARN</li>
	<li><code>E_USER_ERROR</code> when the event's level is equal to or greater than ERROR</li>
	</ul>

	<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>This appender has no configurable parameters.</p>
	</subsection>

	<subsection name="Examples">

	<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="LoggerAppenderPhp">
	<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' => 'LoggerAppenderPhp',
	'layout' => array(
	'class' => 'LoggerLayoutSimple',
	),
	),
	),
	'rootLogger' => array(
	'appenders' => array('default'),
	),
	);
	]]></pre>
	</div>
	</div>
	</div>
	</subsection>
	</section>
	</body>
	</document>