vendor/easycorp/easyadmin-bundle/src/Factory/FieldFactory.php line 72

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Factory;
  5. use Doctrine\DBAL\Types\Types;
  6. use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
  7. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  8. use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Field\ArrayField;
  12. use EasyCorp\Bundle\EasyAdminBundle\Field\BooleanField;
  13. use EasyCorp\Bundle\EasyAdminBundle\Field\DateField;
  14. use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
  15. use EasyCorp\Bundle\EasyAdminBundle\Field\Field;
  16. use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;
  17. use EasyCorp\Bundle\EasyAdminBundle\Field\IdField;
  18. use EasyCorp\Bundle\EasyAdminBundle\Field\IntegerField;
  19. use EasyCorp\Bundle\EasyAdminBundle\Field\NumberField;
  20. use EasyCorp\Bundle\EasyAdminBundle\Field\TextareaField;
  21. use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
  22. use EasyCorp\Bundle\EasyAdminBundle\Field\TimeField;
  23. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\EaFormRowType;
  24. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\EasyAdminTabType;
  25. use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;
  26. use EasyCorp\Bundle\EasyAdminBundle\Security\Permission;
  27. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  29. /**
  30.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  31.  */
  32. final class FieldFactory
  33. {
  34.     private static array $doctrineTypeToFieldFqcn = [
  35.         Types::ARRAY => ArrayField::class,
  36.         Types::BIGINT => TextField::class,
  37.         Types::BINARY => TextareaField::class,
  38.         Types::BLOB => TextareaField::class,
  39.         Types::BOOLEAN => BooleanField::class,
  40.         Types::DATE_MUTABLE => DateField::class,
  41.         Types::DATE_IMMUTABLE => DateField::class,
  42.         Types::DATEINTERVAL => TextField::class,
  43.         Types::DATETIME_MUTABLE => DateTimeField::class,
  44.         Types::DATETIME_IMMUTABLE => DateTimeField::class,
  45.         Types::DATETIMETZ_MUTABLE => DateTimeField::class,
  46.         Types::DATETIMETZ_IMMUTABLE => DateTimeField::class,
  47.         Types::DECIMAL => NumberField::class,
  48.         Types::FLOAT => NumberField::class,
  49.         Types::GUID => TextField::class,
  50.         Types::INTEGER => IntegerField::class,
  51.         Types::JSON => TextField::class,
  52.         Types::OBJECT => TextField::class,
  53.         Types::SIMPLE_ARRAY => ArrayField::class,
  54.         Types::SMALLINT => IntegerField::class,
  55.         Types::STRING => TextField::class,
  56.         Types::TEXT => TextareaField::class,
  57.         Types::TIME_MUTABLE => TimeField::class,
  58.         Types::TIME_IMMUTABLE => TimeField::class,
  59.     ];
  61.     private AdminContextProvider $adminContextProvider;
  62.     private AuthorizationCheckerInterface $authorizationChecker;
  63.     private iterable $fieldConfigurators;
  65.     public function __construct(AdminContextProvider $adminContextProvider, AuthorizationCheckerInterface $authorizationChecker, iterable $fieldConfigurators)
  66.     {
  67.         $this->adminContextProvider = $adminContextProvider;
  68.         $this->authorizationChecker = $authorizationChecker;
  69.         $this->fieldConfigurators = $fieldConfigurators;
  70.     }
  72.     public function processFields(EntityDto $entityDto, FieldCollection $fields): void
  73.     {
  74.         $this->preProcessFields($fields, $entityDto);
  76.         $context = $this->adminContextProvider->getContext();
  77.         $currentPage = $context->getCrud()->getCurrentPage();
  79.         $isDetailOrIndex = \in_array($currentPage, [Crud::PAGE_INDEX, Crud::PAGE_DETAIL], true);
  80.         foreach ($fields as $fieldDto) {
  81.             if ((null !== $currentPage && false === $fieldDto->isDisplayedOn($currentPage))
  82.                 || false === $this->authorizationChecker->isGranted(Permission::EA_VIEW_FIELD, $fieldDto)) {
  83.                 $fields->unset($fieldDto);
  85.                 continue;
  86.             }
  88.             // "form rows" only make sense in pages that contain forms
  89.             if ($isDetailOrIndex && EaFormRowType::class === $fieldDto->getFormType()) {
  90.                 $fields->unset($fieldDto);
  92.                 continue;
  93.             }
  95.             // when creating new entities with "useEntryCrudForm" on an edit page we must
  96.             // explicitly check for the "new" page because $currentPage will be "edit"
  97.             if ((null === $entityDto->getInstance()) && !$fieldDto->isDisplayedOn(Crud::PAGE_NEW)) {
  98.                 $fields->unset($fieldDto);
  100.                 continue;
  101.             }
  103.             foreach ($this->fieldConfigurators as $configurator) {
  104.                 if (!$configurator->supports($fieldDto, $entityDto)) {
  105.                     continue;
  106.                 }
  108.                 $configurator->configure($fieldDto, $entityDto, $context);
  109.             }
  111.             foreach ($fieldDto->getFormThemes() as $formThemePath) {
  112.                 $context?->getCrud()?->addFormTheme($formThemePath);
  113.             }
  115.             $fields->set($fieldDto);
  116.         }
  118.         $isPageWhereTabsAreVisible = \in_array($currentPage, [Crud::PAGE_DETAIL, Crud::PAGE_EDIT, Crud::PAGE_NEW], true);
  119.         if ($isPageWhereTabsAreVisible) {
  120.             $this->checkOrphanTabFields($fields, $context);
  121.         }
  123.         $entityDto->setFields($fields);
  124.     }
  126.     private function preProcessFields(FieldCollection $fields, EntityDto $entityDto): void
  127.     {
  128.         if ($fields->isEmpty()) {
  129.             return;
  130.         }
  132.         // this is needed to handle this edge-case: the list of fields include one or more form panels,
  133.         // but the first fields of the list don't belong to any panel. We must create an automatic empty
  134.         // form panel for those "orphaned fields" so they are displayed as expected
  135.         $firstFieldIsAFormPanel = $fields->first()->isFormDecorationField();
  136.         foreach ($fields as $fieldDto) {
  137.             if (!$firstFieldIsAFormPanel && $fieldDto->isFormDecorationField()) {
  138.                 $fields->prepend(FormField::addPanel()->getAsDto());
  139.                 break;
  140.             }
  141.         }
  143.         foreach ($fields as $fieldDto) {
  144.             if (Field::class !== $fieldDto->getFieldFqcn()) {
  145.                 continue;
  146.             }
  148.             // this is a virtual field, so we can't autoconfigure it
  149.             if (!$entityDto->hasProperty($fieldDto->getProperty())) {
  150.                 continue;
  151.             }
  153.             if ($fieldDto->getProperty() === $entityDto->getPrimaryKeyName()) {
  154.                 $guessedFieldFqcn = IdField::class;
  155.             } else {
  156.                 $doctrinePropertyType = $entityDto->getPropertyMetadata($fieldDto->getProperty())->get('type');
  157.                 $guessedFieldFqcn = self::$doctrineTypeToFieldFqcn[$doctrinePropertyType] ?? null;
  159.                 if (null === $guessedFieldFqcn) {
  160.                     throw new \RuntimeException(sprintf('The Doctrine type of the "%s" field is "%s", which is not supported by EasyAdmin. For Doctrine\'s Custom Mapping Types have a look at EasyAdmin\'s field docs.', $fieldDto->getProperty(), $doctrinePropertyType));
  161.                 }
  162.             }
  164.             $fields->set($this->transformField($fieldDto, $guessedFieldFqcn));
  165.         }
  166.     }
  168.     // transforms a generic Field class into a specific <type>Field class (e.g. DateTimeField)
  169.     private function transformField(FieldDto $fieldDto, string $newFieldFqcn): FieldDto
  170.     {
  171.         /** @var FieldDto $newField */
  172.         $newField = $newFieldFqcn::new($fieldDto->getProperty())->getAsDto();
  173.         $newField->setUniqueId($fieldDto->getUniqueId());
  175.         $newField->setFieldFqcn($newFieldFqcn);
  176.         $newField->setDisplayedOn($fieldDto->getDisplayedOn());
  177.         $newField->setValue($fieldDto->getValue());
  178.         $newField->setFormattedValue($fieldDto->getFormattedValue());
  179.         $newField->setCssClass(trim($newField->getCssClass().' '.$fieldDto->getCssClass()));
  180.         $newField->setColumns($fieldDto->getColumns());
  181.         $newField->setTranslationParameters($fieldDto->getTranslationParameters());
  182.         $newField->setAssets($newField->getAssets()->mergeWith($fieldDto->getAssets()));
  183.         foreach ($fieldDto->getFormThemes() as $formThemePath) {
  184.             $newField->addFormTheme($formThemePath);
  185.         }
  187.         $customFormTypeOptions = $fieldDto->getFormTypeOptions();
  188.         $defaultFormTypeOptions = $newField->getFormTypeOptions();
  189.         $newField->setFormTypeOptions(array_merge($defaultFormTypeOptions, $customFormTypeOptions));
  191.         $customFieldOptions = $fieldDto->getCustomOptions()->all();
  192.         $defaultFieldOptions = $newField->getCustomOptions()->all();
  193.         $mergedFieldOptions = array_merge($defaultFieldOptions, $customFieldOptions);
  194.         $newField->setCustomOptions($mergedFieldOptions);
  196.         if (null !== $fieldDto->getLabel()) {
  197.             $newField->setLabel($fieldDto->getLabel());
  198.         }
  200.         if (null !== $fieldDto->isVirtual()) {
  201.             $newField->setVirtual($fieldDto->isVirtual());
  202.         }
  204.         if (null !== $fieldDto->getTextAlign()) {
  205.             $newField->setTextAlign($fieldDto->getTextAlign());
  206.         }
  208.         if (null !== $fieldDto->isSortable()) {
  209.             $newField->setSortable($fieldDto->isSortable());
  210.         }
  212.         if (null !== $fieldDto->getPermission()) {
  213.             $newField->setPermission($fieldDto->getPermission());
  214.         }
  216.         if (null !== $fieldDto->getHelp()) {
  217.             $newField->setHelp($fieldDto->getHelp());
  218.         }
  220.         if (null !== $fieldDto->getFormType()) {
  221.             $newField->setFormType($fieldDto->getFormType());
  222.         }
  224.         // don't copy the template name and path from the original Field class
  225.         // (because they are just 'crud/field/text' and ' @EasyAdmin/crud/field/text.html.twig')
  226.         // and use the template name/path from the new specific field (e.g. 'crud/field/datetime')
  228.         return $newField;
  229.     }
  231.     /**
  232.      * When rendering fields using tabs, all fields must belong to some tab.
  233.      */
  234.     private function checkOrphanTabFields(FieldCollection $fields, AdminContext $context): void
  235.     {
  236.         $hasTabs = false;
  237.         $isTabField = static fn (FieldDto $fieldDto) => EasyAdminTabType::class === $fieldDto->getFormType();
  238.         $isFormField = static fn (FieldDto $fieldDto) => FormField::class === $fieldDto->getFieldFqcn();
  240.         foreach ($fields as $fieldDto) {
  241.             if ($isTabField($fieldDto)) {
  242.                 $hasTabs = true;
  243.                 break;
  244.             }
  245.         }
  247.         if (!$hasTabs || $isTabField($fields->first())) {
  248.             return;
  249.         }
  251.         $orphanFieldNames = [];
  252.         foreach ($fields as $field) {
  253.             if ($isTabField($field)) {
  254.                 break;
  255.             }
  257.             if ($isFormField($field)) {
  258.                 continue;
  259.             }
  261.             $orphanFieldNames[] = $field->getProperty();
  262.         }
  264.         throw new \RuntimeException(sprintf('The "%s" page of "%s" uses tabs to display its fields, but the following fields don\'t belong to any tab: %s. Use "FormField::addTab(\'...\')" to add a tab before those fields.', $context->getCrud()->getCurrentPage(), $context->getCrud()->getControllerFqcn(), implode(', ', $orphanFieldNames)));
  265.     }
  266. }