Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerConfigurato
r.html
URL: http://svn.apache.org/viewvc/incubator/log4php/site/
apidocs/log4php/spi/LoggerConfigurator.html?view=auto&re
v=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerConfigurato
r.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerConfigurato
r.html Fri Jul 20 19:10:17 2007
 -0,0
+1,113
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerConfigurator</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Interface
LoggerConfigurator</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">Implemented by
classes capable of configuring log4php using a
URL.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_spi---LoggerConfigurator.php.html">/spi/
LoggerConfigurator.php</a> (line <span
class="field">40</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+ <div
class="method-definition">
+ static <span
class="method-result">void</span>
+ <a href="#configure"
title="details"
class="method-name">configure</a>
+ ([<span
class="var-type">string</span> &
lt;span class="var-name">$url</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+<a name="methodconfigure"
id="configure"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">static method
configure</span> (line <span
class="line-number">50</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Interpret a
resource pointed by a <var>url</var> and
configure accordingly.</p>
+<p class="description"><p>The
configuration is done relative to the
<var>repository</var>
parameter.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ static
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ configure
+ </span>
+ ([<span
class="var-type">string</span> &
lt;span class="var-name">$url</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$url</span><span
class="var-description">: The URL to
parse</span> </li>
+ </ul>
+
+
+ </div>
+
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:17
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerDefaultCate
goryFactory.html
URL: http://svn.apache.org/viewvc/incubator/log
4php/site/apidocs/log4php/spi/LoggerDefaultCategoryFactory.h
tml?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerDefaultCate
goryFactory.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerDefaultCate
goryFactory.html Fri Jul 20 19:10:17 2007
-0,0
+1,125
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerDefaultCategoryFactory</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerDefaultCategoryFactory</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">Creates
instances of <a
href="../../log4php/Logger.html">Logger</a&g
t; with a given name.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ <li><span
class="field">since:</span>
0.5</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_LoggerDefaultCategoryFactory.php.html">/
LoggerDefaultCategoryFactory.php</a> (line <span
class="field">28</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/spi/LoggerFactory.html">Log
gerFactory</a>
+ |
+ --LoggerDefaultCategoryFactory</pre>
+
+ </div>
+</div>
+
+
+
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <a href="#makeNewLoggerInstance"
title="details"
class="method-name">makeNewLoggerInstance</a
>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodmakeNewLoggerInstance"
id="makeNewLoggerInstance"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">makeNewLoggerInstance</
span> (line <span
class="line-number">34</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <span class="method-name">
+ makeNewLoggerInstance
+ </span>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$name</span> </li&g
t;
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/spi/LoggerFactory.html#methodmakeNe
wLoggerInstance">LoggerFactory::makeNewLoggerInstanc
e()</a></dt>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/spi/LoggerFactory.html">Log
gerFactory</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/spi/LoggerFactory.html#methodmakeNe
wLoggerInstance">LoggerFactory::makeNewLoggerInstanc
e()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:17
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerFactory.htm
l
URL: http://svn.apache.org/viewvc/incubator/log4php/site/apido
cs/log4php/spi/LoggerFactory.html?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerFactory.htm
l (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerFactory.htm
l Fri Jul 20 19:10:17 2007
-0,0
+1,146
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class LoggerFactory</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerFactory</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-descendents">Descendents</a>
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">Extend and
implement this abstract class to create new instances of
<a
href="../../log4php/Logger.html">Logger</a&g
t; or a sub-class of <a
href="../../log4php/Logger.html">Logger</a&g
t;.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ <li><span
class="field">abstract:</span>
</li>
+ <li><span
class="field">since:</span>
0.5</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_spi---LoggerFactory.php.html">/spi/Logge
rFactory.php</a> (line <span
class="field">31</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+ <a name="sec-descendents"></a>
+ <div class="info-box">
+ <div class="info-box-title">Direct
descendents</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Descendents</span>
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2"
cellspacing="0" class="class-table">
+ <tr>
+ <th
class="class-table-header">Class</th>
+ <th
class="class-table-header">Description</th&g
t;
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/spi/LoggerDefaultCategoryFactory.ht
ml">LoggerDefaultCategoryFactory</a></td>
;
+ <td>
+ Creates instances of <a
href="../../log4php/Logger.html">Logger</a&g
t; with a given name.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <a href="#makeNewLoggerInstance"
title="details"
class="method-name">makeNewLoggerInstance</a
>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodmakeNewLoggerInstance"
id="makeNewLoggerInstance"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">makeNewLoggerInstance</
span> (line <span
class="line-number">38</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">abstract:</span>
</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <span class="method-name">
+ makeNewLoggerInstance
+ </span>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$name</span> </li&g
t;
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../../log4php/spi/LoggerDefaultCategoryFactory.ht
ml#methodmakeNewLoggerInstance">LoggerDefaultCategor
yFactory::makeNewLoggerInstance()</a>
+ </li>
+ </ul>
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:18
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerFilter.html
URL: http://svn.apache.org/viewvc/incubator/log4php/site/apidoc
s/log4php/spi/LoggerFilter.html?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerFilter.html
(added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerFilter.html
Fri Jul 20 19:10:17 2007
-0,0
+1,300
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class LoggerFilter</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerFilter</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-descendents">Descendents</a>
+ | <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">Users should
extend this class to implement customized logging</p>
+<p class="description"><p>event
filtering. Note that LoggerCategory and <a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>, the parent class of all
standard appenders, have built-in filtering rules. It is
suggested that you first use and understand the built-in
rules before rushing to write your own custom
filters.</p><p><p>This abstract
class assumes and also imposes that filters be organized in
a linear chain. The #decide method of each filter is called
sequentially, in the order of their addition to the
chain.</p><p><p>The <a
href="../../log4php/spi/LoggerFilter.html#methoddecide&
quot;>decide()</a> method must return one of the
integer constants LOG4PHP_LOG4PHP_LOGGER_FILTER_DENY, <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_NEUTRAL">LOG4PHP_LOGGER_FI
LTER_NEUTRAL</a> or <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_ACCEPT">LOG4PHP_LOGGER_FIL
TER_ACCEPT</a
>.</p><p><p>If the value <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_DENY">LOG4PHP_LOGGER_FILTE
R_DENY</a> is returned, then the log event is dropped
immediately without consulting with the remaining
filters.</p><p><p>If the value
<a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_NEUTRAL">LOG4PHP_LOGGER_FI
LTER_NEUTRAL</a> is returned, then the next filter in
the chain is consulted. If there are no more filters in the
chain, then the log event is logged. Thus, in the presence
of no filters, the default behaviour is to log all logging
events.</p><p><p>If the value
<a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_ACCEPT">LOG4PHP_LOGGER_FIL
TER_ACCEPT</a> is returned, then the log event is
logged without consulting the remaining
filters.</p><p><p>The philosophy
of log4php filters is largely inspired from the Linux
ipchains.</p></p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556801 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_spi---LoggerFilter.php.html">/spi/Logger
Filter.php</a> (line <span
class="field">73</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+ <a name="sec-descendents"></a>
+ <div class="info-box">
+ <div class="info-box-title">Direct
descendents</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Descendents</span>
+ | <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2"
cellspacing="0" class="class-table">
+ <tr>
+ <th
class="class-table-header">Class</th>
+ <th
class="class-table-header">Description</th&g
t;
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/varia/LoggerStringMatchFilter.html&
quot;>LoggerStringMatchFilter</a></td>
+ <td>
+ This is a very simple filter based on string
matching.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/varia/LoggerLevelMatchFilter.html&q
uot;>LoggerLevelMatchFilter</a></td>
+ <td>
+ This is a very simple filter based on level
matching.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/varia/LoggerLevelRangeFilter.html&q
uot;>LoggerLevelRangeFilter</a></td>
+ <td>
+ This is a very simple filter based on level
matching, which can be used to reject messages with
priorities outside a certain range.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/varia/LoggerDenyAllFilter.html"
;>LoggerDenyAllFilter</a></td>
+ <td>
+ This filter drops all logging events.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <span
class="disabled">Vars</span> (<a
href="#sec-vars">details</a>)
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div
class="var-title">
+ <span class="var-type"><a
href="../../log4php/spi/LoggerFilter.html">Logg
erFilter</a></span>
+ <a href="#$next"
title="details"
class="var-name">$next</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+
+ |
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#activateOptions"
title="details"
class="method-name">activateOptions</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">integer</span>
+ <a href="#decide"
title="details"
class="method-name">decide</a>
+ (<span class="var-type"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></span> <spa
n class="var-name">$event</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getNext"
title="details"
class="method-name">getNext</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <a
href="#sec-var-summary">Vars</a>
(<span
class="disabled">details</span>)
+
+
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$next"
id="$next"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../../log4php/spi/LoggerFilter.html">Logg
erFilter</a></span>
+ <span
class="var-name">$next</span>
+ (line <span
class="line-number">78</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Points to the
next <a
href="../../log4php/spi/LoggerFilter.html">Logg
erFilter</a> in the filter chain.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-descendents">Descendents</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodactivateOptions"
id="activateOptions"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">activateOptions</span&g
t; (line <span
class="line-number">84</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Usually
filters options become active when set. We provide a
default do-nothing implementation for
convenience.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ activateOptions
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methoddecide"
id="decide"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">decide</span> (line
<span class="line-number">100</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Decide what to
do.</p>
+<p class="description"><p>If the
decision is <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_DENY">LOG4PHP_LOGGER_FILTE
R_DENY</a>, then the event will be dropped. If the
decision is <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_NEUTRAL">LOG4PHP_LOGGER_FI
LTER_NEUTRAL</a>, then the next filter, if any, will
be invoked. If the decision is <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_ACCEPT">LOG4PHP_LOGGER_FIL
TER_ACCEPT</a> then the event will be logged without
consulting with other filters in the
chain.</p></p>
+ <ul class="tags">
+ <li><span
class="field">return:</span> <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_NEUTRAL">LOG4PHP_LOGGER_FI
LTER_NEUTRAL</a> or <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_DENY">LOG4PHP_LOGGER_FILTE
R_DENY</a>|<a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_ACCEPT">LOG4PHP_LOGGER_FIL
TER_ACCEPT</a></li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">integer</span>
+ <span class="method-name">
+ decide
+ </span>
+ (<span class="var-type"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></span> <spa
n class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></span>
+ <span
class="var-name">$event</span><span
class="var-description">: The <a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a> to decide
upon.</span> </li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../../log4php/varia/LoggerStringMatchFilter.html#
methoddecide">LoggerStringMatchFilter::decide()</
a>
+ </li>
+ <li>
+ <a
href="../../log4php/varia/LoggerLevelMatchFilter.html#m
ethoddecide">LoggerLevelMatchFilter::decide()</a&
gt;
+ : Return the decision of this filter.
+ </li>
+ <li>
+ <a
href="../../log4php/varia/LoggerLevelRangeFilter.html#m
ethoddecide">LoggerLevelRangeFilter::decide()</a&
gt;
+ : Return the decision of this filter.
+ </li>
+ <li>
+ <a
href="../../log4php/varia/LoggerDenyAllFilter.html#meth
oddecide">LoggerDenyAllFilter::decide()</a>
+ : Always returns the integer constant <a
href="../../log4php/spi/_spi---LoggerFilter.php.html#de
fineLOG4PHP_LOGGER_FILTER_DENY">LOG4PHP_LOGGER_FILTE
R_DENY</a> regardless of the <a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a> parameter.
+ </li>
+ </ul>
+ </div>
+<a name="methodgetNext"
id="getNext"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getNext</span> (line
<span class="line-number">105</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getNext
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:18
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerFormattingI
nfo.html
URL: http://svn.apache.org/viewvc/incubator/log4php/sit
e/apidocs/log4php/spi/LoggerFormattingInfo.html?view=auto&am
p;rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerFormattingI
nfo.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerFormattingI
nfo.html Fri Jul 20 19:10:17 2007
-0,0
+1,255
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerFormattingInfo</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerFormattingInfo</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">This class
encapsulates the information obtained when parsing
formatting modifiers in conversion modifiers.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">since:</span>
0.3</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_helpers---LoggerFormattingInfo.php.html">
;/helpers/LoggerFormattingInfo.php</a> (line <span
class="field">31</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Vars</span> (<a
href="#sec-vars">details</a>)
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div
class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$leftAlign"
title="details"
class="var-name">$leftAlign</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$max" title="details"
class="var-name">$max</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$min" title="details"
class="var-name">$min</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+
+ |
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div
class="method-definition">
+ <span
class="method-result">LoggerFormattingInfo</
span>
+ <a href="#LoggerFormattingInfo"
title="details"
class="method-name">LoggerFormattingInfo</a&
gt;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#dump"
title="details"
class="method-name">dump</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#reset"
title="details"
class="method-name">reset</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a>
(<span
class="disabled">details</span>)
+
+
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$leftAlign"
id="$leftAlign"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$leftAlign</span>
+ = <span class="var-default">
false</span> (line <span
class="line-number">35</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+
+
+
+</div>
+<a name="var$max"
id="$max"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$max</span>
+ = <span class="var-default">
0x7FFFFFFF</span> (line <span
class="line-number">34</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+
+
+
+</div>
+<a name="var$min"
id="$min"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$min</span>
+ = <span class="var-default">
-1</span> (line <span
class="line-number">33</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodLoggerFormattingInfo"
id="LoggerFormattingInfo"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerFormattingInfo</span> (line <span
class="line-number">40</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor</p>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerFormattingInfo</
span>
+ <span class="method-name">
+ LoggerFormattingInfo
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methoddump"
id="dump"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">dump</span> (line
<span class="line-number">49</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ dump
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodreset"
id="reset"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">reset</span> (line
<span class="line-number">42</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ reset
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:18
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerLocationInf
o.html
URL: http://svn.apache.org/viewvc/incubator/log4php/site/
apidocs/log4php/spi/LoggerLocationInfo.html?view=auto&re
v=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerLocationInf
o.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerLocationInf
o.html Fri Jul 20 19:10:17 2007
-0,0
+1,400
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerLocationInfo</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerLocationInfo</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">The internal
representation of caller location information.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556801 $</li>
+ <li><span
class="field">since:</span>
0.3</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_spi---LoggerLocationInfo.php.html">/spi/
LoggerLocationInfo.php</a> (line <span
class="field">34</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Vars</span> (<a
href="#sec-vars">details</a>)
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <
;div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$className"
title="details"
class="var-name">$className</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$fileName"
title="details"
class="var-name">$fileName</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$fullInfo"
title="details"
class="var-name">$fullInfo</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$lineNumber"
title="details"
class="var-name">$lineNumber</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$methodName"
title="details"
class="var-name">$methodName</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+
+ |
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div
class="method-definition">
+ <span
class="method-result">LoggerLocationInfo</sp
an>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ (<span
class="var-type">array</span> &l
t;span class="var-name">$trace</span>,
[<span
class="var-type"></span> <spa
n class="var-name">$fqcn</span> =
<span
class="var-default">null</span>],
<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getClassName"
title="details"
class="method-name">getClassName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getFileName"
title="details"
class="method-name">getFileName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getLineNumber"
title="details"
class="method-name">getLineNumber</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getMethodName"
title="details"
class="method-name">getMethodName</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a>
(<span
class="disabled">details</span>)
+
+
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$className"
id="$className"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$className</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">49</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Caller's fully
qualified class name.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$fileName"
id="$fileName"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fileName</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">44</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Caller's file
name.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$fullInfo"
id="$fullInfo"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fullInfo</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">59</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$lineNumber"
id="$lineNumber"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$lineNumber</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">39</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Caller's line
number.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$methodName"
id="$methodName"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$methodName</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">54</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Caller's method
name.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="method__construct"
id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
__construct</span> (line <span
class="line-number">67</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Instantiate
location information based on a <a href="http://www.ph
p.net/debug_backtrace">http://www.php.net/debug_back
trace</a>.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerLocationInfo</sp
an>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span
class="var-type">array</span> &l
t;span class="var-name">$trace</span>,
[<span
class="var-type"></span> <spa
n class="var-name">$fqcn</span> =
<span
class="var-default">null</span>],
<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">array</span>
+ <span
class="var-name">$trace</span> </li&
gt;
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span> </li
>
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$fqcn</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodgetClassName"
id="getClassName"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getClassName</span>
(line <span
class="line-number">78</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getClassName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetFileName"
id="getFileName"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFileName</span>
(line <span
class="line-number">87</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
file name of the caller.</p>
+<p class="description"><p>This
information is not always available.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getFileName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetLineNumber"
id="getLineNumber"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLineNumber</span>
(line <span
class="line-number">96</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
line number of the caller.</p>
+<p class="description"><p>This
information is not always available.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getLineNumber
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetMethodName"
id="getMethodName"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getMethodName</span>
(line <span
class="line-number">104</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
method name of the caller.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getMethodName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:19
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/LoggerLoggingEven
t.html
URL: http://svn.apache.org/viewvc/incubator/log4php/site/
apidocs/log4php/spi/LoggerLoggingEvent.html?view=auto&re
v=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/LoggerLoggingEven
t.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/LoggerLoggingEven
t.html Fri Jul 20 19:10:17 2007
-0,0
+1,843
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerLoggingEvent</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerLoggingEvent</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ | <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">The internal
representation of logging event.</p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556801 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_spi---LoggerLoggingEvent.php.html">/spi/
LoggerLoggingEvent.php</a> (line <span
class="field">33</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Vars</span> (<a
href="#sec-vars">details</a>)
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+
<div
class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$categoryName"
title="details"
class="var-name">$categoryName</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$fqcn"
title="details"
class="var-name">$fqcn</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span>
+ <a href="#$level"
title="details"
class="var-name">$level</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type"><a
href="../../log4php/spi/LoggerLocationInfo.html"&g
t;LoggerLocationInfo</a></span>
+ <a href="#$locationInfo"
title="details"
class="var-name">$locationInfo</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <a href="#$logger"
title="details"
class="var-name">$logger</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">boolean</span>
+ <a href="#$mdcCopyLookupRequired"
title="details"
class="var-name">$mdcCopyLookupRequired</a&g
t;
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$message"
title="details"
class="var-name">$message</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$ndc" title="details"
class="var-name">$ndc</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">boolean</span>
+ <a href="#$ndcLookupRequired"
title="details"
class="var-name">$ndcLookupRequired</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$renderedMessage"
title="details"
class="var-name">$renderedMessage</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$threadName"
title="details"
class="var-name">$threadName</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">float</span>
+ <a href="#$timeStamp"
title="details"
class="var-name">$timeStamp</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method
Summary</span></div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+
+ |
+ <span
class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
<div
class="method-definition">
+ static <span
class="method-result">float</span>
+ <a href="#getStartTime"
title="details"
class="method-name">getStartTime</a>
+ ()
+ </div>
+
+ <div
class="method-definition">
+ <span
class="method-result">LoggerLoggingEvent</sp
an>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$fqcn</span>,
<span
class="var-type">mixed</span> &l
t;span class="var-name">$logger</span>,
<span class="var-type"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span> <span
class="var-name">$priority</span>,
<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">integer</span>
<span
class="var-name">$timeStamp</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span>
+ <a href="#getLevel"
title="details"
class="method-name">getLevel</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../../log4php/spi/LoggerLocationInfo.html"&g
t;LoggerLocationInfo</a></span>
+ <a href="#getLocationInformation"
title="details"
class="method-name">getLocationInformation</
a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getLoggerName"
title="details"
class="method-name">getLoggerName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getMDC"
title="details"
class="method-name">getMDC</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$key</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">mixed</span>
+ <a href="#getMessage"
title="details"
class="method-name">getMessage</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getNDC"
title="details"
class="method-name">getNDC</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getRenderedMessage"
title="details"
class="method-name">getRenderedMessage</a>
;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">mixed</span>
+ <a href="#getThreadName"
title="details"
class="method-name">getThreadName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">mixed</span>
+ <a href="#getThrowableInformation"
title="details"
class="method-name">getThrowableInformation<
/a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">float</span>
+ <a href="#getTimeStamp"
title="details"
class="method-name">getTimeStamp</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#toString"
title="details"
class="method-name">toString</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#__sleep"
title="details"
class="method-name">__sleep</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a>
(<span
class="disabled">details</span>)
+
+
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$categoryName"
id="$categoryName"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$categoryName</span>
+ (line <span
class="line-number">54</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The category
(logger) name.</p>
+<p class="description"><p>This field
will be marked as private in future releases. Please do not
access it directly. Use the <a
href="../../log4php/spi/LoggerLoggingEvent.html#methodg
etLoggerName">getLoggerName()</a> method
instead.</p></p>
+ <ul class="tags">
+ <li><span
class="field">deprecated:</span>
</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$fqcn"
id="$fqcn"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fqcn</span>
+ (line <span
class="line-number">40</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Fully Qualified
Class Name of the calling category class.</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$level"
id="$level"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span>
+ <span
class="var-name">$level</span>
+ (line <span
class="line-number">64</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Level of
logging event.</p>
+<p class="description"><p>This field
should not be accessed directly. You shoud use the <a
href="../../log4php/spi/LoggerLoggingEvent.html#methodg
etLevel">getLevel()</a> method
instead.</p></p>
+ <ul class="tags">
+ <li><span
class="field">deprecated:</span>
</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$locationInfo"
id="$locationInfo"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../../log4php/spi/LoggerLocationInfo.html"&g
t;LoggerLocationInfo</a></span>
+ <span
class="var-name">$locationInfo</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">117</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> Location
information for the caller.</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$logger"
id="$logger"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../../log4php/Logger.html">Logger</a&g
t;</span>
+ <span
class="var-name">$logger</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">45</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span>
reference</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$mdcCopyLookupRequired"
id="$mdcCopyLookupRequired"><!--
--></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$mdcCopyLookupRequired</spa
n>
+ = <span class="var-default">
true</span> (line <span
class="line-number">86</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Have we tried
to do an MDC lookup? If we did, there is no need to do it
again. Note that its value is always false when
serialized. See also the getMDC and getMDCCopy
methods.</p>
+
+
+
+
+
+</div>
+<a name="var$message"
id="$message"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span>
+ (line <span
class="line-number">91</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> The application
supplied message of logging event.</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$ndc"
id="$ndc"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$ndc</span>
+ (line <span
class="line-number">69</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> The nested
diagnostic context (NDC) of logging event.</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$ndcLookupRequired"
id="$ndcLookupRequired"><!--
--></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$ndcLookupRequired</span>
;
+ = <span class="var-default">
true</span> (line <span
class="line-number">78</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Have we tried
to do an NDC lookup? If we did, there is no need to do it
again. Note that its value is always false when
serialized. Thus, a receiving SocketNode will never use it's
own (incorrect) NDC. See also writeObject
method.</p>
+
+
+
+
+
+</div>
+<a name="var$renderedMessage"
id="$renderedMessage"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$renderedMessage</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">98</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
application supplied message rendered through the log4php
objet rendering mechanism. At present renderedMessage ==
message.</p>
+
+
+
+
+
+</div>
+<a name="var$threadName"
id="$threadName"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$threadName</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">105</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The name of
thread in which this logging event was generated.</p>
+<p class="description"><p>log4php
saves here the process id via <a href="http://
www.php.net/getmypid">getmypid()</a></p
></p>
+
+
+
+
+
+</div>
+<a name="var$timeStamp"
id="$timeStamp"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">float</span>
+ <span
class="var-name">$timeStamp</span>
+ (line <span
class="line-number">112</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The number of
seconds elapsed from 1/1/1970 until logging event was
created plus microseconds if available.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+<a name="methodgetStartTime"
id="getStartTime"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">static method
getStartTime</span> (line <span
class="line-number">301</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
time when the application started, in seconds elapsed since
01.01.1970 plus microseconds if available.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ static
+ <span
class="method-result">float</span>
+ <span class="method-name">
+ getStartTime
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+<a name="method__construct"
id="__construct"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
__construct</span> (line <span
class="line-number">131</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Instantiate a
LoggingEvent from the supplied parameters.</p>
+<p class="description"><p>Except
<a
href="../../log4php/spi/LoggerLoggingEvent.html#var$tim
eStamp">$timeStamp</a> all the other fields of
LoggerLoggingEvent are filled when actually
needed.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerLoggingEvent</sp
an>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$fqcn</span>,
<span
class="var-type">mixed</span> &l
t;span class="var-name">$logger</span>,
<span class="var-type"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span> <span
class="var-name">$priority</span>,
<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">integer</span>
<span
class="var-name">$timeStamp</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fqcn</span><span
class="var-description">: name of the caller
class.</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$logger</span><span
class="var-description">: The <a
href="../../log4php/Logger.html">Logger</a&g
t; category of this event or the logger
name.</span> </li>
+ <li>
+ <span class="var-type"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span>
+ <span
class="var-name">$priority</span><span
class="var-description">: The level of this
event.</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">: The message of this
event.</span> </li>
+ <li>
+ <span
class="var-type">integer</span>
+ <span
class="var-name">$timeStamp</span><spa
n class="var-description">: the timestamp of
this logging event.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodgetLevel"
id="getLevel"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLevel</span>
(line <span
class="line-number">208</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
level of this event. Use this form instead of directly
accessing the $level field.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../../log4php/LoggerLevel.html">LoggerLev
el</a></span>
+ <span class="method-name">
+ getLevel
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetLocationInformation"
id="getLocationInformation"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLocationInformation<
/span> (line <span
class="line-number">163</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Set the
location information for this logging event. The collected
information is cached for future use.</p>
+<p class="description"><p>This method
uses <a href="http://www.php.net/debug_backtrace">debug_bac
ktrace()</a> function (if exists) to collect
informations about caller.</p><p>It only
recognize informations generated by <a
href="../../log4php/Logger.html">Logger</a&g
t; and its subclasses.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../../log4php/spi/LoggerLocationInfo.html"&g
t;LoggerLocationInfo</a></span>
+ <span class="method-name">
+ getLocationInformation
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetLoggerName"
id="getLoggerName"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLoggerName</span>
(line <span
class="line-number">218</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
name of the logger. Use this form instead of directly
accessing the $categoryName field.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getLoggerName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetMDC"
id="getMDC"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getMDC</span> (line
<span class="line-number">263</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
the context corresponding to the <div
class="src-code"><ol><li><div
class="src-line"><a href="http://www.php.net/key">key</a>
;</div></li>
+</ol></div> parameter.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getMDC
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$key</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$key</span> </li>
;
+ </ul>
+
+
+ </div>
+<a name="methodgetMessage"
id="getMessage"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getMessage</span>
(line <span
class="line-number">232</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
message for this logging event.</p>
+<p class="description"><p>Before
serialization, the returned object is the message passed by
the user to generate the logging event. After
serialization, the returned value equals the String form of
the message possibly after object
rendering.</p></p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">mixed</span>
+ <span class="method-name">
+ getMessage
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetNDC"
id="getNDC"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getNDC</span> (line
<span class="line-number">248</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">This method
returns the NDC for this event. It will return the correct
content even if the event was generated in a different
thread or even on a different machine. The <a
href="../../log4php/LoggerNDC.html#methodget">L
oggerNDC::get()</a> method should
<strong>never</strong> be called
directly.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getNDC
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetRenderedMessage"
id="getRenderedMessage"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getRenderedMessage</spa
n> (line <span
class="line-number">272</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Render
message.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getRenderedMessage
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetThreadName"
id="getThreadName"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getThreadName</span>
(line <span
class="line-number">324</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">mixed</span>
+ <span class="method-name">
+ getThreadName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetThrowableInformation"
id="getThrowableInformation"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getThrowableInformation<
;/span> (line <span
class="line-number">334</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span>
null</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">mixed</span>
+ <span class="method-name">
+ getThrowableInformation
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetTimeStamp"
id="getTimeStamp"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getTimeStamp</span>
(line <span
class="line-number">316</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">float</span>
+ <span class="method-name">
+ getTimeStamp
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodtoString"
id="toString"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">toString</span>
(line <span
class="line-number">343</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Serialize this
object</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ toString
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="method__sleep"
id="__sleep"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">__sleep</span> (line
<span class="line-number">351</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Avoid
serialization of the $logger object</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ __sleep
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:19
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/spi/_spi---LoggerConf
igurator.php.html
URL: http://svn.apache.org/viewvc/incubator/lo
g4php/site/apidocs/log4php/spi/_spi---LoggerConfigurator.php
.html?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/spi/_spi---LoggerConf
igurator.php.html (added)
+++
incubator/log4php/site/apidocs/log4php/spi/_spi---LoggerConf
igurator.php.html Fri Jul 20 19:10:17 2007
-0,0
+1,107
+<?xml version="1.0"
encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs for page
LoggerConfigurator.php</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2
class="file-name">/spi/LoggerConfigurator.php&l
t;/h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div
class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-classes">Classes</a>
+ | <a
href="#sec-constants">Constants</a>
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Copyright 2004
The Apache Software Foundation.</p>
+<p class="description"><p>This
software is published under the terms of the Apache Software
License version 2.0, a copy of which has been included with
this distribution in the LICENSE file.</p></p>
+
+ </div>
+</div>
+
+ <a name="sec-classes"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Classes</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Classes</span>
+ | <a
href="#sec-constants">Constants</a>
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2"
cellspacing="0" class="class-table">
+ <tr>
+ <th
class="class-table-header">Class</th>
+ <th
class="class-table-header">Description</th&g
t;
+ </tr>
+ <tr>
+ <td style="padding-right: 2em; vertical-align:
top">
+ <a
href="../../log4php/spi/LoggerConfigurator.html"&g
t;LoggerConfigurator</a>
+ </td>
+ <td>
+ Implemented by classes capable of configuring
log4php using a URL.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+ <a name="sec-constants"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Constants</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-classes">Classes</a>
+ | <span
class="disabled">Constants</span>
+ </div>
+ <div class="info-box-body">
+ <a
name="defineLOG4PHP_LOGGER_CONFIGURATOR_INHERITED"
><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_CONFIGURATOR_
INHERITED</span> = 'inherited'
+ (line <span
class="line-number">23</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Special level
value signifying inherited behaviour. The current value of
this string constant is
<strong>inherited</strong>.</p>
+<p class="description"><p><a
href="../../log4php/spi/_spi---LoggerConfigurator.php.h
tml#defineLOG4PHP_LOGGER_CONFIGURATOR_NULL">LOG4PHP_
LOGGER_CONFIGURATOR_NULL</a> is a
synonym.</p></p>
+
+
+</div>
+<a
name="defineLOG4PHP_LOGGER_CONFIGURATOR_NULL">&
lt;!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_CONFIGURATOR_
NULL</span> = 'null'
+ (line <span
class="line-number">30</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Special level
signifying inherited behaviour, same as <a
href="../../log4php/spi/_spi---LoggerConfigurator.php.h
tml#defineLOG4PHP_LOGGER_CONFIGURATOR_INHERITED">LOG
4PHP_LOGGER_CONFIGURATOR_INHERITED</a>.</p>
+<p class="description"><p>The current
value of this string constant is
<strong>null</strong>.</p></p>
+
+
+</div>
+ </div>
+ </div>
+
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:17
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
|
