Merge branch 'hotfix/log-cs' of https://github.com/b-durand/zf2 into …

…hotfix/log-interfaces
zendframework · Jul 5, 2012 · 44df0b2 · 44df0b2
16 parents 11d6c56 + ecdfdf6 + 38e090d + 7af74e7 + 8b311b1 + e2c2b94 + 51601cb + dcc1eaf + 6f4b805 + a30a64f + ee7347d + 8b04bfe + b487f00 + 0e0780d + eeb7514 + c5d3ce3
commit 44df0b2
Show file tree

Hide file tree

Showing 17 changed files with 84 additions and 210 deletions.
diff --git a/src/Filter.php b/src/Filter.php
diff --git a/src/Filter/Priority.php b/src/Filter/Priority.php
@@ -48,7 +48,7 @@ class Priority implements FilterInterface
      *
      * @param int $priority Priority
      * @param string $operator Comparison operator
-     * @return void
+     * @return Priority
      * @throws Exception\InvalidArgumentException
      */
     public function __construct($priority, $operator = null)

diff --git a/src/Filter/Regex.php b/src/Filter/Regex.php
@@ -19,9 +19,6 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-/**
- * @namespace
- */
 namespace Zend\Log\Filter;
 
 use Zend\Log\Exception;
@@ -46,6 +43,7 @@ class Regex implements FilterInterface
      * Filter out any log messages not matching the pattern
      *
      * @param string $regex Regular expression to test the log message
+     * @return Regex
      * @throws Exception\InvalidArgumentException
      */
     public function __construct($regex)

