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

ModelAutocompleteFilter response_item_callback parameter 3 for reference bug ! #7298

Closed askuiop closed 3 years ago

askuiop commented 3 years ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' sonata-project/admin-bundle 3.100.2 3.102.0 The missing Symfony Admin Generator sonata-project/block-bundle 4.6.0 4.6.0 Symfony SonataBlockBundle sonata-project/cache 2.1.1 2.1.1 Cache library sonata-project/doctrine-extensions 1.12.0 1.13.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 3.34.1 3.34.3 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.6.2 2.7.0 Lightweight Exporter library sonata-project/form-extensions 1.9.0 1.9.0 Symfony form extensions sonata-project/twig-extensions 1.6.0 1.6.0 Sonata twig extensions ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' symfony/asset v4.4.22 v5.3.2 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v4.4.24 v5.3.0 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programm... symfony/cache v4.4.24 v5.3.3 Provides an extended PSR-6, PSR-16 (and tags) implementation symfony/cache-contracts v2.4.0 v2.4.0 Generic abstractions related to caching symfony/config v4.4.23 v5.3.3 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v4.4.24 v5.3.2 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v4.4.24 v5.3.0 Converts CSS selectors to XPath expressions symfony/debug v4.4.22 v4.4.25 Provides tools to ease debugging PHP code symfony/debug-bundle v4.4.20 v5.3.0 Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework symfony/dependency-injection v4.4.24 v5.3.3 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v2.4.0 v2.4.0 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v4.4.24 v5.3.3 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v4.4.24 v5.3.0 Eases DOM navigation for HTML and XML documents symfony/dotenv v4.4.20 v5.3.0 Registers environment variables from a .env file symfony/error-handler v4.4.23 v5.3.3 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v4.4.20 v5.3.0 Provides tools that allow your application components to communicate with each other by dispatching events and l... symfony/event-dispatcher-contracts v1.1.9 v2.4.0 Generic abstractions related to dispatching event symfony/expression-language v4.4.22 v5.3.0 Provides an engine that can compile and evaluate expressions symfony/filesystem v4.4.22 v5.3.3 Provides basic utilities for the filesystem symfony/finder v4.4.24 v5.3.0 Finds files and directories via an intuitive fluent interface symfony/flex v1.13.3 v1.13.3 Composer plugin for Symfony symfony/form v4.4.24 v5.3.3 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v4.4.24 v5.3.3 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v4.4.24 v5.3.3 Provides powerful methods to fetch HTTP resources synchronously or asynchronously symfony/http-client-contracts v2.4.0 v2.4.0 Generic abstractions related to HTTP clients symfony/http-foundation v4.4.23 v5.3.3 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v4.4.24 v5.3.3 Provides a structured process for converting a Request into a Response symfony/inflector v4.4.23 v5.3.0 Converts words between their singular and plural forms (English only) Package symfony/inflector is abandoned, you should avoid using it. Use use `EnglishInflector` from the String component instead instead. symfony/intl v4.4.22 v5.3.0 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v4.4.22 v5.3.3 Helps sending emails symfony/maker-bundle v1.31.1 v1.33.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about... symfony/mime v4.4.24 v5.3.2 Allows manipulating MIME messages symfony/monolog-bridge v4.4.22 v5.3.3 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.7.0 v3.7.0 Symfony MonologBundle symfony/options-resolver v4.4.20 v5.3.0 Provides an improved replacement for the array_replace PHP function symfony/phpunit-bridge v5.2.9 v5.3.3 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-intl-grapheme v1.23.0 v1.23.0 Symfony polyfill for intl's grapheme_* functions symfony/polyfill-intl-icu v1.23.0 v1.23.0 Symfony polyfill for intl's ICU-related data and classes symfony/polyfill-intl-idn v1.23.0 v1.23.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions symfony/polyfill-intl-normalizer v1.23.0 v1.23.0 Symfony polyfill for intl's Normalizer class and related functions symfony/polyfill-mbstring v1.23.0 v1.23.0 Symfony polyfill for the Mbstring extension symfony/polyfill-php72 v1.23.0 v1.23.0 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions symfony/polyfill-php73 v1.23.0 v1.23.0 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions symfony/polyfill-php80 v1.23.0 v1.23.0 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions symfony/process v4.4.22 v5.3.2 Executes commands in sub-processes symfony/property-access v4.4.20 v5.3.0 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v4.4.23 v5.3.1 Extracts information about PHP class' properties using metadata of popular sources symfony/proxy-manager-bridge v4.4.24 v5.3.0 Provides integration for ProxyManager with various Symfony components symfony/routing v4.4.24 v5.3.0 Maps an HTTP request to a set of configuration variables symfony/security-acl v3.1.2 v3.1.2 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v4.4.23 v5.3.3 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v4.4.24 v5.3.3 Symfony Security Component - Core Library symfony/security-csrf v4.4.22 v5.3.3 Symfony Security Component - CSRF Library symfony/security-guard v4.4.23 v5.3.0 Symfony Security Component - Guard symfony/security-http v4.4.24 v5.3.3 Symfony Security Component - HTTP Integration symfony/serializer v4.4.24 v5.3.2 Handles serializing and deserializing data structures, including object graphs, into array structures or other f... symfony/service-contracts v2.4.0 v2.4.0 Generic abstractions related to writing services symfony/stopwatch v4.4.20 v5.3.0 Provides a way to profile code symfony/string v5.2.8 v5.3.3 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a un... symfony/translation v4.4.24 v5.3.3 Provides tools to internationalize your application symfony/translation-contracts v2.4.0 v2.4.0 Generic abstractions related to translation symfony/twig-bridge v4.4.22 v5.3.3 Provides integration for Twig with various Symfony components symfony/twig-bundle v4.4.24 v5.3.3 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v4.4.24 v5.3.3 Provides tools to validate values symfony/var-dumper v4.4.22 v5.3.3 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v4.4.23 v5.3.3 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v4.4.21 v5.3.3 Manages links between resources symfony/web-profiler-bundle v4.4.23 v5.3.2 Provides a development tool that gives detailed information about the execution of any request symfony/yaml v4.4.24 v5.3.3 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 7.3.27 (cli) (built: Mar  2 2021 14:44:24) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.27, Copyright (c) 1998-2018 Zend Technologies
    with Zend OPcache v7.3.27, Copyright (c) 1999-2018, by Zend Technologies

