bug #7136 Fix hiding and showing of fields in AssociationField and CollectionFi… (michaelKaefer)

This PR was merged into the 4.x branch.

Discussion
----------

Fix hiding and showing of fields in AssociationField and CollectionFi…

…eld if crud form is used

`FieldFactory` removes configured fields by checking against the current page (for example `Crud::PAGE_NEW`) here: `$fieldDto->isDisplayedOn($currentPage)`.

Now consider using one of:
- `AssociactionField::new(...)->renderAsEmbeddedForm()`
- `CollectionField::new(...)->useEntryCrudForm()`

`FieldFactory` gets the `$currentPage` of the request: `$this->adminContextProvider->getContext()->getCrud()->getCurrentPage()`. If there are nested CRUD forms (like in the 2 above examples) there have to be multiple current pages. One for the root entity and one for every nested CRUD form. For example when editing (`Crud::PAGE_EDIT`) the root entity we can add new (`Crud::PAGE_NEW`) items to a collection.

This is not possible and a partial fix was introduced in #5704 and edited in #7061. This fix produced another error (for example removing fields on `index` pages, I can elaborate if necessary).

This PR reverts the partial fixes and adds a new fix by passing different `$currentPage` to `FieldFactory` a) for the root entity and b) for nested CRUD forms.

Commits
-------

5bc8490 Fix hiding and showing of fields in AssociationField and CollectionField if crud form is used

Author: javiereguiluz

Makefile

@@ -18,7 +18,7 @@ tests-coverage-view-in-browser: ## Open the generated HTML coverage in your defa
 
 ## —— Linters —————————————————————————————————
 linter-code-syntax: ## Lint PHP code (in dry-run mode, does not edit files)
-	docker run --rm -it --pull always -w=/app -v $(shell pwd):/app oskarstark/php-cs-fixer-ga:latest --diff -vvv --dry-run --using-cache=no
+	docker run --rm -it --pull always -w=/app -v "$(shell pwd)":/app oskarstark/php-cs-fixer-ga:latest --diff -vvv --dry-run --using-cache=no
 linter-docs: ## Lint docs
 	docker run --rm -it --pull always -e DOCS_DIR='/docs' -v $(shell pwd)/doc:/docs oskarstark/doctor-rst:latest --short
 

src/Controller/AbstractCrudController.php

@@ -144,7 +144,7 @@ public function index(AdminContext $context)
         }
 
         $entities = $this->container->get(EntityFactory::class)->createCollection($context->getEntity(), $paginator->getResults());
-        $this->container->get(EntityFactory::class)->processFieldsForAll($entities, $fields);
+        $this->container->get(EntityFactory::class)->processFieldsForAll($entities, $fields, Crud::PAGE_INDEX);
         $procesedFields = $entities->first()?->getFields() ?? FieldCollection::new([]);
         $context->getCrud()->setFieldAssets($this->getFieldAssets($procesedFields));
         $actions = $this->container->get(EntityFactory::class)->processActionsForAll($entities, $context->getCrud()->getActionsConfig());
@@ -184,7 +184,7 @@ public function detail(AdminContext $context)
             throw new InsufficientEntityPermissionException($context);
         }
 
-        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_DETAIL)));
+        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_DETAIL)), Crud::PAGE_DETAIL);
         $context->getCrud()->setFieldAssets($this->getFieldAssets($context->getEntity()->getFields()));
         $this->container->get(EntityFactory::class)->processActions($context->getEntity(), $context->getCrud()->getActionsConfig());
 
@@ -219,7 +219,7 @@ public function edit(AdminContext $context)
             throw new InsufficientEntityPermissionException($context);
         }
 
-        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_EDIT)));
+        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_EDIT)), Crud::PAGE_EDIT);
         $context->getCrud()->setFieldAssets($this->getFieldAssets($context->getEntity()->getFields()));
         $this->container->get(EntityFactory::class)->processActions($context->getEntity(), $context->getCrud()->getActionsConfig());
         /** @var TEntity $entityInstance */
@@ -305,7 +305,7 @@ public function new(AdminContext $context)
         /** @var class-string<TEntity> $entityFqcn */
         $entityFqcn = $context->getEntity()->getFqcn();
         $context->getEntity()->setInstance($this->createEntity($entityFqcn));
