Improved coding standards:
authorIvan Habunek <ihabunek@apache.org>
Tue, 29 May 2012 08:43:19 +0000 (08:43 +0000)
committerIvan Habunek <ihabunek@apache.org>
Tue, 29 May 2012 08:43:19 +0000 (08:43 +0000)
* Removed closing tag (?>) from end of file - insures no spaces are output
* Replaced single-letter variable names with more understandable ones.
* Removed unused variables

git-svn-id: https://svn.apache.org/repos/asf/logging/log4php/trunk@1343601 13f79535-47bb-0310-9956-ffa450edef68

19 files changed:
src/main/php/Logger.php
src/main/php/LoggerAppender.php
src/main/php/LoggerConfigurable.php
src/main/php/appenders/LoggerAppenderConsole.php
src/main/php/appenders/LoggerAppenderMailEvent.php
src/main/php/appenders/LoggerAppenderMongoDB.php
src/main/php/appenders/LoggerAppenderNull.php
src/main/php/appenders/LoggerAppenderPDO.php
src/main/php/configurators/LoggerConfigurationAdapter.php
src/main/php/configurators/LoggerConfigurationAdapterINI.php
src/main/php/configurators/LoggerConfigurationAdapterPHP.php
src/main/php/configurators/LoggerConfigurationAdapterXML.php
src/main/php/configurators/LoggerConfiguratorDefault.php
src/main/php/helpers/LoggerOptionConverter.php
src/main/php/renderers/LoggerRenderer.php
src/main/php/renderers/LoggerRendererDefault.php
src/main/php/renderers/LoggerRendererException.php
src/main/php/renderers/LoggerRendererMap.php
src/main/php/renderers/LoggerRendererObject.php

index efd6982..151c67e 100644 (file)
@@ -569,5 +569,4 @@ class Logger {
        private static function isInitialized() {
                return self::$initialized;
        }
-       
 }
index 5fa41d6..ea0fa13 100644 (file)
@@ -148,12 +148,12 @@ abstract class LoggerAppender extends LoggerConfigurable {
                        return;
                }
 
-               $f = $this->getFirstFilter();
-               while($f !== null) {
-                       switch ($f->decide($event)) {
+               $filter = $this->getFirstFilter();
+               while($filter !== null) {
+                       switch ($filter->decide($event)) {
                                case LoggerFilter::DENY: return;
                                case LoggerFilter::ACCEPT: return $this->append($event);
-                               case LoggerFilter::NEUTRAL: $f = $f->getNext();
+                               case LoggerFilter::NEUTRAL: $filter = $filter->getNext();
                        }
                }
                $this->append($event);
index 7f54e6f..af6ffa5 100644 (file)
@@ -113,7 +113,3 @@ abstract class LoggerConfigurable {
                trigger_error("log4php: $class: $message", E_USER_WARNING);\r
        }\r
 }\r
-\r
-\r
-\r
-?>
\ No newline at end of file
index cb938d6..dd8bfd2 100644 (file)
         * @param string $target
         */
        public function setTarget($target) {
-               $v = trim($target);
-               if ($v == self::STDOUT || strtoupper($v) == 'STDOUT') {
+               $value = trim($target);
+               if ($value == self::STDOUT || strtoupper($value) == 'STDOUT') {
                        $this->target = self::STDOUT;
-               } elseif ($v == self::STDERR || strtoupper($v) == 'STDERR') {
+               } elseif ($value == self::STDERR || strtoupper($value) == 'STDERR') {
                        $this->target = self::STDERR;
                } else {
                        $target = var_export($target);
index 61df9f6..f50adf8 100644 (file)
@@ -177,7 +177,4 @@ class LoggerAppenderMailEvent extends LoggerAppender {
        public function setDry($dry) {
                $this->setBoolean('dry', $dry);
        }
-
-       
-
 }
index c1aa2a6..17a3329 100644 (file)
@@ -314,4 +314,3 @@ class LoggerAppenderMongoDB extends LoggerAppender {
                return $this->collection;
        }
 }
-?>
\ No newline at end of file
index 415a213..c1c914d 100644 (file)
@@ -42,4 +42,3 @@ class LoggerAppenderNull extends LoggerAppender {
        public function append(LoggerLoggingEvent $event) {
        }
 }
-
index 6905a12..9c9ab06 100644 (file)
@@ -283,4 +283,3 @@ class LoggerAppenderPDO extends LoggerAppender {
                return $this->setString('dsn', $dsn);
        }       
 }
-
index 7f0725c..aaeadf8 100644 (file)
@@ -297,4 +297,3 @@ class LoggerConfigurationAdapterINI implements LoggerConfigurationAdapter {
        \r
 }\r
 \r
-?>
\ No newline at end of file
index 91f5fc9..3320409 100644 (file)
@@ -82,4 +82,3 @@ class LoggerConfigurationAdapterPHP implements LoggerConfigurationAdapter
        }\r
 }\r
 \r
