[BUGFIX] Validation error arguments are not applied

If an extbase error object wants to be translated through EXT:form and
no translation is found, the original error message will be shown.
Possibly existing error message arguments must be applied by calling
the error objects __toString() method.

Resolves: #84449
Releases: master, 8.7
Change-Id: I3d1f92a7d9c9abcc239bdab17b42a2cbb9e98d94
Reviewed-on: https://review.typo3.org/56328
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Kay Strobach <typo3@kay-strobach.de>
Tested-by: Kay Strobach <typo3@kay-strobach.de>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Frank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Naegler <frank.naegler@typo3.org>

diff --git a/typo3/sysext/core/Documentation/Changelog/8.7.x/Deprecation-84449-TranslateElementErrorViewHelperArguments.rst b/typo3/sysext/core/Documentation/Changelog/8.7.x/Deprecation-84449-TranslateElementErrorViewHelperArguments.rst
new file mode 100644 (file)
index 0000000..1b0d7cb
--- /dev/null
+++ b/typo3/sysext/core/Documentation/Changelog/8.7.x/Deprecation-84449-TranslateElementErrorViewHelperArguments.rst
@@ -0,0 +1,47 @@
+.. include:: ../../Includes.txt
+
+===============================================================
+Deprecation: #84449 - TranslateElementErrorViewHelper arguments
+===============================================================
+
+See :issue:`84449`
+
+Description
+===========
+
+The template EXT:form/Resources/Private/Frontend/Partials/Field/Field.html has been changed. This
+was necessary because of a bug with validation messages containing arguments.
+For compatibility reasons, the old template syntax is still supported but is deprecated and will be
+removed with TYPO3 v10.
+
+Impact
+======
+
+If a user utilizes his own template for EXT:form/Resources/Private/Frontend/Partials/Field/Field.html,
+a deprecation warning will be thrown.
+
+
+Affected Installations
+======================
+
+Any installation which uses the form framework and a customized template for
+EXT:form/Resources/Private/Frontend/Partials/Field/Field.html.
+
+
+Migration
+=========
+
+Change
+
+.. code-block:: html
+
+   {formvh:translateElementError(element: element, code: error.code, arguments: error.arguments, defaultValue: error.message)}
+
+to
+
+.. code-block:: html
+
+   {formvh:translateElementError(element: element, error: error)}
+
+
+.. index:: Frontend, ext:form
\ No newline at end of file

diff --git a/typo3/sysext/form/Classes/ViewHelpers/TranslateElementErrorViewHelper.php b/typo3/sysext/form/Classes/ViewHelpers/TranslateElementErrorViewHelper.php
index a72528f..3133aa0 100644 (file)
--- a/typo3/sysext/form/Classes/ViewHelpers/TranslateElementErrorViewHelper.php
+++ b/typo3/sysext/form/Classes/ViewHelpers/TranslateElementErrorViewHelper.php
@@ -15,6 +15,7 @@ namespace TYPO3\CMS\Form\ViewHelpers;
  * The TYPO3 project - inspiring people to share!
  */
 
+use TYPO3\CMS\Extbase\Validation\Error;
 use TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
 use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 use TYPO3\CMS\Form\Service\TranslationService;
@@ -40,9 +41,10 @@ class TranslateElementErrorViewHelper extends AbstractViewHelper
     public function initializeArguments()
     {
         $this->registerArgument('element', RootRenderableInterface::class, 'Form Element to translate', true);
-        $this->registerArgument('code', 'integer', 'Error code', true);
-        $this->registerArgument('arguments', 'array', 'Error arguments', false, null);
-        $this->registerArgument('defaultValue', 'string', 'The default value', false, '');
+        $this->registerArgument('error', Error::class, '', false, '');
+        $this->registerArgument('code', 'integer', 'Error code - deprecated', false, '');
+        $this->registerArgument('arguments', 'array', 'Error arguments - deprecated', false, null);
+        $this->registerArgument('defaultValue', 'string', 'The default value - deprecated', false, '');
     }
 
     /**
@@ -57,6 +59,22 @@ class TranslateElementErrorViewHelper extends AbstractViewHelper
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
         $element = $arguments['element'];
+        $error = $arguments['error'];
+
+        $code = $arguments['code'];
+        $errorArguments = $arguments['arguments'];
+        $defaultValue = $arguments['defaultValue'];
+
+        if ($error instanceof Error) {
+            $code = $error->getCode();
+            $errorArguments = $error->getArguments();
+            $defaultValue = $error->__toString();
+        } else {
+            trigger_error(
+                'TranslateElementErrorViewHelper arguments "code", "arguments" and "defaultValue" has been deprecated in v8 and will be removed in v10. Use "error" instead.',
+                E_USER_DEPRECATED
+            );
+        }
 
         /** @var FormRuntime $formRuntime */
         $formRuntime = $renderingContext
@@ -65,9 +83,9 @@ class TranslateElementErrorViewHelper extends AbstractViewHelper
 
         return TranslationService::getInstance()->translateFormElementError(
             $element,
-            $arguments['code'],
-            $arguments['arguments'],
-            $arguments['defaultValue'],
+            $code,
+            $errorArguments,
+            $defaultValue,
             $formRuntime
         );
     }

diff --git a/typo3/sysext/form/Resources/Private/Frontend/Partials/Field/Field.html b/typo3/sysext/form/Resources/Private/Frontend/Partials/Field/Field.html
index 3b01de7..2f993fe 100644 (file)
--- a/typo3/sysext/form/Resources/Private/Frontend/Partials/Field/Field.html
+++ b/typo3/sysext/form/Resources/Private/Frontend/Partials/Field/Field.html
@@ -10,7 +10,7 @@
                                <f:if condition="{validationResults.flattenedErrors}">
                                        <span class="error help-block" role="alert">
                                                <f:for each="{validationResults.errors}" as="error">
-                                                       {formvh:translateElementError(element: element, code: error.code, arguments: error.arguments, defaultValue: error.message)}
+                                                       {formvh:translateElementError(element: element, error: error)}
                                                        <br />
                                                </f:for>
                                        </span>