vendor/symfony/ux-autocomplete/src/Form/WrappedEntityTypeAutocompleter.php line 118

Open in your IDE?
  1. <?php
  3. namespace Symfony\UX\Autocomplete\Form;
  5. use Doctrine\ORM\EntityRepository;
  6. use Doctrine\ORM\QueryBuilder;
  7. use Symfony\Component\Form\FormFactoryInterface;
  8. use Symfony\Component\Form\FormInterface;
  9. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  10. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  11. use Symfony\Component\Security\Core\Security;
  12. use Symfony\UX\Autocomplete\Doctrine\EntityMetadata;
  13. use Symfony\UX\Autocomplete\Doctrine\EntityMetadataFactory;
  14. use Symfony\UX\Autocomplete\Doctrine\EntitySearchUtil;
  15. use Symfony\UX\Autocomplete\EntityAutocompleterInterface;
  17. /**
  18.  * An entity auto-completer that wraps a form type to get its information.
  19.  *
  20.  * @internal
  21.  */
  22. final class WrappedEntityTypeAutocompleter implements EntityAutocompleterInterface
  23. {
  24.     private ?FormInterface $form = null;
  25.     private ?EntityMetadata $entityMetadata = null;
  27.     public function __construct(
  28.         private string $formType,
  29.         private FormFactoryInterface $formFactory,
  30.         private EntityMetadataFactory $metadataFactory,
  31.         private PropertyAccessorInterface $propertyAccessor,
  32.         private EntitySearchUtil $entitySearchUtil
  33.     ) {
  34.     }
  36.     public function getEntityClass(): string
  37.     {
  38.         return $this->getFormOption('class');
  39.     }
  41.     public function createFilteredQueryBuilder(EntityRepository $repository, string $query): QueryBuilder
  42.     {
  43.         $queryBuilder = $this->getFormOption('query_builder');
  44.         $queryBuilder = $queryBuilder ?: $repository->createQueryBuilder('entity');
  46.         if ($filterQuery = $this->getFilterQuery()) {
  47.             $filterQuery($queryBuilder, $query, $repository);
  49.             return $queryBuilder;
  50.         }
  52.         // avoid filtering if there is no query
  53.         if (!$query) {
  54.             return $queryBuilder;
  55.         }
  57.         $this->entitySearchUtil->addSearchClause(
  58.             $queryBuilder,
  59.             $query,
  60.             $this->getEntityClass(),
  61.             $this->getSearchableFields()
  62.         );
  64.         return $queryBuilder;
  65.     }
  67.     public function getLabel(object $entity): string
  68.     {
  69.         $choiceLabel = $this->getFormOption('choice_label');
  71.         if (null === $choiceLabel) {
  72.             return (string) $entity;
  73.         }
  75.         if (\is_string($choiceLabel) || $choiceLabel instanceof PropertyPathInterface) {
  76.             return $this->propertyAccessor->getValue($entity, $choiceLabel);
  77.         }
  79.         // 0 hardcoded as the "index", should not be relevant
  80.         return $choiceLabel($entity, 0, $this->getValue($entity));
  81.     }
  83.     public function getValue(object $entity): string
  84.     {
  85.         return $this->getEntityMetadata()->getIdValue($entity);
  86.     }
  88.     public function isGranted(Security $security): bool
  89.     {
  90.         $securityOption = $this->getForm()->getConfig()->getOption('security');
  92.         if (false === $securityOption) {
  93.             return true;
  94.         }
  96.         if (\is_string($securityOption)) {
  97.             return $security->isGranted($securityOption, $this);
  98.         }
  100.         if (\is_callable($securityOption)) {
  101.             return $securityOption($security);
  102.         }
  104.         throw new \InvalidArgumentException('Invalid passed to the "security" option: it must be the boolean true, a string role or a callable.');
  105.     }
  107.     private function getFormOption(string $name): mixed
  108.     {
  109.         $form = $this->getForm();
  110.         $formOptions = $form['autocomplete']->getConfig()->getOptions();
  112.         return $formOptions[$name] ?? null;
  113.     }
  115.     private function getForm(): FormInterface
  116.     {
  117.         if (null === $this->form) {
  118.             $this->form = $this->formFactory->create($this->formType);
  119.         }
  121.         return $this->form;
  122.     }
  124.     private function getSearchableFields(): ?array
  125.     {
  126.         return $this->getForm()->getConfig()->getOption('searchable_fields');
  127.     }
  129.     private function getFilterQuery(): ?callable
  130.     {
  131.         return $this->getForm()->getConfig()->getOption('filter_query');
  132.     }
  134.     private function getEntityMetadata(): EntityMetadata
  135.     {
  136.         if (null === $this->entityMetadata) {
  137.             $this->entityMetadata = $this->metadataFactory->create($this->getEntityClass());
  138.         }
  140.         return $this->entityMetadata;
  141.     }
  142. }