-        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_NEW)));
+        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), FieldCollection::new($this->configureFields(Crud::PAGE_NEW)), Crud::PAGE_NEW);
         $context->getCrud()->setFieldAssets($this->getFieldAssets($context->getEntity()->getFields()));
         $this->container->get(EntityFactory::class)->processActions($context->getEntity(), $context->getCrud()->getActionsConfig());
 
@@ -495,7 +495,7 @@ public function createIndexQueryBuilder(SearchDto $searchDto, EntityDto $entityD
     public function renderFilters(AdminContext $context): KeyValueStore
     {
         $fields = FieldCollection::new($this->configureFields(Crud::PAGE_INDEX));
-        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), $fields);
+        $this->container->get(EntityFactory::class)->processFields($context->getEntity(), $fields, Crud::PAGE_INDEX);
         $filters = $this->container->get(FilterFactory::class)->create($context->getCrud()->getFiltersConfig(), $context->getEntity()->getFields(), $context->getEntity());
 
         /** @var FormInterface&FiltersFormType $filtersForm */

src/Factory/EntityFactory.php

@@ -38,15 +38,31 @@ public function __construct(FieldFactory $fieldFactory, ActionFactory $actionFac
         $this->eventDispatcher = $eventDispatcher;
     }
 
-    public function processFields(EntityDto $entityDto, FieldCollection $fields): void
+    public function processFields(EntityDto $entityDto, FieldCollection $fields, ?string $pageName = null): void
     {
-        $this->fieldFactory->processFields($entityDto, $fields);
+        if (null === $pageName) {
+            trigger_deprecation(
+                'easycorp/easyadmin-bundle',
+                '4.27.0',
+                'Argument "$pageName" is missing. Omitting it will cause an error in 5.0.0.',
+            );
+        }
+
+        $this->fieldFactory->processFields($entityDto, $fields, $pageName);
     }
 
-    public function processFieldsForAll(EntityCollection $entities, FieldCollection $fields): void
+    public function processFieldsForAll(EntityCollection $entities, FieldCollection $fields, ?string $pageName = null): void
     {
+        if (null === $pageName) {
+            trigger_deprecation(
+                'easycorp/easyadmin-bundle',
+                '4.27.0',
+                'Argument "$pageName" is missing. Omitting it will cause an error in 5.0.0.',
+            );
+        }
+
         foreach ($entities as $entity) {
-            $this->processFields($entity, clone $fields);
+            $this->processFields($entity, clone $fields, $pageName);
             $entities->set($entity);
         }
     }

src/Factory/FieldFactory.php

