## Class LoggerFilter

Description

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 method of each filter is called sequentially, in the order of their addition to the chain.

<p>The 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.

- version: $Revision: 1213283 $
- abstract:

Located in /log4php/LoggerFilter.php (line 56)

    LoggerConfigurable
       |
       --LoggerFilter

Direct descendents

Class | Description
--- | ---
LoggerFilterStringMatch | This is a very simple filter based on string matching.
LoggerFilterLevelMatch | This is a very simple filter based on level matching.
LoggerFilterLevelRange | This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.
LoggerFilterDenyAll | This filter drops all logging events.

Class Constant Summary
ACCEPT = 1
DENY = -1
NEUTRAL = 0
Variable Summary
LoggerFilter $next
Method Summary
void activateOptions ()
void addNext ($filter $filter)
integer decide (LoggerLoggingEvent $event)
the getNext ()
Variables
LoggerFilter $next (line 79)

- var: Points to the next LoggerFilter in the filter chain.
- access: protected

Methods
activateOptions (line 85)

Usually filters options become active when set. We provide a default do-nothing implementation for convenience.

- access: public

void activateOptions ()
addNext (line 110)

Adds a new filter to the filter chain this filter is a part of.

If this filter has already and follow up filter, the param filter is passed on until it is the last filter in chain.

- access: public

void addNext ($filter $filter)

- $filter $filter: - the filter to add to this chain

decide (line 99)

Decide what to do.

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.

- return: LoggerFilter::NEUTRAL or LoggerFilter::DENY|LoggerFilter::ACCEPT
- access: public

integer decide (LoggerLoggingEvent $event)

- LoggerLoggingEvent $event: The LoggerLoggingEvent to decide upon.

Redefined in descendants as:

- LoggerFilterStringMatch::decide()
- LoggerFilterLevelMatch::decide() : Return the decision of this filter.
- LoggerFilterLevelRange::decide() : Return the decision of this filter.
- LoggerFilterDenyAll::decide() : Always returns the integer constant LoggerFilter::DENY regardless of the LoggerLoggingEvent parameter.

getNext (line 122)

Returns the next filter in this chain

- return: next filter
- access: public

the getNext ()

#### Inherited Methods

Inherited From LoggerConfigurable

> LoggerConfigurable::setBoolean()
> LoggerConfigurable::setFileSize()
> LoggerConfigurable::setInteger()
> LoggerConfigurable::setLevel()
> LoggerConfigurable::setNumeric()
> LoggerConfigurable::setPositiveInteger()
> LoggerConfigurable::setString()
> LoggerConfigurable::warn()

Class Constants
ACCEPT = 1 (line 62)

The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.

DENY = -1 (line 74)

The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.

NEUTRAL = 0 (line 68)

This filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision.

Documentation generated on Fri, 10 Apr 2026 12:21:03 +0900 by phpDocumentor 1.4.4