Merge branch 'hotfix/188-double-translation' into develop

Forward port #188

Author: weierophinney

CHANGELOG.md

@@ -34,7 +34,19 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#188](https://github.com/zendframework/zend-form/pull/188) adds a new method to the `FormElementErrors` view helper, `setTranslateMessages(bool $flag)`.
+  By default, the helper continues to translate error messages (if a translator
+  is present), as introduced in 2.11.0. However, using this method, you can
+  disable translation, which may be necessary to prevent double translation
+  and/or to reduce logs from missed translation lookups. Because the method
+  implements a fluent interface, you may do so in one line:
+  
+  ```php
+  echo $this->formElementErrors()->setTranslateMessages(false);
+  ```
+  
+  Note: you will need to reset the value afterwards if you want translations to occur
+  in later invocations.
 
 ### Changed
 

src/View/Helper/FormElementErrors.php

@@ -28,6 +28,11 @@ class FormElementErrors extends AbstractHelper
      */
     protected $attributes = [];
 
+    /**
+     * @var bool Whether or not to translate error messages during render.
+     */
+    protected $translateErrorMessages = true;
+
     /**
      * Invoke helper as functor
      *
@@ -49,6 +54,10 @@ public function __invoke(ElementInterface $element = null, array $attributes = [
     /**
      * Render validation errors for the provided $element
      *
+     * If {@link $translateErrorMessages} is true, and a translator is
+     * composed, messages retrieved from the element will be translated; if
+     * either is not the case, they will not.
+     *
      * @param  ElementInterface $element
      * @param  array $attributes
      * @throws Exception\DomainException
@@ -60,39 +69,32 @@ public function render(ElementInterface $element, array $attributes = [])
         if (empty($messages)) {
             return '';
         }
-        if (! is_array($messages) && ! $messages instanceof Traversable) {
+
+        $messages = $messages instanceof Traversable ? iterator_to_array($messages) : $messages;
+        if (! is_array($messages)) {
             throw new Exception\DomainException(sprintf(
                 '%s expects that $element->getMessages() will return an array or Traversable; received "%s"',
                 __METHOD__,
                 (is_object($messages) ? get_class($messages) : gettype($messages))
             ));
         }
 
+        // Flatten message array
+        $messages = $this->flattenMessages($messages);
+        if (empty($messages)) {
+            return '';
+        }
+
         // Prepare attributes for opening tag
         $attributes = array_merge($this->attributes, $attributes);
         $attributes = $this->createAttributesString($attributes);
         if (! empty($attributes)) {
             $attributes = ' ' . $attributes;
         }
 
-        // Flatten message array
-        $escapeHtml      = $this->getEscapeHtmlHelper();
-        $messagesToPrint = [];
-        $translator      = $this->getTranslator();
-        $textDomain      = $this->getTranslatorTextDomain();
-        $messageCallback = function ($item) use (&$messagesToPrint, $escapeHtml, $translator, $textDomain) {
-            $item = $translator ? $translator->translate($item, $textDomain) : $item;
-            $messagesToPrint[] = $escapeHtml($item);
-        };
-        array_walk_recursive($messages, $messageCallback);
-
-        if (empty($messagesToPrint)) {
-            return '';
-        }
-
         // Generate markup
         $markup  = sprintf($this->getMessageOpenFormat(), $attributes);
-        $markup .= implode($this->getMessageSeparatorString(), $messagesToPrint);
+        $markup .= implode($this->getMessageSeparatorString(), $messages);
         $markup .= $this->getMessageCloseString();
 
         return $markup;
@@ -185,4 +187,56 @@ public function getMessageSeparatorString()
     {
         return $this->messageSeparatorString;
     }
+
+    /**
+     * Set the flag detailing whether or not to translate error messages.
+     *
+     * @param bool $flag
+     * @return self
+     */
+    public function setTranslateMessages($flag)
+    {
+        $this->translateErrorMessages = (bool) $flag;
+        return $this;
+    }
+
+    /**
+     * @param array $messages
+     * @return array
+     */
+    private function flattenMessages(array $messages)
+    {
+        return $this->translateErrorMessages && $this->getTranslator()
+            ? $this->flattenMessagesWithTranslator($messages)
+            : $this->flattenMessagesWithoutTranslator($messages);
+    }
+
+    /**
+     * @param array $messages
+     * @return array
+     */
+    private function flattenMessagesWithoutTranslator(array $messages)
+    {
+        $messagesToPrint = [];
+        array_walk_recursive($messages, function ($item) use (&$messagesToPrint) {
+            $messagesToPrint[] = $item;
+        });
+        return $messagesToPrint;
+    }
+
+    /**
+     * @param array $messages
+     * @return array
+     */
+    private function flattenMessagesWithTranslator(array $messages)
+    {
+        $translator      = $this->getTranslator();
+        $textDomain      = $this->getTranslatorTextDomain();
+        $messagesToPrint = [];
+        $messageCallback = function ($item) use (&$messagesToPrint, $translator, $textDomain) {
+            $messagesToPrint[] = $translator->translate($item, $textDomain);
+        };
+        array_walk_recursive($messages, $messageCallback);
+        return $messagesToPrint;
+    }
 }

