Fix help deprecation

sonata-project · Aug 27, 2020 · a6961b8 · a6961b8
1 parent 0740ee1
commit a6961b8
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 15 deletions.
diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md
@@ -40,7 +40,7 @@ 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>',
     ]);
 ```

diff --git a/src/Admin/BaseFieldDescription.php b/src/Admin/BaseFieldDescription.php
@@ -475,14 +475,15 @@ 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);
-
         return $this->help;
     }
 

diff --git a/src/Form/FormMapper.php b/src/Form/FormMapper.php
@@ -137,10 +137,10 @@ public function add($name, $type = null, array $options = [], array $fieldDescri
             }
 
             // NEXT_MAJOR: Remove this block.
-            if (isset($options['help'])) {
+            if (isset($options['help']) && !isset($options['help_html'])) {
                 $containsHtml = $options['help'] !== strip_tags($options['help']);
 
-                if (!isset($options['help_html']) && $containsHtml) {
+                if ($containsHtml) {
                     @trigger_error(
                         'Using HTML syntax within the "help" option and not setting the "help_html" option to "true" is deprecated'
                         .' since sonata-project/admin-bundle 3.74 and it will not work in version 4.0.',

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,12 @@ 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 %}
+        {% set help_attr = help_attr|merge({class: (help_attr.class|default('') ~ ' help-block sonata-ba-field-help')}) %}
+        {{ parent() }}
+    {% endif %}
+{%- endblock form_help %}
 
 {% block form_widget -%}
     {{ parent() }}

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!")')
         );
     }