From: Chuck Hagenbuch <chuck@horde.org>
Date: Mon, 19 Jul 2010 01:28:03 +0000 (-0400)
Subject: Shorten the formatter interface name; nicer for type hints and docs.
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=83372c506e46dc967699f51c1fb6ebff9ab5b881;p=horde.git

Shorten the formatter interface name; nicer for type hints and docs.
---

diff --git a/framework/Log/lib/Horde/Log/Formatter.php b/framework/Log/lib/Horde/Log/Formatter.php
new file mode 100644
index 000000000..1d97ae7e1
--- /dev/null
+++ b/framework/Log/lib/Horde/Log/Formatter.php
@@ -0,0 +1,30 @@
+<?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.
+ *
+ * @package  Horde_Log
+ * @author   Mike Naberezny <mike@maintainable.com>
+ * @author   Chuck Hagenbuch <chuck@horde.org>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ */
+
+/**
+ * @package  Horde_Log
+ * @author   Mike Naberezny <mike@maintainable.com>
+ * @author   Chuck Hagenbuch <chuck@horde.org>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ */
+interface Horde_Log_Formatter
+{
+    /**
+     * Formats an event to be written by the handler.
+     *
+     * @param  array    $event    Log event
+     * @return string             formatted line
+     */
+    public function format($event);
+}
diff --git a/framework/Log/lib/Horde/Log/Formatter/Interface.php b/framework/Log/lib/Horde/Log/Formatter/Interface.php
deleted file mode 100644
index 0975abcb7..000000000
--- a/framework/Log/lib/Horde/Log/Formatter/Interface.php
+++ /dev/null
@@ -1,31 +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.
- *
- * @package  Horde_Log
- * @author   Mike Naberezny <mike@maintainable.com>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @license  http://opensource.org/licenses/bsd-license.php BSD
- */
-
-/**
- * @package  Horde_Log
- * @author   Mike Naberezny <mike@maintainable.com>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @license  http://opensource.org/licenses/bsd-license.php BSD
- */
-interface Horde_Log_Formatter_Interface
-{
-    /**
-     * Formats an event to be written by the handler.
-     *
-     * @param  array    $event    Log event
-     * @return string             formatted line
-     */
-    public function format($event);
-
-}
diff --git a/framework/Log/lib/Horde/Log/Formatter/Simple.php b/framework/Log/lib/Horde/Log/Formatter/Simple.php
index 8b1963573..1fc3a3d3b 100644
--- a/framework/Log/lib/Horde/Log/Formatter/Simple.php
+++ b/framework/Log/lib/Horde/Log/Formatter/Simple.php
@@ -22,7 +22,7 @@
  * @author   Chuck Hagenbuch <chuck@horde.org>
  * @license  http://opensource.org/licenses/bsd-license.php BSD
  */
