Added zend-view helper plugin manager injection

The zend-view container factory now also injects the HelperPluginManager
instance, adding overrides for the url and serverurl helpers.

Author: weierophinney

doc/book/container/factories.md

@@ -275,11 +275,15 @@ the `TwigExtension` instance (assuming the router was found).
 - **FactoryName**: `Zend\Expressive\Container\Template\ZendViewFactory`
 - **Suggested Name**: `Zend\Expressive\Template\TemplateInterface`
 - **Requires**: no additional services are required.
+    - `Zend\Expressive\Router\RouterInterface`, in order to inject the custom
+      url helper implementation.
 - **Optional**:
     - `config`, an array or `ArrayAccess` instance. This will be used to further
       configure the `ZendView` instance, specifically with the layout template
       name, entries for a `TemplateMapResolver`, and and template paths to
       inject.
+    - `Zend\View\HelperPluginManager`; if present, will be used to inject the
+      `PhpRenderer` instance.
 
 It consumes the following `config` structure:
 
@@ -297,3 +301,9 @@ It consumes the following `config` structure:
     ],
 ]
 ```
+
+When creating the `PhpRenderer` instance, it will inject it with a
+`Zend\View\HelperPluginManager` instance (either pulled from the container, or
+instantiated directly). It injects the helper plugin manager with custom url and
+serverurl helpers, `Zend\Expressive\Template\ZendView\UrlHelper` and
+`Zend\Expressive\Template\ZendView\ServerUrlHelper`, respetively.

doc/book/template/zend-view.md

@@ -145,6 +145,28 @@ $content = $templates->render('blog/entry', [
 ]);
 ```
 
+## Helpers
+
+Expressive provides overrides of specific view helpers in order to better
+integrate with PSR-7. These include:
+
+- `Zend\Expressive\Template\ZendView\UrlHelper`. This helper consumes the
+  application's `Zend\Expressive\Router\RouterInterface` instance in order
+  to generate URIs. It's signature is:
+  `url($routeName, array $substitutions = [])`
+- `Zend\Expressive\Template\ZendView\ServerUrlHelper`. This helper consumes the
+  URI from the application's request in order to provide fully qualified URIs.
+  It's signature is: `serverUrl($path = null)`.
+
+  To use this particular helper, you will need to inject it with the request URI
+  somewhere within your application:
+
+  ```php
+  $serverUrlHelper->setUri($request->getUri());
+  ```
+
+  We recommend doing this within a pre-pipeline middleware.
+
 ## Recommendations
 
 We recommend the following practices when using the zend-view adapter:

src/Container/Template/ZendViewFactory.php

@@ -10,13 +10,21 @@
 namespace Zend\Expressive\Container\Template;
 
 use Interop\Container\ContainerInterface;
+use Zend\Expressive\Router\RouterInterface;
 use Zend\Expressive\Template\ZendView;
+use Zend\View\HelperPluginManager;
 use Zend\View\Renderer\PhpRenderer;
 use Zend\View\Resolver;
 
 /**
  * Create and return a ZendView template instance.
  *
+ * Requires the Zend\Expressive\Router\RouterInterface service (for creating
+ * the UrlHelper instance).
+ *
+ * Optionally requires the Zend\View\HelperPluginManager service; if present,
+ * will use the service to inject the PhpRenderer instance.
+ *
  * Optionally uses the service 'config', which should return an array. This
  * factory consumes the following structure:
  *
@@ -34,6 +42,9 @@
  *     ],
  * ]
  * </code>
+ *
+ * Injects the HelperPluginManager used by the PhpRenderer with zend-expressive
+ * overrides of the url and serverurl helpers.
  */
 class ZendViewFactory
 {
@@ -57,6 +68,9 @@ public function __invoke(ContainerInterface $container)
         $renderer = new PhpRenderer();
         $renderer->setResolver($resolver);
 
+        // Inject helpers
+        $this->injectHelpers($renderer, $container);
+
         // Inject renderer
         $view = new ZendView($renderer, isset($config['layout']) ? $config['layout'] : null);
 
@@ -71,4 +85,29 @@ public function __invoke(ContainerInterface $container)
 
         return $view;
     }
+
+    /**
+     * Inject helpers into the PhpRenderer instance.
+     *
+     * If a HelperPluginManager instance is present in the container, uses that;
+     * otherwise, instantiates one.
+     *
+     * In each case, injects with the custom url/serverurl implementations.
+     *
+     * @param PhpRenderer $renderer
+     * @param ContainerInterface $container
+     */
+    private function injectHelpers(PhpRenderer $renderer, ContainerInterface $container)
+    {
+        $helpers = $container->has(HelperPluginManager::class)
+            ? $container->get(HelperPluginManager::class)
+            : new HelperPluginManager();
+
+        $helpers->setFactory('url', function () use ($container) {
+            return new ZendView\UrlHelper($container->get(RouterInterface::class));
+        });
+        $helpers->setInvokableClass('serverurl', ZendView\ServerUrlHelper::class);
+
+        $renderer->setHelperPluginManager($helpers);
+    }
 }

