vendor/symfony/doctrine-bridge/Form/Type/DoctrineType.php line 57

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Doctrine\Form\Type;
  14. use Doctrine\Common\Collections\Collection;
  15. use Doctrine\Persistence\ManagerRegistry;
  16. use Doctrine\Persistence\ObjectManager;
  17. use Symfony\Bridge\Doctrine\Form\ChoiceList\DoctrineChoiceLoader;
  18. use Symfony\Bridge\Doctrine\Form\ChoiceList\EntityLoaderInterface;
  19. use Symfony\Bridge\Doctrine\Form\ChoiceList\IdReader;
  20. use Symfony\Bridge\Doctrine\Form\DataTransformer\CollectionToArrayTransformer;
  21. use Symfony\Bridge\Doctrine\Form\EventListener\MergeDoctrineCollectionListener;
  22. use Symfony\Component\Form\AbstractType;
  23. use Symfony\Component\Form\ChoiceList\ChoiceList;
  24. use Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator;
  25. use Symfony\Component\Form\Exception\RuntimeException;
  26. use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
  27. use Symfony\Component\Form\FormBuilderInterface;
  28. use Symfony\Component\OptionsResolver\Options;
  29. use Symfony\Component\OptionsResolver\OptionsResolver;
  30. use Symfony\Contracts\Service\ResetInterface;
  32. abstract class DoctrineType extends AbstractType implements ResetInterface
  33. {
  34.     /**
  35.      * @var ManagerRegistry
  36.      */
  37.     protected $registry;
  39.     /**
  40.      * @var IdReader[]
  41.      */
  42.     private array $idReaders = [];
  44.     /**
  45.      * @var EntityLoaderInterface[]
  46.      */
  47.     private array $entityLoaders = [];
  49.     /**
  50.      * Creates the label for a choice.
  51.      *
  52.      * For backwards compatibility, objects are cast to strings by default.
  53.      *
  54.      * @internal This method is public to be usable as callback. It should not
  55.      *           be used in user code.
  56.      */
  57.     public static function createChoiceLabel(object $choice): string
  58.     {
  59.         return (string) $choice;
  60.     }
  62.     /**
  63.      * Creates the field name for a choice.
  64.      *
  65.      * This method is used to generate field names if the underlying object has
  66.      * a single-column integer ID. In that case, the value of the field is
  67.      * the ID of the object. That ID is also used as field name.
  68.      *
  69.      * @param string $value The choice value. Corresponds to the object's ID here.
  70.      *
  71.      * @internal This method is public to be usable as callback. It should not
  72.      *           be used in user code.
  73.      */
  74.     public static function createChoiceName(object $choice, int|string $key, string $value): string
  75.     {
  76.         return str_replace('-', '_', $value);
  77.     }
  79.     /**
  80.      * Gets important parts from QueryBuilder that will allow to cache its results.
  81.      * For instance in ORM two query builders with an equal SQL string and
  82.      * equal parameters are considered to be equal.
  83.      *
  84.      * @param object $queryBuilder A query builder, type declaration is not present here as there
  85.      *                             is no common base class for the different implementations
  86.      *
  87.      * @internal This method is public to be usable as callback. It should not
  88.      *           be used in user code.
  89.      */
  90.     public function getQueryBuilderPartsForCachingHash(object $queryBuilder): ?array
  91.     {
  92.         return null;
  93.     }
  95.     public function __construct(ManagerRegistry $registry)
  96.     {
  97.         $this->registry = $registry;
  98.     }
  100.     public function buildForm(FormBuilderInterface $builder, array $options)
  101.     {
  102.         if ($options['multiple'] && interface_exists(Collection::class)) {
  103.             $builder
  104.                 ->addEventSubscriber(new MergeDoctrineCollectionListener())
  105.                 ->addViewTransformer(new CollectionToArrayTransformer(), true)
  106.             ;
  107.         }
  108.     }
  110.     public function configureOptions(OptionsResolver $resolver)
  111.     {
  112.         $choiceLoader = function (Options $options) {
  113.             // Unless the choices are given explicitly, load them on demand
  114.             if (null === $options['choices']) {
  115.                 // If there is no QueryBuilder we can safely cache
  116.                 $vary = [$options['em'], $options['class']];
  118.                 // also if concrete Type can return important QueryBuilder parts to generate
  119.                 // hash key we go for it as well, otherwise fallback on the instance
  120.                 if ($options['query_builder']) {
  121.                     $vary[] = $this->getQueryBuilderPartsForCachingHash($options['query_builder']) ?? $options['query_builder'];
  122.                 }
  124.                 return ChoiceList::loader($this, new DoctrineChoiceLoader(
  125.                     $options['em'],
  126.                     $options['class'],
  127.                     $options['id_reader'],
  128.                     $this->getCachedEntityLoader(
  129.                         $options['em'],
  130.                         $options['query_builder'] ?? $options['em']->getRepository($options['class'])->createQueryBuilder('e'),
  131.                         $options['class'],
  132.                         $vary
  133.                     )
  134.                 ), $vary);
  135.             }
  137.             return null;
  138.         };
  140.         $choiceName = function (Options $options) {
  141.             // If the object has a single-column, numeric ID, use that ID as
  142.             // field name. We can only use numeric IDs as names, as we cannot
  143.             // guarantee that a non-numeric ID contains a valid form name
  144.             if ($options['id_reader'] instanceof IdReader && $options['id_reader']->isIntId()) {
  145.                 return ChoiceList::fieldName($this, [__CLASS__, 'createChoiceName']);
  146.             }
  148.             // Otherwise, an incrementing integer is used as name automatically
  149.             return null;
  150.         };
  152.         // The choices are always indexed by ID (see "choices" normalizer
  153.         // and DoctrineChoiceLoader), unless the ID is composite. Then they
  154.         // are indexed by an incrementing integer.
  155.         // Use the ID/incrementing integer as choice value.
  156.         $choiceValue = function (Options $options) {
  157.             // If the entity has a single-column ID, use that ID as value
  158.             if ($options['id_reader'] instanceof IdReader && $options['id_reader']->isSingleId()) {
  159.                 return ChoiceList::value($this, $options['id_reader']->getIdValue(...), $options['id_reader']);
  160.             }
  162.             // Otherwise, an incrementing integer is used as value automatically
  163.             return null;
  164.         };
  166.         $emNormalizer = function (Options $options, $em) {
  167.             if (null !== $em) {
  168.                 if ($em instanceof ObjectManager) {
  169.                     return $em;
  170.                 }
  172.                 return $this->registry->getManager($em);
  173.             }
  175.             $em = $this->registry->getManagerForClass($options['class']);
  177.             if (null === $em) {
  178.                 throw new RuntimeException(sprintf('Class "%s" seems not to be a managed Doctrine entity. Did you forget to map it?', $options['class']));
  179.             }
  181.             return $em;
  182.         };
  184.         // Invoke the query builder closure so that we can cache choice lists
  185.         // for equal query builders
  186.         $queryBuilderNormalizer = function (Options $options, $queryBuilder) {
  187.             if (\is_callable($queryBuilder)) {
  188.                 $queryBuilder = $queryBuilder($options['em']->getRepository($options['class']));
  189.             }
  191.             return $queryBuilder;
  192.         };
  194.         // Set the "id_reader" option via the normalizer. This option is not
  195.         // supposed to be set by the user.
  196.         $idReaderNormalizer = function (Options $options) {
  197.             // The ID reader is a utility that is needed to read the object IDs
  198.             // when generating the field values. The callback generating the
  199.             // field values has no access to the object manager or the class
  200.             // of the field, so we store that information in the reader.
  201.             // The reader is cached so that two choice lists for the same class
  202.             // (and hence with the same reader) can successfully be cached.
  203.             return $this->getCachedIdReader($options['em'], $options['class']);
  204.         };
  206.         $resolver->setDefaults([
  207.             'em' => null,
  208.             'query_builder' => null,
  209.             'choices' => null,
  210.             'choice_loader' => $choiceLoader,
  211.             'choice_label' => ChoiceList::label($this, [__CLASS__, 'createChoiceLabel']),
  212.             'choice_name' => $choiceName,
  213.             'choice_value' => $choiceValue,
  214.             'id_reader' => null, // internal
  215.             'choice_translation_domain' => false,
  216.         ]);
  218.         $resolver->setRequired(['class']);
  220.         $resolver->setNormalizer('em', $emNormalizer);
  221.         $resolver->setNormalizer('query_builder', $queryBuilderNormalizer);
  222.         $resolver->setNormalizer('id_reader', $idReaderNormalizer);
  224.         $resolver->setAllowedTypes('em', ['null', 'string', ObjectManager::class]);
  225.     }
  227.     /**
  228.      * Return the default loader object.
  229.      */
  230.     abstract public function getLoader(ObjectManager $manager, object $queryBuilder, string $class): EntityLoaderInterface;
  232.     public function getParent(): string
  233.     {
  234.         return ChoiceType::class;
  235.     }
  237.     public function reset()
  238.     {
  239.         $this->idReaders = [];
  240.         $this->entityLoaders = [];
  241.     }
  243.     private function getCachedIdReader(ObjectManager $manager, string $class): ?IdReader
  244.     {
  245.         $hash = CachingFactoryDecorator::generateHash([$manager, $class]);
  247.         if (isset($this->idReaders[$hash])) {
  248.             return $this->idReaders[$hash];
  249.         }
  251.         $idReader = new IdReader($manager, $manager->getClassMetadata($class));
  253.         // don't cache the instance for composite ids that cannot be optimized
  254.         return $this->idReaders[$hash] = $idReader->isSingleId() ? $idReader : null;
  255.     }
  257.     private function getCachedEntityLoader(ObjectManager $manager, object $queryBuilder, string $class, array $vary): EntityLoaderInterface
  258.     {
  259.         $hash = CachingFactoryDecorator::generateHash($vary);
  261.         return $this->entityLoaders[$hash] ??= $this->getLoader($manager, $queryBuilder, $class);
  262.     }
  263. }