test/View/Helper/FormElementErrorsTest.php

@@ -10,16 +10,29 @@
 namespace ZendTest\Form\View\Helper;
 
 use Zend\Form\Element;
+use Zend\Form\Form;
 use Zend\Form\View\Helper\FormElementErrors as FormElementErrorsHelper;
+use Zend\Validator\AbstractValidator;
 
 class FormElementErrorsTest extends CommonTestCase
 {
+    /**
+     * @var null|\Zend\Validator\Translator\TranslatorInterface
+     */
+    protected $defaultTranslator;
+
     public function setUp()
     {
+        $this->defaultTranslator = AbstractValidator::getDefaultTranslator();
         $this->helper = new FormElementErrorsHelper();
         parent::setUp();
     }
 
+    public function tearDown()
+    {
+        AbstractValidator::setDefaultTranslator($this->defaultTranslator);
+    }
+
     public function getMessageList()
     {
         return [
@@ -76,6 +89,53 @@ public function testRendersErrorMessagesUsingUnorderedListTranslated()
         // @codingStandardsIgnoreEnd
     }
 
+    public function testRendersErrorMessagesWithoutDoubleTranslation()
+    {
+        $form = new Form('test_form');
+        $form->add([
+            'name' => 'test_element',
+            'type' => Element\Color::class,
+        ]);
+        $form->setData(['test_element' => 'This is invalid!']);
+
+        $mockValidatorTranslator = $this->createMock('Zend\Validator\Translator\TranslatorInterface');
+        $mockValidatorTranslator
+            ->expects(self::once())
+            ->method('translate')
+            ->willReturnCallback(
+                function ($message) {
+                    self::assertEquals(
+                        'The input does not match against pattern \'%pattern%\'',
+                        $message,
+                        'Unexpected translation key.'
+                    );
+
+                    return 'TRANSLATED: The input does not match against pattern \'%pattern%\'';
+                }
+            );
+
+        AbstractValidator::setDefaultTranslator($mockValidatorTranslator, 'default');
+
+        self::assertFalse($form->isValid());
+
+        $mockFormTranslator = $this->createMock('Zend\I18n\Translator\Translator');
+        $mockFormTranslator
+            ->expects(self::never())
+            ->method('translate');
+
+        $this->helper->setTranslator($mockFormTranslator);
+        $this->assertTrue($this->helper->hasTranslator());
+
+        $this->helper->setTranslatorTextDomain('default');
+
+        // Disable translation...
+        $this->helper->setTranslateMessages(false);
+
+        $markup = $this->helper->render($form->get('test_element'));
+
+        $this->assertRegexp('#^<ul>\s*<li>TRANSLATED#s', $markup);
+    }
+
     public function testCanSpecifyAttributesForOpeningTag()
     {
         $messages = $this->getMessageList();