Merge pull request #2801 from RyanNerd/setLogErrorRenderer

4.x - Add setLogErrorRenderer() to ErrorHandler
slimphp · Aug 18, 2019 · 8ab3432 · 8ab3432
2 parents 335b5fd + 10b11bd
commit 8ab3432
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/Slim/Handlers/ErrorHandler.php b/Slim/Handlers/ErrorHandler.php
@@ -42,6 +42,11 @@ class ErrorHandler implements ErrorHandlerInterface
      */
     protected $defaultErrorRenderer = HtmlErrorRenderer::class;
 
+    /**
+     * @var ErrorRendererInterface|string|callable
+     */
+    protected $logErrorRenderer = PlainTextErrorRenderer::class;
+
     /**
      * @var array
      */
@@ -259,15 +264,25 @@ public function setDefaultErrorRenderer(string $contentType, $errorRenderer): vo
         $this->defaultErrorRenderer = $errorRenderer;
     }
 
+    /**
+     * Set the renderer for the error logger
+     *
+     * @param ErrorRendererInterface|string|callable $logErrorRenderer
+     */
+    public function setLogErrorRenderer($logErrorRenderer): void
+    {
+        $this->logErrorRenderer = $logErrorRenderer;
+    }
+
     /**
      * Write to the error log if $logErrors has been set to true
      *
      * @return void
      */
     protected function writeToErrorLog(): void
     {
-        $renderer = new PlainTextErrorRenderer();
-        $error = $renderer->__invoke($this->exception, $this->logErrorDetails);
+        $renderer = $this->callableResolver->resolve($this->logErrorRenderer);
+        $error = $renderer($this->exception, $this->logErrorDetails);
         $error .= "\nView in rendered output by enabling the \"displayErrorDetails\" setting.\n";
         $this->logError($error);
     }

diff --git a/tests/Handlers/ErrorHandlerTest.php b/tests/Handlers/ErrorHandlerTest.php
@@ -11,13 +11,17 @@
 
 use Psr\Http\Message\ResponseInterface;
 use ReflectionClass;
+use ReflectionMethod;
+use ReflectionProperty;
+use RuntimeException;
 use Slim\Error\Renderers\HtmlErrorRenderer;
 use Slim\Error\Renderers\JsonErrorRenderer;
 use Slim\Error\Renderers\PlainTextErrorRenderer;
 use Slim\Error\Renderers\XmlErrorRenderer;
 use Slim\Exception\HttpMethodNotAllowedException;
 use Slim\Exception\HttpNotFoundException;
 use Slim\Handlers\ErrorHandler;
+use Slim\Interfaces\CallableResolverInterface;
 use Slim\Tests\Mocks\MockCustomException;
 use Slim\Tests\TestCase;
 
@@ -322,12 +326,37 @@ public function testDefaultErrorRenderer()
             ->withHeader('Accept', 'application/unknown');
 
         $handler = new ErrorHandler($this->getCallableResolver(), $this->getResponseFactory());
-        $exception = new \RuntimeException();
+        $exception = new RuntimeException();
 
         /** @var ResponseInterface $res */
         $res = $handler->__invoke($request, $exception, true, true, true);
 
         $this->assertTrue($res->hasHeader('Content-Type'));
         $this->assertEquals('text/html', $res->getHeaderLine('Content-Type'));
     }
+
+    public function testLogErrorRenderer()
+    {
+        $renderer = function () {
+            return '';
+        };
+
+        $callableResolverProphecy = $this->prophesize(CallableResolverInterface::class);
+        $callableResolverProphecy
+            ->resolve('logErrorRenderer')
+            ->willReturn($renderer)
+            ->shouldBeCalledOnce();
+
+        $handler = new ErrorHandler($callableResolverProphecy->reveal(), $this->getResponseFactory());
+        $handler->setLogErrorRenderer('logErrorRenderer');
+
+        $exception = new RuntimeException();
+        $exceptionProperty = new ReflectionProperty($handler, 'exception');
+        $exceptionProperty->setAccessible(true);
+        $exceptionProperty->setValue($handler, $exception);
+
+        $writeToErrorLogMethod = new ReflectionMethod($handler, 'writeToErrorLog');
+        $writeToErrorLogMethod->setAccessible(true);
+        $writeToErrorLogMethod->invoke($handler);
+    }
 }