vendor/symfony/doctrine-bridge/Form/ChoiceList/ORMQueryBuilderLoader.php line 46

Open in your IDE?
  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\ChoiceList;
  14. use Doctrine\DBAL\Connection;
  15. use Doctrine\DBAL\Types\ConversionException;
  16. use Doctrine\DBAL\Types\Type;
  17. use Doctrine\ORM\QueryBuilder;
  18. use Symfony\Component\Form\Exception\TransformationFailedException;
  20. /**
  21.  * Loads entities using a {@link QueryBuilder} instance.
  22.  *
  23.  * @author Benjamin Eberlei <kontakt@beberlei.de>
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  */
  26. class ORMQueryBuilderLoader implements EntityLoaderInterface
  27. {
  28.     /**
  29.      * Contains the query builder that builds the query for fetching the
  30.      * entities.
  31.      *
  32.      * This property should only be accessed through queryBuilder.
  33.      */
  34.     private $queryBuilder;
  36.     public function __construct(QueryBuilder $queryBuilder)
  37.     {
  38.         $this->queryBuilder = $queryBuilder;
  39.     }
  41.     /**
  42.      * {@inheritdoc}
  43.      */
  44.     public function getEntities(): array
  45.     {
  46.         return $this->queryBuilder->getQuery()->execute();
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function getEntitiesByIds(string $identifier, array $values): array
  53.     {
  54.         if (null !== $this->queryBuilder->getMaxResults() || 0 < (int) $this->queryBuilder->getFirstResult()) {
  55.             // an offset or a limit would apply on results including the where clause with submitted id values
  56.             // that could make invalid choices valid
  57.             $choices = [];
  58.             $metadata = $this->queryBuilder->getEntityManager()->getClassMetadata(current($this->queryBuilder->getRootEntities()));
  60.             foreach ($this->getEntities() as $entity) {
  61.                 if (\in_array((string) current($metadata->getIdentifierValues($entity)), $values, true)) {
  62.                     $choices[] = $entity;
  63.                 }
  64.             }
  66.             return $choices;
  67.         }
  69.         $qb = clone $this->queryBuilder;
  70.         $alias = current($qb->getRootAliases());
  71.         $parameter = 'ORMQueryBuilderLoader_getEntitiesByIds_'.$identifier;
  72.         $parameter = str_replace('.', '_', $parameter);
  73.         $where = $qb->expr()->in($alias.'.'.$identifier, ':'.$parameter);
  75.         // Guess type
  76.         $entity = current($qb->getRootEntities());
  77.         $metadata = $qb->getEntityManager()->getClassMetadata($entity);
  78.         if (\in_array($type = $metadata->getTypeOfField($identifier), ['integer', 'bigint', 'smallint'])) {
  79.             $parameterType = Connection::PARAM_INT_ARRAY;
  81.             // Filter out non-integer values (e.g. ""). If we don't, some
  82.             // databases such as PostgreSQL fail.
  83.             $values = array_values(array_filter($values, function ($v) {
  84.                 return (string) $v === (string) (int) $v || ctype_digit($v);
  85.             }));
  86.         } elseif (\in_array($type, ['ulid', 'uuid', 'guid'])) {
  87.             $parameterType = Connection::PARAM_STR_ARRAY;
  89.             // Like above, but we just filter out empty strings.
  90.             $values = array_values(array_filter($values, function ($v) {
  91.                 return '' !== (string) $v;
  92.             }));
  94.             // Convert values into right type
  95.             if (Type::hasType($type)) {
  96.                 $doctrineType = Type::getType($type);
  97.                 $platform = $qb->getEntityManager()->getConnection()->getDatabasePlatform();
  98.                 foreach ($values as &$value) {
  99.                     try {
  100.                         $value = $doctrineType->convertToDatabaseValue($value, $platform);
  101.                     } catch (ConversionException $e) {
  102.                         throw new TransformationFailedException(sprintf('Failed to transform "%s" into "%s".', $value, $type), 0, $e);
  103.                     }
  104.                 }
  105.                 unset($value);
  106.             }
  107.         } else {
  108.             $parameterType = Connection::PARAM_STR_ARRAY;
  109.         }
  110.         if (!$values) {
  111.             return [];
  112.         }
  114.         return $qb->andWhere($where)
  115.                   ->getQuery()
  116.                   ->setParameter($parameter, $values, $parameterType)
  117.                   ->getResult();
  118.     }
  119. }