Merge pull request #23 from homiedopie/feature/PHP-4

PHP-4 - Add support for error type to be from the error message

Author: homiedopie

src/Stackify/Log/Entities/ErrorWrapper.php

@@ -2,6 +2,9 @@
 
 namespace Stackify\Log\Entities;
 
+use Stackify\Log\Transport\Config\AbstractConfig;
+use Stackify\Log\Transport\Config\Agent;
+
 class ErrorWrapper
 {
 
@@ -10,6 +13,12 @@ class ErrorWrapper
     private $code;
     private $trace;
     private $sourceMethod;
+    /**
+     * Agent config
+     *
+     * @var AbstractConfig
+     */
+    private $_config;
 
     const TYPE_STRING_EXCEPTION = 'StringException';
     const TRACE_UNKNOWN_ITEM = '{unknown}';
@@ -19,8 +28,10 @@ class ErrorWrapper
      */
     private $innerError;
 
-    public function __construct($object, $nestingLevel = 1)
+    public function __construct($object, $nestingLevel = 1, $config = null)
     {
+        $this->_config = !empty($config) ? $config: Agent::getInstance();
+
         if ($object instanceof \Exception) {
             $this->message = $object->getMessage();
             $this->type = get_class($object);
@@ -50,6 +61,13 @@ public function __construct($object, $nestingLevel = 1)
             $this->setTrace(debug_backtrace());
             $this->innerError = null;
         }
+
+        if ($this->_config) {
+            $classBlacklist = $this->_config->getCaptureExceptionClassBlacklist();
+            if (!empty($classBlacklist) && isset($classBlacklist[$this->type])) {
+                $this->type = $this->message;
+            }
+        }
     }
 
     public function getMessage()

src/Stackify/Log/Transport/Config/AbstractConfig.php

@@ -134,6 +134,12 @@ abstract class AbstractConfig
      * @var boolean
      */
     protected $Debug;
+    /**
+     * Exception Class Blacklist
+     *
+     * @var array
+     */
+    protected $CaptureExceptionClassBlacklist;
 
 
     /**
@@ -170,6 +176,7 @@ public function __construct()
         $ds = DIRECTORY_SEPARATOR;
         $this->DebugLogPath = realpath(dirname(__FILE__) . "$ds..$ds..") . $ds . 'debug/log.log';
         $this->Debug = false;
+        $this->CaptureExceptionClassBlacklist = null;
     }
 
     /**
@@ -408,6 +415,17 @@ public function setDebug($enable = null)
     {
         $this->Debug = $this->getBoolean($enable, 'Debug');
     }
+    /**
+     * Set capture Exception Class blacklist for ErrorType
+     *
+     * @param array $rawConfig From config
+     *
+     * @return void
+     */
+    public function setCaptureExceptionClassBlacklist($rawConfig = null)
+    {
+        $this->CaptureExceptionClassBlacklist = $this->parseStringToArray($rawConfig, 'CaptureExceptionClassBlacklist');
+    }
 
 
     /**
@@ -599,6 +617,15 @@ public function getDebug()
     {
         return $this->Debug;
     }
+    /**
+     * Get capture exception class for error type blacklist
+     *
+     * @return mixed
+     */
+    public function getCaptureExceptionClassBlacklist()
+    {
+        return $this->CaptureExceptionClassBlacklist;
+    }
 
     /**
      * Log error message

tests/Log/Entities/ErrorWrapperTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Stackify\Tests\Log\Entities;
+
+use Stackify\Log\Entities\ErrorWrapper;
+use Stackify\Log\Transport\Config\Agent;
+use Stackify\Tests\Log\Entities\Fixtures\TestException;
+
+class ErrorWrapperTest extends \PHPUnit_Framework_TestCase
+{
+    public function testCaptureExceptionBlacklistWithCustomException()
+    {
+        $agentConfig = new Agent();
+        $agentConfig->setCaptureExceptionClassBlacklist([
+            TestException::class
+        ]);
+
+        $message = "Test exception random";
+        $exception = new TestException($message);
+        $errorWrapperObject = new ErrorWrapper($exception, 1, $agentConfig);
+
+        $this->assertSame($message, $errorWrapperObject->getType());
+    }
+
+    public function testEmptyCaptureExceptionBlacklistWithCustomException()
+    {
+        $message = "Test exception random";
+        $exception = new TestException($message);
+        $errorWrapperObject = new ErrorWrapper($exception);
+
+        $this->assertSame(TestException::class, $errorWrapperObject->getType());
+    }
+}

tests/Log/Entities/Fixtures/TestException.php

@@ -0,0 +1,6 @@
+<?php
+
+namespace Stackify\Tests\Log\Entities\Fixtures;
+
+class TestException extends \Exception {
+}