Class LoggerLevelRangeFilter

Description

This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.

The filter admits three options <var>LevelMin</var>, <var>LevelMax</var> and <var>AcceptOnMatch</var>.

If the level of the LoggerLoggingEvent is not between Min and Max (inclusive), then LOG4PHP_LOGGER_FILTER_DENY is returned.

If the Logging event level is within the specified range, then if <var>AcceptOnMatch</var> is true, LOG4PHP_LOGGER_FILTER_ACCEPT is returned, and if <var>AcceptOnMatch</var> is false, LOG4PHP_LOGGER_FILTER_NEUTRAL is returned.

If <var>LevelMin</var> is not defined, then there is no minimum acceptable level (i.e. a level is never rejected for being too "low"/unimportant). If <var>LevelMax</var> is not defined, then there is no maximum acceptable level (ie a level is never rejected for being too "high"/important).

Refer to the LoggerAppenderSkeleton::setThreshold() method available to all appenders extending LoggerAppenderSkeleton for a more convenient way to filter out events by level.

  • author: Marco Vassura
  • version: $Revision: 556784 $
  • since: 0.6

Located in /varia/LoggerLevelRangeFilter.php (line 59)

LoggerFilter
   |
   --LoggerLevelRangeFilter
Variable Summary
Method Summary
integer decide (LoggerLoggingEvent $event)
boolean getAcceptOnMatch ()
void setAcceptOnMatch (boolean $acceptOnMatch)
void setLevelMax (string $l)
void setLevelMin (string $l)
Variables
boolean $acceptOnMatch = true (line 64)
LoggerLevel $levelMax (line 74)
LoggerLevel $levelMin (line 69)

Inherited Variables

Inherited from LoggerFilter

LoggerFilter::$next
Methods
decide (line 130)

Return the decision of this filter.

integer decide (LoggerLoggingEvent $event)

Redefinition of:
LoggerFilter::decide()
Decide what to do.
getAcceptOnMatch (line 79)
boolean getAcceptOnMatch ()
getLevelMax (line 111)
LoggerLevel getLevelMax ()
getLevelMin (line 95)
LoggerLevel getLevelMin ()
setAcceptOnMatch (line 87)
void setAcceptOnMatch (boolean $acceptOnMatch)
  • boolean $acceptOnMatch
setLevelMax (line 119)
void setLevelMax (string $l)
  • string $l: the level max to match
setLevelMin (line 103)
void setLevelMin (string $l)
  • string $l: the level min to match

Inherited Methods

Inherited From LoggerFilter

LoggerFilter::activateOptions()
LoggerFilter::decide()
LoggerFilter::getNext()

Documentation generated by phpDocumentor 1.3.2