svn commit: r558223 - in /incubator/log4php/site: ./ apidocs/ apidocs/log4php/ apidocs/log4ph

Thread: svn commit: r558223 - in /incubator/log4php/site: ./ apidocs/ apidocs/log4php/ apidocs/log4ph

Search this list only Search all lists
svn commit: r558223 - in /incubator/log4php/site: ./ apidocs/ apidocs/log4php/ apidocs/log4ph
United States	2007-07-20 21:10:30
Added: incubator/log4php/site/apidocs/log4php/LoggerMDC.html URL: http: //svn.apache.org/viewvc/incubator/log4php/site/apidocs/log4p hp/LoggerMDC.html?view=auto&rev=558223 ============================================================ ================== --- incubator/log4php/site/apidocs/log4php/LoggerMDC.html (added) +++ incubator/log4php/site/apidocs/log4php/LoggerMDC.html Fri Jul 20 19:10:17 2007 -0,0 +1,190 +<?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 LoggerMDC</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 LoggerMDC</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">The LoggerMDC class is similar to the <a href="../log4php/LoggerNDC.html">LoggerNDC</ a> class except that it is based on a map instead of a stack. It provides <em>mapped diagnostic contexts</em>.</p> +<p class="description"><p>A <em>Mapped Diagnostic Context</em>, or MDC in short, is an instrument for distinguishing interleaved log output from different sources. Log output is typically interleaved when a server handles multiple clients near-simultaneously.</p><p><strong>&lt ;i>The MDC is managed on a per thread basis</i></strong>.</p></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.3</li> + </ul> + <p class="notes"> + Located in <a class="field" href="_LoggerMDC.php.html">/LoggerMDC.php</a > (line <span class="field">45</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">string</span> + <a href="#get" title="details" class="method-name">get</a> + (<span class="var-type">string</span> & lt;span class="var-name">$key</span>) + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#put" title="details" class="method-name">put</a> + (<span class="var-type">string</span> & lt;span class="var-name">$key</span>, <span class="var-type">string</span> & lt;span class="var-name">$value</span>) + </div> + <div class="method-definition"> + static <span class="method-result">string</span> + <a href="#remove" title="details" class="method-name">remove</a> + (<span class="var-type">string</span> & lt;span class="var-name">$key</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="methodget" id="get"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method get</span> (line <span class="line-number">79</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Get the context identified by the key parameter.</p> +<p class="description"><p>You can use special key identifiers to map values in PHP $_SERVER and $_ENV vars. Just put a 'server.' or 'env.' followed by the var name you want to refer.</p><p>This method has no side effects.</p><p></p></p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">string</span> + <span class="method-name"> + get + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$key</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$key</span> </li> ; + </ul> + + + </div> +<a name="methodput" id="put"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method put</span> (line <span class="line-number">60</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Put a context value as identified with the key parameter into the current thread's context map.</p> +<p class="description"><p>If the current thread does not have a context map it is created as a side effect.</p><p>Note that you cannot put more than <a href="../log4php/_LoggerMDC.php.html#defineLOGGER_MDC_H T_SIZE">LOGGER_MDC_HT_SIZE</a> keys.</p><p></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"> + put + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$key</span>, <span class="var-type">string</span> & lt;span class="var-name">$value</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$key</span><span class="var-description">: the key</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$value</span><span class="var-description">: the value</span> </li> + </ul> + + + </div> +<a name="methodremove" id="remove"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method remove</span> (line <span class="line-number">116</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Remove the the context identified by the key parameter.</p> +<p class="description"><p>It only affects user mappings.</p></p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">string</span> + <span class="method-name"> + remove + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$key</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$key</span> </li> ; + </ul> + + + </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/LoggerManager.html URL: h ttp://svn.apache.org/viewvc/incubator/log4php/site/apidocs/l og4php/LoggerManager.html?view=auto&rev=558223 ============================================================ ================== --- incubator/log4php/site/apidocs/log4php/LoggerManager.html (added) +++ incubator/log4php/site/apidocs/log4php/LoggerManager.html Fri Jul 20 19:10:17 2007 -0,0 +1,342 +<?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 LoggerManager</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 LoggerManager</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">Use the LoggerManager to get Logger instances.</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">see:</span> <a href="../log4php/Logger.html">Logger</a>& lt;/li> + <li><span class="field">todo:</span> create a configurator selector</li> + </ul> + <p class="notes"> + Located in <a class="field" href="_LoggerManager.php.html">/LoggerManager.p hp</a> (line <span class="field">33</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">boolean</span> + <a href="#exists" title="details" class="method-name">exists</a> + (<span class="var-type">string</span> & lt;span class="var-name">$name</span>) + </div> + <div class="method-definition"> + static <span class="method-result">array</span> + <a href="#getCurrentLoggers" title="details" class="method-name">getCurrentLoggers</a> + () + </div> + <div class="method-definition"> + static <span class="method-result"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <a href="#getLogger" title="details" class="method-name">getLogger</a> + (<span class="var-type">string</span> & lt;span class="var-name">$name</span>, [<span class="var-type"><a href="../log4php/spi/LoggerFactory.html">Logger Factory</a></span> <span class="var-name">$factory</span> = <span class="var-default">null</span>]) + </div> + <div class="method-definition"> + static <span class="method-result"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <a href="#getLoggerRepository" title="details" class="method-name">getLoggerRepository</a&g t; + () + </div> + <div class="method-definition"> + static <span class="method-result">object</span> + <a href="#getRootLogger" title="details" class="method-name">getRootLogger</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">boolean</span> + <a href="#resetConfiguration" title="details" class="method-name">resetConfiguration</a> ; + () + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#setRepositorySelector" title="details" class="method-name">setRepositorySelector</a > + (<span class="var-type"></span> <spa n class="var-name">$selector</span>, <span class="var-type"></span> <spa n class="var-name">$guard</span>) + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#shutdown" title="details" class="method-name">shutdown</a> + () + </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="methodexists" id="exists"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method exists</span> (line <span class="line-number">42</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">check if a given logger exists.</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">boolean</span> + <span class="method-name"> + exists + </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><span class="var-description">: logger name</span> </li> + </ul> + + + </div> +<a name="methodgetCurrentLoggers" id="getCurrentLoggers"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method getCurrentLoggers</span> (line <span class="line-number">54</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Returns an array this whole Logger instances.</p> + <ul class="tags"> + <li><span class="field">see:</span> <a href="../log4php/Logger.html">Logger</a>& lt;/li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">array</span> + <span class="method-name"> + getCurrentLoggers + </span> + () + </div> + + + + </div> +<a name="methodgetLogger" id="getLogger"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method getLogger</span> (line <span class="line-number">79</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Returns the specified Logger.</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <span class="method-name"> + getLogger + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$name</span>, [<span class="var-type"><a href="../log4php/spi/LoggerFactory.html">Logger Factory</a></span> <span class="var-name">$factory</span> = <span class="var-default">null</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$name</span><span class="var-description">: logger name</span> </li> + <li> + <span class="var-type"><a href="../log4php/spi/LoggerFactory.html">Logger Factory</a></span> + <span class="var-name">$factory</span><span class="var-description">: a <a href="../log4php/spi/LoggerFactory.html">Logger Factory</a> instance or null</span> </li> + </ul> + + + </div> +<a name="methodgetLoggerRepository" id="getLoggerRepository"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method getLoggerRepository</span> (line <span class="line-number">90</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Returns the LoggerHierarchy.</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <span class="method-name"> + getLoggerRepository + </span> + () + </div> + + + + </div> +<a name="methodgetRootLogger" id="getRootLogger"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method getRootLogger</span> (line <span class="line-number">66</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Returns the root logger.</p> + <ul class="tags"> + <li><span class="field">see:</span> <a href="../log4php/LoggerRoot.html">LoggerRoot< ;/a></li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">object</span> + <span class="method-name"> + getRootLogger + </span> + () + </div> + + + + </div> +<a name="methodresetConfiguration" id="resetConfiguration"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method resetConfiguration</span> (line <span class="line-number">102</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Destroy loggers object tree.</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">boolean</span> + <span class="method-name"> + resetConfiguration + </span> + () + </div> + + + + </div> +<a name="methodsetRepositorySelector" id="setRepositorySelector"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method setRepositorySelector</span> (line <span class="line-number">111</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Does nothing.</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"> + setRepositorySelector + </span> + (<span class="var-type"></span> <spa n class="var-name">$selector</span>, <span class="var-type"></span> <spa n class="var-name">$guard</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type"></span> + <span class="var-name">$selector</span> </ li> + <li> + <span class="var-type"></span> + <span class="var-name">$guard</span> </li& gt; + </ul> + + + </div> +<a name="methodshutdown" id="shutdown"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method shutdown</span> (line <span class="line-number">120</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Safely close all appenders.</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"> + shutdown + </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/LoggerNDC.html URL: http: //svn.apache.org/viewvc/incubator/log4php/site/apidocs/log4p hp/LoggerNDC.html?view=auto&rev=558223 ============================================================ ================== --- incubator/log4php/site/apidocs/log4php/LoggerNDC.html (added) +++ incubator/log4php/site/apidocs/log4php/LoggerNDC.html Fri Jul 20 19:10:17 2007 -0,0 +1,349 +<?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 LoggerNDC</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 LoggerNDC</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">The NDC class implements <em>nested diagnostic contexts</em> as defined by Neil Harrison in the article "Patterns for Logging Diagnostic Messages" part of the book "<em>Pattern Languages of + Program Design 3</em>" edited by Martin et al.</p> +<p class="description"><p>A Nested Diagnostic Context, or NDC in short, is an instrument to distinguish interleaved log output from different sources. Log output is typically interleaved when a server handles multiple clients near-simultaneously.</p><p>Interleaved log output can still be meaningful if each log entry from different contexts had a distinctive stamp. This is where NDCs come into play.</p><p><em><b>Note that NDCs are managed on a per thread + basis</b></em>. NDC operations such as <a href="../log4php/LoggerNDC.html#methodpush">pus h()</a>, <a href="../log4php/LoggerNDC.html#methodpop">pop( )</a>, <a href="../log4php/LoggerNDC.html#methodclear">cl ear()</a>, <a href="../log4php/LoggerNDC.html#methodgetDepth"> ;getDepth()</a> and <a href="../log4php/LoggerNDC.html#methodsetMaxDepth" >setMaxDepth()</a> affect the NDC of the <em>current</em> thread only. NDCs of other threads remain unaffected.</p><p>For example, a servlet can build a per client request NDC consisting the clients host name and other information contained in the the request. <em>Cookies</em> are another source of distinctive information. To build an NDC one uses the <a href="../log4php/LoggerNDC.html#methodpush">pus h()</a> operation.</p><p>Simply put, +<ul><li>Contexts can be nested.</li><li>When entering a context, call + <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../log4php/LoggerNDC.html">LoggerNDC</ a></span><span class="src-sym">::</span><a href="../log4php/LoggerNDC.html#methodpush">pus h</a><span class="src-sym">(</span><span class="src-sym">)</span></div></ li> +</ol></div> + As a side effect, if there is no nested diagnostic context for the + current thread, this method will create it.</li><li>When leaving a context, call + <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../log4php/LoggerNDC.html">LoggerNDC</ a></span><span class="src-sym">::</span><a href="../log4php/LoggerNDC.html#methodpop">pop& lt;/a><span class="src-sym">(</span><span class="src-sym">)</span></div></ li> +</ol></div></li><li><strong>W hen exiting a thread make sure to call <a href="../log4php/LoggerNDC.html#methodremove">r emove()</a></strong></li></ul> There is no penalty for forgetting to match each <div class="src-code"><ol><li><div class="src-line"><a href="../log4php/LoggerNDC.html#methodpush">pus h</a></div></li> +</ol></div> operation with a corresponding <div class="src-code"><ol><li><div class="src-line"><a href="../log4php/LoggerNDC.html#methodpop">pop& lt;/a></div></li> +</ol></div>, except the obvious mismatch between the real application context and the context set in the NDC.</p><p>If configured to do so, <a href="../log4php/layouts/LoggerPatternLayout.html" >LoggerPatternLayout</a> and <a href="../log4php/layouts/LoggerLayoutTTCC.html"> ;LoggerLayoutTTCC</a> instances automatically retrieve the nested diagnostic context for the current thread without any user intervention. Hence, even if a servlet is serving multiple clients simultaneously, the logs emanating from the same code (belonging to the same category) can still be distinguished because each client request will have a different NDC tag.</p><p></p></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.3</li> + </ul> + <p class="notes"> + Located in <a class="field" href="_LoggerNDC.php.html">/LoggerNDC.php</a > (line <span class="field">91</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="#clear" title="details" class="method-name">clear</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">array</span> + <a href="#get" title="details" class="method-name">get</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">integer</span> + <a href="#getDepth" title="details" class="method-name">getDepth</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">string</span> + <a href="#peek" title="details" class="method-name">peek</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">string</span> + <a href="#pop" title="details" class="method-name">pop</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#push" title="details" class="method-name">push</a> + (<span class="var-type">string</span> & lt;span class="var-name">$message</span>) + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#remove" title="details" class="method-name">remove</a> + () + </div> + <div class="method-definition"> + static <span class="method-result">void</span> + <a href="#setMaxDepth" title="details" class="method-name">setMaxDepth</a> + (<span class="var-type">integer</span>  <span class="var-name">$maxDepth</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="methodclear" id="clear"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method clear</span> (line <span class="line-number">103</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Clear any nested diagnostic information if any. This method is useful in cases where the same thread can be potentially used over and over in different unrelated contexts.</p> +<p class="description"><p>This method is equivalent to calling the <a href="../log4php/LoggerNDC.html#methodsetMaxDepth" >setMaxDepth()</a> method with a zero <var>maxDepth</var> argument.</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"> + clear + </span> + () + </div> + + + + </div> +<a name="methodget" id="get"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method get</span> (line <span class="line-number">115</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Never use this method directly, use the <a href="../log4php/spi/LoggerLoggingEvent.html#methodgetN DC">LoggerLoggingEvent::getNDC()</a> method instead.</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">array</span> + <span class="method-name"> + get + </span> + () + </div> + + + + </div> +<a name="methodgetDepth" id="getDepth"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method getDepth</span> (line <span class="line-number">129</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Get the current nesting depth of this diagnostic context.</p> + <ul class="tags"> + <li><span class="field">see:</span> <a href="../log4php/LoggerNDC.html#methodsetMaxDepth" >LoggerNDC::setMaxDepth()</a></li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">integer</span> + <span class="method-name"> + getDepth + </span> + () + </div> + + + + </div> +<a name="methodpeek" id="peek"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method peek</span> (line <span class="line-number">166</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Looks at the last diagnostic context at the top of this NDC without removing it.</p> +<p class="description"><p>The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned.</p></p> + <ul class="tags"> + <li><span class="field">return:</span> The innermost diagnostic context.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">string</span> + <span class="method-name"> + peek + </span> + () + </div> + + + + </div> +<a name="methodpop" id="pop"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method pop</span> (line <span class="line-number">146</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Clients should call this method before leaving a diagnostic context.</p> +<p class="description"><p>The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned.</p><p></p></p> + <ul class="tags"> + <li><span class="field">return:</span> The innermost diagnostic context.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">string</span> + <span class="method-name"> + pop + </span> + () + </div> + + + + </div> +<a name="methodpush" id="push"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method push</span> (line <span class="line-number">186</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Push new diagnostic context information for the current thread.</p> +<p class="description"><p>The contents of the <var>message</var> parameter is determined solely by the client.</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"> + push + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$message</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$message</span><span class="var-description">: The new diagnostic context information.</span> </li> + </ul> + + + </div> +<a name="methodremove" id="remove"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">static method remove</span> (line <span class="line-number">197</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Remove the diagnostic context for this thread.</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"> + remove + </span> + () + </div> + + + + </div> +<a name="methodsetMaxDepth" id="setMaxDepth"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method setMaxDepth</span> (line <span class="line-number">219</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Set maximum depth of this diagnostic context. If the current depth is smaller or equal to <var>maxDepth</var>, then no action is taken.</p> +<p class="description"><p>This method is a convenient alternative to multiple <a href="../log4php/LoggerNDC.html#methodpop">pop( )</a> calls. Moreover, it is often the case that at the end of complex call sequences, the depth of the NDC is unpredictable. The <a href="../log4php/LoggerNDC.html#methodsetMaxDepth" >setMaxDepth()</a> method circumvents this problem.</p></p> + <ul class="tags"> + <li><span class="field">see:</span> <a href="../log4php/LoggerNDC.html#methodgetDepth"> ;LoggerNDC::getDepth()</a></li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">void</span> + <span class="method-name"> + setMaxDepth + </span> + (<span class="var-type">integer</span>  <span class="var-name">$maxDepth</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">integer</span> + <span class="var-name">$maxDepth</span> </ li> + </ul> + + + </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/LoggerPropertyConfigu rator.html URL: http://svn.apache.org/viewvc/incubator/log4php/s ite/apidocs/log4php/LoggerPropertyConfigurator.html?view=aut o&rev=558223 ============================================================ ================== --- incubator/log4php/site/apidocs/log4php/LoggerPropertyConfigu rator.html (added) +++ incubator/log4php/site/apidocs/log4php/LoggerPropertyConfigu rator.html Fri Jul 20 19:10:17 2007 -0,0 +1,571 +<?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 LoggerPropertyConfigurator</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 LoggerPropertyConfigurator</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"> + <p class="implements"> + Implements interfaces: + <ul> + <li><a href="../log4php/spi/LoggerConfigurator.html">L oggerConfigurator</a></li> </ul> + </p> + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Allows the configuration of log4php from an external file.</p> +<p class="description"><p>See <a href="../log4php/LoggerPropertyConfigurator.html#method doConfigure">doConfigure()</a> for the expected format.</p><p><p>It is sometimes useful to see how log4php is reading configuration files. You can enable log4php internal logging by defining the <strong>log4php.debug</strong> variable.</p></p><p><p& gt;The <em>LoggerPropertyConfigurator</em> does not handle the advanced configuration features supported by the <a href="../log4php/xml/LoggerDOMConfigurator.html"&g t;LoggerDOMConfigurator</a> such as support for <a href="../log4php/spi/LoggerFilter.html">LoggerF ilter</a>, etc.</p><p><p>All option <em>values</em> admit variable substitution. The syntax of variable substitution is similar to that of Unix shells. The string between an opening <strong>&quot;${&quot;</strong> and closing <strong>&quot;}&quot;</strong> is interpreted as a key. The value of the substituted variable can be defined as a system property or in the configuration file itself. The value of the key is first searched in the defined constants, in the enviroments variables and if not found there, it is then searched in the configuration file being parsed. The corresponding value replaces the $ sequence.</p> <p>For example, if <strong>$_ENV['home']</strong> env var is set to <strong>/home/xyz</strong>, then every occurrence of the sequence <strong>$</strong> will be interpreted as <strong>/home/xyz</strong>. See <a href="../log4php/helpers/LoggerOptionConverter.html#met hodgetSystemProperty">LoggerOptionConverter::getSyst emProperty()</a> for details.</p></p><p><p&g t;Please note that boolean values should be quoted otherwise the default value will be chosen. E.g.: <div class="src-code"><ol><li><div class="src-line"> <span class="src-comm">// Does not  work. Will always resu lt in default value</span>& lt;/div> </li> +<li><div class="src-line"> <span class="src-comm">// (which is  currently 'true' for th is attribute).</span></div></li> +<li><div class="src-line"> <span class="src-id">log4php</span>.<span class="src-id">appender</span>.<span class="src-id">A2</span>.<span class="src-id">append</span>=<span class="src-id">false</span></div>&l t;/li> +<li><div class="src-line"> <span class="src-comm">// Does work .</span></div></li> +<li><div class="src-line"> <span class="src-id">log4php</span>.<span class="src-id">appender</span>.<span class="src-id">A2</span>.<span class="src-id">append</span>=<span class="src-str">"false"</s pan></div></li> +</ol></div> </p></p></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.5</li> + </ul> + <p class="notes"> + Located in <a class="field" href="_LoggerPropertyConfigurator.php.html">/Lo ggerPropertyConfigurator.php</a> (line <span class="field">96</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"><a href="../log4php/spi/LoggerFactory.html">Logger Factory</a></span> + <a href="#$loggerFactory" title="details" class="var-name">$loggerFactory</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">boolean</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">''</span>]) + </div> + + <div class="method-definition"> + <span class="method-result">LoggerPropertyConfigurato r</span> + <a href="#LoggerPropertyConfigurator" title="details" class="method-name">LoggerPropertyConfigurator& lt;/a> + () + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#configureLoggerFactory" title="details" class="method-name">configureLoggerFactory</ a> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#configureRootCategory" title="details" class="method-name">configureRootCategory</a > + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#doConfigure" title="details" class="method-name">doConfigure</a> + (<span class="var-type">string</span> & lt;span class="var-name">$url</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$repository</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#doConfigureProperties" title="details" class="method-name">doConfigureProperties</a > + (<span class="var-type">array</span> &l t;span class="var-name">$properties</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#parseAdditivityForLogger" title="details" class="method-name">parseAdditivityForLogger< ;/a> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">&$cat</span>, <span class="var-type">string</span> & lt;span class="var-name">$loggerName</span>) + </div> + <div class="method-definition"> + <span class="method-result"><a href="../log4php/LoggerAppender.html">LoggerApp ender</a></span> + <a href="#parseAppender" title="details" class="method-name">&parseAppender</ a> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type">string</span> & lt;span class="var-name">$appenderName</span>) + </div> + <div class="method-definition"> + <span class="method-result"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <a href="#parseCategory" title="details" class="method-name">parseCategory</a> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">&$logger</span>, <span class="var-type">string</span> & lt;span class="var-name">$optionKey</span>, <span class="var-type">string</span> & lt;span class="var-name">$loggerName</span>, <span class="var-type">string</span> & lt;span class="var-name">$value</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#parseCatsAndRenderers" title="details" class="method-name">parseCatsAndRenderers</a > + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </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$loggerFactory" id="$loggerFactory"><!-- --></A> +<div class="oddrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type"><a href="../log4php/spi/LoggerFactory.html">Logger Factory</a></span> + <span class="var-name">$loggerFactory</span> + = <span class="var-default"> null</span> (line <span class="line-number">101</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="methodconfigure" id="configure"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">static method configure</span> (line <span class="line-number">120</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Configure the default repository using the resource pointed by <strong>url</strong>.</p> +<p class="description"><p><strong>Url& lt;/strong> is any valid resurce as defined in <a href="http://www.php.net/file">http://www.ph p.net/file</a> function. Note that the resource will be search with <em>use_include_path</em> parameter set to "1".</p></p> + <ul class="tags"> + <li><span class="field">return:</span> configuration result</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + static + <span class="method-result">boolean</span> + <span class="method-name"> + configure + </span> + ([<span class="var-type">string</span> & lt;span class="var-name">$url</span> = <span class="var-default">''</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$url</span> </li> ; + </ul> + + <hr class="separator" /> + <div class="notes">Implementation of:</div> + <dl> + <dt><a href="../log4php/spi/LoggerConfigurator.html#methodconf igure">LoggerConfigurator::configure()</a>< /dt> + <dd>Interpret a resource pointed by a <var>url</var> and configure accordingly.</dd> + </dl> + + </div> + +<a name="methodLoggerPropertyConfigurator" id="LoggerPropertyConfigurator"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">Constructor LoggerPropertyConfigurator</span> (line <span class="line-number">106</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Constructor</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">LoggerPropertyConfigurato r</span> + <span class="method-name"> + LoggerPropertyConfigurator + </span> + () + </div> + + + + </div> +<a name="methodconfigureLoggerFactory" id="configureLoggerFactory"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">configureLoggerFactory< /span> (line <span class="line-number">376</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Check the provided <strong>Properties</strong> object for a <a href="../log4php/spi/LoggerFactory.html">Logger Factory</a> entry specified by <a href="../log4php/_LoggerPropertyConfigurator.php.html#d efineLOG4PHP_LOGGER_PROPERTY_CONFIGURATOR_LOGGER_FACTORY_KEY ">LOG4PHP_LOGGER_PROPERTY_CONFIGURATOR_LOGGER_FACTOR Y_KEY</a>.</p> +<p class="description"><p>If such an entry exists, an attempt is made to create an instance using the default constructor. This instance is used for subsequent Category creations within this configurator.</p></p> + <ul class="tags"> + <li><span class="field">see:</span> <a href="../log4php/LoggerPropertyConfigurator.html#method parseCatsAndRenderers">LoggerPropertyConfigurator::p arseCatsAndRenderers()</a></li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + configureLoggerFactory + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + </ul> + + + </div> +<a name="methodconfigureRootCategory" id="configureRootCategory"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">configureRootCategory</ span> (line <span class="line-number">413</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + configureRootCategory + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + <li> + <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <span class="var-name">&$hierarchy</span> </li> + </ul> + + + </div> +<a name="methoddoConfigure" id="doConfigure"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">doConfigure</span> (line <span class="line-number">321</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Read configuration from a file.</p> +<p class="description"><p>The function <a href="http://www.php.net/parse_i ni_file">http://www.php.net/parse_ini_file</a> is used to read the file.</p><p><strong>The existing configuration is not cleared nor reset.</strong> If you require a different behavior, then call <a href="../log4php/LoggerManager.html#methodresetConfigur ation">LoggerManager::resetConfiguration()</a> method before calling <a href="../log4php/LoggerPropertyConfigurator.html#method doConfigure">doConfigure()</a>. + The configuration file consists of statements in the format <strong>key=value</strong>. The syntax of different configuration elements are discussed below.</p><p><strong>Repository-wide threshold</strong></p><p>The repository-wide threshold filters logging requests by level regardless of logger. The syntax is: <pre> log4php.threshold=[level]</pre></p><p>The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A custom level value can be specified in the form <samp>level#classname</samp>. By default the repository-wide threshold is set to the lowest possible value, namely the level <strong>ALL</strong>.</p><p><stro ng>Appender configuration</strong></p><p>Appender configuration syntax is:</p><p><pre> ; For appender named <i>appenderName</i>, set its class. + ; Note: The appender name can contain dots. + log4php.appender.appenderName=name_of_appender_class + + ; Set appender specific options. + + log4php.appender.appenderName.option1=value1 + log4php.appender.appenderName.optionN=valueN</pre> + For each named appender you can configure its <a href="../log4php/LoggerLayout.html">LoggerLayou t</a>. The syntax for configuring an appender's layout is: <pre> log4php.appender.appenderName.layout=name_of_layout_class + log4php.appender.appenderName.layout.option1=value1 + .... + log4php.appender.appenderName.layout.optionN=valueN</pre& gt; + <strong>Configuring loggers</strong></p><p>The syntax for configuring the root logger is: <pre> log4php.rootLogger=[level], appenderName, appenderName, ...</pre></p><p>This syntax means that an optional <em>level</em> can be supplied followed by appender names separated by commas.</p><p>The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A custom level value can be specified in the form</p><p><pre>level#classname</pre> ; + If a level value is specified, then the root level is set to the corresponding level. If no level value is specified, then the root level remains untouched.</p><p>The root logger can be assigned multiple appenders.</p><p>Each <em>appenderName</em> (separated by commas) will be added to the root logger. The named appender is defined using the appender syntax defined above.</p><p>For non-root categories the syntax is almost the same: <pre> log4php.logger.logger_name=[level\|INHERITED\|NULL], appenderName, appenderName, ...</pre></p><p>The meaning of the optional level value is discussed above in relation to the root logger. In addition however, the value INHERITED can be specified meaning that the named logger should inherit its level from the logger hierarchy.</p><p>If no level value is supplied, then the level of the named logger remains untouched.</p><p>By default categories inherit their level from the hierarchy. However, if you set the level of a logger and late r decide that that logger should inherit its level, then you should specify INHERITED as the value for the level value. NULL is a synonym for INHERITED.</p><p>Similar to the root logger syntax, each <em>appenderName</em> (separated by commas) will be attached to the named logger.</p><p>See the <em>appender additivity rule</em> in the user manual for the meaning of the <strong>additivity</strong> flag.</p><p><strong>ObjectRenderers</st rong></p><p>You can customize the way message objects of a given type are converted to String before being logged. This is done by specifying a <a href="../log4php/or/LoggerObjectRenderer.html"> LoggerObjectRenderer</a> for the object type would like to customize.</p><p>The syntax is: <pre> log4php.renderer.name_of_rendered_class=name_of_rendering.cl ass</pre> As in, <pre> log4php.renderer.myFruit=myFruitRenderer</pre></p&g t;<p><strong>Logger Factories</strong></p><p>The usage of custom logger factories is discouraged and no longer docum ented. + <strong>Example</strong></p><p>An example configuration is given below. Other configuration file examples are given in the <strong>tests</strong> folder. <pre> ; Set options for appender named "A1". + ; Appender "A1" will be a LoggerAppenderSyslog + log4php.appender.A1=LoggerAppenderSyslog + + ; The syslog daemon resides on www.abc.net + log4php.appender.A1.ident=log4php-test + + ; A1's layout is a LoggerPatternLayout, using the conversion pattern + ; <b>%r %-5p %c %M.%L %x - %m%n</b>. Thus, the log output will + ; include the relative time since the start of the application in + ; milliseconds, followed by the level of the log request, + ; followed by the two rightmost components of the logger name, + ; followed by the callers method name, followed by the line number, + ; the nested disgnostic context and finally the message itself. + ; Refer to the documentation of LoggerPatternLayout} for further information + ; on the syntax of the ConversionPattern key. + log4php.appender.A1.layout=LoggerPatternLayout + log4php.appender.A1.layout.ConversionPattern="%-4r %-5p %c %M.%L %x - %m%n" + + ; Set options for appender named "A2" + ; A2 should be a LoggerAppenderRollingFile, with maximum file size of 10 MB + ; using at most one backup file. A2's layout is TTCC, using the + ; ISO8061 date format with context printing enabled. + log4php.appender.A2=LoggerAppenderRollingFile + log4php.appender.A2.MaxFileSize=10MB + log4php.appender.A2.MaxBackupIndex=1 + log4php.appender.A2.layout=LoggerLayoutTTCC + log4php.appender.A2.layout.ContextPrinting="true" + log4php.appender.A2.layout.DateFormat="%c" + + ; Root logger set to DEBUG using the A2 appender defined above. + log4php.rootLogger=DEBUG, A2 + + ; Logger definitions: + ; The SECURITY logger inherits is level from root. However, it's output + ; will go to A1 appender defined above. It's additivity is non-cumulative. + log4php.logger.SECURITY=INHERIT, A1 + log4php.additivity.SECURITY=false + + ; Only warnings or above will be logged for the logger "SECURITY.access". + ; Output will go to A1. + log4php.logger.SECURITY.access=WARN + + + ; The logger "class.of.the.day" inherits its level from the + ; logger hierarchy. Output will go to the appender's of the root + ; logger, A2 in this case. + log4php.logger.class.of.the.day=INHERIT</pre></p> ;<p>Refer to the <strong>setOption</strong> method in each Appender and Layout for class specific options.</p><p>Use the <strong>&quot;;&quot;</strong> character at the beginning of a line for comments.</p><p></p></p> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + doConfigure + </span> + (<span class="var-type">string</span> & lt;span class="var-name">$url</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$repository</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$url</span><span class="var-description">: The name of the configuration file where the configuration information is stored.</span> </li> + <li> + <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <span class="var-name">&$repository</span>& lt;span class="var-description">: the repository to apply the configuration</span> </li> + </ul> + + + </div> +<a name="methoddoConfigureProperties" id="doConfigureProperties"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">doConfigureProperties</ span> (line <span class="line-number">339</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Read configuration options from <strong>properties</strong>.</p> + <ul class="tags"> + <li><span class="field">see:</span> doConfigure().</li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + doConfigureProperties + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$properties</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$properties</span> < ;/li> + <li> + <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <span class="var-name">&$hierarchy</span> </li> + </ul> + + + </div> +<a name="methodparseAdditivityForLogger" id="parseAdditivityForLogger"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">parseAdditivityForLogger&l t;/span> (line <span class="line-number">480</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Parse the additivity option for a non-root category.</p> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + parseAdditivityForLogger + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">&$cat</span>, <span class="var-type">string</span> & lt;span class="var-name">$loggerName</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + <li> + <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <span class="var-name">&$cat</span> </ li> + <li> + <span class="var-type">string</span> + <span class="var-name">$loggerName</span> < ;/li> + </ul> + + + </div> +<a name="methodparseAppender" id="parseAppender"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">parseAppender</span> (line <span class="line-number">573</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> + + <div class="method-signature"> + <span class="method-result"><a href="../log4php/LoggerAppender.html">LoggerApp ender</a></span> + <span class="method-name"> + &parseAppender + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type">string</span> & lt;span class="var-name">$appenderName</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$appenderName</span> & lt;/li> + </ul> + + + </div> +<a name="methodparseCategory" id="parseCategory"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">parseCategory</span> (line <span class="line-number">511</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">This method must work for the root category as well.</p> + <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>& lt;/span> + <span class="method-name"> + parseCategory + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">&$logger</span>, <span class="var-type">string</span> & lt;span class="var-name">$optionKey</span>, <span class="var-type">string</span> & lt;span class="var-name">$loggerName</span>, <span class="var-type">string</span> & lt;span class="var-name">$value</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + <li> + <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <span class="var-name">&$logger</span> &l t;/li> + <li> + <span class="var-type">string</span> + <span class="var-name">$optionKey</span> < /li> + <li> + <span class="var-type">string</span> + <span class="var-name">$loggerName</span> < ;/li> + <li> + <span class="var-type">string</span> + <span class="var-name">$value</span> </li& gt; + </ul> + + + </div> +<a name="methodparseCatsAndRenderers" id="parseCatsAndRenderers"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">parseCatsAndRenderers</ span> (line <span class="line-number">448</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Parse non-root elements, such non-root categories and renderers.</p> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + parseCatsAndRenderers + </span> + (<span class="var-type">array</span> &l t;span class="var-name">$props</span>, <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> <span class="var-name">&$hierarchy</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">array</span> + <span class="var-name">$props</span><span class="var-description">: array of properties</span> </li> + <li> + <span class="var-type"><a href="../log4php/LoggerHierarchy.html">LoggerHi erarchy</a></span> + <span class="var-name">&$hierarchy</span> </li> + </ul> + + + </div> + + </div> + </div> + + + <p class="notes" id="credit"> + Documentation generated on Fri, 20 Jul 2007 22:08:21 -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/LoggerRoot.html URL: http ://svn.apache.org/viewvc/incubator/log4php/site/apidocs/log4 php/LoggerRoot.html?view=auto&rev=558223 ============================================================ ================== --- incubator/log4php/site/apidocs/log4php/LoggerRoot.html (added) +++ incubator/log4php/site/apidocs/log4php/LoggerRoot.html Fri Jul 20 19:10:17 2007 -0,0 +1,438 +<?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 LoggerRoot</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 LoggerRoot</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 root logger.</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">see:</span> <a href="../log4php/Logger.html">Logger</a>& lt;/li> + </ul> + <p class="notes"> + Located in <a class="field" href="_LoggerRoot.php.html">/LoggerRoot.php< /a> (line <span class="field">30</span>) + </p> + + + <pre><a href="../log4php/Logger.html">Logger</a> + \| + --LoggerRoot</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="#$name" title="details" class="var-name">$name</a> + </div> + <div class="var-title"> + <span class="var-type">object must</span> + <a href="#$parent" title="details" class="var-name">$parent</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">LoggerRoot</span> + <a href="#__construct" title="details" class="method-name">__construct</a> + ([<span class="var-type">integer</span>  <span class="var-name">$level</span> = <span class="var-default">null</span>]) + </div> + <div class="method-definition"> + <span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> + <a href="#getChainedLevel" title="details" class="method-name">getChainedLevel</a> + () + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#setLevel" title="details" class="method-name">setLevel</a> + (<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> <span class="var-name">$level</span>) + </div> + <div class="method-definition"> + <span class="method-result">boolean</span> + <a href="#setParent" title="details" class="method-name">setParent</a> + (<span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">$parent</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#setPriority" title="details" class="method-name">setPriority</a> + (<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> <span class="var-name">$level</span>) + </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$name" id="$name"><!-- --></A> +<div class="evenrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$name</span> + = <span class="var-default"> 'root'</span> (line <span class="line-number">35</span>) + </span> + </div> + + <!-- ========== Info from phpDoc block ========= --> + <ul class="tags"> + <li><span class="field">var:</span> name of logger</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#var$name">Logger:: $name</a></dt> + </dl> + + + +</div> +<a name="var$parent" id="$parent"><!-- --></A> +<div class="oddrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">object must</span> + <span class="var-name">$parent</span> + = <span class="var-default"> null</span> (line <span class="line-number">40</span>) + </span> + </div> + + <!-- ========== Info from phpDoc block ========= --> + <ul class="tags"> + <li><span class="field">var:</span> be null for LoggerRoot</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#var$parent">Logger ::$parent</a></dt> + </dl> + + + +</div> + <h4>Inherited Variables</h4> + <A NAME='inherited_vars'><!-- --></A> + <p>Inherited from <span class="classname"><a href="../log4php/Logger.html">Logger</a>& lt;/span></p> + <blockquote> + <span class="var-title"> + <span class="var-name"><a href="../log4php/Logger.html#var$aai">Logger::$ aai</a></span><br> + </span> + <span class="var-title"> + <span class="var-name"><a href="../log4php/Logger.html#var$additive">Logg er::$additive</a></span><br> + </span> + <span class="var-title"> + <span class="var-name"><a href="../log4php/Logger.html#var$fqcn">Logger:: $fqcn</a></span><br> + </span> + <span class="var-title"> + <span class="var-name"><a href="../log4php/Logger.html#var$level">Logger: :$level</a></span><br> + </span> + <span class="var-title"> + <span class="var-name"><a href="../log4php/Logger.html#var$repository">Lo gger::$repository</a></span><br> + </span> + </blockquote> + + </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">48</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Constructor</p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">LoggerRoot</span> + <span class="method-name"> + __construct + </span> + ([<span class="var-type">integer</span>  <span class="var-name">$level</span> = <span class="var-default">null</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">integer</span> + <span class="var-name">$level</span><span class="var-description">: initial log level</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#method__construct"> ;Logger::__construct()</a></dt> + <dd>Constructor.</dd> + </dl> + + </div> +<a name="methodgetChainedLevel" id="getChainedLevel"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">getChainedLevel</span&g t; (line <span class="line-number">59</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> + <ul class="tags"> + <li><span class="field">return:</span> the level</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> + <span class="method-name"> + getChainedLevel + </span> + () + </div> + + + + </div> +<a name="methodsetLevel" id="setLevel"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">setLevel</span> (line <span class="line-number">68</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Setting a null value to the level of the root category may have catastrophic results.</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"> + setLevel + </span> + (<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> <span class="var-name">$level</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> + <span class="var-name">$level</span> </li& gt; + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#methodsetLevel">Lo gger::setLevel()</a></dt> + <dd>Set the level of this Category.</dd> + </dl> + + </div> +<a name="methodsetParent" id="setParent"><!-- --></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">setParent</span> (line <span class="line-number">91</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Always returns false.</p> +<p class="description"><p>Because LoggerRoot has no parents, it returns false.</p></p> + <ul class="tags"> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">boolean</span> + <span class="method-name"> + setParent + </span> + (<span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> <span class="var-name">$parent</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type"><a href="../log4php/Logger.html">Logger</a>& lt;/span> + <span class="var-name">$parent</span> </li > + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#methodsetParent">L ogger::setParent()</a></dt> + </dl> + + </div> +<a name="methodsetPriority" id="setPriority"><!-- --></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">setPriority</span> (line <span class="line-number">80</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<p class="short-description">Please use setLevel() instead.</p> + <ul class="tags"> + <li><span class="field">deprecated:</span> </li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + setPriority + </span> + (<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> <span class="var-name">$level</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel& lt;/a></span> + <span class="var-name">$level</span> </li& gt; + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../log4php/Logger.html#methodsetPriority"> ;Logger::setPriority()</a></dt> + </dl> + + </div> + <h4>Inherited Methods</h4> + <a name='inherited_methods'><!-- --></a> + <!-- =========== Summary =========== --> + <p>Inherited From <span class="classname"><a href="../log4php/Logger.html">Logger</a>& lt;/span></p> + <blockquote> + <span class="method-name"><a href="../log4php/Logger.html#method__construct"> ;Logger::__construct()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodaddAppender"> ;Logger::addAppender()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodassertLog">L ogger::assertLog()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodcallAppenders"& gt;Logger::callAppenders()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methoddebug">Logge r::debug()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methoderror">Logge r::error()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodexists">Logg er::exists()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodfatal">Logge r::fatal()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodforcedLog">L ogger::forcedLog()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetAdditivity"& gt;Logger::getAdditivity()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetAllAppenders" ;>Logger::getAllAppenders()</a></span><br& gt; + <span class="method-name"><a href="../log4php/Logger.html#methodgetAppender"> ;Logger::getAppender()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetChainedPriority&q uot;>Logger::getChainedPriority()</a></span>& lt;br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetCurrentCategories ">Logger::getCurrentCategories()</a></span& gt;<br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetDefaultHierarchy& quot;>Logger::getDefaultHierarchy()</a></span> ;<br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetEffectiveLevel&qu ot;>Logger::getEffectiveLevel()</a></span>< ;br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetHierarchy"&g t;Logger::getHierarchy()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetInstance"> ;Logger::getInstance()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetLevel">Lo gger::getLevel()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetLogger">L ogger::getLogger()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetLoggerRepository& quot;>Logger::getLoggerRepository()</a></span> ;<br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetName">Log ger::getName()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetParent">L ogger::getParent()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetPriority"> ;Logger::getPriority()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetResourceBundle&qu ot;>Logger::getResourceBundle()</a></span>< ;br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetResourceBundleStr ing">Logger::getResourceBundleString()</a>< /span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetRoot">Log ger::getRoot()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodgetRootLogger"& gt;Logger::getRootLogger()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodinfo">Logger ::info()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodisAttached"> Logger::isAttached()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodisDebugEnabled" >Logger::isDebugEnabled()</a></span><br> ; + <span class="method-name"><a href="../log4php/Logger.html#methodisEnabledFor"&g t;Logger::isEnabledFor()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodisInfoEnabled"& gt;Logger::isInfoEnabled()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodl7dlog">Logg er::l7dlog()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodlog">Logger: :log()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodremoveAllAppenders&q uot;>Logger::removeAllAppenders()</a></span>& lt;br> + <span class="method-name"><a href="../log4php/Logger.html#methodremoveAppender" >Logger::removeAppender()</a></span><br> ; + <span class="method-name"><a href="../log4php/Logger.html#methodsetAdditivity"& gt;Logger::setAdditivity()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodsetHierarchy"&g t;Logger::setHierarchy()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodsetLevel">Lo gger::setLevel()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodsetParent">L ogger::setParent()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodsetPriority"> ;Logger::setPriority()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodsetResourceBundle&qu ot;>Logger::setResourceBundle()</a></span>< ;br> + <span class="method-name"><a href="../log4php/Logger.html#methodshutdown">Lo gger::shutdown()</a></span><br> + <span class="method-name"><a href="../log4php/Logger.html#methodwarn">Logger ::warn()</a></span><br> + </blockquote> + + </div> + </div> + + + <p class=&