vendor/easycorp/easyadmin-bundle/src/Field/Configurator/CommonPreConfigurator.php line 41

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Field\Configurator;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  7. use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
  8. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldConfiguratorInterface;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
  12. use EasyCorp\Bundle\EasyAdminBundle\Field\AvatarField;
  13. use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;
  14. use Symfony\Component\PropertyAccess\Exception\AccessException;
  15. use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
  16. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  17. use function Symfony\Component\String\u;
  18. use function Symfony\Component\Translation\t;
  19. use Symfony\Contracts\Translation\TranslatableInterface;
  21. /**
  22.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  23.  */
  24. final class CommonPreConfigurator implements FieldConfiguratorInterface
  25. {
  26.     private PropertyAccessorInterface $propertyAccessor;
  27.     private EntityFactory $entityFactory;
  29.     public function __construct(PropertyAccessorInterface $propertyAccessor, EntityFactory $entityFactory)
  30.     {
  31.         $this->propertyAccessor = $propertyAccessor;
  32.         $this->entityFactory = $entityFactory;
  33.     }
  35.     public function supports(FieldDto $field, EntityDto $entityDto): bool
  36.     {
  37.         // this configurator applies to all kinds of properties
  38.         return true;
  39.     }
  41.     public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $context): void
  42.     {
  43.         $translationDomain = $context->getI18n()->getTranslationDomain();
  45.         // if a field already has set a value, someone has written something to
  46.         // it (as a virtual field or overwrite); don't modify the value in that case
  47.         $isReadable = true;
  48.         if (null === $value = $field->getValue()) {
  49.             try {
  50.                 $value = null === $entityDto->getInstance() ? null : $this->propertyAccessor->getValue($entityDto->getInstance(), $field->getProperty());
  51.             } catch (AccessException|UnexpectedTypeException) {
  52.                 $isReadable = false;
  53.             }
  55.             $field->setValue($value);
  56.             if (null === $field->getFormattedValue()) {
  57.                 $field->setFormattedValue($value);
  58.             }
  59.         }
  61.         $label = $this->buildLabelOption($field, $translationDomain, $context->getCrud()->getCurrentPage());
  62.         $field->setLabel($label);
  64.         $isRequired = $this->buildRequiredOption($field, $entityDto);
  65.         $field->setFormTypeOption('required', $isRequired);
  67.         $isSortable = $this->buildSortableOption($field, $entityDto);
  68.         $field->setSortable($isSortable);
  70.         $isVirtual = $this->buildVirtualOption($field, $entityDto);
  71.         $field->setVirtual($isVirtual);
  73.         $templatePath = $this->buildTemplatePathOption($context, $field, $entityDto, $isReadable);
  74.         $field->setTemplatePath($templatePath);
  76.         $doctrineMetadata = $entityDto->hasProperty($field->getProperty()) ? $entityDto->getPropertyMetadata($field->getProperty())->all() : [];
  77.         $field->setDoctrineMetadata($doctrineMetadata);
  79.         if (null !== $helpMessage = $this->buildHelpOption($field, $translationDomain)) {
  80.             $field->setHelp($helpMessage);
  81.             $field->setFormTypeOptionIfNotSet('help', $helpMessage);
  82.             $field->setFormTypeOptionIfNotSet('help_html', true);
  83.         }
  85.         if ('' !== $field->getCssClass()) {
  86.             $field->setFormTypeOptionIfNotSet('row_attr.class', $field->getCssClass());
  87.         }
  89.         if (null !== $field->getTextAlign()) {
  90.             $field->setFormTypeOptionIfNotSet('attr.data-ea-align', $field->getTextAlign());
  91.         }
  93.         $field->setFormTypeOptionIfNotSet('label', $field->getLabel());
  94.     }
  96.     private function buildHelpOption(FieldDto $field, string $translationDomain): ?TranslatableInterface
  97.     {
  98.         $help = $field->getHelp();
  99.         if (null === $help || $help instanceof TranslatableInterface) {
  100.             return $help;
  101.         }
  103.         return '' === $help ? null : t($help, $field->getTranslationParameters(), $translationDomain);
  104.     }
  106.     /**
  107.      * @return TranslatableInterface|string|false|null
  108.      */
  109.     private function buildLabelOption(FieldDto $field, string $translationDomain, ?string $currentPage)
  110.     {
  111.         // don't autogenerate a label for these special fields (there's a dedicated configurator for them)
  112.         if (FormField::class === $field->getFieldFqcn()) {
  113.             $label = $field->getLabel();
  115.             if ($label instanceof TranslatableInterface) {
  116.                 return $label;
  117.             }
  119.             return (null === $label || false === $label || '' === $label) ? $label : t($label, $field->getTranslationParameters(), $translationDomain);
  120.         }
  122.         // if an Avatar field doesn't define its label, don't autogenerate it for the 'index' page
  123.         // (because the table of the 'index' page looks better without a header in the avatar column)
  124.         if (Action::INDEX === $currentPage && null === $field->getLabel() && AvatarField::class === $field->getFieldFqcn()) {
  125.             $field->setLabel(false);
  126.         }
  128.         // it field doesn't define its label explicitly, generate an automatic
  129.         // label based on the field's field name
  130.         if (null === $label = $field->getLabel()) {
  131.             $label = $this->humanizeString($field->getProperty());
  132.         }
  134.         if ('' === $label) {
  135.             return $label;
  136.         }
  138.         // don't translate labels in form-related pages because Symfony Forms translates
  139.         // labels automatically and that causes false "translation is missing" errors
  140.         if (\in_array($currentPage, [Crud::PAGE_EDIT, Crud::PAGE_NEW], true)) {
  141.             return $label;
  142.         }
  144.         if ($label instanceof TranslatableInterface) {
  145.             return $label;
  146.         }
  148.         return t($label, $field->getTranslationParameters(), $translationDomain);
  149.     }
  151.     private function buildSortableOption(FieldDto $field, EntityDto $entityDto): bool
  152.     {
  153.         if (null !== $isSortable = $field->isSortable()) {
  154.             return $isSortable;
  155.         }
  157.         return $entityDto->hasProperty($field->getProperty());
  158.     }
  160.     private function buildVirtualOption(FieldDto $field, EntityDto $entityDto): bool
  161.     {
  162.         return !$entityDto->hasProperty($field->getProperty());
  163.     }
  165.     private function buildTemplatePathOption(AdminContext $adminContext, FieldDto $field, EntityDto $entityDto, bool $isReadable): string
  166.     {
  167.         if (null !== $templatePath = $field->getTemplatePath()) {
  168.             return $templatePath;
  169.         }
  171.         // if field has a value set, don't display it as inaccessible (needed e.g. for virtual fields)
  172.         if (!$isReadable && null === $field->getValue()) {
  173.             return $adminContext->getTemplatePath('label/inaccessible');
  174.         }
  176.         if (null === $templateName = $field->getTemplateName()) {
  177.             throw new \RuntimeException(sprintf('Fields must define either their templateName or their templatePath. None given for "%s" field.', $field->getProperty()));
  178.         }
  180.         return $adminContext->getTemplatePath($templateName);
  181.     }
  183.     private function buildRequiredOption(FieldDto $field, EntityDto $entityDto): bool
  184.     {
  185.         if (null !== $isRequired = $field->getFormTypeOption('required')) {
  186.             return $isRequired;
  187.         }
  189.         // consider that virtual properties are not required
  190.         if (!$entityDto->hasProperty($field->getProperty())) {
  191.             return false;
  192.         }
  194.         $doctrinePropertyMetadata = $entityDto->getPropertyMetadata($field->getProperty());
  196.         // If at least one join column of an association field isn't nullable then the field is "required" by default, otherwise the field is optional
  197.         if ($entityDto->isAssociation($field->getProperty())) {
  198.             $associatedEntityMetadata = $this->entityFactory->getEntityMetadata($doctrinePropertyMetadata->get('targetEntity'));
  199.             foreach ($doctrinePropertyMetadata->get('joinColumns', []) as $joinColumn) {
  200.                 $propertyNameInAssociatedEntity = $joinColumn['referencedColumnName'];
  201.                 $associatedPropertyMetadata = $associatedEntityMetadata->fieldMappings[$propertyNameInAssociatedEntity] ?? [];
  202.                 $isNullable = $associatedPropertyMetadata['nullable'] ?? true;
  203.                 if (false === $isNullable) {
  204.                     return true;
  205.                 }
  206.             }
  208.             return false;
  209.         }
  211.         // TODO: check if it's correct to never make a boolean value required
  212.         // I guess it's correct because Symfony Forms treat NULL as FALSE by default (i.e. in the database the value won't be NULL)
  213.         if ('boolean' === $doctrinePropertyMetadata->get('type')) {
  214.             return false;
  215.         }
  217.         return false === $doctrinePropertyMetadata->get('nullable');
  218.     }
  220.     private function humanizeString(string $string): string
  221.     {
  222.         $uString = u($string);
  223.         $upperString = $uString->upper()->toString();
  225.         // this prevents humanizing all-uppercase labels (e.g. 'UUID' -> 'U u i d')
  226.         // and other special labels which look better in uppercase
  227.         if ($uString->toString() === $upperString || \in_array($upperString, ['ID', 'URL'], true)) {
  228.             return $upperString;
  229.         }
  231.         return $uString
  232.             ->replaceMatches('/([A-Z])/', '_$1')
  233.             ->replaceMatches('/[_\s]+/', ' ')
  234.             ->trim()
  235.             ->lower()
  236.             ->title(true)
  237.             ->toString();
  238.     }
  239. }