feature #3551 Add option to modify query of AssociationField (with autocomplete) (lukasluecke)

This PR was squashed before being merged into the 3.0.x-dev branch.

Discussion
----------

Add option to modify query of AssociationField (with autocomplete)

Resolves #3476. Depends on #3550.

Works the same for "default" and autocomplete fields.

```php
AssociationField::new('property')
    ->autocomplete() // optional
    ->modifyQuery(fn(QueryBuilder $queryBuilder) => $queryBuilder
        ->where('entity.id > 20')
        ->orderBy('entity.field', 'DESC')
    );
```

Commits
-------

4716e81 Add option to modify query of AssociationField (with autocomplete)

Author: javiereguiluz

src/Controller/AbstractCrudController.php

@@ -16,6 +16,7 @@
 use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
+use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
 use EasyCorp\Bundle\EasyAdminBundle\Event\AfterCrudActionEvent;
 use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntityDeletedEvent;
@@ -29,10 +30,12 @@
 use EasyCorp\Bundle\EasyAdminBundle\Exception\ForbiddenActionException;
 use EasyCorp\Bundle\EasyAdminBundle\Exception\InsufficientEntityPermissionException;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\ActionFactory;
+use EasyCorp\Bundle\EasyAdminBundle\Factory\ControllerFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\FilterFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\FormFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\PaginatorFactory;
+use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
 use EasyCorp\Bundle\EasyAdminBundle\Form\Type\FiltersFormType;
 use EasyCorp\Bundle\EasyAdminBundle\Orm\EntityRepository;
 use EasyCorp\Bundle\EasyAdminBundle\Orm\EntityUpdater;
@@ -88,6 +91,7 @@ public static function getSubscribedServices()
             'event_dispatcher' => '?'.EventDispatcherInterface::class,
             ActionFactory::class => '?'.ActionFactory::class,
             AdminContextProvider::class => '?'.AdminContextProvider::class,
+            ControllerFactory::class => '?'.ControllerFactory::class,
             CrudUrlGenerator::class => '?'.CrudUrlGenerator::class,
             EntityFactory::class => '?'.EntityFactory::class,
             EntityRepository::class => '?'.EntityRepository::class,
@@ -393,6 +397,21 @@ public function delete(AdminContext $context)
     public function autocomplete(AdminContext $context): JsonResponse
     {
         $queryBuilder = $this->createIndexQueryBuilder($context->getSearch(), $context->getEntity(), FieldCollection::new([]), FilterCollection::new());
+
+        $autocompleteContext = $context->getRequest()->get(AssociationField::PARAM_AUTOCOMPLETE_CONTEXT);
+
+        /** @var CrudControllerInterface $controller */
+        $controller = $this->get(ControllerFactory::class)->getCrudControllerInstance($autocompleteContext['crudId'], Action::INDEX, $context->getRequest());
+        /** @var FieldDto $field */
+        $field = FieldCollection::new($controller->configureFields(Crud::PAGE_INDEX))->get($autocompleteContext['propertyName']);
+        /** @var \Closure|null $modify */
+        $modify = $field->getCustomOption(AssociationField::OPTION_MODIFY_QUERY);
+
+        if(null !== $modify)
+        {
+            $modify($queryBuilder);
+        }
+
         $paginator = $this->get(PaginatorFactory::class)->create($queryBuilder);
 
         return JsonResponse::fromJsonString($paginator->getResultsAsJson());

src/Field/AssociationField.php

@@ -15,6 +15,7 @@ final class AssociationField implements FieldInterface
     public const OPTION_AUTOCOMPLETE = 'autocomplete';
     public const OPTION_CRUD_CONTROLLER = 'crudControllerFqcn';
     public const OPTION_WIDGET = 'widget';
+    public const OPTION_MODIFY_QUERY = 'modifyQuery';
     /** @internal this option is intended for internal use only */
     public const OPTION_RELATED_URL = 'relatedUrl';
     /** @internal this option is intended for internal use only */
@@ -23,6 +24,9 @@ final class AssociationField implements FieldInterface
     public const WIDGET_AUTOCOMPLETE = 'autocomplete';
     public const WIDGET_NATIVE = 'native';
 
+    /** @internal this option is intended for internal use only */
+    public const PARAM_AUTOCOMPLETE_CONTEXT = 'autocompleteContext';
+
     public static function new(string $propertyName, ?string $label = null): self
     {
         return (new self())
@@ -34,6 +38,7 @@ public static function new(string $propertyName, ?string $label = null): self
             ->setCustomOption(self::OPTION_AUTOCOMPLETE, false)
             ->setCustomOption(self::OPTION_CRUD_CONTROLLER, null)
             ->setCustomOption(self::OPTION_WIDGET, self::WIDGET_AUTOCOMPLETE)
+            ->setCustomOption(self::OPTION_MODIFY_QUERY, null)
             ->setCustomOption(self::OPTION_RELATED_URL, null)
             ->setCustomOption(self::OPTION_DOCTRINE_ASSOCIATION_TYPE, null);
     }
@@ -58,4 +63,11 @@ public function setCrudController(string $crudControllerFqcn): self
 
         return $this;
     }
+
+    public function modifyQuery(\Closure $modify): self
+    {
+        $this->setCustomOption(self::OPTION_MODIFY_QUERY, $modify);
+
+        return $this;
+    }
 }

src/Field/Configurator/AssociationConfigurator.php

@@ -2,6 +2,7 @@
 
 namespace EasyCorp\Bundle\EasyAdminBundle\Field\Configurator;
 
+use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\PersistentCollection;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
 use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
@@ -72,14 +73,23 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
                 ->setAction('autocomplete')
                 ->setEntityId(null)
                 ->unset('sort') // Avoid passing the 'sort' param from the current entity to the autocompleted one
+                ->set(AssociationField::PARAM_AUTOCOMPLETE_CONTEXT, [
+                    'crudId' => $context->getRequest()->query->get('crudId'),
+                    'propertyName' => $propertyName,
+                ])
                 ->generateUrl();
 
             $field->setFormTypeOption('attr.data-ea-autocomplete-endpoint-url', $autocompleteEndpointUrl);
-
-            // If the field is not required we allow clearing out the selection
-            if (false === $field->getFormTypeOption('required')) {
-                $field->setFormTypeOption('attr.data-allow-clear', 'true');
-            }
+        } else {
+            $field->setFormTypeOption('query_builder', static function(EntityRepository $repository) use($field) {
+                // TODO: should this use `createIndexQueryBuilder` instead, so we get the default ordering etc.?
+                // it would then be identical to the one used in autocomplete action, but it is a bit complex getting it in here
+                $queryBuilder = $repository->createQueryBuilder('entity');
+                if($modify = $field->getCustomOption(AssociationField::OPTION_MODIFY_QUERY)) {
+                    $modify($queryBuilder);
+                }
+                return $queryBuilder;
+            });
         }
     }