| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="ApiGen 2.8.0" /> |
| <meta name="robots" content="noindex" /> |
| |
| <title>File filters/LoggerFilterLevelRange.php | Apache log4php</title> |
| |
| <script type="text/javascript" src="resources/combined.js?238209907"></script> |
| <script type="text/javascript" src="elementlist.js?4055067042"></script> |
| <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" /> |
| |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', "UA-26177991-1"]); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| </head> |
| |
| <body> |
| <div id="left"> |
| <div id="menu"> |
| <a href="index.html" title="Overview"><span>Overview</span></a> |
| |
| |
| <div id="groups"> |
| <h3>Packages</h3> |
| <ul> |
| <li class="active"><a href="package-log4php.html">log4php<span></span></a> |
| <ul> |
| <li><a href="package-log4php.appenders.html">appenders</a> |
| </li> |
| <li><a href="package-log4php.configurators.html">configurators</a> |
| </li> |
| <li class="active"><a href="package-log4php.filters.html">filters</a> |
| </li> |
| <li><a href="package-log4php.helpers.html">helpers</a> |
| </li> |
| <li><a href="package-log4php.layouts.html">layouts</a> |
| </li> |
| <li><a href="package-log4php.pattern.html">pattern</a> |
| </li> |
| <li><a href="package-log4php.renderers.html">renderers</a> |
| </li> |
| </ul></li> |
| </ul> |
| </div> |
| |
| <hr /> |
| |
| |
| <div id="elements"> |
| <h3>Classes</h3> |
| <ul> |
| <li><a href="class-LoggerFilterDenyAll.html">LoggerFilterDenyAll</a></li> |
| <li><a href="class-LoggerFilterLevelMatch.html">LoggerFilterLevelMatch</a></li> |
| <li class="active"><a href="class-LoggerFilterLevelRange.html">LoggerFilterLevelRange</a></li> |
| <li><a href="class-LoggerFilterStringMatch.html">LoggerFilterStringMatch</a></li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| |
| <div id="splitter"></div> |
| |
| <div id="right"> |
| <div id="rightInner"> |
| <form id="search"> |
| <input type="hidden" name="cx" value="" /> |
| <input type="hidden" name="ie" value="UTF-8" /> |
| <input type="text" name="q" class="text" /> |
| <input type="submit" value="Search" /> |
| </form> |
| |
| <div id="navigation"> |
| <ul> |
| <li> |
| <a href="index.html" title="Overview"><span>Overview</span></a> |
| </li> |
| <li> |
| <a href="package-log4php.filters.html" title="Summary of log4php\filters"><span>Package</span></a> |
| </li> |
| <li> |
| <a href="class-LoggerFilterLevelRange.html" title="Summary of LoggerFilterLevelRange"><span>Class</span></a> |
| </li> |
| </ul> |
| <ul> |
| <li> |
| <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
| </li> |
| </ul> |
| <ul> |
| </ul> |
| </div> |
| |
| <pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span> |
| </span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/** |
| </span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more |
| </span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with |
| </span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * this work for additional information regarding copyright ownership. |
| </span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0 |
| </span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * (the "License"); you may not use this file except in compliance with |
| </span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * the License. You may obtain a copy of the License at |
| </span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * |
| </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0 |
| </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * |
| </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software |
| </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS, |
| </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * See the License for the specific language governing permissions and |
| </span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * limitations under the License. |
| </span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * |
| </span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @package log4php |
| </span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> */</span> |
| </span><span id="20" class="l"><a class="l" href="#20"> 20: </a> |
| </span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/** |
| </span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * This is a very simple filter based on level matching, which can be |
| </span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * used to reject messages with priorities outside a certain range. |
| </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * |
| </span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * <p>The filter admits three options <b><var>LevelMin</var></b>, <b><var>LevelMax</var></b> |
| </span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * and <b><var>AcceptOnMatch</var></b>.</p> |
| </span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * |
| </span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * <p>If the level of the {@link LoggerLoggingEvent} is not between Min and Max |
| </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * (inclusive), then {@link LoggerFilter::DENY} is returned.</p> |
| </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * |
| </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * <p>If the Logging event level is within the specified range, then if |
| </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * <b><var>AcceptOnMatch</var></b> is <i>true</i>, |
| </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * {@link LoggerFilter::ACCEPT} is returned, and if |
| </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * <b><var>AcceptOnMatch</var></b> is <i>false</i>, |
| </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * {@link LoggerFilter::NEUTRAL} is returned.</p> |
| </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * |
| </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * <p>If <b><var>LevelMin</var></b> is not defined, then there is no |
| </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * minimum acceptable level (i.e. a level is never rejected for |
| </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * being too "low"/unimportant). If <b><var>LevelMax</var></b> is not |
| </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * defined, then there is no maximum acceptable level (ie a |
| </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * level is never rejected for being too "high"/important).</p> |
| </span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * |
| </span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * <p>Refer to the {@link LoggerAppender::setThreshold()} method |
| </span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * available to <b>all</b> appenders extending {@link LoggerAppender} |
| </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * for a more convenient way to filter out events by level.</p> |
| </span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * |
| </span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * <p> |
| </span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * An example for this filter: |
| </span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * |
| </span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * {@example ../../examples/php/filter_levelrange.php 19} |
| </span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * |
| </span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * <p> |
| </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * The corresponding XML file: |
| </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * |
| </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * {@example ../../examples/resources/filter_levelrange.xml 18} |
| </span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * |
| </span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * @author Simon Kitching |
| </span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * @author based on the org.apache.log4j.varia.LevelRangeFilte Java code by Ceki G&uuml;lc&uuml; |
| </span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * |
| </span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * @version $Revision: 1213283 $ |
| </span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * @package log4php |
| </span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * @subpackage filters |
| </span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * @since 0.6 |
| </span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> */</span> |
| </span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-keyword1">class</span> <a id="LoggerFilterLevelRange" href="#LoggerFilterLevelRange">LoggerFilterLevelRange</a> <span class="php-keyword1">extends</span> LoggerFilter { |
| </span><span id="66" class="l"><a class="l" href="#66"> 66: </a> |
| </span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-comment">/** |
| </span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * @var boolean |
| </span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> */</span> |
| </span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$acceptOnMatch" href="#$acceptOnMatch">$acceptOnMatch</a></span> = <span class="php-keyword1">true</span>; |
| </span><span id="71" class="l"><a class="l" href="#71"> 71: </a> |
| </span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-comment">/** |
| </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @var LoggerLevel |
| </span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> */</span> |
| </span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$levelMin" href="#$levelMin">$levelMin</a></span>; |
| </span><span id="76" class="l"><a class="l" href="#76"> 76: </a> |
| </span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-comment">/** |
| </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * @var LoggerLevel |
| </span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> */</span> |
| </span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$levelMax" href="#$levelMax">$levelMax</a></span>; |
| </span><span id="81" class="l"><a class="l" href="#81"> 81: </a> |
| </span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-comment">/** |
| </span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * @param boolean $acceptOnMatch |
| </span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> */</span> |
| </span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setAcceptOnMatch" href="#_setAcceptOnMatch">setAcceptOnMatch</a>(<span class="php-var">$acceptOnMatch</span>) { |
| </span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-var">$this</span>->setBoolean(<span class="php-quote">'acceptOnMatch'</span>, <span class="php-var">$acceptOnMatch</span>); |
| </span><span id="87" class="l"><a class="l" href="#87"> 87: </a> } |
| </span><span id="88" class="l"><a class="l" href="#88"> 88: </a> |
| </span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-comment">/** |
| </span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @param string $l the level min to match |
| </span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> */</span> |
| </span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setLevelMin" href="#_setLevelMin">setLevelMin</a>(<span class="php-var">$level</span>) { |
| </span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-var">$this</span>->setLevel(<span class="php-quote">'levelMin'</span>, <span class="php-var">$level</span>); |
| </span><span id="94" class="l"><a class="l" href="#94"> 94: </a> } |
| </span><span id="95" class="l"><a class="l" href="#95"> 95: </a> |
| </span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-comment">/** |
| </span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * @param string $l the level max to match |
| </span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span> |
| </span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setLevelMax" href="#_setLevelMax">setLevelMax</a>(<span class="php-var">$level</span>) { |
| </span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-var">$this</span>->setLevel(<span class="php-quote">'levelMax'</span>, <span class="php-var">$level</span>); |
| </span><span id="101" class="l"><a class="l" href="#101">101: </a> } |
| </span><span id="102" class="l"><a class="l" href="#102">102: </a> |
| </span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-comment">/** |
| </span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * Return the decision of this filter. |
| </span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * |
| </span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * @param LoggerLoggingEvent $event |
| </span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * @return integer |
| </span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span> |
| </span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_decide" href="#_decide">decide</a>(LoggerLoggingEvent <span class="php-var">$event</span>) { |
| </span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-var">$level</span> = <span class="php-var">$event</span>->getLevel(); |
| </span><span id="111" class="l"><a class="l" href="#111">111: </a> |
| </span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>->levelMin !== <span class="php-keyword1">null</span>) { |
| </span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-keyword1">if</span>(<span class="php-var">$level</span>->isGreaterOrEqual(<span class="php-var">$this</span>->levelMin) == <span class="php-keyword1">false</span>) { |
| </span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-comment">// level of event is less than minimum</span> |
| </span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-keyword1">return</span> LoggerFilter::DENY; |
| </span><span id="116" class="l"><a class="l" href="#116">116: </a> } |
| </span><span id="117" class="l"><a class="l" href="#117">117: </a> } |
| </span><span id="118" class="l"><a class="l" href="#118">118: </a> |
| </span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>->levelMax !== <span class="php-keyword1">null</span>) { |
| </span><span id="120" class="l"><a class="l" href="#120">120: </a> <span class="php-keyword1">if</span>(<span class="php-var">$level</span>->toInt() > <span class="php-var">$this</span>->levelMax->toInt()) { |
| </span><span id="121" class="l"><a class="l" href="#121">121: </a> <span class="php-comment">// level of event is greater than maximum</span> |
| </span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-comment">// Alas, there is no Level.isGreater method. and using</span> |
| </span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-comment">// a combo of isGreaterOrEqual && !Equal seems worse than</span> |
| </span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-comment">// checking the int values of the level objects..</span> |
| </span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-keyword1">return</span> LoggerFilter::DENY; |
| </span><span id="126" class="l"><a class="l" href="#126">126: </a> } |
| </span><span id="127" class="l"><a class="l" href="#127">127: </a> } |
| </span><span id="128" class="l"><a class="l" href="#128">128: </a> |
| </span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>->acceptOnMatch) { |
| </span><span id="130" class="l"><a class="l" href="#130">130: </a> <span class="php-comment">// this filter set up to bypass later filters and always return</span> |
| </span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-comment">// accept if level in range</span> |
| </span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">return</span> LoggerFilter::ACCEPT; |
| </span><span id="133" class="l"><a class="l" href="#133">133: </a> } <span class="php-keyword1">else</span> { |
| </span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-comment">// event is ok for this filter; allow later filters to have a look..</span> |
| </span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-keyword1">return</span> LoggerFilter::NEUTRAL; |
| </span><span id="136" class="l"><a class="l" href="#136">136: </a> } |
| </span><span id="137" class="l"><a class="l" href="#137">137: </a> } |
| </span><span id="138" class="l"><a class="l" href="#138">138: </a>} |
| </span><span id="139" class="l"><a class="l" href="#139">139: </a></span></code></pre> |
| |
| <div id="footer"> |
| Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
