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

\Symfony\Component\Form\FormBuilderInterface::get don't compability with form \Sonata\AdminBundle\Form\FormMapper::add #7644

Closed nkl90 closed 2 years ago

nkl90 commented 2 years ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' Color legend: - patch or minor release available - update recommended - major release available - update possible - up to date version sonata-project/admin-bundle 4.5.0 4.5.0 The missing Symfony Admin Generator sonata-project/block-bundle 4.9.0 4.9.0 Symfony SonataBlockBundle sonata-project/cache 2.2.0 2.2.0 Cache library sonata-project/doctrine-extensions 1.16.0 1.16.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 4.2.1 4.2.1 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.9.1 2.9.1 Lightweight Exporter library sonata-project/form-extensions 1.12.4 1.12.4 Symfony form extensions sonata-project/twig-extensions 1.9.1 1.9.1 Sonata twig extensions ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' Color legend: - patch or minor release available - update recommended - major release available - update possible - up to date version symfony/asset v5.4.0 v5.4.0 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v5.4.0 v5.4.0 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v5.4.0 v5.4.0 Provides an extended PSR-6, PSR-16 (and tags) implementation symfony/cache-contracts v2.5.0 v2.5.0 Generic abstractions related to caching symfony/config v5.4.0 v5.4.0 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v5.4.0 v5.4.0 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v5.4.0 v5.4.0 Converts CSS selectors to XPath expressions symfony/debug-bundle v5.4.0 v5.4.0 Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework symfony/dependency-injection v5.4.0 v5.4.0 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v2.5.0 v2.5.0 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v5.4.0 v5.4.0 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v5.4.0 v5.4.0 Eases DOM navigation for HTML and XML documents symfony/dotenv v5.4.0 v5.4.0 Registers environment variables from a .env file symfony/error-handler v5.4.0 v5.4.0 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v5.4.0 v5.4.0 Provides tools that allow your application components to communicate with each other by dispatching events and listening to them symfony/event-dispatcher-contracts v2.5.0 v2.5.0 Generic abstractions related to dispatching event symfony/expression-language v5.4.0 v5.4.0 Provides an engine that can compile and evaluate expressions symfony/filesystem v5.4.0 v5.4.0 Provides basic utilities for the filesystem symfony/finder v5.4.0 v5.4.0 Finds files and directories via an intuitive fluent interface symfony/flex v1.17.6 v1.17.6 Composer plugin for Symfony symfony/form v5.4.0 v5.4.0 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v5.4.0 v5.4.0 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v5.4.0 v5.4.0 Provides powerful methods to fetch HTTP resources synchronously or asynchronously symfony/http-client-contracts v2.5.0 v2.5.0 Generic abstractions related to HTTP clients symfony/http-foundation v5.4.0 v5.4.0 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v5.4.0 v5.4.0 Provides a structured process for converting a Request into a Response symfony/intl v5.4.0 v5.4.0 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v5.4.0 v5.4.0 Helps sending emails symfony/maker-bundle v1.36.4 v1.36.4 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code. symfony/mime v5.4.0 v5.4.0 Allows manipulating MIME messages symfony/monolog-bridge v5.4.0 v5.4.0 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.7.1 v3.7.1 Symfony MonologBundle symfony/notifier v5.4.0 v5.4.0 Sends notifications via one or more channels (email, SMS, ...) symfony/options-resolver v5.4.0 v5.4.0 Provides an improved replacement for the array_replace PHP function symfony/password-hasher v5.4.0 v5.4.0 Provides password hashing utilities symfony/phpunit-bridge v5.4.0 v6.0.0 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-intl-grapheme v1.23.1 v1.23.1 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.1 v1.23.1 Symfony polyfill for the Mbstring extension 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.1 v1.23.1 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.4.0 v5.4.0 Executes commands in sub-processes symfony/property-access v5.4.0 v5.4.0 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v5.4.0 v5.4.0 Extracts information about PHP class' properties using metadata of popular sources symfony/proxy-manager-bridge v5.4.0 v5.4.0 Provides integration for ProxyManager with various Symfony components symfony/routing v5.4.0 v5.4.0 Maps an HTTP request to a set of configuration variables symfony/runtime v5.4.0 v5.4.0 Enables decoupling PHP applications from global state symfony/security-acl v3.2.0 v3.2.0 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v5.4.0 v5.4.0 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v5.4.0 v5.4.0 Symfony Security Component - Core Library symfony/security-csrf v5.4.0 v5.4.0 Symfony Security Component - CSRF Library symfony/security-guard v5.4.0 v5.4.0 Symfony Security Component - Guard symfony/security-http v5.4.0 v5.4.0 Symfony Security Component - HTTP Integration symfony/serializer v5.4.0 v5.4.0 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON. symfony/service-contracts v2.5.0 v2.5.0 Generic abstractions related to writing services symfony/stopwatch v5.4.0 v5.4.0 Provides a way to profile code symfony/string v5.4.0 v5.4.0 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way symfony/translation v5.4.0 v5.4.0 Provides tools to internationalize your application symfony/translation-contracts v2.5.0 v2.5.0 Generic abstractions related to translation symfony/twig-bridge v5.4.0 v5.4.0 Provides integration for Twig with various Symfony components symfony/twig-bundle v5.4.0 v5.4.0 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v5.4.0 v5.4.0 Provides tools to validate values symfony/var-dumper v5.4.0 v5.4.0 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v5.4.0 v5.4.0 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v5.4.0 v5.4.0 Manages links between resources symfony/web-profiler-bundle v5.4.0 v5.4.0 Provides a development tool that gives detailed information about the execution of any request symfony/webpack-encore-bundle v1.13.2 v1.13.2 Integration with your Symfony app & Webpack Encore! symfony/yaml v5.4.0 v5.4.0 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 7.4.26 (cli) (built: Nov 22 2021 09:48:15) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.26, Copyright (c), by Zend Technologies
    with Xdebug v3.1.1, Copyright (c) 2002-2021, by Derick Rethans

