search

sonata-project / SonataAdminBundle

The missing Symfony Admin Generator
https://docs.sonata-project.org/projects/SonataAdminBundle
MIT License
2.11k stars 1.26k forks source link

Twig template produces deprecation message for Sonata\AdminBundle\Admin\BaseFieldDescription::getHelp() #6664

Closed simplegr closed 3 years ago

simplegr commented 3 years ago

Environment

Sonata packages

$ composer show --latest 'sonata-project/*'

sonata-project/admin-bundle              3.82.0 3.82.0 The missing Symfony Admin Generator
sonata-project/block-bundle              4.4.0  4.4.0  Symfony SonataBlockBundle
sonata-project/cache                     2.0.1  2.0.1  Cache library
sonata-project/datagrid-bundle           3.2.0  3.2.0  Symfony SonataDatagridBundle
sonata-project/doctrine-extensions       1.10.1 1.10.1 Doctrine2 behavioral extensions
sonata-project/doctrine-orm-admin-bundle 3.26.0 3.26.0 Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/easy-extends-bundle       2.5.0  2.5.0  Symfony SonataEasyExtendsBundle
sonata-project/exporter                  2.4.1  2.4.1  Lightweight Exporter library
sonata-project/form-extensions           1.7.1  1.7.1  Symfony form extensions
sonata-project/twig-extensions           1.4.1  1.4.1  Sonata twig extensions
sonata-project/user-bundle               4.10.1 4.10.1 Symfony SonataUserBundle

Symfony packages

$ composer show --latest 'symfony/*'

