From: Chuck Hagenbuch Date: Mon, 19 Jul 2010 01:34:30 +0000 (-0400) Subject: Shorten the filter interface name; nice for type hints and docs. X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=e44892e41fb4939d61c082a778d1faf6c6302561;p=horde.git Shorten the filter interface name; nice for type hints and docs. --- diff --git a/framework/Log/lib/Horde/Log/Filter.php b/framework/Log/lib/Horde/Log/Filter.php new file mode 100644 index 000000000..f795d0685 --- /dev/null +++ b/framework/Log/lib/Horde/Log/Filter.php @@ -0,0 +1,34 @@ + + * @author Chuck Hagenbuch + * @license http://opensource.org/licenses/bsd-license.php BSD + */ + +/** + * @category Horde + * @package Horde_Log + * @subpackage Filters + * @author Mike Naberezny + * @author Chuck Hagenbuch + * @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); +} diff --git a/framework/Log/lib/Horde/Log/Filter/Constraint.php b/framework/Log/lib/Horde/Log/Filter/Constraint.php index e5100defb..f68ea6ad1 100644 --- a/framework/Log/lib/Horde/Log/Filter/Constraint.php +++ b/framework/Log/lib/Horde/Log/Filter/Constraint.php @@ -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 index 48120cb9b..000000000 --- a/framework/Log/lib/Horde/Log/Filter/Interface.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @author Chuck Hagenbuch - * @license http://opensource.org/licenses/bsd-license.php BSD - */ - -/** - * @category Horde - * @package Horde_Log - * @subpackage Filters - * @author Mike Naberezny - * @author Chuck Hagenbuch - * @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); - -} diff --git a/framework/Log/lib/Horde/Log/Filter/Level.php b/framework/Log/lib/Horde/Log/Filter/Level.php index c7f04adf9..51abf4cf6 100644 --- a/framework/Log/lib/Horde/Log/Filter/Level.php +++ b/framework/Log/lib/Horde/Log/Filter/Level.php @@ -20,7 +20,7 @@ * @author Chuck Hagenbuch * @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; } - } diff --git a/framework/Log/lib/Horde/Log/Filter/Message.php b/framework/Log/lib/Horde/Log/Filter/Message.php index 74b6d0b05..0dddffbd7 100644 --- a/framework/Log/lib/Horde/Log/Filter/Message.php +++ b/framework/Log/lib/Horde/Log/Filter/Message.php @@ -22,7 +22,7 @@ * @author Chuck Hagenbuch * @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; } - } diff --git a/framework/Log/lib/Horde/Log/Filter/Suppress.php b/framework/Log/lib/Horde/Log/Filter/Suppress.php index ed430fdfd..02f35008d 100644 --- a/framework/Log/lib/Horde/Log/Filter/Suppress.php +++ b/framework/Log/lib/Horde/Log/Filter/Suppress.php @@ -22,7 +22,7 @@ * @author Chuck Hagenbuch * @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; } - } diff --git a/framework/Log/lib/Horde/Log/Handler/Base.php b/framework/Log/lib/Horde/Log/Handler/Base.php index 8279b0320..2bba7ea61 100644 --- a/framework/Log/lib/Horde/Log/Handler/Base.php +++ b/framework/Log/lib/Horde/Log/Handler/Base.php @@ -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); - } diff --git a/framework/Log/lib/Horde/Log/Logger.php b/framework/Log/lib/Horde/Log/Logger.php index ab644e724..15a56bd28 100644 --- a/framework/Log/lib/Horde/Log/Logger.php +++ b/framework/Log/lib/Horde/Log/Logger.php @@ -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) diff --git a/framework/Log/package.xml b/framework/Log/package.xml index 62d141aa6..3c807f909 100644 --- a/framework/Log/package.xml +++ b/framework/Log/package.xml @@ -40,7 +40,6 @@ http://pear.php.net/dtd/package-2.0.xsd"> - @@ -60,6 +59,7 @@ http://pear.php.net/dtd/package-2.0.xsd"> + @@ -92,10 +92,10 @@ http://pear.php.net/dtd/package-2.0.xsd"> - +