Shorten the filter interface name; nice for type hints and docs.
authorChuck Hagenbuch <chuck@horde.org>
Mon, 19 Jul 2010 01:34:30 +0000 (21:34 -0400)
committerChuck Hagenbuch <chuck@horde.org>
Mon, 19 Jul 2010 01:34:30 +0000 (21:34 -0400)
framework/Log/lib/Horde/Log/Filter.php [new file with mode: 0644]
framework/Log/lib/Horde/Log/Filter/Constraint.php
framework/Log/lib/Horde/Log/Filter/Interface.php [deleted file]
framework/Log/lib/Horde/Log/Filter/Level.php
framework/Log/lib/Horde/Log/Filter/Message.php
framework/Log/lib/Horde/Log/Filter/Suppress.php
framework/Log/lib/Horde/Log/Handler/Base.php
framework/Log/lib/Horde/Log/Logger.php
framework/Log/package.xml

diff --git a/framework/Log/lib/Horde/Log/Filter.php b/framework/Log/lib/Horde/Log/Filter.php
new file mode 100644 (file)
index 0000000..f795d06
--- /dev/null
@@ -0,0 +1,34 @@
+<?php
+/**
+ * Horde Log package
+ *
+ * This package is based on Zend_Log from the Zend Framework
+ * (http://framework.zend.com).  Both that package and this
+ * one were written by Mike Naberezny and Chuck Hagenbuch.
+ *
+ * @category Horde
+ * @package  Horde_Log
+ * @subpackage Filters
+ * @author   Mike Naberezny <mike@maintainable.com>
+ * @author   Chuck Hagenbuch <chuck@horde.org>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ */
+
+/**
+ * @category Horde
+ * @package  Horde_Log
+ * @subpackage Filters
+ * @author   Mike Naberezny <mike@maintainable.com>
+ * @author   Chuck Hagenbuch <chuck@horde.org>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ */
+interface Horde_Log_Filter
+{
+    /**
+     * Returns TRUE to accept the message, FALSE to block it.
+     *
+     * @param  array    $event    Log event
+     * @return boolean            accepted?
+     */
+    public function accept($event);
+}
index e5100de..f68ea6a 100644 (file)
@@ -20,7 +20,7 @@
  * @todo Implement constraint objects for the different types of filtering ie
  * regex,required,type..etc..  so we can add different constaints ad infinitum.
  */