Subject

Minimal repository with the bug

Warning: Parameter 3 to App\Admin\XxxAdmin::App\Admin{closure}() expected to be a reference, value given in vendor/sonata-project/admin-bundle/src/Action/RetrieveAutocompleteItemsAction.php (line 228)

 227           if (\is_callable($responseItemCallback)) {
 228               \call_user_func($responseItemCallback, $admin, $model, $item);
 229           }

Steps to reproduce

$datagridMapper
->add('xxx',  ModelAutocompleteFilter::class, array(
                'admin_code' => 'admin.xxx',
            ), ModelAutocompleteType::class, [
                'property' => 'title',
                'minimum_input_length' => 2,
                'response_item_callback' => function ($admin, $entity, &$item) {
                    $item['client'] = $entity->getClientId();
                    $item['xx'] = 'yy';
                },
            ])
...

ModelAutocompleteFilter options response_item_callback doc : https://symfony.com/doc/current/bundles/SonataAdminBundle/reference/form_types.html#sonata-adminbundle-form-type-modelautocompletetype

VincentLanglet commented 3 years ago

The option was introduced here: https://github.com/sonata-project/SonataAdminBundle/pull/6789 by @keshancs I would say it never worked because call_user_func can only pass variable by value and not by reference.

IMHO working with reference is not great.

I would prefer to update the code to 

item = \call_user_func($responseItemCallback, $admin, $model, $item);

and the doc of response_item_callback to return an array.

'response_item_callback' => function ($admin, $entity, $item) {
                    $item['client'] = $entity->getClientId();
                    $item['xx'] = 'yy';

                    return $item;
                },

Can you do the PR @askuiop ?