Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / Logger.html
blob: 438b64e08419a16643a23f16e7019c8fc7364c60 [file] [log] [blame]
<?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-transitional.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" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</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 is the central class in the log4php package. All logging operations are done through this class.</p>
<p class="description"><p>The main logging methods are: <ul><li><a href="../log4php/Logger.html#methodtrace">trace()</a></li><li><a href="../log4php/Logger.html#methoddebug">debug()</a></li><li><a href="../log4php/Logger.html#methodinfo">info()</a></li><li><a href="../log4php/Logger.html#methodwarn">warn()</a></li><li><a href="../log4php/Logger.html#methoderror">error()</a></li><li><a href="../log4php/Logger.html#methodfatal">fatal()</a></li></ul></p></p>
<ul class="tags">
<li><span class="field">version:</span> SVN: $Id: Logger.php 1241439 2012-02-07 12:17:21Z ihabunek $</li>
<li><span class="field">link:</span> <a href="http://logging.apache.org/log4php">http://logging.apache.org/log4php</a></li>
<li><span class="field">license:</span> <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Logger.php.html">/Logger.php</a> (line <span class="field">42</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>
</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">
static <span class="var-type">mixed</span>
<a href="#$hierarchy" title="details" class="var-name">$hierarchy</a>
</div>
<div class="var-title">
static <span class="var-type">mixed</span>
<a href="#$initialized" title="details" class="var-name">$initialized</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">mixed</span>
<a href="#$appenders" title="details" class="var-name">$appenders</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$fqcn" title="details" class="var-name">$fqcn</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$level" title="details" class="var-name">$level</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$name" title="details" class="var-name">$name</a>
</div>
<div class="var-title">
<span class="var-type">mixed</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-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">boolean</span>
<a href="#clear" title="details" class="method-name">clear</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#configure" title="details" class="method-name">configure</a>
([<span class="var-type">string|array</span>&nbsp;<span class="var-name">$configuration</span> = <span class="var-default">null</span>], [<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>&nbsp;<span class="var-name">$configurator</span> = <span class="var-default">null</span>])
</div>
<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>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#getConfigurator" title="details" class="method-name">getConfigurator</a>
([<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>&nbsp;<span class="var-name">$configurator</span> = <span class="var-default">null</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/LoggerHierarchy.html">LoggerHierarchy</a></span>
<a href="#getHierarchy" title="details" class="method-name">getHierarchy</a>
()
</div>
<div class="method-definition">
static <span class="method-result"><a href="../log4php/Logger.html">Logger</a></span>
<a href="#getLogger" title="details" class="method-name">getLogger</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</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">
static <span class="method-result">boolean</span>
<a href="#isInitialized" title="details" class="method-name">isInitialized</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</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="#shutdown" title="details" class="method-name">shutdown</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>&nbsp;<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">LoggerAppender</a></span>&nbsp;<span class="var-name">$appender</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>&nbsp;<span class="var-name">$assertion</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<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/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>&nbsp;<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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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>&nbsp;<span class="var-name">$fqcn</span>, <span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span>, <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<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">LoggerAppender</a></span>
<a href="#getAppender" title="details" class="method-name">getAppender</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<a href="#getEffectiveLevel" title="details" class="method-name">getEffectiveLevel</a>
()
</div>
<div class="method-definition">
<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<a href="#getLevel" title="details" class="method-name">getLevel</a>
()
</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></span>
<a href="#getParent" title="details" class="method-name">getParent</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#isAttached" title="details" class="method-name">isAttached</a>
(<span class="var-type"><a href="../log4php/LoggerAppender.html">LoggerAppender</a></span>&nbsp;<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</a></span>&nbsp;<span class="var-name">$level</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#isErrorEnabled" title="details" class="method-name">isErrorEnabled</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#isFatalEnabled" title="details" class="method-name">isFatalEnabled</a>
()
</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">boolean</span>
<a href="#isTraceEnabled" title="details" class="method-name">isTraceEnabled</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#isWarnEnabled" title="details" class="method-name">isWarnEnabled</a>
()
</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</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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>&nbsp;<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>&nbsp;<span class="var-name">$additive</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</a></span>&nbsp;<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"><a href="../log4php/Logger.html">Logger</a></span>&nbsp;<span class="var-name">$logger</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#trace" title="details" class="method-name">trace</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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$hierarchy" id="$hierarchy"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$hierarchy</span>
(line <span class="line-number">409</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The logger hierarchy used by log4php.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$initialized" id="$initialized"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$initialized</span>
= <span class="var-default"> false</span> (line <span class="line-number">412</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Inidicates if log4php has been initialized</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$additive" id="$additive"><!-- --></A>
<div class="evenrow">
<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">49</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logger additivity. If set to true then child loggers will inherit the appenders of their ancestors by default.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$appenders" id="$appenders"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$appenders</span>
= <span class="var-default">array()</span> (line <span class="line-number">67</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A collection of appenders linked to this logger.</p>
<ul class="tags">
<li><span class="field">access:</span> private</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">mixed</span>
<span class="var-name">$fqcn</span>
= <span class="var-default"> 'Logger'</span> (line <span class="line-number">55</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Logger's fully qualified class name.</p>
<p class="description"><p>TODO: Determine if this is useful.</p></p>
<ul class="tags">
<li><span class="field">access:</span> private</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">mixed</span>
<span class="var-name">$level</span>
(line <span class="line-number">58</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The assigned Logger level.</p>
<ul class="tags">
<li><span class="field">access:</span> private</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">mixed</span>
<span class="var-name">$name</span>
(line <span class="line-number">61</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The name of this Logger instance.</p>
<ul class="tags">
<li><span class="field">access:</span> private</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">mixed</span>
<span class="var-name">$parent</span>
(line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The parent logger. Set to null if this is the root logger.</p>
<ul class="tags">
<li><span class="field">access:</span> private</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="methodclear" id="clear"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static clear</span> (line <span class="line-number">458</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears all Logger definitions from the logger hierarchy.</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">
clear
</span>
()
</div>
</div>
<a name="methodconfigure" id="configure"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static configure</span> (line <span class="line-number">514</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Configures log4php.</p>
<p class="description"><p>This method needs to be called before the first logging event has occured. If this method is not called before then the default configuration will be used.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
configure
</span>
([<span class="var-type">string|array</span>&nbsp;<span class="var-name">$configuration</span> = <span class="var-default">null</span>], [<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>&nbsp;<span class="var-name">$configurator</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string|array</span>
<span class="var-name">$configuration</span><span class="var-description">: Either a path to the configuration file, or a configuration array.</span> </li>
<li>
<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>
<span class="var-name">$configurator</span><span class="var-description">: A custom configurator class: either a class name (string), or an object which implements the LoggerConfigurator interface. If left empty, the default configurator implementation will be used.</span> </li>
</ul>
</div>
<a name="methodexists" id="exists"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static exists</span> (line <span class="line-number">486</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>&nbsp;<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="methodgetConfigurator" id="getConfigurator"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getConfigurator</span> (line <span class="line-number">529</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a logger configurator instance based on the provided configurator class. If no class is given, returns an instance of the default configurator.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
getConfigurator
</span>
([<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>&nbsp;<span class="var-name">$configurator</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string|<a href="../log4php/LoggerConfigurator.html">LoggerConfigurator</a></span>
<span class="var-name">$configurator</span><span class="var-description">: The configurator class or LoggerConfigurator instance.</span> </li>
</ul>
</div>
<a name="methodgetCurrentLoggers" id="getCurrentLoggers"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static getCurrentLoggers</span> (line <span class="line-number">495</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></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="methodgetHierarchy" id="getHierarchy"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getHierarchy</span> (line <span class="line-number">423</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the hierarchy used by this Logger.</p>
<p class="description"><p>Caution: do not use this hierarchy unless you have called initialize(). To get Loggers, use the Logger::getLogger and Logger::getRootLogger methods instead of operating on on the hierarchy directly.</p></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">LoggerHierarchy</a></span>
<span class="method-name">
getHierarchy
</span>
()
</div>
</div>
<a name="methodgetLogger" id="getLogger"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static getLogger</span> (line <span class="line-number">436</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a Logger by name. If it does not exist, it will be created.</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></span>
<span class="method-name">
getLogger
</span>
(<span class="var-type">string</span>&nbsp;<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">: The logger name</span> </li>
</ul>
</div>
<a name="methodgetRootLogger" id="getRootLogger"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getRootLogger</span> (line <span class="line-number">447</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the Root 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/LoggerRoot.html">LoggerRoot</a></span>
<span class="method-name">
getRootLogger
</span>
()
</div>
</div>
<a name="methodisInitialized" id="isInitialized"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static isInitialized</span> (line <span class="line-number">567</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the log4php framework has been initialized.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
static <span class="method-result">boolean</span>
<span class="method-name">
isInitialized
</span>
()
</div>
</div>
<a name="methodresetConfiguration" id="resetConfiguration"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static resetConfiguration</span> (line <span class="line-number">465</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destroy configurations for logger definitions</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">
resetConfiguration
</span>
()
</div>
</div>
<a name="methodshutdown" id="shutdown"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static shutdown</span> (line <span class="line-number">476</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Safely close all appenders.</p>
<ul class="tags">
<li><span class="field">deprecated:</span> This is no longer necessary due the appenders shutdown via destructors.</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">
shutdown
</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">73</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>&nbsp;<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">: Name of the logger.</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">281</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new appender to the Logger.</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">LoggerAppender</a></span>&nbsp;<span class="var-name">$appender</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerAppender.html">LoggerAppender</a></span>
<span class="var-name">$appender</span><span class="var-description">: The appender to add.</span> </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">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If assertion parameter evaluates as false, then logs the message using the ERROR 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">
assertLog
</span>
([<span class="var-type">bool</span>&nbsp;<span class="var-name">$assertion</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<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">311</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Forwards the given logging event to all linked 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">
callAppenders
</span>
(<span class="var-type"><a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>&nbsp;<span class="var-name">$event</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>
<span class="var-name">$event</span> </li>
</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">115</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the DEBUG 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">
debug
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</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">148</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the ERROR 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">
error
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
<a name="methodfatal" id="fatal"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">fatal</span> (line <span class="line-number">159</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the FATAL 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">
fatal
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
<a name="methodforcedLog" id="forcedLog"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">forcedLog</span> (line <span class="line-number">204</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#methodtrace">trace()</a>, <a href="../log4php/Logger.html#methoddebug">debug()</a>, <a href="../log4php/Logger.html#methodinfo">info()</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">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>&nbsp;<span class="var-name">$fqcn</span>, <span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span>, <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
<li>
<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</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 to log</span> </li>
</ul>
</div>
<a name="methodgetAdditivity" id="getAdditivity"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getAdditivity</span> (line <span class="line-number">351</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the additivity flag.</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="evenrow">
<div class="method-header">
<span class="method-title">getAllAppenders</span> (line <span class="line-number">327</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the appenders linked to this logger as an array.</p>
<ul class="tags">
<li><span class="field">return:</span> collection of appender names</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="oddrow">
<div class="method-header">
<span class="method-title">getAppender</span> (line <span class="line-number">335</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a linked appender by 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">LoggerAppender</a></span>
<span class="method-name">
getAppender
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</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">360</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starting from this Logger, search the Logger 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</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</a></span>
<span class="method-name">
getEffectiveLevel
</span>
()
</div>
</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">372</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the assigned Logger level.</p>
<ul class="tags">
<li><span class="field">return:</span> The assigned level or null if none is assigned.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="method-name">
getLevel
</span>
()
</div>
</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getName</span> (line <span class="line-number">81</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the logger 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="oddrow">
<div class="method-header">
<span class="method-title">getParent</span> (line <span class="line-number">89</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the parent Logger. Can be null if this is the root logger.</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></span>
<span class="method-name">
getParent
</span>
()
</div>
</div>
<a name="methodinfo" id="info"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">info</span> (line <span class="line-number">126</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
<a name="methodisAttached" id="isAttached"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">isAttached</span> (line <span class="line-number">391</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether an appender is attached to this logger 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">
isAttached
</span>
(<span class="var-type"><a href="../log4php/LoggerAppender.html">LoggerAppender</a></span>&nbsp;<span class="var-name">$appender</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerAppender.html">LoggerAppender</a></span>
<span class="var-name">$appender</span> </li>
</ul>
</div>
<a name="methodisDebugEnabled" id="isDebugEnabled"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">isDebugEnabled</span> (line <span class="line-number">237</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger 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="oddrow">
<div class="method-header">
<span class="method-title">isEnabledFor</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger 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</a></span>&nbsp;<span class="var-name">$level</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="var-name">$level</span><span class="var-description">: level</span> </li>
</ul>
</div>
<a name="methodisErrorEnabled" id="isErrorEnabled"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">isErrorEnabled</span> (line <span class="line-number">261</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger is enabled for the ERROR 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">
isErrorEnabled
</span>
()
</div>
</div>
<a name="methodisFatalEnabled" id="isFatalEnabled"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">isFatalEnabled</span> (line <span class="line-number">269</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger is enabled for the FATAL 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">
isFatalEnabled
</span>
()
</div>
</div>
<a name="methodisInfoEnabled" id="isInfoEnabled"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">isInfoEnabled</span> (line <span class="line-number">245</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger is enabled for the INFO 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">
isInfoEnabled
</span>
()
</div>
</div>
<a name="methodisTraceEnabled" id="isTraceEnabled"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">isTraceEnabled</span> (line <span class="line-number">229</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger is enabled for the TRACE 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">
isTraceEnabled
</span>
()
</div>
</div>
<a name="methodisWarnEnabled" id="isWarnEnabled"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">isWarnEnabled</span> (line <span class="line-number">253</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this Logger is enabled for the WARN 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">
isWarnEnabled
</span>
()
</div>
</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">171</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message using the provided logging 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">
log
</span>
(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="var-name">$level</span><span class="var-description">: The logging level.</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$message</span><span class="var-description">: Message to log.</span> </li>
<li>
<span class="var-type">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
<a name="methodremoveAllAppenders" id="removeAllAppenders"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">removeAllAppenders</span> (line <span class="line-number">287</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes all appenders from the Logger.</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">297</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the appender passed as parameter form the Logger.</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>&nbsp;<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">: an appender name or a <a href="../log4php/LoggerAppender.html">LoggerAppender</a> instance.</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">343</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the additivity flag.</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>&nbsp;<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="methodsetLevel" id="setLevel"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setLevel</span> (line <span class="line-number">381</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the Logger 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">
setLevel
</span>
(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="var-name">$level</span><span class="var-description">: the level to set</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../log4php/LoggerRoot.html#methodsetLevel">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="evenrow">
<div class="method-header">
<span class="method-title">setParent</span> (line <span class="line-number">400</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the parent logger.</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">
setParent
</span>
(<span class="var-type"><a href="../log4php/Logger.html">Logger</a></span>&nbsp;<span class="var-name">$logger</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../log4php/Logger.html">Logger</a></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">LoggerRoot::setParent()</a>
: Always returns false.
</li>
</ul>
</div>
<a name="methodtrace" id="trace"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">trace</span> (line <span class="line-number">104</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the TRACE 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">
trace
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
<a name="methodwarn" id="warn"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">warn</span> (line <span class="line-number">137</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>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">Exception</span>&nbsp;<span class="var-name">$throwable</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">Exception</span>
<span class="var-name">$throwable</span><span class="var-description">: Optional throwable information to include in the logging event.</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:20 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>