some update

Author: inhere

src/Components/TextTemplate.php

@@ -14,15 +14,31 @@
  */
 class TextTemplate
 {
-    /** @var array  */
+    /**
+     * comments: {* comments ... *}
+     */
+    const MATCH_COMMENT = '#\{\*.*?\*\}#sm';
+
+    /**
+     * {#include 'text-0.tpl'}
+     */
+    const MATCH_INCLUDE = '#\{\#include (.*)\}#';
+
+    /** @var array */
     private $vars = [];
 
-    /** @var string  */
+    /** @var string */
     private $openChar = '{$';
 
-    /** @var string  */
+    /** @var string */
     private $closeChar = '}';
 
+    /** @var string */
+    private $basePath;
+
+    /** @var bool clear first and last space. */
+    private $clearFLSpace = true;
+
     /**
      * TextTemplate constructor.
      * @param array $vars
@@ -34,6 +50,11 @@ public function __construct(array $vars = [])
         }
     }
 
+    public function reset()
+    {
+        $this->vars = [];
+    }
+
     /**
      * @param string $tplFile
      * @param array $vars
@@ -46,6 +67,10 @@ public function renderFile(string $tplFile, array $vars = [], $saveAs = null)
             throw new \InvalidArgumentException("Template file not exists. FILE: $tplFile");
         }
 
+        if (!$this->basePath) {
+            $this->basePath = \dirname($tplFile);
+        }
+
         return $this->render(file_get_contents($tplFile), $vars, $saveAs);
     }
 
@@ -73,9 +98,23 @@ public function render(string $template, array $vars = [], $saveAs = null)
             $pairs[$key] = $value;
         }
 
+        // has include tag
+        if ($this->basePath && false !== strpos($template, '{#include')) {
+            $template = (string)preg_replace_callback(self::MATCH_INCLUDE, function ($m) use ($pairs) {
+                return $this->renderInclude($m, $pairs);
+            }, $template);
+        }
+
+        // remove comments
+        $template = $this->removeComments($template);
+
         // replace vars to values.
         $rendered = strtr($template, $pairs);
 
+        if ($this->clearFLSpace) {
+            $rendered = trim($rendered);
+        }
+
         if (!$saveAs) {
             return $rendered;
         }
@@ -89,6 +128,45 @@ public function render(string $template, array $vars = [], $saveAs = null)
         return (bool)file_put_contents($saveAs, $rendered);
     }
 
+    /**
+     * @param array $matches
+     * @param array $data
+     * @return string
+     */
+    protected function renderInclude(array $matches, array $data)
+    {
+        if (!isset($matches[1]) || !($include = trim($matches[1], ' \'"'))) {
+            return '!!CANNOT INCLUDE EMPTY FILE!!';
+        }
+
+        $include = $this->basePath . '/' . $include;
+
+        if (!\is_file($include)) {
+            return '!!THE INCLUDE FILE NOT FOUND!!';
+        }
+
+        $rendered = strtr(file_get_contents($include), $data);
+
+        if ($this->clearFLSpace) {
+            $rendered = trim($rendered);
+        }
+
+        return $rendered;
+    }
+
+    /**
+     * @param string $input
+     * @return string
+     */
+    protected function removeComments(string $input)
+    {
+        return preg_replace(
+            self::MATCH_COMMENT,
+            '',
+            $input = str_replace("\r\n", "\n", $input)
+        );
+    }
+
     /**
      * Multidimensional array expansion to one dimension array
      * @param array $vars
@@ -197,4 +275,31 @@ public function setCloseChar(string $closeChar)
             $this->closeChar = $closeChar;
         }
     }
+
+    /**
+     * @return string
+     */
+    public function getBasePath()
+    {
+        return $this->basePath;
+    }
+
+    /**
+     * @param string $basePath
+     */
+    public function setBasePath(string $basePath)
+    {
+        $this->basePath = $basePath;
+    }
+
+    /**
+     * @param bool $clearFLSpace
+     * @return TextTemplate
+     */
+    public function setClearFLSpace(bool $clearFLSpace): TextTemplate
+    {
+        $this->clearFLSpace = $clearFLSpace;
+
+        return $this;
+    }
 }

tests/Components/TextTemplateTest.php

@@ -23,7 +23,7 @@ public function testRender()
         $tpl = <<<EOF
 test tpl on date {\$date}
 
-use array {\$map.0} {\$map.key1}
+use array {\$map.0} {\$map.key1}{* comments *}
 EOF;
         $date = date('Ymd');
 
@@ -42,4 +42,23 @@ public function testRender()
         $this->assertTrue((bool)strpos($ret, 'VAL0'));
         $this->assertStringEndsWith('VAL1', $ret);
     }
+
+    public function testInclude()
+    {
+        $date = date('Ymd');
+        $tt = new TextTemplate([
+            'name' => 'test',
+            'date' => $date,
+            'map' => [
+                'VAL0',
+                'key1' => 'VAL1',
+            ],
+        ]);
+
+        $ret = $tt->renderFile(__DIR__ . '/files/text-1.tpl');
+        var_dump($ret);
+        $this->assertTrue((bool)strpos($ret, $date));
+        $this->assertSame(0, strpos($ret, 'VAL0'));
+        $this->assertStringEndsWith('VAL1', $ret);
+    }
 }

tests/Components/files/text-0.tpl

@@ -0,0 +1,10 @@
+{$map.0}
+
+{*
+comments
+comments
+*}
+
+I am in the text-0.tpl
+
+{$map.key1}

tests/Components/files/text-1.tpl

@@ -0,0 +1,9 @@
+{#include 'text-0.tpl' }
+
+date: {$date}
+I am in the text-1.tpl
+{*
+comments
+comments
+*}
+{#include "text-0.tpl "}