Class LoggerFilter

Description

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.

<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 LOG4PHP_LOG4PHP_LOGGER_FILTER_DENY, LOG4PHP_LOGGER_FILTER_NEUTRAL or LOG4PHP_LOGGER_FILTER_ACCEPT.

<p>If the value LOG4PHP_LOGGER_FILTER_DENY is returned, then the log event is dropped immediately without consulting with the remaining filters.

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

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

  • author: Marco Vassura
  • version: $Revision: 556801 $

Located in /spi/LoggerFilter.php (line 73)


	
			
Direct descendents
Class Description
LoggerStringMatchFilter This is a very simple filter based on string matching.
LoggerLevelMatchFilter This is a very simple filter based on level matching.
LoggerLevelRangeFilter This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.
LoggerDenyAllFilter This filter drops all logging events.
Variable Summary
Method Summary
void activateOptions ()
integer decide (LoggerLoggingEvent $event)
void getNext ()
Variables
LoggerFilter $next (line 78)
  • var: Points to the next LoggerFilter in the filter chain.
  • access: protected
Methods
activateOptions (line 84)

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

  • access: public
void activateOptions ()
decide (line 100)

Decide what to do.

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

integer decide (LoggerLoggingEvent $event)

Redefined in descendants as:
getNext (line 105)
  • access: public
void getNext ()

Documentation generated by phpDocumentor 1.3.2