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

[4.0.0-alpha-2] ModelAutocompleteFilter : "The required option "property" is missing #7236

Closed Fl0ux closed 3 years ago

Fl0ux commented 3 years ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' sonata-project/admin-bundle 4.0.0-alpha-2 4.0.0-alpha-2 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.12.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 4.0.0-alpha-2 4.0.0-alpha-2 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.6.2 2.6.2 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 v5.3.0 v5.3.0 Manages URL generation and versioning of web assets such as CSS stylesheets, ... symfony/browser-kit v5.3.0 v5.3.0 Simulates the behavior of a web browser, allowing you to make requests, click... symfony/cache v5.3.0 v5.3.0 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 v5.3.0 v5.3.0 Helps you find, load, combine, autofill and validate configuration values of ... symfony/console v5.3.0 v5.3.0 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v5.3.0 v5.3.0 Converts CSS selectors to XPath expressions symfony/debug-bundle v5.3.0 v5.3.0 Provides a tight integration of the Symfony Debug component into the Symfony ... symfony/dependency-injection v5.3.0 v5.3.0 Allows you to standardize and centralize the way objects are constructed in y... symfony/deprecation-contracts v2.4.0 v2.4.0 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v5.3.0 v5.3.0 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v5.3.0 v5.3.0 Eases DOM navigation for HTML and XML documents symfony/dotenv v5.3.0 v5.3.0 Registers environment variables from a .env file symfony/error-handler v5.3.0 v5.3.0 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v5.3.0 v5.3.0 Provides tools that allow your application components to communicate with eac... symfony/event-dispatcher-contracts v2.4.0 v2.4.0 Generic abstractions related to dispatching event symfony/expression-language v5.3.0 v5.3.0 Provides an engine that can compile and evaluate expressions symfony/filesystem v5.3.0 v5.3.0 Provides basic utilities for the filesystem symfony/finder v5.3.0 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 v5.3.0 v5.3.0 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v5.3.0 v5.3.0 Provides a tight integration between Symfony components and the Symfony full-... symfony/http-client v5.3.0 v5.3.0 Provides powerful methods to fetch HTTP resources synchronously or asynchrono... symfony/http-client-contracts v2.4.0 v2.4.0 Generic abstractions related to HTTP clients symfony/http-foundation v5.3.0 v5.3.0 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v5.3.0 v5.3.0 Provides a structured process for converting a Request into a Response symfony/intl v5.3.0 v5.3.0 Provides a PHP replacement layer for the C intl extension that includes addit... symfony/maker-bundle v1.31.1 v1.31.1 Symfony Maker helps you create empty commands, controllers, form classes, tes... symfony/mime v5.3.0 v5.3.0 Allows manipulating MIME messages symfony/monolog-bridge v5.3.0 v5.3.0 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.7.0 v3.7.0 Symfony MonologBundle symfony/options-resolver v5.3.0 v5.3.0 Provides an improved replacement for the array_replace PHP function symfony/password-hasher v5.3.0 v5.3.0 Provides password hashing utilities symfony/phpunit-bridge v5.3.0 v5.3.0 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/polyfill-php81 v1.23.0 v1.23.0 Symfony polyfill backporting some PHP 8.1+ features to lower PHP versions symfony/process v5.3.0 v5.3.0 Executes commands in sub-processes symfony/property-access v5.3.0 v5.3.0 Provides functions to read and write from/to an object or array using a simpl... symfony/property-info v5.3.0 v5.3.0 Extracts information about PHP class' properties using metadata of popular so... symfony/routing v5.3.0 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 v5.3.0 v5.3.0 Provides a tight integration of the Security component into the Symfony full-... symfony/security-core v5.3.0 v5.3.0 Symfony Security Component - Core Library symfony/security-csrf v5.3.0 v5.3.0 Symfony Security Component - CSRF Library symfony/security-guard v5.3.0 v5.3.0 Symfony Security Component - Guard symfony/security-http v5.3.0 v5.3.0 Symfony Security Component - HTTP Integration symfony/serializer v5.3.0 v5.3.0 Handles serializing and deserializing data structures, including object graph... symfony/service-contracts v2.4.0 v2.4.0 Generic abstractions related to writing services symfony/stopwatch v5.3.0 v5.3.0 Provides a way to profile code symfony/string v5.3.0 v5.3.0 Provides an object-oriented API to strings and deals with bytes, UTF-8 code p... symfony/swiftmailer-bundle v3.5.2 v3.5.2 Symfony SwiftmailerBundle symfony/templating v5.3.0 v5.3.0 Provides all the tools needed to build any kind of template system symfony/translation v5.3.0 v5.3.0 Provides tools to internationalize your application symfony/translation-contracts v2.4.0 v2.4.0 Generic abstractions related to translation symfony/twig-bridge v5.3.0 v5.3.0 Provides integration for Twig with various Symfony components symfony/twig-bundle v5.3.0 v5.3.0 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v5.3.0 v5.3.0 Provides tools to validate values symfony/var-dumper v5.3.0 v5.3.0 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v5.3.0 v5.3.0 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v5.3.0 v5.3.0 Manages links between resources symfony/web-profiler-bundle v5.3.0 v5.3.0 Provides a development tool that gives detailed information about the executi... symfony/yaml v5.3.0 v5.3.0 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 8.0.6 (cli) (built: May  5 2021 04:49:35) ( NTS )
Copyright (c) The PHP Group
Zend Engine v4.0.6, Copyright (c) Zend Technologies
    with Xdebug v3.0.2, Copyright (c) 2002-2021, by Derick Rethans

Subject

I am migrating a Symfony 4.4 application with Sonata 3.x to Symfony 5.3 and Sonata 4.0.0-alpha-2.

ModelAutocompleteFilter seems to be broken, or maybe it is my fault due to misconfiguration. The entities list is crashing when I want to access it. Here is a sample of my code :

SurveyAdmin.php

// Fields to be shown on filter forms
protected function configureDatagridFilters(DatagridMapper $datagridMapper): void
{
    $datagridMapper
        ->add('name')
        ->add('title')
        ->add('privateName')
        ->add('city', ModelAutocompleteFilter::class, ['property' => 'name']);
}

CityAdmin.php

// Fields to be shown on filter forms
protected function configureDatagridFilters(DatagridMapper $datagridMapper): void
{
    $datagridMapper
        ->add('name');
}

The error I get accessing /admin/app/survey/list : 

An error has occurred resolving the options of the form "Sonata\AdminBundle\Form\Type\ModelAutocompleteType": The required option "property" is missing.

After isolating the problem, it really comes from ModelAutocompleteFilter and not ModelAutocompleteType as it is said in the error.

axzx commented 3 years ago

example from my project

->add('owner', ModelAutocompleteFilter::class, [
                    'field_options' => [
                        'property' => ['nameOrEmail'],
                        'minimum_input_length' => 0,
                    ],
                ])
Fl0ux commented 3 years ago

Thanks @axzx it works now !

My bad, I missed it in the documentation.

VincentLanglet commented 3 years ago

My bad, I missed it in the documentation.

Does the documentation should be improved ?

Fl0ux commented 3 years ago

Maybe... I search "ModelAutocompleteFilter" in the documentation and found nothing. However, there is a "Filter" section that explains how it works.

VincentLanglet commented 3 years ago

Since the method add has the following definition

public function add(
        $name,
        ?string $type = null,
        array $filterOptions = [],
        array $fieldDescriptionOptions = []
    ): self {

The documentation is not up to date indeed https://sonata-project.org/bundles/doctrine-orm-admin/master/doc/reference/filter_field_definition.html

I'll create an issue in doctrine-orm-admin.