Added twig template engine for view. (hyperf#905)

caoqiang1990 · Nov 10, 2019 · 8ecbae4 · 8ecbae4
1 parent 05c375c
commit 8ecbae4
Show file tree

Hide file tree

Showing 9 changed files with 94 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Added
 
 - [#827](https://github.com/hyperf/hyperf/pull/827) Added a simple db component.
+- [#905](https://github.com/hyperf/hyperf/pull/905) Added twig template engine for view.
 
 ## Fixed
 

diff --git a/composer.json b/composer.json
@@ -58,7 +58,8 @@
         "smarty/smarty": "^3.1",
         "swoft/swoole-ide-helper": "dev-master",
         "symfony/property-access": "^4.3",
-        "symfony/serializer": "^4.3"
+        "symfony/serializer": "^4.3",
+        "twig/twig": "^2.12"
     },
     "replace": {
         "hyperf/amqp": "self.version",

diff --git a/doc/zh/view.md b/doc/zh/view.md
@@ -64,7 +64,7 @@ return [
 
 ## 视图渲染引擎
 
-官方目前支持 `Blade` 和 `Smarty` 两种模板，默认安装 [hyperf/view](https://github.com/hyperf/view) 时不会自动安装任何模板引擎，需要您根据自身需求，自行安装对应的模板引擎，使用前必须安装任一模板引擎。
+官方目前支持 `Blade` ，`Smarty` 和 `Twig` 三种模板，默认安装 [hyperf/view](https://github.com/hyperf/view) 时不会自动安装任何模板引擎，需要您根据自身需求，自行安装对应的模板引擎，使用前必须安装任一模板引擎。
 
 ### 安装 Blade 引擎
 
@@ -78,6 +78,12 @@ composer require duncan3dc/blade
 composer require smarty/smarty
 ```
 
+### 安装 Twig 引擎
+
+```bash
+composer require twig/twig
+```
+
 ### 接入其他模板
 
 假设我们想要接入一个虚拟的模板引擎名为 `TemplateEngine`，那么我们需要在任意地方创建对应的 `TemplateEngine` 类，并实现 `Hyperf\View\Engine\EngineInterface` 接口。

diff --git a/src/view/composer.json b/src/view/composer.json
@@ -26,6 +26,7 @@
     "suggest": {
         "hyperf/task": "Required to use task as a view render mode.",
         "smarty/smarty": "Required to use smarty as a view render engine.",
+        "twig/twig": "Required to use twig as a view render engine.",
         "duncan3dc/blade": "Required to use blade as a view render engine."
     },
     "autoload": {

diff --git a/src/view/src/Engine/TwigEngine.php b/src/view/src/Engine/TwigEngine.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://doc.hyperf.io
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace Hyperf\View\Engine;
+
+use Twig\Environment;
+use Twig\Loader\FilesystemLoader;
+
+class TwigEngine implements EngineInterface
+{
+    public function render($template, $data, $config): string
+    {
+        $loader = new FilesystemLoader($config['view_path']);
+        $twig = new Environment($loader, ['cache' => $config['cache_path']]);
+
+        return $twig->render($template, $data);
+    }
+}
diff --git a/src/view/tests/SmartyTest.php b/src/view/tests/SmartyTest.php
@@ -29,7 +29,7 @@ public function testRender()
         ];
 
         $engine = new SmartyEngine();
-        $res = $engine->render('smarty.tpl', ['name' => 'Hyperf'], $config);
+        $res = $engine->render('index.tpl', ['name' => 'Hyperf'], $config);
 
         $this->assertEquals('<!DOCTYPE html>
 <html lang="en">

diff --git a/src/view/tests/TwigTest.php b/src/view/tests/TwigTest.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://doc.hyperf.io
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace HyperfTest\View;
+
+use Hyperf\View\Engine\TwigEngine;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class TwigTest extends TestCase
+{
+    public function testRender()
+    {
+        $config = [
+            'view_path' => __DIR__ . '/tpl',
+            'cache_path' => __DIR__ . '/runtime',
+        ];
+
+        $engine = new TwigEngine();
+        $res = $engine->render('index.twig', ['name' => 'Hyperf'], $config);
+
+        $this->assertEquals('<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Hyperf</title>
+</head>
+<body>
+Hello, Hyperf. You are using smarty template now.
+</body>
+</html>', $res);
+    }
+}
diff --git a/src/view/tests/tpl/smarty.tpl → src/view/tests/tpl/index.tpl b/src/view/tests/tpl/smarty.tpl → src/view/tests/tpl/index.tpl
diff --git a/src/view/tests/tpl/index.twig b/src/view/tests/tpl/index.twig
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Hyperf</title>
+</head>
+<body>
+Hello, {{ name }}. You are using smarty template now.
+</body>
+</html>