You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ih...@apache.org on 2013/11/28 17:03:38 UTC
[08/43] LOG4PHP-121: Reorganized classes into namespaces
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/layouts/pattern.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/layouts/pattern.xml b/src/site/xdoc/docs/layouts/pattern.xml
deleted file mode 100644
index 7b3a6cf..0000000
--- a/src/site/xdoc/docs/layouts/pattern.xml
+++ /dev/null
@@ -1,655 +0,0 @@
-<?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>LoggerLayoutPattern</title>
- </properties>
-
- <body>
- <section name="LoggerLayoutPattern">
-
- <p>LoggerLayoutPattern is a flexible layout configurable via a conversion pattern.</p>
-
- <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>conversionPattern</td>
- <td>string</td>
- <td>No</td>
- <td>%message%newline</td>
- <td>String which controls the output. See full specification below.</td>
- </tr>
- </tbody>
- </table>
-
- <h4>Conversion patterns</h4>
-
- <p><strong>Conversion pattern</strong> is a string which controls the formatting of logging
- events. It controls how logging events will be transformed into strings by the layout.</p>
-
- <p>The conversion pattern is closely related to the conversion pattern of the PHP
- <a href="http://www.php.net/manual/en/function.sprintf.php" class="external">sprintf</a> function.
- It is composed of literal text and format control expressions called <em>conversion specifiers</em>.
- </p>
-
- <p>A conversion specifier begins with a percent sign (%) and is followed by a <em>conversion word</em>.
- Some conversion words require one or more <em>options</em> to be given. These are specified in braces after the
- conversion word. An example of a conversion specifier is <code>%message</code> which will be converted into
- the message from the logging event which is being logged.</p>
-
- <p>The recognized conversion specifiers are:</p>
-
- <table class="table table-bordered">
- <thead>
- <tr>
- <th>Conversion specifier</th>
- <th>Converts to</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <p><strong>%c</strong>{length}</p>
- <p><strong>%lo</strong>{length}</p>
- <p><strong>%logger</strong>{length}</p>
- </td>
- <td>
- <p>Name of the Logger which generated the logging request.</p>
-
- <p>Optionally, a desired output length can be specified. If given, the converter will attempt
- to abbreviate the logger name without losing too much information in the process. If
- zero length is specified, only the rightmost name fragment will be output.</p>
-
- <p>Specifying the desired length 0 means that only the class name will be returned without
- the corresponding namespace.</p>
-
- <p>Several examples of the shortening algorithm in action:</p>
-
- <table class="table table-bordered table-not-wide">
- <thead>
- <tr>
- <th>Conversion specifier</th>
- <th>Logger name</th>
- <th>Result</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>%logger</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>org\apache\logging\log4php\Foo</td>
- </tr>
- <tr>
- <td>%logger{0}</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>Foo</td>
- </tr>
- <tr>
- <td>%logger{10}</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>o\a\l\l\Foo</td>
- </tr>
- <tr>
- <td>%logger{20}</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>o\a\l\log4php\Foo</td>
- </tr>
- <tr>
- <td>%logger{25}</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>o\a\logging\log4php\Foo</td>
- </tr>
- <tr>
- <td>%logger{30}</td>
- <td>org\apache\logging\log4php\Foo</td>
- <td>org\apache\logging\log4php\Foo</td>
- </tr>
- </tbody>
- </table>
-
- <p>Note that rightmost segment will never be shortened. It is possible that the
- resulting string will be longer than the specified desired length.</p>
- <p>For backward compatibility, a dot can be used as a namespace separator, as well as
- the backslash.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%C</strong>{length}</p>
- <p><strong>%class</strong>{length}</p>
- </td>
- <td>
- <p>The fully qualified class name of the caller issuing the logging request.</p>
- <p>Just like <strong>%logger</strong>, a desired length can be defined as an option.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%cookie</strong>{key}</p>
- </td>
- <td>
- <p>A value from the $_COOKIE superglobal array corresponding to the given key.</p>
- <p>If no key is given, will return all values in key=value format.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%d</strong>{pattern}</p>
- <p><strong>%date</strong>{pattern}</p>
- </td>
- <td>
- <p>The date/time of the logging event. Accepts a pattern string as an option. The
- pattern syntax is the same as used by the PHP's <code><a href="http://php.net/manual/en/function.date.php"
- class="external">date()</a></code> function.</p>
-
- <p>If no pattern is given, the date format will default to the ISO8601 datetime format,
- which is the same as giving the pattern: <code>c</code>.</p>
-
- <table>
- <thead>
- <tr>
- <th>Conversion specifier</th>
- <th>Result</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>%d</td>
- <td>2011-12-27T12:01:32+01:00</td>
- </tr>
- <tr>
- <td>%date</td>
- <td>2011-12-27T12:01:32+01:00</td>
- </tr>
- <tr>
- <td>%date{ISO8601}</td>
- <td>2011-12-27T12:01:32+01:00</td>
- </tr>
- <tr>
- <td>%date{Y-m-d H:i:s,u}</td>
- <td>2011-12-27 12:01:32,610</td>
- </tr>
- <tr>
- <td>%date{l jS \of F Y h:i:s A}</td>
- <td>Tuesday 27th of December 2011 12:01:32 PM</td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%e</strong>{key}</p>
- <p><strong>%env</strong>{key}</p>
- </td>
- <td>
- <p>A value from the $_ENV superglobal array corresponding to the given key.</p>
- <p>If no key is given, will return all values in key=value format.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%ex</strong></p>
- <p><strong>%exception</strong></p>
- <p><strong>%throwable</strong></p>
- </td>
- <td>
- <p>The exception associated with the logging event, along with it's stack trace. If
- there is no exception, evalutates to an empty string.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%F</strong></p>
- <p><strong>%file</strong></p>
- </td>
- <td>Name of the file from which the logging request was issued.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%l</strong></p>
- <p><strong>%location</strong></p>
- </td>
- <td>
- <p>Location information of the caller which generated the logging event.</p>
- <p>Identical to <code>%C.%M(%F:%L)</code></p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%L</strong></p>
- <p><strong>%line</strong></p>
- </td>
- <td>The line number at which the logging request was issued.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%m</strong></p>
- <p><strong>%msg</strong></p>
- <p><strong>%message</strong></p>
- </td>
- <td>The message associated with the logging event.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%M</strong></p>
- <p><strong>%method</strong></p>
- </td>
- <td>The method or function name from which the logging request was issued.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%n</strong></p>
- <p><strong>%newline</strong></p>
- </td>
- <td>
- <p>A platform dependent line-break character(s).</p>
- <p>Note that a line break will not be printed unless explicitely specified.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%p</strong></p>
- <p><strong>%le</strong></p>
- <p><strong>%level</strong></p>
- </td>
- <td>The level of the logging event.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%r</strong></p>
- <p><strong>%relative</strong></p>
- </td>
- <td>The number of milliseconds elapsed since the start of the application until the creation of the logging event.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%req</strong>{key}</p>
- <p><strong>%request</strong>{key}</p>
- </td>
- <td>
- <p>A value from the $_REQUEST superglobal array corresponding to the given key.</p>
- <p>If no key is given, will return all values in key=value format.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%s</strong>{key}</p>
- <p><strong>%server</strong>{key}</p>
- </td>
- <td>
- <p>A value from the $_SERVER superglobal array corresponding to the given key.</p>
- <p>If no key is given, will return all values in key=value format.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%ses</strong>{key}</p>
- <p><strong>%session</strong>{key}</p>
- </td>
- <td>
- <p>A value from the $_SESSION superglobal array corresponding to the given key.</p>
- <p>If no key is given, will return all values in key=value format.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%sid</strong></p>
- <p><strong>%sessionid</strong></p>
- </td>
- <td>
- <p>The active session ID, or an empty string if not in session.</p>
- <p>Equivalent to calling <code>session_id()</code>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><strong>%t</strong></p>
- <p><strong>%pid</strong></p>
- <p><strong>%process</strong></p>
- </td>
- <td>The ID of the process that generated the logging event.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%x</strong></p>
- <p><strong>%ndc</strong></p>
- </td>
- <td>The NDC (Nested Diagnostic Context) associated with the thread that generated the logging event.</td>
- </tr>
- <tr>
- <td>
- <p><strong>%X</strong>{key}</p>
- <p><strong>%mdc</strong>{key}</p>
- </td>
- <td>
- <p>A value from the Mapped Diagnostic Context (MDC) corresponding to the given key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </subsection>
-
- <subsection name="Format modifiers">
- <p>By default the relevant information is output as-is. However, with the aid of format modifiers
- it is possible to change the minimum and maximum width and the justifications of each data field.
- </p>
-
- <p>Both format modifiers are optional, and are placed between the percent sign (%) and the conversion
- word. These are, in order:</p>
-
- <ol>
- <li>A <b>minimum width specifier</b>, a number which determines the minimum width of the resulting
- string. If the resulting string is shorter that the given number, it will be padded with spaces to
- the desired length. By default, the string is right-justified (padded from left), but adding a
- "-" sign before the specifier will make it left-justified.</li>
-
- <li>A <b>maximum widht specifier</b>, a dot (".") followed by a number which determines the maximum
- allowed width of the resulting string. If the resulting string is shorter than the given number, it
- will be truncated to the maximum width. By default the string is truncated from the right, but
- adding a "-" sign before the specifier will cause it to truncate from the left.</li>
- </ol>
-
- <p>The following table demonstrates various uses of format modifiers:</p>
-
- <table>
- <thead>
- <tr>
- <th>Format modifier</th>
- <th>Padding</th>
- <th>Trimming</th>
- <th>Minimum width</th>
- <th>Maximum width</th>
- <th>Comment</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td align="center"><strong>%logger</strong></td>
- <td align="center">none</td>
- <td align="center">none</td>
- <td align="center">none</td>
- <td align="center">none</td>
- <td>Output the logger name as-is.</td>
- </tr>
- <tr>
- <td align="center"><strong>%20logger</strong></td>
- <td align="center">right</td>
- <td align="center">none</td>
- <td align="center">20</td>
- <td align="center">none</td>
- <td>Left pad with spaces if the logger name is less than 20 characters long.</td>
- </tr>
- <tr>
- <td align="center"><strong>%-20logger</strong></td>
- <td align="center">left</td>
- <td align="center">none</td>
- <td align="center">20</td>
- <td align="center">none</td>
- <td>Right pad with spaces if the logger name is less than 20 characters long.</td>
- </tr>
- <tr>
- <td align="center"><strong>%.30logger</strong></td>
- <td align="center">none</td>
- <td align="center">right</td>
- <td align="center">none</td>
- <td align="center">30</td>
- <td>Trim from the end if the logger name is longer than 30 characters.</td>
- </tr>
- <tr>
- <td align="center"><strong>%.-30logger</strong></td>
- <td align="center">none</td>
- <td align="center">left</td>
- <td align="center">none</td>
- <td align="center">30</td>
- <td>Trim from the beginning if the logger name is longer than 30 characters.</td>
- </tr>
- <tr>
- <td align="center"><strong>%20.30logger</strong></td>
- <td align="center">right</td>
- <td align="center">right</td>
- <td align="center">20</td>
- <td align="center">30</td>
- <td>Left pad with spaces if the logger name is shorter than 20 characters. However, if
- the logger name is longer than 30 characters, then trim from the end.</td>
- </tr>
- <tr>
- <td align="center"><strong>%-20.30logger</strong></td>
- <td align="center">left</td>
- <td align="center">right</td>
- <td align="center">20</td>
- <td align="center">30</td>
- <td>Right pad with spaces if the logger name is shorter than 20 characters. However, if the
- logger name is longer than 30 characters, then trim from the end.</td>
- </tr>
- </tbody>
- </table>
-
- <p>The following table lists a couple of examples for using format modifiers. Note that the square
- brackets are added to the conversion pattern to delimit the output.</p>
-
- <table class="table table-bordered table-striped table-not-wide">
- <thead>
- <tr>
- <th>Conversion pattern</th>
- <th>Logger name</th>
- <th>Result</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>[%10logger]</td>
- <td>Foo</td>
- <td><code>[ Foo]</code></td>
- <td>Added padding, right aligned.</td>
- </tr>
- <tr>
- <td>[%-10logger]</td>
- <td>Foo</td>
- <td><code>[Foo ]</code></td>
- <td>Added padding, left aligned.</td>
- </tr>
- <tr>
- <td>[%.10logger]</td>
- <td>org.apache.log4php.Foo</td>
- <td><code>[org.apache]</code></td>
- <td>Trimmed from right.</td>
- </tr>
- <tr>
- <td>[%.-10logger]</td>
- <td>org.apache.log4php.Foo</td>
- <td><code>[og4php.Foo]</code></td>
- <td>Trimmed from left.</td>
- </tr>
- </tbody>
- </table>
- </subsection>
-
- <subsection name="Examples">
- <p>The following configuration configures a <code>LoggerAppenderEcho</code> which uses the pattern
- layout. All examples will use the same code and configuration, only the conversion pattern will
- change from example to example.</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="LoggerLayoutPattern">
- <param name="conversionPattern" value="%date %logger %-5level %msg%n" />
- </layout>
- </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' => 'LoggerLayoutPattern',
- 'params' => array(
- 'conversionPattern' => '%date %logger %-5level %msg%n'
- )
- )
- )
- ),
- 'rootLogger' => array(
- 'appenders' => array('default')
- ),
-)
-]]></pre>
- </div>
- </div>
- </div>
-
-
- <p>Example 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>
-
- <h4>A simple example</h4>
-
- <p>Conversion pattern: <code>%date %logger %-5level %msg%n</code></p>
-
- <p>Running the example code produces the following output:</p>
-
-<pre>
-2012-02-27T19:42:17+01:00 myLogger INFO Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-2012-02-27T19:42:17+01:00 myLogger DEBUG Donec a diam lectus.
-2012-02-27T19:42:17+01:00 myLogger WARN Sed sit amet ipsum mauris.
-</pre>
-
- <p>In this example, <code>%date</code> is converted to the event datetime in default format
- (corresponding to the ISO-8601 specification), and <code>%-5level</code> produces the event
- level right padded to 5 characters. Since longest level name is 5 characters long, this
- ensures that the message always starts at the same character position which improves log
- readability.</p>
-
- <p>Notice that the newline between logging events (%n) has to be explicitely defined. Otherwise all
- logging events will be logged in the same line.</p>
-
- <h4>Formatting the date</h4>
-
- <p>The <code>%date</code> conversion word can take the desired date format as an option. For example,
- if you're European, the d.m.Y date format might be more familiar. Also, adding milliseconds.</p>
-
- <p>Conversion pattern: <code>%date{d.m.Y H:i:s,u} %logger %-5level %msg%n</code></p>
-
- <p>Running the example code produces the following output:</p>
-
-<pre>
-27.02.2012 20:14:41,624 myLogger INFO Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-27.02.2012 20:14:41,625 myLogger DEBUG Donec a diam lectus.
-27.02.2012 20:14:41,626 myLogger WARN Sed sit amet ipsum mauris.
-</pre>
-
- <h4>Logging HTTP requests</h4>
-
- <p>If log4php is used to log HTTP requests, a pattern like this might be useful:</p>
-
- <p><code>%date [%pid] From:%server{REMOTE_ADDR}:%server{REMOTE_PORT} Request:[%request] Message: %msg%n</code></p>
-
- <p>Request <code>/test.php?foo=bar</code> it will produce the output similar to:</p>
-
-<pre>
-2012-01-02T14:19:33+01:00 [22924] From:194.152.205.71:11257 Request:[foo=bar] Message: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-2012-01-02T14:19:33+01:00 [22924] From:194.152.205.71:11257 Request:[foo=bar] Message: Donec a diam lectus.
-2012-01-02T14:19:33+01:00 [22924] From:194.152.205.71:11257 Request:[foo=bar] Message: Sed sit amet ipsum mauris.
-</pre>
-
- <p><code>%server{REMOTE_ADDR}</code> is equivalent to PHP code <code>$_SERVER['REMOTE_ADDR']</code>.</p>
-
- <h4>Logging exceptions</h4>
-
- <p>If you wish to log any exception passed to the logging methods, you should add the <code>%ex</code>
- specifier to the end of your conversion pattern, after <code>%newline</code>. This way, if an exception
- is loggerd it will be addded to your log below your message.</p>
-
- <p>For example: <code>%date %logger %message%newline%ex</code></p>
-
- <p>In the following code, suppose that the work() method can throw an exception. This wolud be a good
- way to deal with it:</p>
-
-<pre class="prettyprint linenums">
-$log = Logger::getLogger('foo');
-$log->info("Let's try this");
-
-try
-{
- $foo = new Foo();
- $foo->work(123);
-}
-catch(Exception $ex)
-{
- // Exception is passed as the second parameter
- $log->error("That didn't work", $ex);
-}
-$log->info("Done.");
-</pre>
-
- <p>If work() throws an exception, your log might look something like this:</p>
-
-<pre>
-2012-10-08T10:11:18+02:00 foo Let's try this
-2012-10-08T10:11:18+02:00 foo That didn't work
-exception 'Exception' with message 'Doesn't work' in D:\work\exceptions.php:38
-Stack trace:
-#0 D:\work\exceptions.php(29): Bar->work(123)
-#1 D:\work\exceptions.php(48): Foo->work(123)
-#2 {main}
-2012-10-08T10:11:18+02:00 foo Done.
-</pre>
-
- <p>The exception, along with the full stack trace ends up in your log. This also works with nested
- exceptions, the full stack trace is added.</p>
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/layouts/serialized.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/layouts/serialized.xml b/src/site/xdoc/docs/layouts/serialized.xml
deleted file mode 100644
index adae267..0000000
--- a/src/site/xdoc/docs/layouts/serialized.xml
+++ /dev/null
@@ -1,122 +0,0 @@
-<?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>LoggerLayoutSerialized</title>
- </properties>
-
- <body>
- <section name="LoggerLayoutSerialized">
-
- <p><code>LoggerLayoutSerialized</code> formats the logging event using the PHP's
- <code><a href="http://php.net/manual/en/function.serialize.php">serialize()</a></code> function.</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>false</td>
- <td>If set to true, event's location information will be initialized before serialization.
- Enabling this parameter makes logging slower and should be used only if required.</td>
- </tr>
- </tbody>
- </table>
-
- </subsection>
-
- <subsection name="Examples">
-
- <p>Sample 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="LoggerLayoutSerialized" />
- </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' => 'LoggerLayoutSerialized',
- )
- )
- ),
- '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 linenums"><![CDATA[
-O:18:"LoggerLoggingEvent":10:{s:24:" LoggerLoggingEvent fqcn";s:6:"Logger";s:32:" LoggerLoggingEvent categoryName";s:8:"myLogger";s:8:" * level";O:11:"LoggerLevel":3:{s:18:" LoggerLevel level";i:20000;s:21:" LoggerLevel levelStr";s:4:"INFO";s:29:" LoggerLevel syslogEquivalent";i:6;}s:23:" LoggerLoggingEvent ndc";N;s:37:" LoggerLoggingEvent ndcLookupRequired";b:1;s:27:" LoggerLoggingEvent message";s:56:"Lorem ipsum dolor sit amet, consectetur adipiscing elit.";s:35:" LoggerLoggingEvent renderedMessage";N;s:30:" LoggerLoggingEvent threadName";N;s:9:"timeStamp";d:1319380554.782227;s:32:" LoggerLoggingEvent locationInfo";N;}
-O:18:"LoggerLoggingEvent":10:{s:24:" LoggerLoggingEvent fqcn";s:6:"Logger";s:32:" LoggerLoggingEvent categoryName";s:8:"myLogger";s:8:" * level";O:11:"LoggerLevel":3:{s:18:" LoggerLevel level";i:10000;s:21:" LoggerLevel levelStr";s:5:"DEBUG";s:29:" LoggerLevel syslogEquivalent";i:7;}s:23:" LoggerLoggingEvent ndc";N;s:37:" LoggerLoggingEvent ndcLookupRequired";b:1;s:27:" LoggerLoggingEvent message";s:20:"Donec a diam lectus.";s:35:" LoggerLoggingEvent renderedMessage";N;s:30:" LoggerLoggingEvent threadName";N;s:9:"timeStamp";d:1319380554.78247;s:32:" LoggerLoggingEvent locationInfo";N;}
-O:18:"LoggerLoggingEvent":10:{s:24:" LoggerLoggingEvent fqcn";s:6:"Logger";s:32:" LoggerLoggingEvent categoryName";s:8:"myLogger";s:8:" * level";O:11:"LoggerLevel":3:{s:18:" LoggerLevel level";i:30000;s:21:" LoggerLevel levelStr";s:4:"WARN";s:29:" LoggerLevel syslogEquivalent";i:4;}s:23:" LoggerLoggingEvent ndc";N;s:37:" LoggerLoggingEvent ndcLookupRequired";b:1;s:27:" LoggerLoggingEvent message";s:26:"Sed sit amet ipsum mauris.";s:35:" LoggerLoggingEvent renderedMessage";N;s:30:" LoggerLoggingEvent threadName";N;s:9:"timeStamp";d:1319380554.78268;s:32:" LoggerLoggingEvent locationInfo";N;}
-]]></pre>
- </subsection>
-
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/layouts/simple.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/layouts/simple.xml b/src/site/xdoc/docs/layouts/simple.xml
deleted file mode 100644
index 0e59715..0000000
--- a/src/site/xdoc/docs/layouts/simple.xml
+++ /dev/null
@@ -1,104 +0,0 @@
-<?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>LoggerLayoutSimple</title>
- </properties>
-
- <body>
- <section name="LoggerLayoutSimple">
-
- <p><code>LoggerLayoutSimple</code> is a basic layout which outputs only the level followed by the message.</p>
-
- <p>It is interesting to note that the output of <code>LoggerLayoutSimple</code> is identical to that of
- <code><a href="pattern.html">LoggerLayoutPattern</a></code> with the <em>conversion pattern</em> set to
- <code>%p - %m%n</code>.</p>
-
-
- <subsection name="Parameters">
- <p>This layout does not have any configurable parameters.</p>
- </subsection>
-
- <subsection name="Examples">
-
- <p>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 linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderEcho">
- <layout class="LoggerLayoutSimple" />
- </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' => 'LoggerLayoutSimple',
- )
- )
- ),
- 'rootLogger' => array(
- 'appenders' => array('default')
- ),
-)
-]]></pre>
- </div>
- </div>
- </div>
-
-
- <p>Running the following code:</p>
-
-<pre class="prettyprint linenums">
-Logger::configure("layout_xml.xml");
-$log = Logger::getRootLogger();
-$log->info("My first message.");
-$log->debug("My second message.");
-$log->warn("My third message.");
-</pre>
-
- <p>Produces the following output:</p>
-
-<pre>
-INFO - My first message.
-DEBUG - My second message.
-WARN - My third message.
-</pre>
-
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/layouts/ttcc.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/layouts/ttcc.xml b/src/site/xdoc/docs/layouts/ttcc.xml
deleted file mode 100644
index 4a797f9..0000000
--- a/src/site/xdoc/docs/layouts/ttcc.xml
+++ /dev/null
@@ -1,162 +0,0 @@
-<?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>LoggerLayoutTTCC</title>
- </properties>
-
- <body>
- <section name="LoggerLayoutTTCC">
-
- <div class="alert alert-error">
- <span class="alert-heading">Deprecated!</span>
- <p>LoggerLayoutTTCC is deprecated and will be removed in a future release. Please use
- <a href="pattern.html">LoggerLayoutPattern</a> instead.</p>
- </div>
-
- <p>The TTCC layout format was taken from Apache log4j, and originally consisted of Time, Thread, Category
- and nested diagnostic Context information, hence the name.</p>
-
- <p><code>LoggerLayoutTTCC</code> contains equivalent information:</p>
- <ul>
- <li>Time</li>
- <li>Process ID</li>
- <li>Logger name</li>
- <li>Nested diagnostic context</li>
- </ul>
-
- <p>Output of <code>LoggerLayoutTTCC</code> is identical to that of
- <code><a href="pattern.html">LoggerLayoutPattern</a></code> with the <em>conversion pattern</em> set to
- <code>%d{m/d/y H:i:s,u} [%t] %p %c %x - %m%n</code>.</p>
-
- <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>threadPrinting</td>
- <td>boolean</td>
- <td>No</td>
- <td>true</td>
- <td>If set to true, the process ID will be included in output.</td>
- </tr>
- <tr>
- <td>categoryPrefixing</td>
- <td>boolean</td>
- <td>No</td>
- <td>true</td>
- <td>If set to true, the logger name will be included in output.</td>
- </tr>
- <tr>
- <td>contextPrinting</td>
- <td>boolean</td>
- <td>No</td>
- <td>true</td>
- <td>If set to true, the nested diagnostic context will be included in output.</td>
- </tr>
- <tr>
- <td>microSecondsPrinting</td>
- <td>boolean</td>
- <td>No</td>
- <td>true</td>
- <td>If set to true, the microseconds will be included in output.</td>
- </tr>
- </tbody>
- </table>
- </subsection>
-
- <subsection name="Examples">
-
- <p>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 linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderEcho">
- <layout class="LoggerLayoutTTCC" />
- </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' => 'LoggerLayoutTTCC',
- )
- )
- ),
- 'rootLogger' => array(
- 'appenders' => array('default')
- ),
-)
-]]></pre>
- </div>
- </div>
- </div>
-
-
- <p>For this example, some Nested Diagnostic Context is added also. Running the following code:</p>
-
-<pre class="prettyprint linenums">
-Logger::configure("config.xml");
-LoggerNDC::push("Some Context");
-
-$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>
-02/20/12 23:36:39,772 [9820] INFO myLogger Some Context - Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-02/20/12 23:36:39,773 [9820] DEBUG myLogger Some Context - Donec a diam lectus.
-02/20/12 23:36:39,773 [9820] WARN myLogger Some Context - Sed sit amet ipsum mauris.
-</pre>
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/layouts/xml.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/layouts/xml.xml b/src/site/xdoc/docs/layouts/xml.xml
deleted file mode 100644
index 125c0d2..0000000
--- a/src/site/xdoc/docs/layouts/xml.xml
+++ /dev/null
@@ -1,189 +0,0 @@
-<?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>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/loggers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/loggers.xml b/src/site/xdoc/docs/loggers.xml
deleted file mode 100644
index 9892d4f..0000000
--- a/src/site/xdoc/docs/loggers.xml
+++ /dev/null
@@ -1,289 +0,0 @@
-<?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>Loggers</title>
- </properties>
-
- <body>
- <section name="Loggers">
-
- <p>A logger is a component which will take your logging request and log it. Each class in a project can
- have an individual logger, or they can all use a common logger. Loggers are named entities; it is
- common to name them after the class which will use it for logging.</p>
-
- <p>Creating a logger is done by calling the static <code>getLogger()</code> method on the Logger object
- and providing the name of the logger. For example, to create a logger named <code>foo</code>:</p>
-
- <pre class="prettyprint">$logger = Logger::getLogger('foo');</pre>
-
- <p>Logging requests are made by invoking one of the printing methods of a Logger instance. These logging
- methods are: trace, debug, info, warn, error and fatal. The printing method determines the level of a
- logging request. For example, calling the method <code>info()</code> creates a logging request of level
- <code>INFO</code>. For example:</p>
-
- <pre class="prettyprint">$logger->info("This is the message to be logged.");</pre>
-
- <p>Loggers by themselves do not define where these messages will be logged. For that you need to assign
- one or more <a href="./appenders.html">appenders</a> to the logger.</p>
-
- <subsection name="Logger threshold" id="Logger_threshold">
- <p>A logger can be assigned a threshold level. All logging requests with level lower than this threshold
- will be ignored.</p>
-
- <p>For example, setting logger threshold to <code>INFO</code> means that logging requests with levels
- <code>TRACE</code> and <code>DEBUG</code> will not be logged by this logger.</p>
-
- <p>An example of setting the root logger threshold to <code>INFO</code>:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderConsole" />
- <root>
- <level value="info" />
- <appender_ref ref="default" />
- </root>
-</configuration>
-]]></pre>
-
- <p>If not explicitly configured, loggers will have their threshold level set to <code>DEBUG</code> by
- default.</p>
- </subsection>
-
- <subsection name="Configuring loggers" id="Configuring_loggers">
- <p>Loggers can be individually configured in the configuration file. </p>
-
- <p>The simplest example is to configure the root logger, since all other loggers will inherit its
- settings, as explained in the <a href="#Logger_hierarchy">next section</a>.</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderConsole" />
- <root>
- <level value="info" />
- <appender_ref ref="default" />
- </root>
-</configuration>
-]]></pre>
- <p>This configuration adds the <code>default</code> appender to the root logger, and sets it's
- <a href="#Logger_threshold">threshold level</a> to <code>INFO</code>.</p>
-
- <p>It is also possible to configure individual named loggers. For example, let's configure the
- <code>foo</code> logger, used in the example above, and set it's threshold to WARN:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderConsole" />
- <logger name="foo">
- <level value="warn" />
- <appender_ref ref="default" />
- </logger>
-</configuration>
-]]></pre>
- </subsection>
-
- <subsection name="Logger hierarchy" id="Logger_hierarchy">
- <p>Loggers follow a parent-child relationship pattern which is implemented by using a naming pattern.
- A logger is said to be an <em>ancestor</em> of another logger if its name followed by a dot is a
- prefix of the <em>descendant</em> logger name. A logger is said to be a <em>parent</em> of a
- <em>child</em> logger if there are no ancestors between itself and the descendant logger.</p>
-
- <p>For example, the logger named <code>foo</code> is a parent of the logger named <code>foo.bar</code>.
- Similarly, <code>org</code> is a parent of <code>org.apache</code> and an ancestor of
- <code>org.apache.logging</code>. This naming scheme should be familiar to most developers.</p>
-
- <p>The root logger resides at the top of the logger hierarchy. It is exceptional in two ways:</p>
- <ul>
- <li>it always exists,</li>
- <li>it cannot be retrieved by name.</li>
- </ul>
-
- <p>Invoking the class static <code>Logger::getRootLogger()</code> method retrieves the root logger.
- All other loggers are instantiated and retrieved with the <code>Logger::getLogger($name)</code>
- method. This method takes the name of the desired logger as a parameter. If the logger does not exist
- at the time of the call, it will be created.</p>
- </subsection>
-
- <subsection name="Logger inheritance" id="Logger_inheritance">
- <p>The threshold level and appenders are inherited from the parent to the child loggers.</p>
-
- <p>For example examine the following configuration:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="default" class="LoggerAppenderConsole" />
- <root>
- <level value="debug" />
- <appender_ref ref="default" />
- </root>
-</configuration>
-]]></pre>
-
- <p>The threshold level of the root logger is set to debug. Also, the root logger is linked to a console
- appender. Any named logger that is created will inherit these root settings.</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-$main = Logger::getLogger('main');
-$main->trace('This will not be logged.');
-$main->info('This will be logged.');
-]]></pre>
- <p>A logger named <code>main</code> is created. Since there is no logger-specific configuration, it
- will inherit all of it's settings from the root logger: a console appender, and threshold set to DEBUG.
- Therefore, this code will produce the following output:</p>
-
- <pre>INFO - This will be logged.</pre>
- </subsection>
-
- <subsection name="Appender additivity" id="Appender_additivity">
- <p>Appender additivity is a property of loggers to inherit their parent's appenders. By default all
- loggers have appender additivity enabled.</p>
-
- <p>Let's take the following example:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="A1" class="LoggerAppenderConsole" />
- <appender name="A2" class="LoggerAppenderConsole" />
- <root>
- <appender_ref ref="A1" />
- </root>
- <logger name="foo">
- <appender_ref ref="A2" />
- </logger>
-</configuration>
-]]></pre>
- <p>Since additivity is enabled by default, the logger <code>foo</code> will have two linked appenders:
- A1 which it will inherit from the root logger, and A2 which is defined for it specifically.</p>
-
- <p>Therefore, by executing the following code:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-$main = Logger::getLogger('foo');
-$main->info('This will be logged twice.');
-]]></pre>
- <p>The message will be logged twice - once by A1 and once by A2, producing:</p>
-
-<pre>
-INFO - This will be logged twice.
-INFO - This will be logged twice.
-</pre>
-
- <h4>Disabling appender additivity</h4>
-
- <p>Logger's appender additivity can also be disabled if needed.</p>
-
- <p>If the <code>foo</code> logger in the previous example was configured like this:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<logger name="foo" additivity="false">
- <appender_ref ref="A2" />
-</logger>
-]]></pre>
- <p>Then the logger would not have inherited the A1 appender from the root logger, and the message
- would have been logged only once.</p>
-
- <h4>A more complex example</h4>
-
- <p>In this example we will look at multiple loggers making a hierarchy.</p>
-
- <p>Not to make the example too complex, all appenders will log to the console. Of course, this doesn't
- always have to be the case.</p>
-
- <p>Let's take the following configuration file:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="A1" class="LoggerAppenderConsole" />
- <appender name="A2" class="LoggerAppenderConsole" />
- <appender name="A3" class="LoggerAppenderConsole" />
- <appender name="A4" class="LoggerAppenderConsole" />
-
- <root>
- <appender_ref ref="A1" />
- </root>
- <logger name="foo">
- <appender_ref ref="A2" />
- <appender_ref ref="A3" />
- </logger>
- <logger name="foo.bar" />
- <logger name="foo.bar.baz" additivity="false">
- <appender_ref ref="A4" />
- </logger>
-</configuration>
-]]></pre>
- <p>The table below shows how the configuration is interpreted, and which appenders are inherited:</p>
-
- <table>
- <thead>
- <tr>
- <th>Logger name</th>
- <th>Linked appenders</th>
- <th>Additivity flag</th>
- <th>Output targets</th>
- <th>Comment</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>root</td>
- <td>A1</td>
- <td>N/A</td>
- <td>A1</td>
- <td>One appender, named A1, is added to root logger. Any logging requests to root logger
- will be forwarded only to that one appender.</td>
- </tr>
- <tr>
- <td>foo</td>
- <td>A2, A3</td>
- <td>true</td>
- <td>A1, A2, A3</td>
- <td>A logger named <code>foo</code> is created and two appenders, named A2 and A3, are
- added to it. Additionally, because of logger additivity, <code>foo</code> inherits the
- appender A1 from the root logger which is it's parent in the logger hierarchy. Therefore
- logging requests to this logger will be forwarded to appenders A1, A2 and A3.</td>
- </tr>
- <tr>
- <td>foo.bar</td>
- <td>none</td>
- <td>true</td>
- <td>A1, A2, A3</td>
- <td>A logger named <code>foo.bar</code> is created. Because it's name starts with
- <code>foo</code>, it will be created as a child of the <code>foo</code> logger.
- No appenders are added to <code>foo.bar</code> but it will inherit it's ancestor's
- appenders: appenders A2 and A3 from <code>foo</code> and A1 from <code>root</code>.
- Logging requests to this logger will be forwarded to appenders A1, A2 and A3.</td>
- </tr>
- <tr>
- <td>foo.bar.baz</td>
- <td>A4</td>
- <td>false</td>
- <td>A4</td>
- <td>Finally, logger <code>foo.bar.baz</code> is created, and because of it's name it is
- created as child to <code>foo.bar</code>. One appender, A4 is added to it. However, since
- it's additivity flag is set to <em>false</em>, it will not inherit any appenders from it's
- ancestors. Logging requests to this logger will be forwarded only to appender A4.</td>
- </tr>
- </tbody>
-
- </table>
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/docs/renderers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/docs/renderers.xml b/src/site/xdoc/docs/renderers.xml
deleted file mode 100644
index 6c1b921..0000000
--- a/src/site/xdoc/docs/renderers.xml
+++ /dev/null
@@ -1,218 +0,0 @@
-<?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>Renderers</title>
- </properties>
-
- <body>
- <section name="Renderers">
- <p>Apache log4php can log more than just string messages. If you try to log an object it will be converted
- to a string and logged. The component which converts Objects to strings in log4php is called a
- <em>renderer</em>.</p>
-
- <subsection name="Default renderer">
-
- <p>For example, let's say that an application uses a Person object, like this one:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-class Person {
- public $firstName;
- public $lastName;
- public $age;
-}
-]]></pre>
-
- <p>If you try logging it:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-$person = new Person();
-$person->firstName = 'John';
-$person->lastName = 'Doe';
-$person->age = 37;
-
-$logger = Logger::getLogger('main');
-$logger->info("Here comes the person:");
-$logger->info($person);
-]]></pre>
- <p>Log4php will render it using the default renderer and you will end the output will look something
- like:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-INFO - Here comes the person:
-INFO - Person Object
-(
- [firstName] => John
- [lastName] => Doe
- [age] => 37
-)
-]]></pre>
-
- </subsection>
-
- <subsection name="Creating a custom renderer">
- <p>In order to make log4php log the Person object in a more readable format, a custom renderer
- class can be defined which will convert Person objects to a string suitable for logging.</p>
-
- <p>Let's call this renderer class PersonRenderer.</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-/** All renderers must implement the LoggerRenderer interface. */
-class PersonRenderer implements LoggerRenderer {
- public function render($person) {
- return "{$person->firstName} {$person->lastName} ({$person->age})";
- }
-}
-]]></pre>
-
- <p>Now log4php has to be configured to use PersonRenderer for rendering Person objects. This is done
- in the 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/">
- <renderer renderedClass="Person" renderingClass="PersonRenderer" />
- <appender name="defualt" class="LoggerAppenderEcho" />
- <root>
- <appender_ref ref="defualt" />
- </root>
-</configuration>
-]]></pre>
- </div>
- <div class="tab-pane">
-<pre class="prettyprint linenums"><![CDATA[
-array(
- 'renderers' => array(
- array(
- 'renderedClass' => 'Person',
- 'renderingClass' => 'PersonRenderer'
- )
- ),
- 'appenders' => array(
- 'default' => array(
- 'class' => 'LoggerAppenderEcho',
- ),
- ),
- 'rootLogger' => array(
- 'appenders' => array('default'),
- ),
-)
-]]></pre>
- </div>
- </div>
- </div>
-
-
- <p>If the same code is run as above, the following output is produced:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-INFO - Here comes the person:
-INFO - John Doe (37)
-]]></pre>
- <p>Which is much more readable than the default rendering.</p>
- </subsection>
-
- <subsection name="Overriding the default renderer">
- <p>It is possible to set your own custom renderer as the default renderer.</p>
-
- <p>For example, if you're not happy with the way in which the default renderer converts objects,
- you can create your own renderer:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-class MyRenderer implements LoggerRenderer {
- public function render($input) {
- return var_dump($input);
- }
-}
-]]></pre>
-
- <p>And set it as the default renderer in the 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 linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <defaultRenderer renderingClass="MyRenderer" />
- <appender name="defualt" class="LoggerAppenderEcho" />
- <root>
- <appender_ref ref="defualt" />
- </root>
-</configuration>
-]]></pre>
- </div>
- <div class="tab-pane">
-<pre class="prettyprint linenums"><![CDATA[
-array(
- 'defaultRenderer' => 'MyRenderer',
- 'appenders' => array(
- 'default' => array(
- 'class' => 'LoggerAppenderEcho',
- ),
- ),
- 'rootLogger' => array(
- 'appenders' => array('default'),
- ),
-)
-]]></pre>
- </div>
- </div>
- </div>
-
- <p>Logging a Person object using this configuration will make log4php fall back to the newly
- defined default renderer, which uses <code>var_dump</code> instead of <code>print_r</code>, and
- the result will look like:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-INFO - Here comes the person:
-class Person#5 (3) {
- public $firstName =>
- string(4) "John"
- public $lastName =>
- string(3) "Doe"
- public $age =>
- int(37)
-}
-]]></pre>
- </subsection>
-
- <subsection name="Class hierarchy">
- <p>Object rendering follows the class hierarchy. </p>
-
- <p>For example, if there is a class named Fruit, and classes Orange, Lemon and Apple all extend Fruit.
- When FruitRenderer is registered as renderer for the Fruit class, all subclasses of Fruit will also
- be rendered by FruitRenderer. Of course, it is possible to override this by registering OrangeRenderer
- as renderer for the Orange class.</p>
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/install.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/install.xml b/src/site/xdoc/install.xml
deleted file mode 100644
index 82572c2..0000000
--- a/src/site/xdoc/install.xml
+++ /dev/null
@@ -1,89 +0,0 @@
-<?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>Installing</title>
- </properties>
-
- <body>
- <section name="Installing">
-
- <subsection name="From source package">
-
- <p>Download the latest source package from the <a href="download.html">download page</a> and unpack it.</p>
-
- <p>The package directory structure is as follows:</p>
-
-<pre>
-├───apidocs - API generated documentation
-└───src
- ├───assembly - Maven assembly configuration
- ├───changes - The change log
- ├───examples - Various usage examples
- ├───main
- │ └───php - The main source code
- ├───site - Web site source
- └───test - Unit tests
-</pre>
- <p>Most users will primarily be interested in the source code which is located in
- <code>/src/main/php</code>. The contents of this directory may be copied to a directory within your
- project for easier access.</p>
-
- </subsection>
-
- <subsection name="From PEAR repository">
-
- <p>Apache log4php has it's own <a href="http://pear.apache.org/log4php/index.html">PEAR channel</a>.</p>
-
- <p>To install from the PEAR channel, execute the following commands:</p>
-
-<pre>
-pear channel-discover pear.apache.org/log4php
-pear install log4php/Apache_log4php
-</pre>
-
- </subsection>
-
- <subsection name="From Composer">
-
- <p>Apache log4php is available from <a href="https://packagist.org/packages/apache/log4php">Packagist</a> via <a href="http://getcomposer.org/">Composer</a>. Please note: this channel is not an official Apache Software Foundation channel,
- but maintained from Apache log4php committers.</p>
-
- <p>To with compoers, add the following lines to composer.json:</p>
-
-<pre>
-"require": {
- "apache/log4php": "2.3.0"
-}
-</pre>
- <p>Then run:</p>
-
-<pre>
-php composer.phar install
-</pre>
- <p>Or, if you have composer installed as binary:</p>
-
-<pre>
-composer install
-</pre>
- </subsection>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/privacy.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/privacy.xml b/src/site/xdoc/privacy.xml
deleted file mode 100644
index 523c79f..0000000
--- a/src/site/xdoc/privacy.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-<?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>Privacy policy</title>
- </properties>
-
- <body>
- <section name="Privacy policy">
- <p>Information about your use of this web site is collected using server access logs and a tracking cookie.
- The collected information consists of the following:</p>
-
- <ul>
- <li>The IP address from which you access the web site;</li>
- <li>The type of browser and operating system you use to access our site;</li>
- <li>The date and time you access our site;</li>
- <li>The pages you visit; and</li>
- <li>The addresses of pages from where you followed a link to our site.</li>
- </ul>
-
- <p>Part of this information is gathered using a tracking cookie set by the
- <a href="http://www.google.com/analytics" class="external">Google Analytics</a> service and handled by
- Google as described in their
- <a href="http://www.google.com/privacy.html" class="external">privacy policy</a>.
- See your browser documentation for instructions on how to disable the cookie if you prefer not to share
- this data with Google.</p>
-
- <p>We use the gathered information to help us make our site more useful to visitors and to better understand how
- and when our site is used. We do not track or collect personally identifiable information or associate gathered
- data with any personally identifying information from other sources.</p>
-
- <p>By using this web site, you consent to the collection of this data in the manner and for the purpose described
- above.</p>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/site/xdoc/quickstart.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/quickstart.xml b/src/site/xdoc/quickstart.xml
deleted file mode 100644
index cc54eab..0000000
--- a/src/site/xdoc/quickstart.xml
+++ /dev/null
@@ -1,208 +0,0 @@
-<?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>Quick start</title>
- </properties>
-
- <body>
- <section name="Quick start">
-
- <p>First, <a href="install.html">install Apache log4php</a>.</p>
-
- <p>You may also like to read the <a href="docs/introduction.html">introduction chapter</a> to familiarise
- yoursef with the basic concepts used throughout the documentation and examples.</p>
-
- <subsection name="A trivial example">
- <p>Just want logging to stdout?</p>
-
-<pre class="prettyprint linenums">
-include('Logger.php');
-$logger = Logger::getLogger("main");
-$logger->info("This is an informational message.");
-$logger->warn("I'm not feeling so good...");
-</pre>
-
- <p>This produces the following output:</p>
-
-<pre>
-INFO - This is an informational message.
-WARN - I'm not feeling so good...
-</pre>
-
- </subsection>
-
- <subsection name="A simple example">
- <p>This example shows how to configure log4php using an XML configuration file. The framework will be
- configured to log messages to a file, but only those with level greater or equal to <code>WARN</code>.
- </p>
-
- <p>First, create a configuration file named <code>config.xml</code> containing:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
- <appender name="myAppender" class="LoggerAppenderFile">
- <param name="file" value="myLog.log" />
- </appender>
- <root>
- <level value="WARN" />
- <appender_ref ref="myAppender" />
- </root>
-</configuration>
-]]></pre>
-
- <p>This configuration file does the following:</p>
-
- <ul>
- <li><em>line 2</em>: Creates an appender named <code>myAppender</code> using appender class <code>
- <a href="docs/appenders/file.html">LoggerAppenderFile</a></code> which is used for
- logging to a file.</li>
-
- <li><em>line 3</em>: Sets the <code>file</code> parameter, which tells the appender to which file to
- write.</li>
-
- <li><em>line 6</em>: Sets the root logger level to <code>WARN</code>. This means that logging requests
- with the level lower than <code>WARN</code> will not be logged by the root logger.</li>
-
- <li><em>line 7</em>: Links <code>myAppender</code> to the root logger so that all events recieved by the root
- logger will be forwarded to <code>myAppender</code> and written into the log file.</li>
- </ul>
-
- <p>To try it out, run the following code:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-// Insert the path where you unpacked log4php
-include('log4php/Logger.php');
-
-// Tell log4php to use our configuration file.
-Logger::configure('config.xml');
-
-// Fetch a logger, it will inherit settings from the root logger
-$log = Logger::getLogger('myLogger');
-
-// Start logging
-$log->trace("My first message."); // Not logged because TRACE < WARN
-$log->debug("My second message."); // Not logged because DEBUG < WARN
-$log->info("My third message."); // Not logged because INFO < WARN
-$log->warn("My fourth message."); // Logged because WARN >= WARN
-$log->error("My fifth message."); // Logged because ERROR >= WARN
-$log->fatal("My sixth message."); // Logged because FATAL >= WARN
-]]></pre>
-
- <p>This will create a file named <code>myLog.log</code> containing the following output:</p>
-
-<pre><![CDATA[
-WARN - My fourth message.
-ERROR - My fifth message.
-FATAL - My sixth message.
-]]></pre>
-
- </subsection>
-
- <subsection name="An advanced example">
-
- <p>This example covers named loggers, layouts and best practices in object-oriented programming.</p>
-
- <p>Create a configuration file named <code>config.xml</code> with the following content:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-<configuration xmlns="http://logging.apache.org/log4php/">
-
- <appender name="myConsoleAppender" class="LoggerAppenderConsole" />
-
- <appender name="myFileAppender" class="LoggerAppenderFile">
- <layout class="LoggerLayoutPattern">
- <param name="conversionPattern" value="%date [%logger] %message%newline" />
- </layout>
- <param name="file" value="myLog.log" />
- </appender>
-
- <logger name="Foo">
- <appender_ref ref="myFileAppender" />
- </logger>
-
- <root>
- <level value="DEBUG" />
- <appender_ref ref="myConsoleAppender" />
- </root>
-</configuration>
-]]></pre>
-
- <p>The configuration defines two appenders: one writes to the console, and the other to a file.</p>
-
- <p>The
- console appender doesn't have a layout defined, so it will revert to default layout
- (<code><a href="docs/layouts/simple.html">LoggerLayoutSimple</a></code>). The
- file appender uses a different layout
- (<code><a href="docs/layouts/pattern.html">LoggerLayoutPattern</a></code>)
- which will result in different formatting of the logging
- events.</p>
-
- <p>The console appender is linked to the root logger. The file appender is linked to the logger named
- <code>Foo</code>, however <code>Foo</code> also inherits appenders from the root logger (in this case
- the console appender). This means that logging events sent to the <code>Foo</code> logger will be
- logged both to the console and the file.</p>
-
- <p>Consider the following code snippet:</p>
-
-<pre class="prettyprint linenums"><![CDATA[
-// Include and configure log4php
-include('log4php/Logger.php');
-Logger::configure('config.xml');
-
-/**
- * This is a classic usage pattern: one logger object per class.
- */
-class Foo
-{
- /** Holds the Logger. */
- private $log;
-
- /** Logger is instantiated in the constructor. */
- public function __construct()
- {
- // The __CLASS__ constant holds the class name, in our case "Foo".
- // Therefore this creates a logger named "Foo" (which we configured in the config file)
- $this->log = Logger::getLogger(__CLASS__);
- }
-
- /** Logger can be used from any member method. */
- public function go()
- {
- $this->log->info("We have liftoff.");
- }
-}
-
-$foo = new Foo();
-$foo->go();
-]]></pre>
-
- <p>This produces the following output in the console:</p>
- <pre>INFO - We have liftoff.</pre>
-
- <p>And the following in the log file:</p>
- <pre>01/06/11 18:43:39,545 [5428] INFO Foo - We have liftoff.</pre>
-
- <p>Note the different layout, this is because LoggerLayoutTTCC was used as layout for the file appender.</p>
- </subsection>
-
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/test/config/phpunit_to_surefire.xslt
----------------------------------------------------------------------
diff --git a/src/test/config/phpunit_to_surefire.xslt b/src/test/config/phpunit_to_surefire.xslt
deleted file mode 100644
index 1f8fd61..0000000
--- a/src/test/config/phpunit_to_surefire.xslt
+++ /dev/null
@@ -1,38 +0,0 @@
-<?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.
--->
-<xsl:stylesheet version="2.0"
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema"
- xmlns:fn="http://www.w3.org/2005/xpath-functions">
- <xsl:output method="xml" version="1.0" encoding="UTF-8" indent="yes" />
- <xsl:param name="outputDir">.</xsl:param>
-
- <xsl:template match="testsuites">
- <xsl:apply-templates select="testsuite" />
- </xsl:template>
-
- <xsl:template match="testsuite">
- <xsl:if test="testcase">
- <xsl:variable name="outputName" select="./@name" />
- <xsl:result-document href="{$outputDir}/{$outputName}.xml" method="xml">
- <xsl:copy-of select="." />
- </xsl:result-document>
- </xsl:if>
-
- <xsl:apply-templates select="testsuite" />
- </xsl:template>
-</xsl:stylesheet>
http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/79ed2d0d/src/test/php/LoggerAppenderPoolTest.php
----------------------------------------------------------------------
diff --git a/src/test/php/LoggerAppenderPoolTest.php b/src/test/php/LoggerAppenderPoolTest.php
deleted file mode 100644
index 89aecff..0000000
--- a/src/test/php/LoggerAppenderPoolTest.php
+++ /dev/null
@@ -1,65 +0,0 @@
-<?php
-/**
- * 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.
- *
- * @category tests
- * @package log4php
- * @subpackage filters
- * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
- * @version $Revision$
- * @link http://logging.apache.org/log4php
- */
-
-/**
- * @group filters
- */
-class LoggerAppenderPoolTest extends PHPUnit_Framework_TestCase {
-
- private $appenderMock;
-
- public function setUp() {
- $this->appenderMock = $this->getMock('LoggerAppenderConsole', array(), array(), '', false);
- }
-
- /**
- * @expectedException PHPUnit_Framework_Error
- * @expectedExceptionMessage log4php: Cannot add unnamed appender to pool.
- */
- public function testAppenderHasNoName() {
- $this->appenderMock->expects($this->once())
- ->method('getName')
- ->will($this->returnValue(''));
-
- LoggerAppenderPool::add($this->appenderMock);
- }
-
- /**
- * @expectedException PHPUnit_Framework_Error
- * @expectedExceptionMessage log4php: Appender [foo] already exists in pool. Overwriting existing appender.
- */
- public function testAppenderIsAdded() {
- $this->appenderMock->expects($this->any())
- ->method('getName')
- ->will($this->returnValue('foo'));
-
- LoggerAppenderPool::add($this->appenderMock);
- LoggerAppenderPool::add($this->appenderMock);
-
- $expected = 1;
- $actual = count(LoggerAppenderPool::getAppenders());
- $this->assertEquals($expected, $actual);
- }
-}