[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * log4php is a PHP port of the log4j java logging package.
   4   * 
   5   * <p>This framework is based on log4j (see {@link http://jakarta.apache.org/log4j log4j} for details).</p>
   6   * <p>Design, strategies and part of the methods documentation are developed by log4j team 
   7   * (Ceki G�lc� as log4j project founder and 
   8   * {@link http://jakarta.apache.org/log4j/docs/contributors.html contributors}).</p>
   9   *
  10   * <p>PHP port, extensions and modifications by VxR. All rights reserved.<br>
  11   * For more information, please see {@link http://www.vxr.it/log4php/}.</p>
  12   *
  13   * <p>This software is published under the terms of the LGPL License
  14   * a copy of which has been included with this distribution in the LICENSE file.</p>
  15   * 
  16   * @package log4php
  17   * @subpackage varia
  18   */
  19  
  20  /**
  21   * @ignore 
  22   */
  23  if (!defined('LOG4PHP_DIR')) define('LOG4PHP_DIR', dirname(__FILE__) . '/..');
  24   
  25  /**
  26   */
  27  require_once (LOG4PHP_DIR . '/spi/LoggerFilter.php');
  28  
  29  /**
  30   * This is a very simple filter based on string matching.
  31   * 
  32   * <p>The filter admits two options {@link $stringToMatch} and
  33   * {@link $acceptOnMatch}. If there is a match (using {@link PHP_MANUAL#strpos}
  34   * between the value of the {@link $stringToMatch} option and the message 
  35   * of the {@link LoggerLoggingEvent},
  36   * then the {@link decide()} method returns {@link LOG4PHP_LOGGER_FILTER_ACCEPT} if
  37   * the <b>AcceptOnMatch</b> option value is true, if it is false then
  38   * {@link LOG4PHP_LOGGER_FILTER_DENY} is returned. If there is no match, {@link LOG4PHP_LOGGER_FILTER_NEUTRAL}
  39   * is returned.</p>
  40   *
  41   * @author VxR <[email protected]>
  42   * @version $Revision: 1.4 $
  43   * @package log4php
  44   * @subpackage varia
  45   * @since 0.3
  46   */
  47  class LoggerStringMatchFilter extends LoggerFilter {
  48    
  49      /**
  50       * @var boolean
  51       */
  52      var $acceptOnMatch = true;
  53  
  54      /**
  55       * @var string
  56       */
  57      var $stringToMatch = null;
  58    
  59      /**
  60       * @return boolean
  61       */
  62      function getAcceptOnMatch()
  63      {
  64          return $this->acceptOnMatch;
  65      }
  66      
  67      /**
  68       * @param mixed $acceptOnMatch a boolean or a string ('true' or 'false')
  69       */
  70      function setAcceptOnMatch($acceptOnMatch)
  71      {
  72          $this->acceptOnMatch = is_bool($acceptOnMatch) ? 
  73              $acceptOnMatch : 
  74              (bool)(strtolower($acceptOnMatch) == 'true');
  75      }
  76      
  77      /**
  78       * @return string
  79       */
  80      function getStringToMatch()
  81      {
  82          return $this->stringToMatch;
  83      }
  84      
  85      /**
  86       * @param string $s the string to match
  87       */
  88      function setStringToMatch($s)
  89      {
  90          $this->stringToMatch = $s;
  91      }
  92  
  93      /**
  94       * @return integer a {@link LOGGER_FILTER_NEUTRAL} is there is no string match.
  95       */
  96      function decide($event)
  97      {
  98          $msg = $event->getRenderedMessage();
  99          
 100          if($msg === null or  $this->stringToMatch === null)
 101              return LOG4PHP_LOGGER_FILTER_NEUTRAL;
 102          if( strpos($msg, $this->stringToMatch) !== false ) {
 103              return ($this->acceptOnMatch) ? LOG4PHP_LOGGER_FILTER_ACCEPT : LOG4PHP_LOGGER_FILTER_DENY ; 
 104          }
 105          return LOG4PHP_LOGGER_FILTER_NEUTRAL;        
 106      }
 107  }
 108  ?>