Subject

In doc section 12.3. Adding a FormBuilderInterface there is an example of reuse of the existing Symfony form. But, \Sonata\AdminBundle\Form\FormMapper::add the string is expected as the first parameter while \Symfony\Component\Form\FormBuilderInterface::get return self (FormBuilderInterface).

Minimal repository with the bug

// TODO: link minimal repo to reproduce this bug

Steps to reproduce

Create the Form:

<?php

namespace App\Form;

use App\Entity\Person;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class PersonFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('firstName')
            ->add('patronymic')
            ->add('lastName')
            ->add('sex', ChoiceType::class, [
                'choices' => [
                    'male' => true,
                    'famale' => false,
                ],
            ])
            ->add('dateOfBirth', DateType::class, [
                'widget' => 'single_text',
            ])
            //->add('systemUser', ModelHiddenType::class)
        ;
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => Person::class,
        ]);
    }
}

Then create the Admin class:

<?php

declare(strict_types=1);

namespace App\Admin;

use App\DBAL\Types\RoleEnumType;
use App\Form\PersonFormType;
use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Show\ShowMapper;
use Sonata\DoctrineORMAdminBundle\Filter\CallbackFilter;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\TextType;

final class UserAdmin extends AbstractAdmin
{
    public function configure(): void
    {
        parent::configure(); // TODO: Change the autogenerated stub
//        $this->setTranslationDomain('');
    }

    protected function configureDatagridFilters(DatagridMapper $filter): void
    {
        $filter
            ->add('id')
            ->add('email')
            ->add('roles')
            ->add('password')
            ;
    }

    protected function configureListFields(ListMapper $list): void
    {
        $list
            ->add('id')
            ->add('email')
            ->add('roles')
//            ->add('password')
            ->add(ListMapper::NAME_ACTIONS, null, [
                'actions' => [
                    'show' => [],
                    'edit' => [],
                    'delete' => [],
                ],
            ]);
    }

    protected function configureFormFields(FormMapper $form): void
    {
        $personFormBuilder = $form->getFormBuilder()->getFormFactory()->createBuilder(PersonFormType::class);
        $form
            ->tab('System')
                ->with('System user data')
                ->add('email')
                ->add('password')
                ->add('roles', ChoiceType::class, [
                    'choices' => RoleEnumType::getChoices(),
                    'multiple' => true,
                    'required' => true,
                    'empty_data' => false,
                ])
                ->end()
            ->end()
            ->tab('Person')
                ->with('Person user data', ['class' => 'col-md-9'])
                    ->add($personFormBuilder->get('firstName'))
                    ->add($personFormBuilder->get('patronymic'))
                    ->add($personFormBuilder->get('lastName'))
                ->end()
                ->with('Person user data', ['class' => 'col-md-3'])
                    ->add($personFormBuilder->get('sex'))
                    ->add($personFormBuilder->get('dateOfBirth'))
                ->end()
            ->end()
            ;
    }

    protected function configureShowFields(ShowMapper $show): void
    {
        $show
            ->add('id')
            ->add('email')
            ->add('roles')
            ->add('password')
            ;
    }
}

Expected results

Grouped reusable the exiting Symfony form fields.

Actual results

Argument 1 passed to Sonata\AdminBundle\Form\FormMapper::add() must be of the type string, object given

VincentLanglet commented 2 years ago

This is a feature we dropped on Sonata 4. Didn't know there was doc about it.

The previous code can be found https://github.com/sonata-project/SonataAdminBundle/blame/82af7ce5b5c3fa1706d417a7d3287c65138e7190/src/Form/FormMapper.php#L81

Basically, it was doing something like

->add($builder->get('author')-> getName(), \get_class($builder->get('author')->getType()->getInnerType())

Dunno if we should

nkl90 commented 2 years ago

It seems to me that such reuse of individual fields of ready-made forms becomes meaningless.

VincentLanglet commented 2 years ago

It seems to me that such reuse of individual fields of ready-made forms becomes meaningless.

A PR to remove the doc must be enough then

nkl90 commented 2 years ago

This is my first PR in open source project! ;)