From 83372c506e46dc967699f51c1fb6ebff9ab5b881 Mon Sep 17 00:00:00 2001 From: Chuck Hagenbuch Date: Sun, 18 Jul 2010 21:28:03 -0400 Subject: [PATCH] Shorten the formatter interface name; nicer for type hints and docs. --- .../lib/Horde/Log/{Formatter/Interface.php => Formatter.php} | 3 +-- framework/Log/lib/Horde/Log/Formatter/Simple.php | 2 +- framework/Log/lib/Horde/Log/Formatter/Xml.php | 2 +- framework/Log/lib/Horde/Log/Handler/Firebug.php | 6 +++--- framework/Log/lib/Horde/Log/Handler/Scribe.php | 8 ++++---- framework/Log/lib/Horde/Log/Handler/Stream.php | 12 +++++------- framework/Log/package.xml | 4 ++-- 7 files changed, 17 insertions(+), 20 deletions(-) rename framework/Log/lib/Horde/Log/{Formatter/Interface.php => Formatter.php} (95%) diff --git a/framework/Log/lib/Horde/Log/Formatter/Interface.php b/framework/Log/lib/Horde/Log/Formatter.php similarity index 95% rename from framework/Log/lib/Horde/Log/Formatter/Interface.php rename to framework/Log/lib/Horde/Log/Formatter.php index 0975abcb7..1d97ae7e1 100644 --- a/framework/Log/lib/Horde/Log/Formatter/Interface.php +++ b/framework/Log/lib/Horde/Log/Formatter.php @@ -18,7 +18,7 @@ * @author Chuck Hagenbuch * @license http://opensource.org/licenses/bsd-license.php BSD */ -interface Horde_Log_Formatter_Interface +interface Horde_Log_Formatter { /** * Formats an event to be written by the handler. @@ -27,5 +27,4 @@ interface Horde_Log_Formatter_Interface * @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 * @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 * @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"> - @@ -61,6 +60,7 @@ http://pear.php.net/dtd/package-2.0.xsd"> + @@ -96,9 +96,9 @@ http://pear.php.net/dtd/package-2.0.xsd"> - + -- 2.11.0