| <!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 LoggerFilter.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><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-Logger.html">Logger</a></li> |
| <li><a href="class-LoggerAppender.html">LoggerAppender</a></li> |
| <li><a href="class-LoggerAppenderPool.html">LoggerAppenderPool</a></li> |
| <li><a href="class-LoggerAutoloader.html">LoggerAutoloader</a></li> |
| <li><a href="class-LoggerConfigurable.html">LoggerConfigurable</a></li> |
| <li><a href="class-LoggerConfiguratorDefault.html">LoggerConfiguratorDefault</a></li> |
| <li class="active"><a href="class-LoggerFilter.html">LoggerFilter</a></li> |
| <li><a href="class-LoggerHierarchy.html">LoggerHierarchy</a></li> |
| <li><a href="class-LoggerLayout.html">LoggerLayout</a></li> |
| <li><a href="class-LoggerLevel.html">LoggerLevel</a></li> |
| <li><a href="class-LoggerLocationInfo.html">LoggerLocationInfo</a></li> |
| <li><a href="class-LoggerLoggingEvent.html">LoggerLoggingEvent</a></li> |
| <li><a href="class-LoggerMDC.html">LoggerMDC</a></li> |
| <li><a href="class-LoggerNDC.html">LoggerNDC</a></li> |
| <li><a href="class-LoggerReflectionUtils.html">LoggerReflectionUtils</a></li> |
| <li><a href="class-LoggerRoot.html">LoggerRoot</a></li> |
| <li><a href="class-LoggerThrowableInformation.html">LoggerThrowableInformation</a></li> |
| </ul> |
| |
| <h3>Interfaces</h3> |
| <ul> |
| <li><a href="class-LoggerConfigurator.html">LoggerConfigurator</a></li> |
| </ul> |
| |
| |
| <h3>Exceptions</h3> |
| <ul> |
| <li><a href="class-LoggerException.html">LoggerException</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.html" title="Summary of log4php"><span>Package</span></a> |
| </li> |
| <li> |
| <a href="class-LoggerFilter.html" title="Summary of LoggerFilter"><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"> * Users should extend this class to implement customized logging |
| </span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * event filtering. Note that {@link LoggerCategory} and {@link LoggerAppender}, |
| </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * the parent class of all standard |
| </span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * appenders, have built-in filtering rules. It is suggested that you |
| </span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * first use and understand the built-in rules before rushing to write |
| </span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * your own custom filters. |
| </span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * |
| </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * <p>This abstract class assumes and also imposes that filters be |
| </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * organized in a linear chain. The {@link #decide |
| </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * decide(LoggerLoggingEvent)} method of each filter is called sequentially, |
| </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * in the order of their addition to the chain. |
| </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * |
| </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * <p>The {@link decide()} method must return one |
| </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * of the integer constants {@link LoggerFilter::DENY}, |
| </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * {@link LoggerFilter::NEUTRAL} or {@link LoggerFilter::ACCEPT}. |
| </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * |
| </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * <p>If the value {@link LoggerFilter::DENY} is returned, then the log event is |
| </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * dropped immediately without consulting with the remaining |
| </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * filters. |
| </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * |
| </span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * <p>If the value {@link LoggerFilter::NEUTRAL} is returned, then the next filter |
| </span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * in the chain is consulted. If there are no more filters in the |
| </span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * chain, then the log event is logged. Thus, in the presence of no |
| </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * filters, the default behaviour is to log all logging events. |
| </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>If the value {@link LoggerFilter::ACCEPT} is returned, then the log |
| </span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * event is logged without consulting the remaining filters. |
| </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"> * <p>The philosophy of log4php filters is largely inspired from the |
| </span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * Linux ipchains. |
| </span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * |
| </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * @version $Revision: 1213283 $ |
| </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * @package log4php |
| </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> */</span> |
| </span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="LoggerFilter" href="#LoggerFilter">LoggerFilter</a> <span class="php-keyword1">extends</span> LoggerConfigurable { |
| </span><span id="57" class="l"><a class="l" href="#57"> 57: </a> |
| </span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-comment">/** |
| </span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * The log event must be logged immediately without consulting with |
| </span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * the remaining filters, if any, in the chain. |
| </span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> */</span> |
| </span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-keyword1">const</span> <a id="ACCEPT" href="#ACCEPT">ACCEPT</a> = <span class="php-num">1</span>; |
| </span><span id="63" class="l"><a class="l" href="#63"> 63: </a> |
| </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-comment"> * This filter is neutral with respect to the log event. The |
| </span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * remaining filters, if any, should be consulted for a final decision. |
| </span></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-keyword1">const</span> <a id="NEUTRAL" href="#NEUTRAL">NEUTRAL</a> = <span class="php-num">0</span>; |
| </span><span id="69" class="l"><a class="l" href="#69"> 69: </a> |
| </span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-comment">/** |
| </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * The log event must be dropped immediately without consulting |
| </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * with the remaining filters, if any, in the chain. |
| </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span> |
| </span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-keyword1">const</span> <a id="DENY" href="#DENY">DENY</a> = -<span class="php-num">1</span>; |
| </span><span id="75" class="l"><a class="l" href="#75"> 75: </a> |
| </span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-comment">/** |
| </span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * @var LoggerFilter Points to the next {@link LoggerFilter} in the filter chain. |
| </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span> |
| </span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$next" href="#$next">$next</a></span>; |
| </span><span id="80" class="l"><a class="l" href="#80"> 80: </a> |
| </span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-comment">/** |
| </span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * Usually filters options become active when set. We provide a |
| </span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * default do-nothing implementation for convenience. |
| </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="_activateOptions" href="#_activateOptions">activateOptions</a>() { |
| </span><span id="86" class="l"><a class="l" href="#86"> 86: </a> } |
| </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 class="php-comment">/** |
| </span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * Decide what to do. |
| </span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * <p>If the decision is {@link LoggerFilter::DENY}, then the event will be |
| </span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * dropped. If the decision is {@link LoggerFilter::NEUTRAL}, then the next |
| </span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * filter, if any, will be invoked. If the decision is {@link LoggerFilter::ACCEPT} then |
| </span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * the event will be logged without consulting with other filters in |
| </span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * the chain. |
| </span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * |
| </span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * @param LoggerLoggingEvent $event The {@link LoggerLoggingEvent} to decide upon. |
| </span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * @return integer {@link LoggerFilter::NEUTRAL} or {@link LoggerFilter::DENY}|{@link LoggerFilter::ACCEPT} |
| </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="_decide" href="#_decide">decide</a>(LoggerLoggingEvent <span class="php-var">$event</span>) { |
| </span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-keyword1">return</span> self::NEUTRAL; |
| </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"> * Adds a new filter to the filter chain this filter is a part of. |
| </span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * If this filter has already and follow up filter, the param filter |
| </span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * is passed on until it is the last filter in chain. |
| </span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * |
| </span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * @param $filter - the filter to add to this chain |
| </span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> */</span> |
| </span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addNext" href="#_addNext">addNext</a>(<span class="php-var">$filter</span>) { |
| </span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-><span class="php-keyword2">next</span> !== <span class="php-keyword1">null</span>) { |
| </span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-var">$this</span>-><span class="php-keyword2">next</span>->addNext(<span class="php-var">$filter</span>); |
| </span><span id="113" class="l"><a class="l" href="#113">113: </a> } <span class="php-keyword1">else</span> { |
| </span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-var">$this</span>-><span class="php-keyword2">next</span> = <span class="php-var">$filter</span>; |
| </span><span id="115" class="l"><a class="l" href="#115">115: </a> } |
| </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 class="php-comment">/** |
| </span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * Returns the next filter in this chain |
| </span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * @return the next filter |
| </span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> */</span> |
| </span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getNext" href="#_getNext">getNext</a>() { |
| </span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-keyword2">next</span>; |
| </span><span id="124" class="l"><a class="l" href="#124">124: </a> } |
| </span><span id="125" class="l"><a class="l" href="#125">125: </a> |
| </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></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> |
