Fix help deprecation

sonata-project · Aug 30, 2020 · 63de836 · 63de836
1 parent 951df1a
commit 63de836
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 14 deletions.
diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md
@@ -40,8 +40,14 @@ You MUST use Symfony's [`help`](https://symfony.com/doc/4.4/reference/forms/type
 Before:
 ```php
 $formMapper
-    ->add('field', null, [
+    ->add('field', null, [], [
         'help' => 'Help text <small>Please!</small>',
+    ])
+    ->add('field2')
+    ->addHelp('field2', 'This field is required.')
+    ->add('field3')
+    ->setHelps([
+        'field3' => 'Great day to great work!',
     ]);
 ```
 
@@ -51,6 +57,12 @@ $formMapper
     ->add('field', null, [
         'help' => 'Help text <small>Please!</small>',
         'help_html' => true,
+    ])
+    ->add('field2', null, [
+        'help' => 'This field is required.'
+    ])
+    ->add('field3', null, [
+        'help' => 'Great day to great work!'
     ]);
 ```
 

diff --git a/src/Admin/BaseFieldDescription.php b/src/Admin/BaseFieldDescription.php
@@ -475,13 +475,22 @@ public function setHelp($help)
         $this->help = $help;
     }
 
+    /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.x and will be removed in version 4.0. Use Symfony Form "help" option instead.
+     *
+     * @return string
+     */
     public function getHelp()
     {
-        @trigger_error(sprintf(
-            'The "%s()" method is deprecated since sonata-project/admin-bundle 3.74 and will be removed in version 4.0.'
-            .' Use Symfony Form "help" option instead.',
-            __METHOD__
-        ), E_USER_DEPRECATED);
+        if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
+            @trigger_error(sprintf(
+                'The "%s()" method is deprecated since sonata-project/admin-bundle 3.74 and will be removed in version 4.0.'
+                .' Use Symfony Form "help" option instead.',
+                __METHOD__
+            ), E_USER_DEPRECATED);
+        }
 
         return $this->help;
     }

diff --git a/src/Resources/views/Form/form_admin_fields.html.twig b/src/Resources/views/Form/form_admin_fields.html.twig
@@ -33,11 +33,13 @@ file that was distributed with this source code.
 {% endapply %}
 {% endblock %}
 
-{% block form_help %}
-    {% apply spaceless %}
-        <span class="help-block sonata-ba-field-widget-help sonata-ba-field-help">{{ parent() }}</span>
-    {% endapply %}
-{% endblock %}
+{% block form_help -%}
+    {% if help is not empty %}
+        {# NEXT_MAJOR: Remove class sonata-ba-field-widget-help #}
+        {% set help_attr = help_attr|merge({class: (help_attr.class|default('') ~ ' help-block sonata-ba-field-widget-help sonata-ba-field-help')}) %}
+        {{ parent() }}
+    {% endif %}
+{%- endblock form_help %}
 
 {% block form_widget -%}
     {{ parent() }}
@@ -401,8 +403,7 @@ file that was distributed with this source code.
             {% endif %}
 
             {# NEXT_MAJOR: Remove this block #}
-            {% if sonata_admin is defined and sonata_admin_enabled and sonata_admin.field_description.help|default(false) %}
-                {% deprecated 'The "help" option is deprecated in field description since sonata-project/admin-bundle 3.74, to be removed in 4.0. Use Symfony Form "help" option instead.' %}
+            {% if sonata_admin is defined and sonata_admin_enabled and sonata_admin.field_description.getHelp('sonata_deprecation_mute')|default(false) %}
                 <span class="help-block sonata-ba-field-help">{{ sonata_admin.field_description.help|trans(help_translation_parameters, sonata_admin.field_description.translationDomain ?: admin.translationDomain)|raw }}</span>
             {% endif %}
 

diff --git a/tests/Functional/Controller/CRUDControllerTest.php b/tests/Functional/Controller/CRUDControllerTest.php
@@ -52,7 +52,7 @@ public function testCreate(): void
         );
         $this->assertCount(
             1,
-            $crawler->filter('.sonata-ba-field-help:contains("Help me!")')
+            $crawler->filter('p.help-block.sonata-ba-field-help:contains("Help me!")')
         );
     }
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,7 +52,7 @@ public function testCreate(): void @@
             );
             $this->assertCount(
 ,
-                $crawler->filter('.sonata-ba-field-help:contains("Help me!")')
+                $crawler->filter('p.help-block.sonata-ba-field-help:contains("Help me!")')
             );
         }
@@ Expand Down @@