Merge branch 'feature/511' into develop

Close #511 Fixes #360
zendframework · Oct 9, 2017 · 7c0dec8 · 7c0dec8
2 parents 91daf13 + 7d5a6d7
commit 7c0dec8
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,16 @@ All notable changes to this project will be documented in this file, in reverse
   This change is an internal implementation detail only, and will not affect
   existing implementations or extensions.
 
+- [#511](https://github.com/zendframework/zend-expressive/pull/511) modifies
+  the `NotFoundDelegate` to accept an optional `$layout` argument to its
+  constructor; the value defaults to `layout::default` if not provided. That
+  value will be passed for the `layout` template variable when the delegate
+  renders a template, allowing zend-view users (and potentially other template
+  systems) to customize the layout template used for reporting errors.
+
+  You may provide the template via the configuration
+  `zend-expressive.error_handler.layout`.
+
 ### Deprecated
 
 - Nothing.

diff --git a/src/Container/NotFoundDelegateFactory.php b/src/Container/NotFoundDelegateFactory.php
@@ -27,7 +27,10 @@ public function __invoke(ContainerInterface $container)
         $template = isset($config['zend-expressive']['error_handler']['template_404'])
             ? $config['zend-expressive']['error_handler']['template_404']
             : NotFoundDelegate::TEMPLATE_DEFAULT;
+        $layout = isset($config['zend-expressive']['error_handler']['layout'])
+            ? $config['zend-expressive']['error_handler']['layout']
+            : NotFoundDelegate::LAYOUT_DEFAULT;
 
-        return new NotFoundDelegate(new Response(), $renderer, $template);
+        return new NotFoundDelegate(new Response(), $renderer, $template, $layout);
     }
 }
diff --git a/src/Delegate/NotFoundDelegate.php b/src/Delegate/NotFoundDelegate.php
@@ -16,6 +16,7 @@
 class NotFoundDelegate implements DelegateInterface
 {
     const TEMPLATE_DEFAULT = 'error::404';
+    const LAYOUT_DEFAULT = 'layout::default';
 
     /**
      * @var TemplateRendererInterface
@@ -35,19 +36,27 @@ class NotFoundDelegate implements DelegateInterface
      */
     private $template;
 
+    /**
+     * @var string
+     */
+    private $layout;
+
     /**
      * @param ResponseInterface $responsePrototype
      * @param TemplateRendererInterface $renderer
      * @param string $template
+     * @param string $layout
      */
     public function __construct(
         ResponseInterface $responsePrototype,
         TemplateRendererInterface $renderer = null,
-        $template = self::TEMPLATE_DEFAULT
+        $template = self::TEMPLATE_DEFAULT,
+        $layout = self::LAYOUT_DEFAULT
     ) {
         $this->responsePrototype = $responsePrototype;
-        $this->renderer          = $renderer;
-        $this->template          = $template;
+        $this->renderer = $renderer;
+        $this->template = $template;
+        $this->layout = $layout;
     }
 
     /**
@@ -95,7 +104,7 @@ private function generateTemplatedResponse(ServerRequestInterface $request)
     {
         $response = $this->responsePrototype->withStatus(StatusCodeInterface::STATUS_NOT_FOUND);
         $response->getBody()->write(
-            $this->renderer->render($this->template, ['request' => $request])
+            $this->renderer->render($this->template, ['request' => $request, 'layout' => $this->layout])
         );
 
         return $response;

diff --git a/test/Container/NotFoundDelegateFactoryTest.php b/test/Container/NotFoundDelegateFactoryTest.php
@@ -54,6 +54,7 @@ public function testFactoryUsesConfigured404TemplateWhenPresent()
         $config = [
             'zend-expressive' => [
                 'error_handler' => [
+                    'layout' => 'layout::error',
                     'template_404' => 'foo::bar',
                 ],
             ],
@@ -64,6 +65,11 @@ public function testFactoryUsesConfigured404TemplateWhenPresent()
         $factory = new NotFoundDelegateFactory();
 
         $delegate = $factory($this->container->reveal());
+        $this->assertAttributeEquals(
+            $config['zend-expressive']['error_handler']['layout'],
+            'layout',
+            $delegate
+        );
         $this->assertAttributeEquals(
             $config['zend-expressive']['error_handler']['template_404'],
             'template',

diff --git a/test/Delegate/NotFoundDelegateTest.php b/test/Delegate/NotFoundDelegateTest.php
@@ -37,12 +37,14 @@ public function testConstructorCanAcceptRendererAndTemplate()
     {
         $renderer = $this->prophesize(TemplateRendererInterface::class)->reveal();
         $template = 'foo::bar';
+        $layout = 'layout::error';
 
-        $delegate = new NotFoundDelegate($this->response->reveal(), $renderer, $template);
+        $delegate = new NotFoundDelegate($this->response->reveal(), $renderer, $template, $layout);
 
         $this->assertInstanceOf(NotFoundDelegate::class, $delegate);
         $this->assertAttributeSame($renderer, 'renderer', $delegate);
         $this->assertAttributeEquals($template, 'template', $delegate);
+        $this->assertAttributeEquals($layout, 'layout', $delegate);
     }
 
     public function testRendersDefault404ResponseWhenNoRendererPresent()
@@ -68,7 +70,14 @@ public function testUsesRendererToGenerateResponseContentsWhenPresent()
         $request = $this->prophesize(ServerRequestInterface::class)->reveal();
 
         $renderer = $this->prophesize(TemplateRendererInterface::class);
-        $renderer->render(NotFoundDelegate::TEMPLATE_DEFAULT, ['request' => $request])
+        $renderer
+            ->render(
+                NotFoundDelegate::TEMPLATE_DEFAULT,
+                [
+                    'request' => $request,
+                    'layout' => NotFoundDelegate::LAYOUT_DEFAULT,
+                ]
+            )
             ->willReturn('CONTENT');
 
         $stream = $this->prophesize(StreamInterface::class);