Provide a negative unit test for the double translation of PR-104

[MatthiasKuehneEllerhold]

As requested in https://github.com/zendframework/zend-form/pull/104#issuecomment-350272000 I provide a negative unit test to prove that error message from zend-validator will get doubly translated.

Some notes:

• This tests uses some actual objects instead of mocks.
  • Especially Zend\Form\Form, Zend\Form\Element\Color, Zend\Validator\Regex, etc...
  • They should be replaced, but I wanted to show the error in a real-world example and not in a fully mocked-out test case that only shows what I tell them to.
• Zend\Form\Form uses duck-typing to fulfill Zend\InputFilter\InputFilterAwareInterface but not actually implementing it. Why is there no "implements InputFilterAwareInterface"?
• Zend\Validator\Translator\TranslatorInterface and Zend\I18n\Translator\TranslatorInterface are 2 different interfaces and only Zend\Mvc\I18n\Translator implements both. But thats not a dependency of this module.
  • Thats why I needed two different translator-mocks.

[weierophinney]

Why is there no "implements InputFilterAwareInterface"?

That code likely pre-dates the interface. That said, we're removing "Aware" interfaces everywhere, so I'm not sure it makes sense to add that check at this time, either.

[weierophinney]

In looking through this, I think there's really only one way we can achieve both the goals of #104 and resolve the issues you brought up in here: have two separate helpers, and a way to tell FormRow which one to use. This way the default behavior can revert to what it was pre-#104, and users can use the translatable variant on-demand as a helper, or tell formRow() which one to use prior to invoking it. My thought is something like this:

echo $this->formElementErrors($element); // no translation
echo $this->translatedFormElementErrors($element); // translated version

echo $this->formRow($element); // no translation
echo $this->formRow()->setErrorsHelper($this->translatedFormElementErrors()); // w/translation
$this->formRow()->setErrorsHelper($this->formElementErrors()); // reset to original variant

Thoughts?

[MatthiasKuehneEllerhold]

Wouldn't it be enough to make this behavior togglable in the current helper?

$this->formElementErrors()->setTranslateMessages(true);
echo $this->formRow($element); // helper will translate messages

$this->formElementErrors()->setTranslateMessages(false);
echo $this->formRow($element); // helper will not translate messages

I'd argue that the default value should be false (= no translation) because this was the behavior of most of the libraries lifetime and it only recently changed. On the other hand, setting it to false would be another BC break and should be avoided for all users that already have arrenged themselves with the new behavior.

[froschdesign]

Wouldn't it be enough to make this behavior togglable in the current helper?

I also prefer this solution. No need for:

• new view helpers
• extends of the formRow helper
• or other special handling

echo $this->formElementErrors($element); // no translation
echo $this->formElementErrors($element)->setTranslateMessages(true); // translated version

And the view helper formElementErrors already has some methods for messages:

• setMessageCloseString()
• getMessageCloseString()
• setMessageOpenFormat()
• getMessageOpenFormat()
• setMessageSeparatorString()
• getMessageSeparatorString()

[weierophinney]

@MatthiasKuehneEllerhold — I have pushed changes to your branch:

• I rebased
• I fixed a testing issue introduced by your new test
• I added the new method, setTranslateMessages()

As noted, I've kept the default to true, as that is the behavior currently. However, usage will be exactly like @froschdesign has noted above (you can set the flag and render in one step, or set it once, use it everywhere).

If both of you could review, I'd appreciate it!

[MatthiasKuehneEllerhold]

Your edits look fine to me! Thank you very much for listening and keeping this issue on your radar.

I have just a small correction for the example calls from @froschdesign:

echo $this->formElementErrors($element); // no translation
echo $this->formElementErrors()->setTranslateMessages(true)->render($element); // translated version

Otherwise: if you call the helper with an $element it'll return a string and not the Helper itself! Seems like you fixed it in the release notes yourself.

[froschdesign]

@MatthiasKuehneEllerhold

I have just a small correction for the example calls…

That's right, only the navigation view helpers have a __toString() method.

That's why we need the documentation. (#203)