Merge pull request #399 from koenvu/master

Add translation template for labels
kristijanhusak · Feb 13, 2018 · 9861696 · 9861696
2 parents 264ce72 + 24a97d1
commit 9861696
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 3 deletions.
diff --git a/src/Kris/LaravelFormBuilder/Fields/ChildFormType.php b/src/Kris/LaravelFormBuilder/Fields/ChildFormType.php
@@ -116,7 +116,8 @@ protected function getClassFromOptions()
             $options = [
                 'model' => $this->getOption($this->valueProperty) ?: $this->parent->getModel(),
                 'name' => $this->name,
-                'language_name' => $this->parent->getLanguageName()
+                'language_name' => $this->parent->getLanguageName(),
+                'translation_template' => $this->parent->getTranslationTemplate(),
             ];
 
             if (!$this->parent->clientValidationEnabled()) {
@@ -146,6 +147,10 @@ protected function getClassFromOptions()
                 $class->setLanguageName($this->parent->getLanguageName());
             }
 
+            if (!$class->getTranslationTemplate()) {
+                $class->setTranslationTemplate($this->parent->getTranslationTemplate());
+            }
+
             if (!$this->parent->clientValidationEnabled()) {
                 $class->setClientValidationEnabled(false);
             }

diff --git a/src/Kris/LaravelFormBuilder/Fields/FormField.php b/src/Kris/LaravelFormBuilder/Fields/FormField.php
@@ -203,7 +203,8 @@ public function render(array $options = [], $showLabel = true, $showField = true
                 'options' => $this->options,
                 'showLabel' => $showLabel,
                 'showField' => $showField,
-                'showError' => $showError
+                'showError' => $showError,
+                'translationTemplate' => $this->parent->getTranslationTemplate(),
             ]
         )->render();
     }
@@ -593,7 +594,13 @@ protected function setupLabel()
             return;
         }
 
-        if ($langName = $this->parent->getLanguageName()) {
+        if ($template = $this->parent->getTranslationTemplate()) {
+            $label = str_replace(
+                ['{name}', '{type}'],
+                [$this->getRealName(), 'label'],
+                $template
+            );
+        } elseif ($langName = $this->parent->getLanguageName()) {
             $label = sprintf('%s.%s', $langName, $this->getRealName());
         } else {
             $label = $this->getRealName();

diff --git a/src/Kris/LaravelFormBuilder/Form.php b/src/Kris/LaravelFormBuilder/Form.php
@@ -122,6 +122,11 @@ class Form
      */
     protected $languageName;
 
+    /**
+     * @var string
+     */
+    protected $translationTemplate;
+
     /**
      * To filter and mutate request values or not.
      *
@@ -491,6 +496,7 @@ public function setFormOptions(array $formOptions)
         $this->pullFromOptions('client_validation', 'setClientValidationEnabled');
         $this->pullFromOptions('template_prefix', 'setTemplatePrefix');
         $this->pullFromOptions('language_name', 'setLanguageName');
+        $this->pullFromOptions('translation_template', 'setTranslationTemplate');
 
         return $this;
     }
@@ -870,6 +876,29 @@ public function setLanguageName($prefix)
         return $this;
     }
 
+    /**
+     * Get the translation template.
+     *
+     * @return string
+     */
+    public function getTranslationTemplate()
+    {
+        return $this->translationTemplate;
+    }
+
+    /**
+     * Set a translation template, used to determine labels for fields.
+     *
+     * @param string $template
+     * @return $this
+     */
+    public function setTranslationTemplate($template)
+    {
+        $this->translationTemplate = (string) $template;
+
+        return $this;
+    }
+
     /**
      * Render the form.
      *

diff --git a/tests/Fields/ChildFormTypeTest.php b/tests/Fields/ChildFormTypeTest.php
@@ -19,6 +19,18 @@ public function it_implicitly_inherits_language_name()
         $this->assertEquals('test_name', $plainChild->getLanguageName());
     }
 
+    /** @test */
+    public function it_implicitly_inherits_translation_template()
+    {
+        $plainParent = $this->formBuilder->plain(['translation_template' => 'form.{name}.{type}']);
+        $plainChild = $this->formBuilder->plain();
+
+        $plainParent->add('a form', 'form', ['class' => $plainChild]);
+
+        $this->assertEquals($plainParent->getTranslationTemplate(), $plainChild->getTranslationTemplate());
+        $this->assertEquals('form.{name}.{type}', $plainChild->getTranslationTemplate());
+    }
+
     /** @test */
     public function it_does_not_overwrite_language_name()
     {
@@ -30,4 +42,16 @@ public function it_does_not_overwrite_language_name()
         $this->assertEquals('different_name', $plainChild->getLanguageName());
         $this->assertEquals('test_name', $plainParent->getLanguageName());
     }
+
+    /** @test */
+    public function it_does_not_overwrite_translation_template()
+    {
+        $plainParent = $this->formBuilder->plain(['translation_template' => 'test.{name}']);
+        $plainChild = $this->formBuilder->plain(['translation_template' => 'different.{name}']);
+
+        $plainParent->add('a form', 'form', ['class' => $plainChild]);
+
+        $this->assertEquals('different.{name}', $plainChild->getTranslationTemplate());
+        $this->assertEquals('test.{name}', $plainParent->getTranslationTemplate());
+    }
 }
diff --git a/tests/Fields/FormFieldTest.php b/tests/Fields/FormFieldTest.php
@@ -171,6 +171,19 @@ public function it_translates_the_label_if_translation_exists()
         );
     }
 
+    /** @test */
+    public function it_translates_the_label_using_translation_templates()
+    {
+        // We use build in validation translations prefix for easier testing
+        // just to make sure translation file is properly used
+        $this->plainForm->setTranslationTemplate('validation.{name}')->add('accepted', 'text');
+
+        $this->assertEquals(
+            'The :attribute must be accepted.',
+            $this->plainForm->accepted->getOption('label')
+        );
+    }
+
     /** @test */
     public function provided_label_from_option_overrides_translated_one()
     {