-?>
\ No newline at end of file
index 980692c..a6a90a0 100644 (file)
@@ -255,4 +255,3 @@ class LoggerConfigurationAdapterXML implements LoggerConfigurationAdapter
        }\r
 }\r
 \r
-?>
\ No newline at end of file
index 495b356..cea88a8 100644 (file)
@@ -435,7 +435,6 @@ class LoggerConfiguratorDefault implements LoggerConfigurator
                        if (isset($level)) {\r
                                $logger->setLevel($level);\r
                        } else {\r
-                               $default = $logger->getLevel();\r
                                $this->warn("Invalid level value [{$config['level']}] specified for logger [$loggerName]. Ignoring level definition.");\r
                        }\r
                }\r
@@ -501,4 +500,4 @@ class LoggerConfiguratorDefault implements LoggerConfigurator
        private function warn($message) {\r
                trigger_error("log4php: $message", E_USER_WARNING);\r
        }\r
-}
\ No newline at end of file
+}\r
index ddd90dd..00279e5 100644 (file)
@@ -248,20 +248,20 @@ class LoggerOptionConverter {
                        return $default;
                }
 
-               $s = strtoupper(trim($value));
+               $string = strtoupper(trim($value));
                $multiplier = (float)1;
-               if(($index = strpos($s, 'KB')) !== false) {
+               if(($index = strpos($string, 'KB')) !== false) {
                        $multiplier = 1024;
-                       $s = substr($s, 0, $index);
-               } else if(($index = strpos($s, 'MB')) !== false) {
+                       $string = substr($string, 0, $index);
+               } else if(($index = strpos($string, 'MB')) !== false) {
                        $multiplier = 1024 * 1024;
-                       $s = substr($s, 0, $index);
-               } else if(($index = strpos($s, 'GB')) !== false) {
+                       $string = substr($string, 0, $index);
+               } else if(($index = strpos($string, 'GB')) !== false) {
                        $multiplier = 1024 * 1024 * 1024;
-                       $s = substr($s, 0, $index);
+                       $string = substr($string, 0, $index);
                }
-               if(is_numeric($s)) {
-                       return (float)$s * $multiplier;
+               if(is_numeric($string)) {
+                       return (float)$string * $multiplier;
                } 
                return $default;
        }
index fd16eb2..816d1f8 100644 (file)
@@ -39,8 +39,8 @@
 interface LoggerRenderer {
        /**
         * Render the entity passed as parameter as a String.
-        * @param mixed $o entity to render
+        * @param mixed $input entity to render
         * @return string
         */
-       public function render($o);
+       public function render($input);
 }
index 1982cd1..b5f409a 100644 (file)
@@ -42,10 +42,10 @@ class LoggerRendererDefault implements LoggerRenderer {
        /**
         * Render objects by type casting
         *
-        * @param mixed $o the object to render
+        * @param mixed $input the object to render
         * @return string
         */
-       public function render($o) {
-               return var_export($o, true);
+       public function render($input) {
+               return var_export($input, true);
        }
 }
index 147e8cd..4040035 100644 (file)
  */
 class LoggerRendererException implements LoggerRenderer {
 
-       public function render($o) {
-               $strRep  = 'Throwable('.get_class($o).'): '.$o->getMessage().' in '.$o->getFile().' on line '.$o->getLine();
-               $strRep .= PHP_EOL.$o->getTraceAsString();
+       public function render($input) {
+               $strRep  = 'Throwable('.get_class($input).'): '.$input->getMessage().' in '.$input->getFile().' on line '.$input->getLine();
+               $strRep .= PHP_EOL.$input->getTraceAsString();
                
-               if (method_exists($o, 'getPrevious') && $o->getPrevious() !== null) {
-                       $strRep .= PHP_EOL.'Caused by: '.$this->render($o->getPrevious());
+               if (method_exists($input, 'getPrevious') && $input->getPrevious() !== null) {
+                       $strRep .= PHP_EOL.'Caused by: '.$this->render($input->getPrevious());
                }
                
                return $strRep;         
        }
 }
-?>
\ No newline at end of file
index 8fff083..d02eed2 100644 (file)
@@ -47,7 +47,6 @@ class LoggerRendererMap {
        private $defaultRenderer;
        
        /**
-        * 
         * @var LoggerRendererObject
         */
        private $defaultObjectRenderer;
@@ -88,23 +87,23 @@ class LoggerRendererMap {
         * Once a renderer is found, it is applied on the object <var>o</var> and 
         * the result is returned as a string.
         *
-        * @param mixed $o
+        * @param mixed $input
         * @return string 
         */
-       public function findAndRender($o) {
-               if($o == null) {
+       public function findAndRender($input) {
+               if($input == null) {
                        return null;
                } else {
-                       if(is_object($o)) {
-                               $renderer = $this->getByObject($o);
+                       if(is_object($input)) {
+                               $renderer = $this->getByObject($input);
                                if($renderer !== null) {
-                                       return $renderer->render($o);
+                                       return $renderer->render($input);
                                }
 
-                               return $this->defaultObjectRenderer->render($o);
+                               return $this->defaultObjectRenderer->render($input);
                        } else {
                                $renderer = $this->defaultRenderer;
-                               return $renderer->render($o);
+                               return $renderer->render($input);
                        }
                }
        }
@@ -113,11 +112,11 @@ class LoggerRendererMap {
         * Syntactic sugar method that calls {@link PHP_MANUAL#get_class} with the
         * class of the object parameter.
         * 
-        * @param mixed $o
+        * @param mixed $object
         * @return string
         */
-       public function getByObject($o) {
-               return ($o == null) ? null : $this->getByClassName(get_class($o));
+       public function getByObject($object) {
+               return ($object == null) ? null : $this->getByClassName(get_class($object));
        }
 
 
@@ -131,10 +130,10 @@ class LoggerRendererMap {
         * @return LoggerRendererObject
         */
        public function getByClassName($class) {
-               for($c = $class; !empty($c); $c = get_parent_class($c)) {
-                       $c = strtolower($c);
-                       if(isset($this->map[$c])) {
-                               return $this->map[$c];
+               for(; !empty($class); $class = get_parent_class($class)) {
+                       $class = strtolower($class);
+                       if(isset($this->map[$class])) {
+                               return $this->map[$class];
                        }
                }
                return null;
@@ -145,12 +144,12 @@ class LoggerRendererMap {
        }
 
        /**
-        * Register a {@link LoggerRendererObject} for <var>clazz</var>.
-        * @param string $class
-        * @param LoggerRendererObject $or
+        * Register a {@link LoggerRendererObject}.
+        * @param string $class Class which to render.
+        * @param LoggerRendererObject $renderer
         */
-       private function put($class, $or) {
-               $this->map[strtolower($class)] = $or;
+       private function put($class, $renderer) {
+               $this->map[strtolower($class)] = $renderer;
        }
        
        public function setDefaultObjectRenderer($renderer) {
index 08dbc6a..0ad21d3 100644 (file)
@@ -33,5 +33,3 @@ class LoggerRendererObject implements LoggerRenderer {
                return print_r($o, true);\r
        }\r
 }\r
-\r
-?>
\ No newline at end of file