Use string template engine to render language translations

Signed-off-by: Jack Cherng <[email protected]>

Author: jfcherng

.phan/config.php

@@ -18,6 +18,7 @@
         'src',
         'vendor/jfcherng/php-mb-string/src',
         'vendor/jfcherng/php-sequence-matcher/src',
+        'vendor/nicmart/string-template/src',
     ],
 
     // A directory list that defines files that will be excluded

composer.json

@@ -28,7 +28,8 @@
     "require": {
         "php": "^7.1.3",
         "jfcherng/php-mb-string": "^1.3",
-        "jfcherng/php-sequence-matcher": "^3.1"
+        "jfcherng/php-sequence-matcher": "^3.1",
+        "nicmart/string-template": "~0.1"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.15",

composer.lock

@@ -173,14 +173,15 @@ protected function updateLanguage($old, $new): self
     /**
      * A shorthand to do translation.
      *
-     * @param string $text       The text
-     * @param bool   $escapeHtml Escape the translated text for HTML?
+     * @param string $text         The text
+     * @param array  $placeholders The placeholders
+     * @param bool   $escapeHtml   Escape the translated text for HTML?
      *
      * @return string the translated text
      */
-    protected function _(string $text, bool $escapeHtml = true): string
+    protected function _(string $text, array $placeholders = [], bool $escapeHtml = true): string
     {
-        $text = $this->t->translate($text);
+        $text = $this->t->translate($text, $placeholders);
 
         return $escapeHtml ? \htmlspecialchars($text) : $text;
     }

src/Renderer/AbstractRenderer.php

@@ -4,8 +4,15 @@
 
 namespace Jfcherng\Diff\Utility;
 
+use StringTemplate\Engine as StringTemplateEngine;
+
 final class Language
 {
+    /**
+     * @var \StringTemplate\Engine
+     */
+    private $stringEngine;
+
     /**
      * @var string[] the translation dict
      */
@@ -23,6 +30,7 @@ final class Language
      */
     public function __construct($target = 'eng')
     {
+        $this->stringEngine = new StringTemplateEngine('{', '}');
         $this->setLanguageOrTranslations($target);
     }
 
@@ -106,13 +114,16 @@ public static function getTranslationsByLanguage(string $language): array
     /**
      * Translation the text.
      *
-     * @param string $text the text
+     * @param string $text         the text
+     * @param array  $placeholders the placeholders
      *
      * @return string
      */
-    public function translate(string $text): string
+    public function translate(string $text, array $placeholders = []): string
     {
-        return $this->translations[$text] ?? "![{$text}]";
+        return isset($this->translations[$text])
+            ? $this->stringEngine->render($this->translations[$text], $placeholders)
+            : "![{$text}]";
     }
 
     /**