test/Container/Template/ZendViewFactoryTest.php

@@ -13,7 +13,9 @@
 use PHPUnit_Framework_TestCase as TestCase;
 use ReflectionProperty;
 use Zend\Expressive\Container\Template\ZendViewFactory;
+use Zend\Expressive\Router\RouterInterface;
 use Zend\Expressive\Template\ZendView;
+use Zend\View\HelperPluginManager;
 use Zend\View\Model\ModelInterface;
 use Zend\View\Resolver\AggregateResolver;
 use Zend\View\Resolver\TemplateMapResolver;
@@ -37,6 +39,7 @@ public function fetchPhpRenderer(ZendView $view)
     public function testCallingFactoryWithNoConfigReturnsZendViewInstance()
     {
         $this->container->has('config')->willReturn(false);
+        $this->container->has(HelperPluginManager::class)->willReturn(false);
         $factory = new ZendViewFactory();
         $view    = $factory($this->container->reveal());
         $this->assertInstanceOf(ZendView::class, $view);
@@ -62,6 +65,7 @@ public function testConfiguresLayout()
         ];
         $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn($config);
+        $this->container->has(HelperPluginManager::class)->willReturn(false);
         $factory = new ZendViewFactory();
         $view = $factory($this->container->reveal());
 
@@ -81,6 +85,7 @@ public function testConfiguresPaths()
         ];
         $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn($config);
+        $this->container->has(HelperPluginManager::class)->willReturn(false);
         $factory = new ZendViewFactory();
         $view = $factory($this->container->reveal());
 
@@ -113,6 +118,7 @@ public function testConfiguresTemplateMap()
         ];
         $this->container->has('config')->willReturn(true);
         $this->container->get('config')->willReturn($config);
+        $this->container->has(HelperPluginManager::class)->willReturn(false);
         $factory = new ZendViewFactory();
         $view = $factory($this->container->reveal());
 
@@ -133,4 +139,54 @@ public function testConfiguresTemplateMap()
         $this->assertTrue($resolver->has('bar'));
         $this->assertEquals('baz', $resolver->get('bar'));
     }
+
+    public function testInjectsCustomHelpersIntoHelperManager()
+    {
+        $router = $this->prophesize(RouterInterface::class)->reveal();
+        $this->container->has('config')->willReturn(false);
+        $this->container->has(HelperPluginManager::class)->willReturn(false);
+        $this->container->has(RouterInterface::class)->willReturn(true);
+        $this->container->get(RouterInterface::class)->willReturn($router);
+        $factory = new ZendViewFactory();
+        $view    = $factory($this->container->reveal());
+        $this->assertInstanceOf(ZendView::class, $view);
+
+        $renderer = $this->fetchPhpRenderer($view);
+        $helpers  = $renderer->getHelperPluginManager();
+        $this->assertInstanceOf(HelperPluginManager::class, $helpers);
+        $this->assertTrue($helpers->has('url'));
+        $this->assertTrue($helpers->has('serverurl'));
+        $this->assertInstanceOf(ZendView\UrlHelper::class, $helpers->get('url'));
+        $this->assertInstanceOf(ZendView\ServerUrlHelper::class, $helpers->get('serverurl'));
+    }
+
+    public function testWillUseHelperManagerFromContainer()
+    {
+        $router = $this->prophesize(RouterInterface::class)->reveal();
+        $this->container->has('config')->willReturn(false);
+        $this->container->has(RouterInterface::class)->willReturn(true);
+        $this->container->get(RouterInterface::class)->willReturn($router);
+
+        $helpers = new HelperPluginManager();
+        $this->container->has(HelperPluginManager::class)->willReturn(true);
+        $this->container->get(HelperPluginManager::class)->willReturn($helpers);
+        $factory = new ZendViewFactory();
+        $view    = $factory($this->container->reveal());
+        $this->assertInstanceOf(ZendView::class, $view);
+
+        $renderer = $this->fetchPhpRenderer($view);
+        $this->assertSame($helpers, $renderer->getHelperPluginManager());
+        return $helpers;
+    }
+
+    /**
+     * @depends testWillUseHelperManagerFromContainer
+     */
+    public function testInjectsCustomHelpersIntoHelperManagerFromContainer(HelperPluginManager $helpers)
+    {
+        $this->assertTrue($helpers->has('url'));
+        $this->assertTrue($helpers->has('serverurl'));
+        $this->assertInstanceOf(ZendView\UrlHelper::class, $helpers->get('url'));
+        $this->assertInstanceOf(ZendView\ServerUrlHelper::class, $helpers->get('serverurl'));
+    }
 }