Merge 7c2f737 into 6d23d46

composer.json

@@ -23,7 +23,8 @@
         "league/plates": "^3.3",
         "zendframework/zend-expressive-helpers": "^2.2 || ^3.0.1 || ^4.0",
         "zendframework/zend-expressive-router": "^1.3.2 || ^2.1",
-        "zendframework/zend-expressive-template": "^1.0.4"
+        "zendframework/zend-expressive-template": "^1.0.4",
+        "zendframework/zend-escaper": "^2.5"
     },
     "require-dev": {
         "malukenho/docheader": "^0.1.5",

src/Extension/EscaperExtension.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive-platesrenderer for the canonical source repository
+ * @copyright Copyright (c) 2016-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive-platesrenderer/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Expressive\Plates\Extension;
+
+use League\Plates\Engine;
+use League\Plates\Extension\ExtensionInterface;
+use Zend\Escaper\Escaper;
+use Zend\Escaper\Exception\InvalidArgumentException;
+
+class EscaperExtension implements ExtensionInterface
+{
+    /**
+     * Register functions with the Plates engine.
+     *
+     * Registers:
+     *
+     * - escapeHtml($string) : string
+     * - escapeHtmlAttr($string) : string
+     * - escapeJs($string) : string
+     * - escapeCss($string) : string
+     * - escapeUrl($string) : string
+     *
+     * @param Engine $engine
+     * @return void
+     * @throws InvalidArgumentException
+     */
+    public function register(Engine $engine)
+    {
+        $escaper = new Escaper();
+
+        $engine->registerFunction('escapeHtml', [$escaper, 'escapeHtml']);
+        $engine->registerFunction('escapeHtmlAttr', [$escaper, 'escapeHtmlAttr']);
+        $engine->registerFunction('escapeJs', [$escaper, 'escapeJs']);
+        $engine->registerFunction('escapeCss', [$escaper, 'escapeCss']);
+        $engine->registerFunction('escapeUrl', [$escaper, 'escapeUrl']);
+    }
+}

test/Extension/EscaperExtensionTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace ZendTest\Expressive\Plates\Extension;
+
+use League\Plates\Engine;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Zend\Escaper\Escaper;
+use Zend\Expressive\Plates\Extension\EscaperExtension;
+
+class EscaperExtensionTest extends TestCase
+{
+    public function testRegistersEscaperFunctionsWithEngine()
+    {
+        $extension = new EscaperExtension();
+
+        $engine = $this->prophesize(Engine::class);
+        $engine
+            ->registerFunction('escapeHtml', Argument::that(function ($argument) {
+                return is_array($argument) && $argument[0] instanceof Escaper && $argument[1] === 'escapeHtml';
+            }))->shouldBeCalled();
+        $engine
+            ->registerFunction('escapeHtmlAttr', Argument::that(function ($argument) {
+                return is_array($argument) && $argument[0] instanceof Escaper && $argument[1] === 'escapeHtmlAttr';
+            }))->shouldBeCalled();
+        $engine
+            ->registerFunction('escapeJs', Argument::that(function ($argument) {
+                return is_array($argument) && $argument[0] instanceof Escaper && $argument[1] === 'escapeJs';
+            }))->shouldBeCalled();
+        $engine
+            ->registerFunction('escapeCss', Argument::that(function ($argument) {
+                return is_array($argument) && $argument[0] instanceof Escaper && $argument[1] === 'escapeCss';
+            }))->shouldBeCalled();
+        $engine
+            ->registerFunction('escapeUrl', Argument::that(function ($argument) {
+                return is_array($argument) && $argument[0] instanceof Escaper && $argument[1] === 'escapeUrl';
+            }))->shouldBeCalled();
+
+        $extension->register($engine->reveal());
+    }
+}