Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / filters / LoggerFilterLevelMatch.html
blob: 1f323b4311e1ce9a4a03d5f14e4cb5e4ebe51cb3 [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 LoggerFilterLevelMatch</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 LoggerFilterLevelMatch</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-consts">Constants</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This is a very simple filter based on level matching.</p>
<p class="description"><p>The filter admits two options <strong>&lt;var&gt;LevelToMatch&lt;/var&gt;</strong> and <strong>&lt;var&gt;AcceptOnMatch&lt;/var&gt;</strong>. If there is an exact match between the value of the <strong>&lt;var&gt;LevelToMatch&lt;/var&gt;</strong> option and the level of the <a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a>, then the <a href="../../log4php/filters/LoggerFilterLevelMatch.html#methoddecide">decide()</a> method returns <a href="../../log4php/LoggerFilter.html#constACCEPT">LoggerFilter::ACCEPT</a> in case the <strong>&lt;var&gt;AcceptOnMatch&lt;/var&gt;</strong> option value is set to <em>true</em>, if it is <em>false</em> then <a href="../../log4php/LoggerFilter.html#constDENY">LoggerFilter::DENY</a> is returned. If there is no match, <a href="../../log4php/LoggerFilter.html#constNEUTRAL">LoggerFilter::NEUTRAL</a> is returned.</p><p>An example for this filter: <div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once&nbsp;</span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../../main/php/Logger.php'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line"><span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodconfigure">configure</a><span class="src-sym">(</span><a href="http://www.php.net/dirname">dirname</a><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../resources/filter_levelmatch.xml'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><span class="src-var">$logger&nbsp;</span>=&nbsp;<span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodgetRootLogger">getRootLogger</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><span class="src-var">$logger</span><span class="src-sym">-&gt;</span><span class="src-id">debug</span><span class="src-sym">(</span><span class="src-str">&quot;Matching&nbsp;and&nbsp;will&nbsp;be&nbsp;rejected&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><span class="src-var">$logger</span><span class="src-sym">-&gt;</span><span class="src-id">info</span><span class="src-sym">(</span><span class="src-str">&quot;Not&nbsp;matching&nbsp;and&nbsp;will&nbsp;be&nbsp;accepted&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>The corresponding XML file: <div class="src-code"><ol><li><div class="src-line">&lt;log4php:configuration&nbsp;xmlns:log4php=&quot;http://logging.apache.org/log4php/&quot;&nbsp;threshold=&quot;all&quot;&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&lt;appender&nbsp;name=&quot;default&quot;&nbsp;class=&quot;LoggerAppenderEcho&quot;&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;layout&nbsp;class=&quot;LoggerLayoutTTCC&quot;&nbsp;/&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;filter&nbsp;class=&quot;LoggerFilterLevelMatch&quot;&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;param&nbsp;name=&quot;LevelToMatch&quot;&nbsp;value=&quot;DEBUG&quot;&nbsp;/&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;param&nbsp;name=&quot;AcceptOnMatch&quot;&nbsp;value=&quot;false&quot;&nbsp;/&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/filter&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&lt;/appender&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&lt;root&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;level&nbsp;value=&quot;DEBUG&quot;&nbsp;/&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;appender_ref&nbsp;ref=&quot;default&quot;&nbsp;/&gt;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&lt;/root&gt;</div></li>
<li><div class="src-line">&lt;/log4php:configuration&gt;</div></li>
</ol></div></p></p>
<ul class="tags">
<li><span class="field">version:</span> $Revision: 1213283 $</li>
<li><span class="field">since:</span> 0.6</li>
</ul>
<p class="notes">
Located in <a class="field" href="_filters---LoggerFilterLevelMatch.php.html">/filters/LoggerFilterLevelMatch.php</a> (line <span class="field">48</span>)
</p>
<pre><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a>
|
--<a href="../../log4php/LoggerFilter.html">LoggerFilter</a>
|
--LoggerFilterLevelMatch</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-consts">Constants</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$acceptOnMatch" title="details" class="var-name">$acceptOnMatch</a>
</div>
<div class="var-title">
<span class="var-type"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>
<a href="#$levelToMatch" title="details" class="var-name">$levelToMatch</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-consts">Constants</a>
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#decide" title="details" class="method-name">decide</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="#setAcceptOnMatch" title="details" class="method-name">setAcceptOnMatch</a>
(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$acceptOnMatch</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setLevelToMatch" title="details" class="method-name">setLevelToMatch</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$l</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-consts">Constants</a>
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$acceptOnMatch" id="$acceptOnMatch"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$acceptOnMatch</span>
= <span class="var-default"> true</span> (line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates if this event should be accepted or denied on match</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$levelToMatch" id="$levelToMatch"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="var-name">$levelToMatch</span>
(line <span class="line-number">60</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The level, when to match</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../log4php/LoggerFilter.html">LoggerFilter</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerFilter.html#var$next">LoggerFilter::$next</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-consts">Constants</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="methoddecide" id="decide"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">decide</span> (line <span class="line-number">89</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the decision of this filter.</p>
<p class="description"><p>Returns <a href="../../log4php/LoggerFilter.html#constNEUTRAL">LoggerFilter::NEUTRAL</a> if the <strong>&lt;var&gt;LevelToMatch&lt;/var&gt;</strong> option is not set or if there is not match. Otherwise, if there is a match, then the returned decision is <a href="../../log4php/LoggerFilter.html#constACCEPT">LoggerFilter::ACCEPT</a> if the <strong>&lt;var&gt;AcceptOnMatch&lt;/var&gt;</strong> property is set to <em>true</em>. The returned decision is <a href="../../log4php/LoggerFilter.html#constDENY">LoggerFilter::DENY</a> if the <strong>&lt;var&gt;AcceptOnMatch&lt;/var&gt;</strong> property is set to <em>false</em>.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
decide
</span>
(<span class="var-type"><a href="../../log4php/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>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../log4php/LoggerFilter.html#methoddecide">LoggerFilter::decide()</a></dt>
<dd>Decide what to do.</dd>
</dl>
</div>
<a name="methodsetAcceptOnMatch" id="setAcceptOnMatch"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setAcceptOnMatch</span> (line <span class="line-number">65</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">
setAcceptOnMatch
</span>
(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$acceptOnMatch</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$acceptOnMatch</span> </li>
</ul>
</div>
<a name="methodsetLevelToMatch" id="setLevelToMatch"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setLevelToMatch</span> (line <span class="line-number">72</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">
setLevelToMatch
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$l</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$l</span><span class="var-description">: the level to match</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$level</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../log4php/LoggerFilter.html">LoggerFilter</a></span></p>
<blockquote>
<span class="method-name"><a href="../../log4php/LoggerFilter.html#methodactivateOptions">LoggerFilter::activateOptions()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerFilter.html#methodaddNext">LoggerFilter::addNext()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerFilter.html#methoddecide">LoggerFilter::decide()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerFilter.html#methodgetNext">LoggerFilter::getNext()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a></span></p>
<blockquote>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetBoolean">LoggerConfigurable::setBoolean()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetFileSize">LoggerConfigurable::setFileSize()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetInteger">LoggerConfigurable::setInteger()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetLevel">LoggerConfigurable::setLevel()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetNumeric">LoggerConfigurable::setNumeric()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetPositiveInteger">LoggerConfigurable::setPositiveInteger()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetString">LoggerConfigurable::setString()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodwarn">LoggerConfigurable::warn()</a></span><br>
</blockquote>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</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">
<h4>Inherited Constants</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../log4php/LoggerFilter.html">LoggerFilter</a></span></p>
<blockquote>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../log4php/LoggerFilter.html#constACCEPT">LoggerFilter::ACCEPT</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../log4php/LoggerFilter.html#constDENY">LoggerFilter::DENY</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../log4php/LoggerFilter.html#constNEUTRAL">LoggerFilter::NEUTRAL</a></span><br>
</span>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:24 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>