-class Horde_Log_Filter_Constraint implements Horde_Log_Filter_Interface
+class Horde_Log_Filter_Constraint implements Horde_Log_Filter
 {
     /**
      * @var array
diff --git a/framework/Log/lib/Horde/Log/Filter/Interface.php b/framework/Log/lib/Horde/Log/Filter/Interface.php
deleted file mode 100644 (file)
index 48120cb..0000000
+++ /dev/null
@@ -1,35 +0,0 @@
-<?php
-/**
- * Horde Log package
- *
- * This package is based on Zend_Log from the Zend Framework
- * (http://framework.zend.com).  Both that package and this
- * one were written by Mike Naberezny and Chuck Hagenbuch.
- *
- * @category Horde
- * @package  Horde_Log
- * @subpackage Filters
- * @author   Mike Naberezny <mike@maintainable.com>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @license  http://opensource.org/licenses/bsd-license.php BSD
- */
-
-/**
- * @category Horde
- * @package  Horde_Log
- * @subpackage Filters
- * @author   Mike Naberezny <mike@maintainable.com>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @license  http://opensource.org/licenses/bsd-license.php BSD
- */
-interface Horde_Log_Filter_Interface
-{
-    /**
-     * Returns TRUE to accept the message, FALSE to block it.
-     *
-     * @param  array    $event    Log event
-     * @return boolean            accepted?
-     */
-    public function accept($event);
-
-}
index c7f04ad..51abf4c 100644 (file)
@@ -20,7 +20,7 @@
  * @author   Chuck Hagenbuch <chuck@horde.org>
  * @license  http://opensource.org/licenses/bsd-license.php BSD
  */
-class Horde_Log_Filter_Level implements Horde_Log_Filter_Interface
+class Horde_Log_Filter_Level implements Horde_Log_Filter
 {
     /**
      * @var integer
@@ -51,5 +51,4 @@ class Horde_Log_Filter_Level implements Horde_Log_Filter_Interface
     {
         return $event['level'] <= $this->_level;
     }
-
 }
index 74b6d0b..0dddffb 100644 (file)
@@ -22,7 +22,7 @@
  * @author   Chuck Hagenbuch <chuck@horde.org>
  * @license  http://opensource.org/licenses/bsd-license.php BSD
  */
-class Horde_Log_Filter_Message implements Horde_Log_Filter_Interface
+class Horde_Log_Filter_Message implements Horde_Log_Filter
 {
     /**
      * @var string
@@ -53,5 +53,4 @@ class Horde_Log_Filter_Message implements Horde_Log_Filter_Interface
     {
         return preg_match($this->_regexp, $event['message']) > 0;
     }
-
 }
index ed430fd..02f3500 100644 (file)
@@ -22,7 +22,7 @@
  * @author   Chuck Hagenbuch <chuck@horde.org>
  * @license  http://opensource.org/licenses/bsd-license.php BSD
  */
-class Horde_Log_Filter_Suppress implements Horde_Log_Filter_Interface
+class Horde_Log_Filter_Suppress implements Horde_Log_Filter
 {
     /**
      * @var boolean
@@ -53,5 +53,4 @@ class Horde_Log_Filter_Suppress implements Horde_Log_Filter_Interface
     {
         return $this->_accept;
     }
-
 }
index 8279b03..2bba7ea 100644 (file)
@@ -30,14 +30,14 @@ abstract class Horde_Log_Handler_Base
     protected $_options = array();
 
     /**
-     * @var array of Horde_Log_Filter_Interface
+     * @var array of Horde_Log_Filter
      */
     protected $_filters = array();
 
     /**
      * Add a filter specific to this handler.
      *
-     * @param  Horde_Log_Filter_Interface  $filter
+     * @param  Horde_Log_Filter $filter
      * @return void
      */
     public function addFilter($filter)
@@ -91,5 +91,4 @@ abstract class Horde_Log_Handler_Base
      * @param  array    $event    Log event
      */
     abstract public function write($event);
-
 }
index ab644e7..15a56bd 100644 (file)
@@ -39,19 +39,19 @@ class Horde_Log_Logger
     private $_levels = array();
 
     /**
-     * @var array of Horde_Log_Handler_Abstract objects
+     * @var array of Horde_Log_Handler_Base objects
      */
     private $_handlers = array();
 
     /**
-     * @var array of Horde_Log_Filter_Interface objects
+     * @var array of Horde_Log_Filter objects
      */
     private $_filters = array();
 
     /**
      * Class constructor.  Create a new logger
      *
-     * @param Horde_Log_Handler_Abstract|null  $handler  default handler
+     * @param Horde_Log_Handler_Base|null  $handler  default handler
      */
     public function __construct($handler = null)
     {
@@ -174,7 +174,7 @@ class Horde_Log_Logger
      * Before a message will be received by any of the handlers, it
      * must be accepted by all filters added with this method.
      *
-     * @param  Horde_Log_Filter_Interface  $filter
+     * @param  Horde_Log_Filter  $filter
      * @return void
      */
     public function addFilter($filter)
@@ -190,7 +190,7 @@ class Horde_Log_Logger
      * Add a handler.  A handler is responsible for taking a log
      * message and writing it out to storage.
      *
-     * @param  Horde_Log_Handler_Abstract $handler
+     * @param  Horde_Log_Handler_Base $handler
      * @return void
      */
     public function addHandler($handler)
index 62d141a..3c807f9 100644 (file)
@@ -40,7 +40,6 @@ http://pear.php.net/dtd/package-2.0.xsd">
      <dir name="Log">
       <dir name="Filter">
        <file name="Constraint.php" role="php" />
-       <file name="Interface.php" role="php" />
        <file name="Level.php" role="php" />
        <file name="Message.php" role="php" />
        <file name="Suppress.php" role="php" />
@@ -60,6 +59,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
        <file name="Syslog.php" role="php" />
       </dir> <!-- /lib/Horde/Log/Handler -->
       <file name="Exception.php" role="php" />
+      <file name="Filter.php" role="php" />
       <file name="Formatter.php" role="php" />
       <file name="Logger.php" role="php" />
      </dir> <!-- /lib/Horde/Log -->
@@ -92,10 +92,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
   <filelist>
    <install name="lib/Horde/Log/Exception.php" as="Horde/Log/Exception.php" />
    <install name="lib/Horde/Log/Filter/Constraint.php" as="Horde/Log/Filter/Constraint.php" />
-   <install name="lib/Horde/Log/Filter/Interface.php" as="Horde/Log/Filter/Interface.php" />
    <install name="lib/Horde/Log/Filter/Level.php" as="Horde/Log/Filter/Level.php" />
    <install name="lib/Horde/Log/Filter/Message.php" as="Horde/Log/Filter/Message.php" />
    <install name="lib/Horde/Log/Filter/Suppress.php" as="Horde/Log/Filter/Suppress.php" />
+   <install name="lib/Horde/Log/Filter.php" as="Horde/Log/Filter.php" />
    <install name="lib/Horde/Log/Formatter/Simple.php" as="Horde/Log/Formatter/Simple.php" />
    <install name="lib/Horde/Log/Formatter/Xml.php" as="Horde/Log/Formatter/Xml.php" />
    <install name="lib/Horde/Log/Formatter.php" as="Horde/Log/Formatter.php" />