diff --git a/src/Filter/Validator.php b/src/Filter/Validator.php
@@ -43,7 +43,8 @@ class Validator implements FilterInterface
     /**
      * Filter out any log messages not matching the validator
      *
-     * @param  ZendValidator $validator
+     * @param ZendValidator $validator
+     * @return Validator
      */
     public function __construct(ZendValidator $validator)
     {

diff --git a/src/Formatter.php b/src/Formatter.php
diff --git a/src/Formatter/ErrorHandler.php b/src/Formatter/ErrorHandler.php
@@ -19,9 +19,6 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-/**
- * @namespace
- */
 namespace Zend\Log\Formatter;
 
 use Zend\Log\Exception;
@@ -47,8 +44,9 @@ class ErrorHandler implements FormatterInterface
     /**
      * Class constructor
      *
-     * @param  null|string  $format  Format specifier for log messages
-     * @throws Zend\Log\Exception\InvalidArgumentException
+     * @param null|string $format Format specifier for log messages
+     * @return ErrorHandler
+     * @throws Exception\InvalidArgumentException
      */
     public function __construct($format = null)
     {

diff --git a/src/Formatter/ExceptionHandler.php b/src/Formatter/ExceptionHandler.php
@@ -19,9 +19,6 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-/**
- * @namespace
- */
 namespace Zend\Log\Formatter;
 
 /**
@@ -36,35 +33,39 @@ class ExceptionHandler implements FormatterInterface
     /**
      * This method formats the event for the PHP Exception
      *
-     * @param  array $event
+     * @param array $event
      * @return string
      */
     public function format($event)
     {
-        $output = $event['timestamp'] . ' ' . $event['priorityName'] . ' (' .
-                  $event['priority'] . ') ' . $event['message'] .' in ' .
-                  $event['extra']['file'] . ' on line ' . $event['extra']['line'];
+        $output = $event['timestamp'] . ' ' . $event['priorityName'] . ' ('
+                . $event['priority'] . ') ' . $event['message'] .' in '
+                . $event['extra']['file'] . ' on line ' . $event['extra']['line'];
+
         if (!empty($event['extra']['trace'])) {
             $outputTrace = '';
             foreach ($event['extra']['trace'] as $trace) {
-                $outputTrace .= "File  : {$trace['file']}\n" .
-                                "Line  : {$trace['line']}\n" .
-                                "Func  : {$trace['function']}\n" .
-                                "Class : {$trace['class']}\n" .
-                                "Type  : " . $this->getType($trace['type']) . "\n" .
-                                "Args  : " . print_r($trace['args'], true) . "\n";
+                $outputTrace .= "File  : {$trace['file']}\n"
+                              . "Line  : {$trace['line']}\n"
+                              . "Func  : {$trace['function']}\n"
+                              . "Class : {$trace['class']}\n"
+                              . "Type  : " . $this->getType($trace['type']) . "\n"
+                              . "Args  : " . print_r($trace['args'], true) . "\n";
             }
-            $output.= "\n[Trace]\n" . $outputTrace;
+            $output .= "\n[Trace]\n" . $outputTrace;
         }
+
         return $output;
     }
+
     /**
      * Get the type of a function
      * 
-     * @param  string $type
+     * @param string $type
      * @return string 
      */
-    protected function getType($type) {
+    protected function getType($type)
+    {
         switch ($type) {
             case "::" :
                 return "static";

diff --git a/src/Formatter/FormatterInterface.php b/src/Formatter/FormatterInterface.php
@@ -31,8 +31,8 @@ interface FormatterInterface
     /**
      * Formats data into a single line to be written by the writer.
      *
-     * @param  array    $event    event data
-     * @return string             formatted line to write to the log
+     * @param array $event event data
+     * @return string formatted line to write to the log
      */
     public function format($event);
 }
diff --git a/src/Formatter/Simple.php b/src/Formatter/Simple.php
@@ -35,16 +35,16 @@ class Simple implements FormatterInterface
     /**
      * @var string
      */
-    protected $_format;
+    protected $format;
 
     const DEFAULT_FORMAT = '%timestamp% %priorityName% (%priority%): %message% %info%';
 
     /**
      * Class constructor
      *
-     * @param  null|string  $format  Format specifier for log messages
-     * @return void
-     * @throws \Zend\Log\Exception\InvalidArgumentException
+     * @param null|string $format Format specifier for log messages
+     * @return Simple
+     * @throws Exception\InvalidArgumentException
      */
     public function __construct($format = null)
     {
@@ -56,18 +56,18 @@ public function __construct($format = null)
             throw new Exception\InvalidArgumentException('Format must be a string');
         }
 
-        $this->_format = $format;
+        $this->format = $format;
     }
 
     /**
      * Formats data into a single line to be written by the writer.
      *
-     * @param  array    $event    event data
-     * @return string             formatted line to write to the log
+     * @param array $event event data
+     * @return string formatted line to write to the log
      */
     public function format($event)
     {
-        $output = $this->_format;
+        $output = $this->format;
 
         if (!isset($event['info'])) {
             $event['info'] = '';

diff --git a/src/Formatter/Xml.php b/src/Formatter/Xml.php
@@ -38,23 +38,24 @@ class Xml implements FormatterInterface
     /**
      * @var string Name of root element
      */
-    protected $_rootElement;
+    protected $rootElement;
 
     /**
      * @var array Relates XML elements to log data field keys.
      */
-    protected $_elementMap;
+    protected $elementMap;
 
     /**
      * @var string Encoding to use in XML
      */
-    protected $_encoding;
+    protected $encoding;
 
     /**
      * Class constructor
      * (the default encoding is UTF-8)
      *
-     * @param  array|Traversable $options
+     * @param array|Traversable $options
+     * @return Xml
      */
     public function __construct($options = array())
     {
@@ -86,11 +87,11 @@ public function __construct($options = array())
             $options['encoding'] = 'UTF-8';
         }
 
-        $this->_rootElement = $options['rootElement'];
+        $this->rootElement = $options['rootElement'];
         $this->setEncoding($options['encoding']);
 
         if (array_key_exists('elementMap', $options)) {
-            $this->_elementMap  = $options['elementMap'];
+            $this->elementMap  = $options['elementMap'];
         }
     }
 
@@ -101,48 +102,48 @@ public function __construct($options = array())
      */
     public function getEncoding()
     {
-        return $this->_encoding;
+        return $this->encoding;
     }
 
     /**
      * Set encoding
      *
-     * @param  string $value
-     * @return \Zend\Log\Formatter\Xml
+     * @param string $value
+     * @return Xml
      */
     public function setEncoding($value)
     {
-        $this->_encoding = (string) $value;
+        $this->encoding = (string) $value;
         return $this;
     }
 
     /**
      * Formats data into a single line to be written by the writer.
      *
-     * @param  array    $event    event data
-     * @return string             formatted line to write to the log
+     * @param array $event event data
+     * @return string formatted line to write to the log
      */
     public function format($event)
     {
-        if ($this->_elementMap === null) {
+        if ($this->elementMap === null) {
             $dataToInsert = $event;
         } else {
             $dataToInsert = array();
-            foreach ($this->_elementMap as $elementName => $fieldKey) {
+            foreach ($this->elementMap as $elementName => $fieldKey) {
                 $dataToInsert[$elementName] = $event[$fieldKey];
             }
         }
 
         $enc = $this->getEncoding();
         $dom = new DOMDocument('1.0', $enc);
-        $elt = $dom->appendChild(new DOMElement($this->_rootElement));
+        $elt = $dom->appendChild(new DOMElement($this->rootElement));
 
         foreach ($dataToInsert as $key => $value) {
             if (empty($value)
                 || is_scalar($value)
                 || (is_object($value) && method_exists($value,'__toString'))
             ) {
-                if($key == "message") {
+                if ($key == "message") {
                     $value = htmlspecialchars($value, ENT_COMPAT, $enc);
                 }
                 $elt->appendChild(new DOMElement($key, (string)$value));