From c8ef75ceba334d701a223ecddc4d6a90b29f1fd0 Mon Sep 17 00:00:00 2001
From: Chuck Hagenbuch <chuck@horde.org>
Date: Sun, 18 Jul 2010 21:40:14 -0400
Subject: [PATCH] Use named constants (Horde_Log_Filter::ACCEPT,
 Horde_Log_Filter::IGNORE) for clarity in filters.

---
 framework/Log/lib/Horde/Log/Filter.php            | 13 ++++++++++++-
 framework/Log/lib/Horde/Log/Filter/Constraint.php |  7 ++++---
 framework/Log/lib/Horde/Log/Filter/Level.php      |  3 ++-
 framework/Log/lib/Horde/Log/Filter/Message.php    |  3 ++-
 framework/Log/lib/Horde/Log/Filter/Suppress.php   |  5 +++--
 5 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/framework/Log/lib/Horde/Log/Filter.php b/framework/Log/lib/Horde/Log/Filter.php
index f795d0685..8a0b297d7 100644
--- a/framework/Log/lib/Horde/Log/Filter.php
+++ b/framework/Log/lib/Horde/Log/Filter.php
@@ -25,7 +25,18 @@
 interface Horde_Log_Filter
 {
     /**
-     * Returns TRUE to accept the message, FALSE to block it.
+     * Accept a message
+     */
+    const ACCEPT = true;
+
+    /**
+     * Filter out a message
+     */
+    const IGNORE = false;
+
+    /**
+     * Returns Horde_Log_Filter::ACCEPT to accept the message,
+     * Horde_Log_Filter::IGNORE to ignore it.
      *
      * @param  array    $event    Log event
      * @return boolean            accepted?
diff --git a/framework/Log/lib/Horde/Log/Filter/Constraint.php b/framework/Log/lib/Horde/Log/Filter/Constraint.php
index f68ea6ad1..d7e42b8f5 100644
--- a/framework/Log/lib/Horde/Log/Filter/Constraint.php
+++ b/framework/Log/lib/Horde/Log/Filter/Constraint.php
@@ -109,7 +109,8 @@ class Horde_Log_Filter_Constraint implements Horde_Log_Filter
     }
 
     /**
-     * Returns TRUE to accept the message, FALSE to block it.
+     * Returns Horde_Log_Filter::ACCEPT to accept the message,
+     * Horde_Log_Filter::IGNORE to ignore it.
      *
      * @param  array    $event    Log event
      * @return boolean            accepted?
@@ -119,9 +120,9 @@ class Horde_Log_Filter_Constraint implements Horde_Log_Filter
         foreach ($this->_constraints as $field => $constraint) {
             $value = isset($event[$field]) ? $event[$field] : null;
             if (!$constraint->evaluate($value)) {
-                return false;
+                return Horde_Log_Filter::IGNORE;
             }
         }
-        return true;
+        return Horde_Log_Filter::ACCEPT;
     }
 }
diff --git a/framework/Log/lib/Horde/Log/Filter/Level.php b/framework/Log/lib/Horde/Log/Filter/Level.php
index 51abf4cf6..4a7a248e4 100644
--- a/framework/Log/lib/Horde/Log/Filter/Level.php
+++ b/framework/Log/lib/Horde/Log/Filter/Level.php
@@ -42,7 +42,8 @@ class Horde_Log_Filter_Level implements Horde_Log_Filter
     }
 
     /**
-     * Returns TRUE to accept the message, FALSE to block it.
+     * Returns Horde_Log_Filter::ACCEPT to accept the message,
+     * Horde_Log_Filter::IGNORE to ignore it.
      *
      * @param  array    $event    Log event
      * @return boolean            accepted?
diff --git a/framework/Log/lib/Horde/Log/Filter/Message.php b/framework/Log/lib/Horde/Log/Filter/Message.php
index 0dddffbd7..e0da1ee4c 100644
--- a/framework/Log/lib/Horde/Log/Filter/Message.php
+++ b/framework/Log/lib/Horde/Log/Filter/Message.php
@@ -44,7 +44,8 @@ class Horde_Log_Filter_Message implements Horde_Log_Filter
     }
 
     /**
-     * Returns TRUE to accept the message, FALSE to block it.
+     * Returns Horde_Log_Filter::ACCEPT to accept the message,
+     * Horde_Log_Filter::IGNORE to ignore it.
      *
      * @param  array    $event    Log event
      * @return boolean            accepted?
diff --git a/framework/Log/lib/Horde/Log/Filter/Suppress.php b/framework/Log/lib/Horde/Log/Filter/Suppress.php
index 02f35008d..2b3f9cba9 100644
--- a/framework/Log/lib/Horde/Log/Filter/Suppress.php
+++ b/framework/Log/lib/Horde/Log/Filter/Suppress.php
@@ -27,7 +27,7 @@ class Horde_Log_Filter_Suppress implements Horde_Log_Filter
     /**
      * @var boolean
      */
-    protected $_accept = true;
+    protected $_accept = Horde_Log_Filter::ACCEPT;
 
     /**
      * This is a simple boolean filter.
@@ -44,7 +44,8 @@ class Horde_Log_Filter_Suppress implements Horde_Log_Filter
     }
 
     /**
-     * Returns TRUE to accept the message, FALSE to block it.
+     * Returns Horde_Log_Filter::ACCEPT to accept the message,
+     * Horde_Log_Filter::IGNORE to ignore it.
      *
      * @param  array    $event    event data
      * @return boolean            accepted?
-- 
2.11.0