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

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