Adding parameters to templates before render-time

src/Template/AddParametersTrait.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @see       https://github.com/zendframework/zend-expressive for the canonical source repository
+ * @copyright Copyright (c) 2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Expressive\Template;
+
+trait AddParametersTrait
+{
+    /**
+     * @var array
+     */
+    protected $templateParams = [];
+
+    /**
+     * Add parameters to template
+     *
+     * If no template name is given, the parameters will be added to all templates rendered
+     *
+     * @param array|object $params
+     * @param string|null $name
+     */
+    public function addParameters($params, $name = null)
+    {
+        if (method_exists($this, 'normalizeParams')) {
+            $params = $this->normalizeParams($params);
+        }
+        $name = (string) $name;
+        $existing = isset($this->templateParams[$name]) ? $this->templateParams[$name] : null;
+        $this->templateParams[$name] = array_merge($existing, $params, $name);
+    }
+
+    /**
+     * Returns merged global, template-specific and given params
+     *
+     * @param array $params
+     * @param string $name
+     * @return array
+     */
+    protected function mergeParams($params, $name)
+    {
+        return array_merge(
+            isset($this->templateParams['']) ? $this->templateParams[''] : [],
+            isset($this->templateParams[$name]) ? $this->templateParams[$name] : [],
+            $params
+        );
+    }
+}

src/Template/PlatesRenderer.php

@@ -88,6 +88,21 @@ public function getPaths()
         return $paths;
     }
 
+    /**
+     * Add parameters to template
+     *
+     * If no template name is given, the parameters will be added to all templates rendered
+     *
+     * @param array|object $params
+     * @param string $name
+     */
+    public function addParameters($params, $name = null)
+    {
+        $params = $this->normalizeParams($params);
+        $this->template->addData($params, $name);
+    }
+
+
     /**
      * Create a default Plates engine
      *

src/Template/TemplateRendererInterface.php

@@ -43,4 +43,14 @@ public function addPath($path, $namespace = null);
      * @return TemplatePath[]
      */
     public function getPaths();
+
+    /**
+     * Add parameters to template
+     *
+     * If no template name is given, the parameters will be added to all templates rendered
+     *
+     * @param array|object $params
+     * @param string|null $name
+     */
+    public function addParameters($params, $name = null);
 }

src/Template/TwigRenderer.php

@@ -18,6 +18,7 @@
  */
 class TwigRenderer implements TemplateRendererInterface
 {
+    use AddParametersTrait;
     use ArrayParametersTrait;
 
     /**
@@ -90,7 +91,7 @@ private function getDefaultLoader()
     public function render($name, $params = [])
     {
         $name   = $this->normalizeTemplate($name);
-        $params = $this->normalizeParams($params);
+        $params = $this->mergeParams($this->normalizeParams($params), $name);
         return $this->template->render($name, $params);
     }
 

src/Template/ZendViewRenderer.php

@@ -28,6 +28,7 @@
  */
 class ZendViewRenderer implements TemplateRendererInterface
 {
+    use AddParametersTrait;
     use ArrayParametersTrait;
 
     /**
@@ -118,8 +119,9 @@ public function __construct(RendererInterface $renderer = null, $layout = null)
      */
     public function render($name, $params = [])
     {
+        $params = $this->mergeParams($this->normalizeParams($params), $name);
         return $this->renderModel(
-            $this->createModel($name, $this->normalizeParams($params)),
+            $this->createModel($name, $params),
             $this->renderer
         );
     }

test/Template/PlatesRendererTest.php

@@ -184,4 +184,74 @@ public function testProperlyResolvesNamespacedTemplate()
 
         $this->assertSame($expected, $test);
     }
+
+    public function testAddParameterToOneTemplate()
+    {
+        $renderer = new PlatesRenderer();
+        $renderer->addPath(__DIR__ . '/TestAsset');
+        $name = 'Plates';
+        $renderer->addParameters(['name' => $name], 'plates');
+        $result = $renderer->render('plates');
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates.php');
+        $content= str_replace('<?=$this->e($name)?>', $name, $content);
+        $this->assertEquals($content, $result);
+
+        // @fixme hack to work around https://github.com/thephpleague/plates/issues/60, remove if ever merged
+        set_error_handler(function ($error, $message) {
+            $this->assertContains('Undefined variable: name', $message);
+            return true;
+        }, E_NOTICE);
+        $renderer->render('plates-2');
+        restore_error_handler();
+
+        $content= str_replace('<?=$this->e($name)?>', '', $content);
+        $this->assertEquals($content, $result);
+    }
+
+    public function testAddSharedParameters()
+    {
+        $renderer = new PlatesRenderer();
+        $renderer->addPath(__DIR__ . '/TestAsset');
+        $name = 'Plates';
+        $renderer->addParameters(['name' => $name]);
+        $result = $renderer->render('plates');
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates.php');
+        $content= str_replace('<?=$this->e($name)?>', $name, $content);
+        $this->assertEquals($content, $result);
+        $result = $renderer->render('plates-2');
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates-2.php');
+        $content= str_replace('<?=$this->e($name)?>', $name, $content);
+        $this->assertEquals($content, $result);
+    }
+
+    public function testOverrideSharedParametersPerTemplate()
+    {
+        $renderer = new PlatesRenderer();
+        $renderer->addPath(__DIR__ . '/TestAsset');
+        $name = 'Plates';
+        $name2 = 'Saucers';
+        $renderer->addParameters(['name' => $name]);
+        $renderer->addParameters(['name' => $name2], 'plates-2');
+        $result = $renderer->render('plates');
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates.php');
+        $content= str_replace('<?=$this->e($name)?>', $name, $content);
+        $this->assertEquals($content, $result);
+        $result = $renderer->render('plates-2');
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates-2.php');
+        $content= str_replace('<?=$this->e($name)?>', $name2, $content);
+        $this->assertEquals($content, $result);
+    }
+
+    public function testOverrideSharedParametersAtRender()
+    {
+        $renderer = new PlatesRenderer();
+        $renderer->addPath(__DIR__ . '/TestAsset');
+        $name = 'Plates';
+        $name2 = 'Saucers';
+        $renderer->addParameters(['name' => $name]);
+        $result = $renderer->render('plates', ['name' => $name2]);
+        $content = file_get_contents(__DIR__ . '/TestAsset/plates.php');
+        $content= str_replace('<?=$this->e($name)?>', $name2, $content);
+        $this->assertEquals($content, $result);
+    }
 }

test/Template/TestAsset/plates-2.php

@@ -0,0 +1,3 @@
+<h1>This is a second template file for Plates</h1>
+
+<p>You are using <strong><?=$this->e($name)?></strong>!</p>