Class LoggerFilter

Description

Users should extend this class to implement customized logging event filtering. the parent class of all standard appenders, have built-in filtering rules. first use and understand the built-in rules before rushing to write your own custom filters.

Users should extend this class to implement customized logging event filtering. Note that LoggerCategory and LoggerAppenderSkeleton, 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. 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.

The decide() method must return one of the integer constants LOGGER_FILTER_DENY, LOGGER_FILTER_NEUTRAL or LOGGER_FILTER_ACCEPT.

If the value LOGGER_FILTER_DENY is returned, then the log event is dropped immediately without consulting with the remaining filters.

If the value LOGGER_FILTER_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.

If the value LOGGER_FILTER_ACCEPT is returned, then the log event is logged without consulting the remaining filters.

The philosophy of log4php filters is largely inspired from the Linux ipchains.

Located in Program_Root/src/log4php/spi/LoggerFilter.php (line 76)


	
			
Direct descendents
Class Description
LoggerDenyAllFilter This filter drops all logging events.
LoggerStringMatchFilter This is a very simple filter based on string matching.
Variable Summary
object Points $next
Method Summary
void activateOptions ()
integer decide (object $event)
Variables
object Points $next (line 81)
Methods
activateOptions (line 87)

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

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

void activateOptions ()
decide (line 102)

If the decision is LOGGER_FILTER_DENY, then the event will be dropped. filter, if any, will be invoked. the event will be logged without consulting with other filters in the chain.

If the decision is LOGGER_FILTER_DENY, then the event will be dropped. If the decision is LOGGER_FILTER_NEUTRAL, then the next filter, if any, will be invoked. If the decision is LOGGER_FILTER_ACCEPT then the event will be logged without consulting with other filters in the chain.

integer decide (object $event)

Redefined in descendants as:

Documentation generated on Wed, 27 Aug 2003 18:11:38 +0200 by phpDocumentor 1.2.2