symfony/apache-pack                v1.0.1  v1.0.1  A pack for Apache support in Symfony
symfony/asset                      v4.4.17 v4.4.17 Symfony Asset Component
symfony/browser-kit                v4.4.17 v4.4.17 Symfony BrowserKit Component
symfony/cache                      v4.4.17 v4.4.17 Symfony Cache component with PSR-6, PSR-16, and tags
symfony/cache-contracts            v2.2.0  v2.2.0  Generic abstractions related to caching
symfony/config                     v4.4.17 v4.4.17 Symfony Config Component
symfony/console                    v4.4.17 v4.4.17 Symfony Console Component
symfony/css-selector               v4.4.17 v4.4.17 Symfony CssSelector Component
symfony/debug                      v4.4.17 v4.4.17 Symfony Debug Component
symfony/debug-bundle               v4.4.17 v4.4.17 Symfony DebugBundle
symfony/debug-pack                 v1.0.9  v1.0.9  A debug pack for Symfony projects
symfony/dependency-injection       v4.4.17 v4.4.17 Symfony DependencyInjection Component
symfony/deprecation-contracts      v2.2.0  v2.2.0  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v4.4.17 v4.4.17 Symfony Doctrine Bridge
symfony/dom-crawler                v4.4.17 v4.4.17 Symfony DomCrawler Component
symfony/dotenv                     v4.4.17 v4.4.17 Registers environment variables from a .env file
symfony/error-handler              v4.4.17 v4.4.17 Symfony ErrorHandler Component
symfony/event-dispatcher           v4.4.17 v4.4.17 Symfony EventDispatcher Component
symfony/event-dispatcher-contracts v1.1.9  v2.2.0  Generic abstractions related to dispatching event
symfony/expression-language        v4.4.17 v4.4.17 Symfony ExpressionLanguage Component
symfony/filesystem                 v4.4.17 v4.4.17 Symfony Filesystem Component
symfony/finder                     v4.4.17 v4.4.17 Symfony Finder Component
symfony/flex                       v1.11.0 v1.11.0 Composer plugin for Symfony
symfony/form                       v4.4.17 v4.4.17 Symfony Form Component
symfony/framework-bundle           v4.4.17 v4.4.17 Symfony FrameworkBundle
symfony/http-client-contracts      v2.3.1  v2.3.1  Generic abstractions related to HTTP clients
symfony/http-foundation            v4.4.17 v4.4.17 Symfony HttpFoundation Component
symfony/http-kernel                v4.4.17 v4.4.17 Symfony HttpKernel Component
symfony/inflector                  v4.4.17 v4.4.17 Symfony Inflector Component
symfony/intl                       v4.4.17 v4.4.17 A PHP replacement layer for the C intl extension that includes additional data from the ICU library.
symfony/mailer                     v4.4.17 v4.4.17 Symfony Mailer Component
symfony/maker-bundle               v1.25.0 v1.25.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/mime                       v4.4.17 v4.4.17 A library to manipulate MIME messages
symfony/monolog-bridge             v4.4.17 v4.4.17 Symfony Monolog Bridge
symfony/monolog-bundle             v3.6.0  v3.6.0  Symfony MonologBundle
symfony/options-resolver           v4.4.17 v4.4.17 Symfony OptionsResolver Component
symfony/orm-pack                   v1.2.0  v2.0.0  A pack for the Doctrine ORM
symfony/phpunit-bridge             v4.4.17 v5.2.0  Symfony PHPUnit Bridge
symfony/polyfill-intl-grapheme     v1.20.0 v1.20.0 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-icu          v1.20.0 v1.20.0 Symfony polyfill for intl's ICU-related data and classes
symfony/polyfill-intl-idn          v1.20.0 v1.20.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.20.0 v1.20.0 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.20.0 v1.20.0 Symfony polyfill for the Mbstring extension
symfony/polyfill-php72             v1.20.0 v1.20.0 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions
symfony/polyfill-php73             v1.20.0 v1.20.0 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
symfony/polyfill-php80             v1.20.0 v1.20.0 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/process                    v4.4.17 v4.4.17 Symfony Process Component
symfony/profiler-pack              v1.0.5  v1.0.5  A pack for the Symfony web profiler
symfony/property-access            v4.4.17 v4.4.17 Symfony PropertyAccess Component
symfony/property-info              v4.4.17 v4.4.17 Symfony Property Info Component
symfony/routing                    v4.4.17 v4.4.17 Symfony Routing Component
symfony/security-acl               v3.1.0  v3.1.0  Symfony Security Component - ACL (Access Control List)
symfony/security-bundle            v4.4.17 v4.4.17 Symfony SecurityBundle
symfony/security-core              v4.4.17 v4.4.17 Symfony Security Component - Core Library
symfony/security-csrf              v4.4.17 v4.4.17 Symfony Security Component - CSRF Library
symfony/security-guard             v4.4.17 v4.4.17 Symfony Security Component - Guard
symfony/security-http              v4.4.17 v4.4.17 Symfony Security Component - HTTP Integration
symfony/serializer                 v4.4.17 v4.4.17 Symfony Serializer Component
symfony/serializer-pack            v1.0.4  v1.0.4  A pack for the Symfony serializer
symfony/service-contracts          v2.2.0  v2.2.0  Generic abstractions related to writing services
symfony/stopwatch                  v4.4.17 v4.4.17 Symfony Stopwatch Component
symfony/string                     v5.2.0  v5.2.0  Symfony String component
symfony/swiftmailer-bundle         v3.5.1  v3.5.1  Symfony SwiftmailerBundle
symfony/templating                 v4.4.17 v4.4.17 Symfony Templating Component
symfony/test-pack                  v1.0.7  v1.0.7  A pack for functional and end-to-end testing within a Symfony app
symfony/translation                v4.4.17 v4.4.17 Symfony Translation Component
symfony/translation-contracts      v2.3.0  v2.3.0  Generic abstractions related to translation
symfony/twig-bridge                v4.4.17 v4.4.17 Symfony Twig Bridge
symfony/twig-bundle                v4.4.17 v4.4.17 Symfony TwigBundle
symfony/validator                  v4.4.17 v4.4.17 Symfony Validator Component
symfony/var-dumper                 v4.4.17 v4.4.17 Symfony mechanism for exploring and dumping PHP variables
symfony/var-exporter               v4.4.17 v4.4.17 A blend of var_export() + serialize() to turn any serializable data structure to plain PHP code
symfony/web-link                   v4.4.17 v4.4.17 Symfony WebLink Component
symfony/web-profiler-bundle        v4.4.17 v4.4.17 Symfony WebProfilerBundle
symfony/webpack-encore-bundle      v1.8.0  v1.8.0  Integration with your Symfony app & Webpack Encore!
symfony/yaml                       v4.4.17 v4.4.17 Symfony Yaml Component

PHP version

$ php -v

PHP 7.3.16 (cli) (built: Mar 17 2020 13:33:00) ( ZTS MSVC15 (Visual C++ 2017) x64 )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.16, Copyright (c) 1998-2018 Zend Technologies
    with Zend OPcache v7.3.16, Copyright (c) 1999-2018, by Zend Technologies

Subject

In twig template edit_one_to_many_inline_table.html.twig the following line 55: {% if sonata_admin.field_description.associationadmin.formfielddescriptions[field_name].help %}

calls BaseFieldDescription::getHelp() and produces deprecation message:

User Deprecated: The "Sonata\AdminBundle\Admin\BaseFieldDescription::getHelp()" method is deprecated since sonata-project/admin-bundle 3.74 and will be removed in version 4.0. Use Symfony Form "help" option instead.

just for checking if help exists.

Minimal repository with the bug

Steps to reproduce

Expected results

Should not produce deprecation message if sonata_admin.field_description.associationadmin.formfielddescriptions[field_name].help is null

Actual results

VincentLanglet commented 3 years ago

See https://github.com/sonata-project/SonataAdminBundle/blob/3.x/src/Admin/BaseFieldDescription.php#L542

We should replace 

sonata_admin.field_description.associationadmin.formfielddescriptions[field_name].help

By

sonata_admin.field_description.associationadmin.formfielddescriptions[field_name].getHelp('sonata_deprecation_mute')

Can you try it and provide a PR @simplegr ?