Added: incubator/log4php/site/apidocs/log4php/Logger.html
URL: http://s
vn.apache.org/viewvc/incubator/log4php/site/apidocs/log4php/
Logger.html?view=auto&rev=558223
============================================================
==================
--- incubator/log4php/site/apidocs/log4php/Logger.html
(added)
+++ incubator/log4php/site/apidocs/log4php/Logger.html Fri
Jul 20 19:10:17 2007
 -0,0
+1,1866
+<?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 Logger</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
Logger</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">This class has
been deprecated and replaced by the Logger
subclass.</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="_Logger.php.html">/Logger.php</a>
(line <span class="field">44</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/LoggerRoot.html">LoggerRoot<
;/a></td>
+ <td>
+ The root logger.
+ </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">array</span>
+ <a href="#$aai" title="details"
class="var-name">$aai</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">boolean</span>
+ <a href="#$additive"
title="details"
class="var-name">$additive</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">LoggerLevel&
lt;/a></span>
+ <a href="#$level"
title="details"
class="var-name">$level</a>
+ </div>
+ <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"><a
href="../log4php/Logger.html">Logger</a>&
lt;/span>
+ <a href="#$parent"
title="details"
class="var-name">$parent</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <a href="#$repository"
title="details"
class="var-name">$repository</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">
+ 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/LoggerRoot.html">LoggerRoot<
;/a></span>
+ <a href="#getRootLogger"
title="details"
class="method-name">getRootLogger</a>
+ ()
+ </div>
+
+ <div
class="method-definition">
+ <span
class="method-result">Logger</span>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#addAppender"
title="details"
class="method-name">addAppender</a>
+ (<span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span> <span
class="var-name">$newAppender</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#assertLog"
title="details"
class="method-name">assertLog</a>
+ ([<span
class="var-type">bool</span> <
;span class="var-name">$assertion</span>
= <span
class="var-default">true</span>],
[<span
class="var-type">string</span> &
lt;span class="var-name">$msg</span> =
<span class="var-default">''</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#callAppenders"
title="details"
class="method-name">callAppenders</a>
+ (<span class="var-type"><a
href="../log4php/spi/LoggerLoggingEvent.html">L
oggerLoggingEvent</a></span> <span
class="var-name">$event</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#debug"
title="details"
class="method-name">debug</a>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#error"
title="details"
class="method-name">error</a>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</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">
+ <span
class="method-result">void</span>
+ <a href="#fatal"
title="details"
class="method-name">fatal</a>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#forcedLog"
title="details"
class="method-name">forcedLog</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">$caller</span>,
<span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span> <span
class="var-name">$level</span>, <span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getAdditivity"
title="details"
class="method-name">getAdditivity</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">array</span>
+ <a href="#getAllAppenders"
title="details"
class="method-name">getAllAppenders</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span>
+ <a href="#getAppender"
title="details"
class="method-name">getAppender</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getChainedPriority"
title="details"
class="method-name">getChainedPriority</a>
;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getCurrentCategories"
title="details"
class="method-name">getCurrentCategories</a&
gt;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getDefaultHierarchy"
title="details"
class="method-name">getDefaultHierarchy</a&g
t;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span>
+ <a href="#getEffectiveLevel"
title="details"
class="method-name">getEffectiveLevel</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <a href="#getHierarchy"
title="details"
class="method-name">getHierarchy</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/Logger.html">Logger</a>&
lt;/span>
+ <a href="#getInstance"
title="details"
class="method-name">getInstance</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span>
+ <a href="#getLevel"
title="details"
class="method-name">getLevel</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <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">
+ <span
class="method-result">string</span>
+ <a href="#getName"
title="details"
class="method-name">getName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/Logger.html">Logger</a>&
lt;/span>
+ <a href="#getParent"
title="details"
class="method-name">getParent</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getPriority"
title="details"
class="method-name">getPriority</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getResourceBundle"
title="details"
class="method-name">getResourceBundle</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getResourceBundleString"
title="details"
class="method-name">getResourceBundleString<
/a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$key</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result"><a
href="../log4php/LoggerRoot.html">LoggerRoot<
;/a></span>
+ <a href="#getRoot"
title="details"
class="method-name">getRoot</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#info"
title="details"
class="method-name">info</a>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#isAttached"
title="details"
class="method-name">isAttached</a>
+ (<span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span> <span
class="var-name">$appender</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#isDebugEnabled"
title="details"
class="method-name">isDebugEnabled</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#isEnabledFor"
title="details"
class="method-name">isEnabledFor</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="#isInfoEnabled"
title="details"
class="method-name">isInfoEnabled</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#l7dlog"
title="details"
class="method-name">l7dlog</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$priority</span>,
<span
class="var-type"></span> <spa
n class="var-name">$key</span>, <span
class="var-type"></span> <spa
n class="var-name">$params</span>,
<span
class="var-type"></span> <spa
n class="var-name">$t</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#log"
title="details"
class="method-name">log</a>
+ (<span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/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">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#removeAllAppenders"
title="details"
class="method-name">removeAllAppenders</a>
;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#removeAppender"
title="details"
class="method-name">removeAppender</a>
+ (<span
class="var-type">mixed</span> &l
t;span
class="var-name">$appender</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setAdditivity"
title="details"
class="method-name">setAdditivity</a>
+ (<span
class="var-type">boolean</span>
<span
class="var-name">$additive</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setHierarchy"
title="details"
class="method-name">setHierarchy</a>
+ (<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="#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">void</span>
+ <a href="#setParent"
title="details"
class="method-name">setParent</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$logger</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"></span> <spa
n class="var-name">$priority</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setResourceBundle"
title="details"
class="method-name">setResourceBundle</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$bundle</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#shutdown"
title="details"
class="method-name">shutdown</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#warn"
title="details"
class="method-name">warn</a>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</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-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$aai"
id="$aai"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">array</span>
+ <span
class="var-name">$aai</span>
+ = <span
class="var-default">array()</span> (lin
e <span
class="line-number">82</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> collection of
appenders</li>
+ <li><span
class="field">see:</span> <a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$additive"
id="$additive"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$additive</span>
+ = <span class="var-default">
true</span> (line <span
class="line-number">51</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Additivity is
set to true by default, that is children inherit the
appenders of their ancestors by default.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$fqcn"
id="$fqcn"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fqcn</span>
+ = <span class="var-default">
'LoggerCategory'</span> (line <span
class="line-number">56</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> fully qualified
class name</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$level"
id="$level"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span>
+ <span
class="var-name">$level</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">61</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> The assigned
level of this category.</li>
+ </ul>
+
+
+
+
+
+</div>
+<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">
''</span> (line <span
class="line-number">66</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> name of this
category.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#var$name">Logg
erRoot::$name</a>
+ </li>
+ </ul>
+
+
+</div>
+<a name="var$parent"
id="$parent"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../log4php/Logger.html">Logger</a>&
lt;/span>
+ <span
class="var-name">$parent</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">71</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> The parent of
this category.</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#var$parent">Lo
ggerRoot::$parent</a>
+ </li>
+ </ul>
+
+
+</div>
+<a name="var$repository"
id="$repository"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <span
class="var-name">$repository</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">76</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> the object
repository</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="methodgetLogger"
id="getLogger"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">static method
getLogger</span> (line <span
class="line-number">322</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Get a Logger
by name (Delegate to <a
href="../log4php/LoggerManager.html">LoggerMana
ger</a>)</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="methodgetRootLogger"
id="getRootLogger"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">static method
getRootLogger</span> (line <span
class="line-number">393</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">get the Root
Logger (Delegate to <a
href="../log4php/LoggerManager.html">LoggerMana
ger</a>)</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/LoggerRoot.html">LoggerRoot<
;/a></span>
+ <span class="method-name">
+ getRootLogger
+ </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">93</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">Logger</span>
+ <span class="method-name">
+ __construct
+ </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">: Category
name</span> </li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#method__construct"
;>LoggerRoot::__construct()</a>
+ : Constructor
+ </li>
+ </ul>
+ </div>
+<a name="methodaddAppender"
id="addAppender"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">addAppender</span>
(line <span
class="line-number">103</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Add a new
Appender to the list of appenders of this Category
instance.</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">
+ addAppender
+ </span>
+ (<span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span> <span
class="var-name">$newAppender</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span>
+ <span
class="var-name">$newAppender</span> &l
t;/li>
+ </ul>
+
+
+ </div>
+<a name="methodassertLog"
id="assertLog"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">assertLog</span>
(line <span
class="line-number">115</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">If assertion
parameter is false, then logs msg as an error
statement.</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">
+ assertLog
+ </span>
+ ([<span
class="var-type">bool</span> <
;span class="var-name">$assertion</span>
= <span
class="var-default">true</span>],
[<span
class="var-type">string</span> &
lt;span class="var-name">$msg</span> =
<span class="var-default">''</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">bool</span>
+ <span
class="var-name">$assertion</span> <
/li>
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$msg</span><span
class="var-description">: message to
log</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodcallAppenders"
id="callAppenders"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">callAppenders</span>
(line <span
class="line-number">127</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Call the
appenders in the hierarchy starting at this.</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">
+ callAppenders
+ </span>
+ (<span class="var-type"><a
href="../log4php/spi/LoggerLoggingEvent.html">L
oggerLoggingEvent</a></span> <span
class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../log4php/spi/LoggerLoggingEvent.html">L
oggerLoggingEvent</a></span>
+ <span
class="var-name">$event</span> </li&
gt;
+ </ul>
+
+
+ </div>
+<a name="methoddebug"
id="debug"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">debug</span> (line
<span class="line-number">145</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a message
object with the DEBUG level including 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">
+ debug
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methoderror"
id="error"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">error</span> (line
<span class="line-number">162</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a message
object with the ERROR level including 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">
+ error
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodexists"
id="exists"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">exists</span> (line
<span class="line-number">180</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Deprecated.
Please use LoggerManager::exists() instead.</p>
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../log4php/LoggerManager.html#methodexists"&
gt;LoggerManager::exists()</a></li>
+ <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">
+ 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> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodfatal"
id="fatal"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">fatal</span> (line
<span class="line-number">191</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a message
object with the FATAL level including 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">
+ fatal
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodforcedLog"
id="forcedLog"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">forcedLog</span>
(line <span
class="line-number">214</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">This method
creates a new logging event and logs the event without
further checks.</p>
+<p class="description"><p>It should
not be called directly. Use <a
href="../log4php/Logger.html#methodinfo">info()
</a>, <a
href="../log4php/Logger.html#methoddebug">debug
()</a>, <a
href="../log4php/Logger.html#methodwarn">warn()
</a>, <a
href="../log4php/Logger.html#methoderror">error
()</a> and <a
href="../log4php/Logger.html#methodfatal">fatal
()</a> wrappers.</p></p>
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../log4php/spi/LoggerLoggingEvent.html">L
oggerLoggingEvent</a></li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ forcedLog
+ </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">$caller</span>,
<span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span> <span
class="var-name">$level</span>, <span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$fqcn</span><span
class="var-description">: Fully Qualified Class
Name of the Logger</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ <li>
+ <span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span>
+ <span
class="var-name">$level</span><span
class="var-description">: log
level</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodgetAdditivity"
id="getAdditivity"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getAdditivity</span>
(line <span
class="line-number">224</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Get the
additivity flag for this Category instance.</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">
+ getAdditivity
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetAllAppenders"
id="getAllAppenders"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getAllAppenders</span&g
t; (line <span
class="line-number">233</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Get the
appenders contained in this category as an array.</p>
+ <ul class="tags">
+ <li><span
class="field">return:</span> collection
of appenders</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">array</span>
+ <span class="method-name">
+ getAllAppenders
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetAppender"
id="getAppender"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getAppender</span>
(line <span
class="line-number">242</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Look for the
appender named as name.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span>
+ <span class="method-name">
+ getAppender
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$name</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodgetChainedPriority"
id="getChainedPriority"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getChainedPriority</spa
n> (line <span
class="line-number">251</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Please use the
getEffectiveLevel() method 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">
+ getChainedPriority
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetCurrentCategories"
id="getCurrentCategories"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getCurrentCategories</s
pan> (line <span
class="line-number">260</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Please use
<a
href="../log4php/LoggerManager.html#methodgetCurrentLog
gers">LoggerManager::getCurrentLoggers()</a>
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">
+ getCurrentCategories
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetDefaultHierarchy"
id="getDefaultHierarchy"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getDefaultHierarchy</sp
an> (line <span
class="line-number">269</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Please use
<a
href="../log4php/LoggerManager.html#methodgetLoggerRepo
sitory">LoggerManager::getLoggerRepository()</a&g
t; 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">
+ getDefaultHierarchy
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetEffectiveLevel"
id="getEffectiveLevel"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getEffectiveLevel</span
> (line <span
class="line-number">288</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Starting from
this category, search the category hierarchy for a non-null
level and return it.</p>
+ <ul class="tags">
+ <li><span
class="field">return:</span> or
null</li>
+ <li><span
class="field">see:</span> <a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></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">
+ getEffectiveLevel
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetHierarchy"
id="getHierarchy"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getHierarchy</span>
(line <span
class="line-number">278</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">deprecated:</span> Use
<a
href="../log4php/Logger.html#methodgetLoggerRepository&
quot;>getLoggerRepository()</a></li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <span class="method-name">
+ getHierarchy
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetInstance"
id="getInstance"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getInstance</span>
(line <span
class="line-number">301</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Retrieve a
category with named as the name parameter.</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">
+ getInstance
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$name</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodgetLevel"
id="getLevel"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLevel</span>
(line <span
class="line-number">310</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
assigned Level, if any, for this Category.</p>
+ <ul class="tags">
+ <li><span
class="field">return:</span> or
null</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">
+ getLevel
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetLoggerRepository"
id="getLoggerRepository"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLoggerRepository</sp
an> (line <span
class="line-number">331</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the the
repository where this Category is attached.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <span class="method-name">
+ getLoggerRepository
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetName"
id="getName"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getName</span> (line
<span class="line-number">340</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
category name.</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">
+ getName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetParent"
id="getParent"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getParent</span>
(line <span
class="line-number">349</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
parent of this category.</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">
+ getParent
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetPriority"
id="getPriority"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getPriority</span>
(line <span
class="line-number">358</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Please use
getLevel() 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">
+ getPriority
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetResourceBundle"
id="getResourceBundle"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getResourceBundle</span
> (line <span
class="line-number">366</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
inherited ResourceBundle for this category.</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">
+ getResourceBundle
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetResourceBundleString"
id="getResourceBundleString"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getResourceBundleString<
;/span> (line <span
class="line-number">374</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
string resource corresponding to key in this category's
inherited resource bundle.</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">
+ getResourceBundleString
+ </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="methodgetRoot"
id="getRoot"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getRoot</span> (line
<span class="line-number">383</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Return the
root of the default category hierarchy.</p>
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../log4php/LoggerRoot.html">LoggerRoot<
;/a></span>
+ <span class="method-name">
+ getRoot
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodinfo"
id="info"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">info</span> (line
<span class="line-number">404</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a message
object with the INFO Level.</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">
+ info
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodisAttached"
id="isAttached"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">isAttached</span>
(line <span
class="line-number">420</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Is the
appender passed as parameter attached to this
category?</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">
+ isAttached
+ </span>
+ (<span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span> <span
class="var-name">$appender</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a></span>
+ <span
class="var-name">$appender</span> </
li>
+ </ul>
+
+
+ </div>
+<a name="methodisDebugEnabled"
id="isDebugEnabled"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">isDebugEnabled</span>
; (line <span
class="line-number">429</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Check whether
this category is enabled for the DEBUG Level.</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">
+ isDebugEnabled
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodisEnabledFor"
id="isEnabledFor"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">isEnabledFor</span>
(line <span
class="line-number">444</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Check whether
this category is enabled for a given Level passed as
parameter.</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">
+ isEnabledFor
+ </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><span
class="var-description">:
level</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodisInfoEnabled"
id="isInfoEnabled"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">isInfoEnabled</span>
(line <span
class="line-number">457</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Check whether
this category is enabled for the info Level.</p>
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ isInfoEnabled
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodl7dlog"
id="l7dlog"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">l7dlog</span> (line
<span class="line-number">469</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a
localized and parameterized message.</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">
+ l7dlog
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$priority</span>,
<span
class="var-type"></span> <spa
n class="var-name">$key</span>, <span
class="var-type"></span> <spa
n class="var-name">$params</span>,
<span
class="var-type"></span> <spa
n class="var-name">$t</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$priority</span> </
li>
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$key</span> </li>
;
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$params</span> </li
>
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$t</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodlog"
id="log"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">log</span> (line
<span class="line-number">481</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">This generic
form is intended to be used by wrappers.</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">
+ log
+ </span>
+ (<span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/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">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../log4php/LoggerLevel.html">LoggerLevel&
lt;/a></span>
+ <span
class="var-name">$priority</span><span
class="var-description">: a valid
level</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodremoveAllAppenders"
id="removeAllAppenders"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">removeAllAppenders</spa
n> (line <span
class="line-number">494</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Remove all
previously added appenders from this Category
instance.</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">
+ removeAllAppenders
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodremoveAppender"
id="removeAppender"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">removeAppender</span>
; (line <span
class="line-number">508</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Remove the
appender passed as parameter form the list of
appenders.</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">
+ removeAppender
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span
class="var-name">$appender</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$appender</span><span
class="var-description">: can be an appender
name or a <a
href="../log4php/LoggerAppender.html">LoggerApp
ender</a> object</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetAdditivity"
id="setAdditivity"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setAdditivity</span>
(line <span
class="line-number">524</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Set the
additivity flag for this Category instance.</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">
+ setAdditivity
+ </span>
+ (<span
class="var-type">boolean</span>
<span
class="var-name">$additive</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$additive</span> </
li>
+ </ul>
+
+
+ </div>
+<a name="methodsetHierarchy"
id="setHierarchy"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setHierarchy</span>
(line <span
class="line-number">544</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Only the
Hierarchy class can set the hierarchy of a
category.</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">
+ setHierarchy
+ </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"><a
href="../log4php/LoggerHierarchy.html">LoggerHi
erarchy</a></span>
+ <span
class="var-name">$repository</span> <
;/li>
+ </ul>
+
+
+ </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">554</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Set the level
of this Category.</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><span
class="var-description">: a level string or a
level constant</span> </li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#methodsetLevel"&g
t;LoggerRoot::setLevel()</a>
+ : Setting a null value to the level of the root
category may have catastrophic results.
+ </li>
+ </ul>
+ </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">559</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">
+ setParent
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$logger</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$logger</span> </li
>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#methodsetParent"&
gt;LoggerRoot::setParent()</a>
+ : Always returns false.
+ </li>
+ </ul>
+ </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">533</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../log4php/Logger.html#methodsetLevel">Lo
gger::setLevel()</a></li>
+ <li><span
class="field">deprecated:</span> Please
use <a
href="../log4php/Logger.html#methodsetLevel">se
tLevel()</a> instead.</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"></span> <spa
n class="var-name">$priority</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$priority</span> </
li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../log4php/LoggerRoot.html#methodsetPriority"
;>LoggerRoot::setPriority()</a>
+ : Please use setLevel() instead.
+ </li>
+ </ul>
+ </div>
+<a name="methodsetResourceBundle"
id="setResourceBundle"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setResourceBundle</span
> (line <span
class="line-number">568</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Set the
resource bundle to be used with localized logging
methods</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">
+ setResourceBundle
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$bundle</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$bundle</span> </li
>
+ </ul>
+
+
+ </div>
+<a name="methodshutdown"
id="shutdown"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">shutdown</span>
(line <span
class="line-number">577</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../log4php/LoggerManager.html#methodshutdown"
;>LoggerManager::shutdown()</a></li>
+ <li><span
class="field">deprecated:</span> use
<a
href="../log4php/LoggerManager.html#methodshutdown"
;>LoggerManager::shutdown()</a>
instead.</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ shutdown
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodwarn"
id="warn"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">warn</span> (line
<span class="line-number">588</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Log a message
with the WARN level.</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">
+ warn
+ </span>
+ (<span
class="var-type">mixed</span> &l
t;span class="var-name">$message</span>,
[<span
class="var-type">mixed</span> &l
t;span class="var-name">$caller</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$message</span><span
class="var-description">:
message</span> </li>
+ <li>
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$caller</span><span
class="var-description">: caller object or
caller string id</span> </li>
+ </ul>
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:14
-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
|