-class Horde_Log_Formatter_Simple implements Horde_Log_Formatter_Interface
+class Horde_Log_Formatter_Simple implements Horde_Log_Formatter
 {
     /**
      * Format string
diff --git a/framework/Log/lib/Horde/Log/Formatter/Xml.php b/framework/Log/lib/Horde/Log/Formatter/Xml.php
index b3ad9a311..e50c3e992 100644
--- a/framework/Log/lib/Horde/Log/Formatter/Xml.php
+++ b/framework/Log/lib/Horde/Log/Formatter/Xml.php
@@ -22,7 +22,7 @@
  * @author   Chuck Hagenbuch <chuck@horde.org>
  * @license  http://opensource.org/licenses/bsd-license.php BSD
  */
-class Horde_Log_Formatter_Xml implements Horde_Log_Formatter_Interface
+class Horde_Log_Formatter_Xml implements Horde_Log_Formatter
 {
     protected $_options = array('elementEntry'     => 'log',
                                 'elementTimestamp' => 'timestamp',
diff --git a/framework/Log/lib/Horde/Log/Handler/Firebug.php b/framework/Log/lib/Horde/Log/Handler/Firebug.php
index 077d92bc4..67be282d6 100644
--- a/framework/Log/lib/Horde/Log/Handler/Firebug.php
+++ b/framework/Log/lib/Horde/Log/Handler/Firebug.php
@@ -22,7 +22,7 @@ class Horde_Log_Handler_Firebug extends Horde_Log_Handler_Base
 {
     /**
      * Formats the log message before writing.
-     * @var Horde_Log_Formatter_Interface
+     * @var Horde_Log_Formatter
      */
     protected $_formatter;
 
@@ -58,9 +58,9 @@ class Horde_Log_Handler_Firebug extends Horde_Log_Handler_Base
     /**
      * Class Constructor
      *
-     * @param Horde_Log_Formatter_Interface $formatter  Log formatter
+     * @param Horde_Log_Formatter $formatter  Log formatter
      */
-    public function __construct($formatter = null)
+    public function __construct(Horde_Log_Formatter $formatter = null)
     {
         if (is_null($formatter)) {
             $formatter = new Horde_Log_Formatter_Simple();
diff --git a/framework/Log/lib/Horde/Log/Handler/Scribe.php b/framework/Log/lib/Horde/Log/Handler/Scribe.php
index 13e4050e7..a6602c4cb 100644
--- a/framework/Log/lib/Horde/Log/Handler/Scribe.php
+++ b/framework/Log/lib/Horde/Log/Handler/Scribe.php
@@ -28,7 +28,7 @@ class Horde_Log_Handler_Scribe extends Horde_Log_Handler_Base
 
     /**
      * Formats the log message before writing.
-     * @var Horde_Log_Formatter_Interface
+     * @var Horde_Log_Formatter
      */
     protected $_formatter;
 
@@ -44,11 +44,11 @@ class Horde_Log_Handler_Scribe extends Horde_Log_Handler_Base
     /**
      * Class Constructor
      *
-     * @param Horde_Scribe_Client           $scribe     Scribe client
-     * @param Horde_Log_Formatter_Interface $formatter  Log formatter
+     * @param Horde_Scribe_Client  $scribe     Scribe client
+     * @param Horde_Log_Formatter  $formatter  Log formatter
      */
     public function __construct(Horde_Scribe_Client $scribe,
-                                Horde_Log_Formatter_Interface $formatter = null)
+                                Horde_Log_Formatter $formatter = null)
     {
         if (is_null($formatter)) {
             $formatter = new Horde_Log_Formatter_Simple();
diff --git a/framework/Log/lib/Horde/Log/Handler/Stream.php b/framework/Log/lib/Horde/Log/Handler/Stream.php
index dcb4d351b..54fc2a101 100644
--- a/framework/Log/lib/Horde/Log/Handler/Stream.php
+++ b/framework/Log/lib/Horde/Log/Handler/Stream.php
@@ -26,7 +26,7 @@ class Horde_Log_Handler_Stream extends Horde_Log_Handler_Base
 {
     /**
      * Formats the log message before writing.
-     * @var Horde_Log_Formatter_Interface
+     * @var Horde_Log_Formatter
      */
     protected $_formatter;
 
@@ -53,14 +53,12 @@ class Horde_Log_Handler_Stream extends Horde_Log_Handler_Base
     /**
      * Class Constructor
      *
-     * @param mixed $streamOrUrl                        Stream or URL to open
-     *                                                  as a stream.
-     * @param string $mode                              Mode, only applicable
-     *                                                  if a URL is given.
-     * @param Horde_Log_Formatter_Interface $formatter  Log formatter.
+     * @param mixed $streamOrUrl              Stream or URL to open as a stream.
+     * @param string $mode                    Mode, only applicable if a URL is given.
+     * @param Horde_Log_Formatter $formatter  Log formatter.
      */
     public function __construct($streamOrUrl, $mode = 'a+',
-                                Horde_Log_Formatter_Interface $formatter = null)
+                                Horde_Log_Formatter $formatter = null)
     {
         if (is_null($formatter)) {
             $formatter = new Horde_Log_Formatter_Simple();
diff --git a/framework/Log/package.xml b/framework/Log/package.xml
index f36f68df4..62d141aa6 100644
--- a/framework/Log/package.xml
+++ b/framework/Log/package.xml
@@ -46,7 +46,6 @@ http://pear.php.net/dtd/package-2.0.xsd">
        <file name="Suppress.php" role="php" />
       </dir> <!-- /lib/Horde/Log/Filter -->
       <dir name="Formatter">
-       <file name="Interface.php" role="php" />
        <file name="Simple.php" role="php" />
        <file name="Xml.php" role="php" />
       </dir> <!-- /lib/Horde/Log/Formatter -->
@@ -61,6 +60,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="Formatter.php" role="php" />
       <file name="Logger.php" role="php" />
      </dir> <!-- /lib/Horde/Log -->
      <file name="Log.php" role="php" />
@@ -96,9 +96,9 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <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/Formatter/Interface.php" as="Horde/Log/Formatter/Interface.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" />
    <install name="lib/Horde/Log/Handler/Base.php" as="Horde/Log/Handler/Base.php" />
    <install name="lib/Horde/Log/Handler/Db.php" as="Horde/Log/Handler/Db.php" />
    <install name="lib/Horde/Log/Handler/Firebug.php" as="Horde/Log/Handler/Firebug.php" />