Docs For Class LoggerFilterStringMatch

Description

This is a very simple filter based on string matching.

The filter admits two options $stringToMatch and $acceptOnMatch. If there is a match (using http://www.php.net/strpos between the value of the $stringToMatch option and the message of the LoggerLoggingEvent, then the decide() method returns LoggerFilter::ACCEPT if the AcceptOnMatch option value is true, if it is false then LoggerFilter::DENY is returned. If there is no match, LoggerFilter::NEUTRAL is returned.

An example for this filter:

require_once dirname(__FILE__).'/../../main/php/Logger.php';
Logger::configure(dirname(__FILE__).'/../resources/filter_stringmatch.xml');
$logger = Logger::getRootLogger();
$logger->debug("Some text to match that will be rejected");
$logger->info("Some other text that will be accepted");

The corresponding XML file:

<log4php:configuration xmlns:log4php="http://logging.apache.org/log4php/" threshold="all">
<appender name="default" class="LoggerAppenderEcho">
<layout class="LoggerLayoutTTCC" />
<filter class="LoggerFilterStringMatch">
<param name="StringToMatch" value="match" />
<param name="AcceptOnMatch" value="false" />
</filter>
</appender>
<root>
<level value="DEBUG" />
<appender_ref ref="default" />
</root>
</log4php:configuration>

version: $Revision: 1213283 $
since: 0.3

Located in /filters/LoggerFilterStringMatch.php (line 48)

LoggerConfigurable
   |
   --LoggerFilter
      |
      --LoggerFilterStringMatch

Variable Summary

boolean $acceptOnMatch

string $stringToMatch

Method Summary

integer decide (LoggerLoggingEvent $event)

void setAcceptOnMatch (mixed $acceptOnMatch)

void setStringToMatch ( $string, string $s)

Variables

boolean $acceptOnMatch = true (line 53)

access: protected

string $stringToMatch (line 58)

access: protected

Inherited Variables

Inherited from LoggerFilter

LoggerFilter::$next

Methods

decide (line 77)

return: a LOGGER_FILTER_NEUTRAL is there is no string match.
access: public

integer decide (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

LoggerFilter::decide(): Decide what to do.

setAcceptOnMatch (line 63)

access: public

void setAcceptOnMatch (mixed $acceptOnMatch)

mixed $acceptOnMatch: a boolean or a string ('true' or 'false')

setStringToMatch (line 70)

access: public

void setStringToMatch ( $string, string $s)

string $s: the string to match
$string

Inherited Methods

Inherited From LoggerFilter

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

Inherited From LoggerConfigurable

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

Class Constants

Inherited Constants

Inherited from LoggerFilter

LoggerFilter::ACCEPT
LoggerFilter::DENY
LoggerFilter::NEUTRAL