@@ -71,12 +71,20 @@ public function __construct(
     {
     }
 
-    public function processFields(EntityDto $entityDto, FieldCollection $fields): void
+    public function processFields(EntityDto $entityDto, FieldCollection $fields, ?string $currentPage = null): void
     {
         $this->replaceGenericFieldsWithSpecificFields($fields, $entityDto);
 
         $context = $this->adminContextProvider->getContext();
-        $currentPage = $context->getCrud()->getCurrentPage();
+
+        if (null === $currentPage) {
+            trigger_deprecation(
+                'easycorp/easyadmin-bundle',
+                '4.27.0',
+                'Argument "$currentPage" is missing. Omitting it will cause an error in 5.0.0.',
+            );
+            $currentPage = $context->getCrud()->getCurrentPage();
+        }
 
         $isDetailOrIndex = \in_array($currentPage, [Crud::PAGE_INDEX, Crud::PAGE_DETAIL], true);
         foreach ($fields as $fieldDto) {
@@ -94,14 +102,6 @@ public function processFields(EntityDto $entityDto, FieldCollection $fields): vo
                 continue;
             }
 
-            // when creating new entities with "useEntryCrudForm" on an edit page we must
-            // explicitly check for the "new" page because $currentPage will be "edit"
-            if ($isDetailOrIndex && (null === $entityDto->getInstance()) && !$fieldDto->isDisplayedOn(Crud::PAGE_NEW)) {
-                $fields->unset($fieldDto);
-
-                continue;
-            }
-
             foreach ($this->fieldConfigurators as $configurator) {
                 if (!$configurator->supports($fieldDto, $entityDto)) {
                     continue;

src/Field/Configurator/AssociationConfigurator.php

@@ -304,22 +304,24 @@ private function configureCrudForm(FieldDto $field, EntityDto $entityDto, string
         if (null === $associatedEntity) {
             $targetCrudControllerAction = Action::NEW;
             $targetCrudControllerPageName = $field->getCustomOption(AssociationField::OPTION_EMBEDDED_CRUD_FORM_NEW_PAGE_NAME) ?? Crud::PAGE_NEW;
+            $crudPageName = Crud::PAGE_NEW;
         } else {
             $targetCrudControllerAction = Action::EDIT;
             $targetCrudControllerPageName = $field->getCustomOption(AssociationField::OPTION_EMBEDDED_CRUD_FORM_EDIT_PAGE_NAME) ?? Crud::PAGE_EDIT;
+            $crudPageName = Crud::PAGE_EDIT;
         }
 
         $field->setFormTypeOption(
             'entityDto',
-            $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, $targetCrudControllerAction, $targetCrudControllerPageName),
+            $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, $targetCrudControllerAction, $targetCrudControllerPageName, $crudPageName),
         );
     }
 
     /**
      * @param class-string $entityFqcn
      * @param class-string $crudControllerFqcn
      */
-    private function createEntityDto(string $entityFqcn, string $crudControllerFqcn, string $crudControllerAction, string $crudControllerPageName): EntityDto
+    private function createEntityDto(string $entityFqcn, string $crudControllerFqcn, string $crudControllerAction, string $crudControllerPageName, string $crudPageName): EntityDto
     {
         $entityDto = $this->entityFactory->create($entityFqcn);
 
@@ -331,7 +333,7 @@ private function createEntityDto(string $entityFqcn, string $crudControllerFqcn,
 
         $fields = $crudController->configureFields($crudControllerPageName);
 
-        $this->entityFactory->processFields($entityDto, FieldCollection::new($fields));
+        $this->entityFactory->processFields($entityDto, FieldCollection::new($fields), $crudPageName);
 
         return $entityDto;
     }

src/Field/Configurator/CollectionConfigurator.php

@@ -101,11 +101,11 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
             }
 
             $crudEditPageName = $field->getCustomOption(CollectionField::OPTION_ENTRY_CRUD_EDIT_PAGE_NAME) ?? Crud::PAGE_EDIT;
-            $editEntityDto = $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, Action::EDIT, $crudEditPageName);
+            $editEntityDto = $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, Action::EDIT, $crudEditPageName, Crud::PAGE_EDIT);
             $field->setFormTypeOption('entry_options.entityDto', $editEntityDto);
 
             $crudNewPageName = $field->getCustomOption(CollectionField::OPTION_ENTRY_CRUD_NEW_PAGE_NAME) ?? Crud::PAGE_NEW;
-            $newEntityDto = $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, Action::NEW, $crudNewPageName);
+            $newEntityDto = $this->createEntityDto($targetEntityFqcn, $targetCrudControllerFqcn, Action::NEW, $crudNewPageName, Crud::PAGE_NEW);
 
             try {
                 $field->setFormTypeOption('prototype_options.entityDto', $newEntityDto);
@@ -157,7 +157,7 @@ private function countNumElements(mixed $collection): int
      * @param class-string $targetEntityFqcn
      * @param class-string $targetCrudControllerFqcn
      */
-    private function createEntityDto(string $targetEntityFqcn, string $targetCrudControllerFqcn, string $crudAction, string $pageName): EntityDto
+    private function createEntityDto(string $targetEntityFqcn, string $targetCrudControllerFqcn, string $crudAction, string $crudControllerPageName, string $crudPageName): EntityDto
     {
         $entityDto = $this->entityFactory->create($targetEntityFqcn);
 
@@ -167,9 +167,9 @@ private function createEntityDto(string $targetEntityFqcn, string $targetCrudCon
             $this->requestStack->getMainRequest()
         );
 
-        $fields = $crudController->configureFields($pageName);
+        $fields = $crudController->configureFields($crudControllerPageName);
 
-        $this->entityFactory->processFields($entityDto, FieldCollection::new($fields));
+        $this->entityFactory->processFields($entityDto, FieldCollection::new($fields), $crudPageName);
 
         return $entityDto;
     }