Class LoggerFilter
Users should extend this class to implement customized logging
event filtering. Note that LoggerCategory and LoggerAppender,
the parent class of all standard
appenders, have built-in filtering rules. It is suggested that you
first use and understand the built-in rules before rushing to write
your own custom filters.
<
p>This abstract class assumes and also imposes that filters be organized in a linear chain. The #decide decide(LoggerLoggingEvent) method of each filter is called sequentially, in the order of their addition to the chain.
<
p>The LoggerFilter::decide() method must return one
of the integer constants LoggerFilter::DENY,
LoggerFilter::NEUTRAL or LoggerFilter::ACCEPT.
<
p>If the value LoggerFilter::DENY is returned, then the log event is dropped immediately without consulting with the remaining filters.
<
p>If the value LoggerFilter::NEUTRAL is returned, then the next filter in the chain is consulted. If there are no more filters in the chain, then the log event is logged. Thus, in the presence of no filters, the default behaviour is to log all logging events.
<
p>If the value LoggerFilter::ACCEPT is returned, then the log event is logged without consulting the remaining filters.
<
p>The philosophy of log4php filters is largely inspired from the Linux ipchains.
- LoggerConfigurable
-
LoggerFilter
Direct known subclasses
LoggerFilterDenyAll, LoggerFilterLevelMatch, LoggerFilterLevelRange, LoggerFilterStringMatch
public
|
#
activateOptions( )
Usually filters options become active when set. We provide a default do-nothing implementation for convenience. |
public
integer
|
#
decide(
Decide what to do. < p>If the decision is LoggerFilter::DENY, then the event will be dropped. If the decision is LoggerFilter::NEUTRAL, then the next filter, if any, will be invoked. If the decision is LoggerFilter::ACCEPT then the event will be logged without consulting with other filters in the chain. |
public
|
|
public
the
|
setBoolean(),
setFileSize(),
setInteger(),
setLevel(),
setNumeric(),
setPositiveInteger(),
setString(),
warn()
|
integer |
ACCEPT
The log event must be logged immediately without consulting with the remaining filters, if any, in the chain. |
#
1
|
integer |
NEUTRAL
This filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision. |
#
0
|
integer |
DENY
The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain. |
#
-1
|
protected
|
$next
Points to the next |