vendor/doctrine/orm/lib/Doctrine/ORM/Persisters/Entity/BasicEntityPersister.php line 789

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Persisters\Entity;
  7. use BackedEnum;
  8. use Doctrine\Common\Collections\Criteria;
  9. use Doctrine\Common\Collections\Expr\Comparison;
  10. use Doctrine\DBAL\Connection;
  11. use Doctrine\DBAL\LockMode;
  12. use Doctrine\DBAL\Platforms\AbstractPlatform;
  13. use Doctrine\DBAL\Result;
  14. use Doctrine\DBAL\Types\Type;
  15. use Doctrine\DBAL\Types\Types;
  16. use Doctrine\Deprecations\Deprecation;
  17. use Doctrine\ORM\EntityManagerInterface;
  18. use Doctrine\ORM\Mapping\ClassMetadata;
  19. use Doctrine\ORM\Mapping\MappingException;
  20. use Doctrine\ORM\Mapping\QuoteStrategy;
  21. use Doctrine\ORM\OptimisticLockException;
  22. use Doctrine\ORM\PersistentCollection;
  23. use Doctrine\ORM\Persisters\Exception\CantUseInOperatorOnCompositeKeys;
  24. use Doctrine\ORM\Persisters\Exception\InvalidOrientation;
  25. use Doctrine\ORM\Persisters\Exception\UnrecognizedField;
  26. use Doctrine\ORM\Persisters\SqlExpressionVisitor;
  27. use Doctrine\ORM\Persisters\SqlValueVisitor;
  28. use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
  29. use Doctrine\ORM\Query;
  30. use Doctrine\ORM\Query\QueryException;
  31. use Doctrine\ORM\Repository\Exception\InvalidFindByCall;
  32. use Doctrine\ORM\UnitOfWork;
  33. use Doctrine\ORM\Utility\IdentifierFlattener;
  34. use Doctrine\ORM\Utility\PersisterHelper;
  35. use LengthException;
  37. use function array_combine;
  38. use function array_keys;
  39. use function array_map;
  40. use function array_merge;
  41. use function array_search;
  42. use function array_unique;
  43. use function array_values;
  44. use function assert;
  45. use function count;
  46. use function implode;
  47. use function is_array;
  48. use function is_object;
  49. use function reset;
  50. use function spl_object_id;
  51. use function sprintf;
  52. use function str_contains;
  53. use function strtoupper;
  54. use function trim;
  56. /**
  57.  * A BasicEntityPersister maps an entity to a single table in a relational database.
  58.  *
  59.  * A persister is always responsible for a single entity type.
  60.  *
  61.  * EntityPersisters are used during a UnitOfWork to apply any changes to the persistent
  62.  * state of entities onto a relational database when the UnitOfWork is committed,
  63.  * as well as for basic querying of entities and their associations (not DQL).
  64.  *
  65.  * The persisting operations that are invoked during a commit of a UnitOfWork to
  66.  * persist the persistent entity state are:
  67.  *
  68.  *   - {@link addInsert} : To schedule an entity for insertion.
  69.  *   - {@link executeInserts} : To execute all scheduled insertions.
  70.  *   - {@link update} : To update the persistent state of an entity.
  71.  *   - {@link delete} : To delete the persistent state of an entity.
  72.  *
  73.  * As can be seen from the above list, insertions are batched and executed all at once
  74.  * for increased efficiency.
  75.  *
  76.  * The querying operations invoked during a UnitOfWork, either through direct find
  77.  * requests or lazy-loading, are the following:
  78.  *
  79.  *   - {@link load} : Loads (the state of) a single, managed entity.
  80.  *   - {@link loadAll} : Loads multiple, managed entities.
  81.  *   - {@link loadOneToOneEntity} : Loads a one/many-to-one entity association (lazy-loading).
  82.  *   - {@link loadOneToManyCollection} : Loads a one-to-many entity association (lazy-loading).
  83.  *   - {@link loadManyToManyCollection} : Loads a many-to-many entity association (lazy-loading).
  84.  *
  85.  * The BasicEntityPersister implementation provides the default behavior for
  86.  * persisting and querying entities that are mapped to a single database table.
  87.  *
  88.  * Subclasses can be created to provide custom persisting and querying strategies,
  89.  * i.e. spanning multiple tables.
  90.  *
  91.  * @psalm-import-type AssociationMapping from ClassMetadata
  92.  */
  93. class BasicEntityPersister implements EntityPersister
  94. {
  95.     /** @var array<string,string> */
  96.     private static $comparisonMap = [
  97.         Comparison::EQ          => '= %s',
  98.         Comparison::NEQ         => '!= %s',
  99.         Comparison::GT          => '> %s',
  100.         Comparison::GTE         => '>= %s',
  101.         Comparison::LT          => '< %s',
  102.         Comparison::LTE         => '<= %s',
  103.         Comparison::IN          => 'IN (%s)',
  104.         Comparison::NIN         => 'NOT IN (%s)',
  105.         Comparison::CONTAINS    => 'LIKE %s',
  106.         Comparison::STARTS_WITH => 'LIKE %s',
  107.         Comparison::ENDS_WITH   => 'LIKE %s',
  108.     ];
  110.     /**
  111.      * Metadata object that describes the mapping of the mapped entity class.
  112.      *
  113.      * @var ClassMetadata
  114.      */
  115.     protected $class;
  117.     /**
  118.      * The underlying DBAL Connection of the used EntityManager.
  119.      *
  120.      * @var Connection $conn
  121.      */
  122.     protected $conn;
  124.     /**
  125.      * The database platform.
  126.      *
  127.      * @var AbstractPlatform
  128.      */
  129.     protected $platform;
  131.     /**
  132.      * The EntityManager instance.
  133.      *
  134.      * @var EntityManagerInterface
  135.      */
  136.     protected $em;
  138.     /**
  139.      * Queued inserts.
  140.      *
  141.      * @psalm-var array<int, object>
  142.      */
  143.     protected $queuedInserts = [];
  145.     /**
  146.      * The map of column names to DBAL mapping types of all prepared columns used
  147.      * when INSERTing or UPDATEing an entity.
  148.      *
  149.      * @see prepareInsertData($entity)
  150.      * @see prepareUpdateData($entity)
  151.      *
  152.      * @var mixed[]
  153.      */
  154.     protected $columnTypes = [];
  156.     /**
  157.      * The map of quoted column names.
  158.      *
  159.      * @see prepareInsertData($entity)
  160.      * @see prepareUpdateData($entity)
  161.      *
  162.      * @var mixed[]
  163.      */
  164.     protected $quotedColumns = [];
  166.     /**
  167.      * The INSERT SQL statement used for entities handled by this persister.
  168.      * This SQL is only generated once per request, if at all.
  169.      *
  170.      * @var string|null
  171.      */
  172.     private $insertSql;
  174.     /**
  175.      * The quote strategy.
  176.      *
  177.      * @var QuoteStrategy
  178.      */
  179.     protected $quoteStrategy;
  181.     /**
  182.      * The IdentifierFlattener used for manipulating identifiers
  183.      *
  184.      * @var IdentifierFlattener
  185.      */
  186.     protected $identifierFlattener;
  188.     /** @var CachedPersisterContext */
  189.     protected $currentPersisterContext;
  191.     /** @var CachedPersisterContext */
  192.     private $limitsHandlingContext;
  194.     /** @var CachedPersisterContext */
  195.     private $noLimitsContext;
  197.     /**
  198.      * Initializes a new <tt>BasicEntityPersister</tt> that uses the given EntityManager
  199.      * and persists instances of the class described by the given ClassMetadata descriptor.
  200.      */
  201.     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  202.     {
  203.         $this->em                    = $em;
  204.         $this->class                 = $class;
  205.         $this->conn                  = $em->getConnection();
  206.         $this->platform              = $this->conn->getDatabasePlatform();
  207.         $this->quoteStrategy         = $em->getConfiguration()->getQuoteStrategy();
  208.         $this->identifierFlattener   = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
  209.         $this->noLimitsContext       = $this->currentPersisterContext = new CachedPersisterContext(
  210.             $class,
  211.             new Query\ResultSetMapping(),
  212.             false
  213.         );
  214.         $this->limitsHandlingContext = new CachedPersisterContext(
  215.             $class,
  216.             new Query\ResultSetMapping(),
  217.             true
  218.         );
  219.     }
  221.     /**
  222.      * {@inheritDoc}
  223.      */
  224.     public function getClassMetadata()
  225.     {
  226.         return $this->class;
  227.     }
  229.     /**
  230.      * {@inheritDoc}
  231.      */
  232.     public function getResultSetMapping()
  233.     {
  234.         return $this->currentPersisterContext->rsm;
  235.     }
  237.     /**
  238.      * {@inheritDoc}
  239.      */
  240.     public function addInsert($entity)
  241.     {
  242.         $this->queuedInserts[spl_object_id($entity)] = $entity;
  243.     }
  245.     /**
  246.      * {@inheritDoc}
  247.      */
  248.     public function getInserts()
  249.     {
  250.         return $this->queuedInserts;
  251.     }
  253.     /**
  254.      * {@inheritDoc}
  255.      */
  256.     public function executeInserts()
  257.     {
  258.         if (! $this->queuedInserts) {
  259.             return;
  260.         }
  262.         $uow            = $this->em->getUnitOfWork();
  263.         $idGenerator    = $this->class->idGenerator;
  264.         $isPostInsertId = $idGenerator->isPostInsertGenerator();
  266.         $stmt      = $this->conn->prepare($this->getInsertSQL());
  267.         $tableName = $this->class->getTableName();
  269.         foreach ($this->queuedInserts as $key => $entity) {
  270.             $insertData = $this->prepareInsertData($entity);
  272.             if (isset($insertData[$tableName])) {
  273.                 $paramIndex = 1;
  275.                 foreach ($insertData[$tableName] as $column => $value) {
  276.                     $stmt->bindValue($paramIndex++, $value, $this->columnTypes[$column]);
  277.                 }
  278.             }
  280.             $stmt->executeStatement();
  282.             if ($isPostInsertId) {
  283.                 $generatedId = $idGenerator->generateId($this->em, $entity);
  284.                 $id          = [$this->class->identifier[0] => $generatedId];
  286.                 $uow->assignPostInsertId($entity, $generatedId);
  287.             } else {
  288.                 $id = $this->class->getIdentifierValues($entity);
  289.             }
  291.             if ($this->class->requiresFetchAfterChange) {
  292.                 $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  293.             }
  295.             // Unset this queued insert, so that the prepareUpdateData() method knows right away
  296.             // (for the next entity already) that the current entity has been written to the database
  297.             // and no extra updates need to be scheduled to refer to it.
  298.             //
  299.             // In \Doctrine\ORM\UnitOfWork::executeInserts(), the UoW already removed entities
  300.             // from its own list (\Doctrine\ORM\UnitOfWork::$entityInsertions) right after they
  301.             // were given to our addInsert() method.
  302.             unset($this->queuedInserts[$key]);
  303.         }
  304.     }
  306.     /**
  307.      * Retrieves the default version value which was created
  308.      * by the preceding INSERT statement and assigns it back in to the
  309.      * entities version field if the given entity is versioned.
  310.      * Also retrieves values of columns marked as 'non insertable' and / or
  311.      * 'not updatable' and assigns them back to the entities corresponding fields.
  312.      *
  313.      * @param object  $entity
  314.      * @param mixed[] $id
  315.      *
  316.      * @return void
  317.      */
  318.     protected function assignDefaultVersionAndUpsertableValues($entity, array $id)
  319.     {
  320.         $values = $this->fetchVersionAndNotUpsertableValues($this->class, $id);
  322.         foreach ($values as $field => $value) {
  323.             $value = Type::getType($this->class->fieldMappings[$field]['type'])->convertToPHPValue($value, $this->platform);
  325.             $this->class->setFieldValue($entity, $field, $value);
  326.         }
  327.     }
  329.     /**
  330.      * Fetches the current version value of a versioned entity and / or the values of fields
  331.      * marked as 'not insertable' and / or 'not updatable'.
  332.      *
  333.      * @param ClassMetadata $versionedClass
  334.      * @param mixed[]       $id
  335.      *
  336.      * @return mixed
  337.      */
  338.     protected function fetchVersionAndNotUpsertableValues($versionedClass, array $id)
  339.     {
  340.         $columnNames = [];
  341.         foreach ($this->class->fieldMappings as $key => $column) {
  342.             if (isset($column['generated']) || ($this->class->isVersioned && $key === $versionedClass->versionField)) {
  343.                 $columnNames[$key] = $this->quoteStrategy->getColumnName($key, $versionedClass, $this->platform);
  344.             }
  345.         }
  347.         $tableName  = $this->quoteStrategy->getTableName($versionedClass, $this->platform);
  348.         $identifier = $this->quoteStrategy->getIdentifierColumnNames($versionedClass, $this->platform);
  350.         // FIXME: Order with composite keys might not be correct
  351.         $sql = 'SELECT ' . implode(', ', $columnNames)
  352.             . ' FROM ' . $tableName
  353.             . ' WHERE ' . implode(' = ? AND ', $identifier) . ' = ?';
  355.         $flatId = $this->identifierFlattener->flattenIdentifier($versionedClass, $id);
  357.         $values = $this->conn->fetchNumeric(
  358.             $sql,
  359.             array_values($flatId),
  360.             $this->extractIdentifierTypes($id, $versionedClass)
  361.         );
  363.         if ($values === false) {
  364.             throw new LengthException('Unexpected empty result for database query.');
  365.         }
  367.         $values = array_combine(array_keys($columnNames), $values);
  369.         if (! $values) {
  370.             throw new LengthException('Unexpected number of database columns.');
  371.         }
  373.         return $values;
  374.     }
  376.     /**
  377.      * @param mixed[] $id
  378.      *
  379.      * @return int[]|null[]|string[]
  380.      * @psalm-return list<int|string|null>
  381.      */
  382.     final protected function extractIdentifierTypes(array $id, ClassMetadata $versionedClass): array
  383.     {
  384.         $types = [];
  386.         foreach ($id as $field => $value) {
  387.             $types = array_merge($types, $this->getTypes($field, $value, $versionedClass));
  388.         }
  390.         return $types;
  391.     }
  393.     /**
  394.      * {@inheritDoc}
  395.      */
  396.     public function update($entity)
  397.     {
  398.         $tableName  = $this->class->getTableName();
  399.         $updateData = $this->prepareUpdateData($entity);
  401.         if (! isset($updateData[$tableName])) {
  402.             return;
  403.         }
  405.         $data = $updateData[$tableName];
  407.         if (! $data) {
  408.             return;
  409.         }
  411.         $isVersioned     = $this->class->isVersioned;
  412.         $quotedTableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  414.         $this->updateTable($entity, $quotedTableName, $data, $isVersioned);
  416.         if ($this->class->requiresFetchAfterChange) {
  417.             $id = $this->class->getIdentifierValues($entity);
  419.             $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  420.         }
  421.     }
  423.     /**
  424.      * Performs an UPDATE statement for an entity on a specific table.
  425.      * The UPDATE can optionally be versioned, which requires the entity to have a version field.
  426.      *
  427.      * @param object  $entity          The entity object being updated.
  428.      * @param string  $quotedTableName The quoted name of the table to apply the UPDATE on.
  429.      * @param mixed[] $updateData      The map of columns to update (column => value).
  430.      * @param bool    $versioned       Whether the UPDATE should be versioned.
  431.      *
  432.      * @throws UnrecognizedField
  433.      * @throws OptimisticLockException
  434.      */
  435.     final protected function updateTable(
  436.         $entity,
  437.         $quotedTableName,
  438.         array $updateData,
  439.         $versioned = false
  440.     ): void {
  441.         $set    = [];
  442.         $types  = [];
  443.         $params = [];
  445.         foreach ($updateData as $columnName => $value) {
  446.             $placeholder = '?';
  447.             $column      = $columnName;
  449.             switch (true) {
  450.                 case isset($this->class->fieldNames[$columnName]):
  451.                     $fieldName = $this->class->fieldNames[$columnName];
  452.                     $column    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  454.                     if (isset($this->class->fieldMappings[$fieldName]['requireSQLConversion'])) {
  455.                         $type        = Type::getType($this->columnTypes[$columnName]);
  456.                         $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  457.                     }
  459.                     break;
  461.                 case isset($this->quotedColumns[$columnName]):
  462.                     $column = $this->quotedColumns[$columnName];
  464.                     break;
  465.             }
  467.             $params[] = $value;
  468.             $set[]    = $column . ' = ' . $placeholder;
  469.             $types[]  = $this->columnTypes[$columnName];
  470.         }
  472.         $where      = [];
  473.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  475.         foreach ($this->class->identifier as $idField) {
  476.             if (! isset($this->class->associationMappings[$idField])) {
  477.                 $params[] = $identifier[$idField];
  478.                 $types[]  = $this->class->fieldMappings[$idField]['type'];
  479.                 $where[]  = $this->quoteStrategy->getColumnName($idField, $this->class, $this->platform);
  481.                 continue;
  482.             }
  484.             $params[] = $identifier[$idField];
  485.             $where[]  = $this->quoteStrategy->getJoinColumnName(
  486.                 $this->class->associationMappings[$idField]['joinColumns'][0],
  487.                 $this->class,
  488.                 $this->platform
  489.             );
  491.             $targetMapping = $this->em->getClassMetadata($this->class->associationMappings[$idField]['targetEntity']);
  492.             $targetType    = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
  494.             if ($targetType === []) {
  495.                 throw UnrecognizedField::byFullyQualifiedName($this->class->name, $targetMapping->identifier[0]);
  496.             }
  498.             $types[] = reset($targetType);
  499.         }
  501.         if ($versioned) {
  502.             $versionField = $this->class->versionField;
  503.             assert($versionField !== null);
  504.             $versionFieldType = $this->class->fieldMappings[$versionField]['type'];
  505.             $versionColumn    = $this->quoteStrategy->getColumnName($versionField, $this->class, $this->platform);
  507.             $where[]  = $versionColumn;
  508.             $types[]  = $this->class->fieldMappings[$versionField]['type'];
  509.             $params[] = $this->class->reflFields[$versionField]->getValue($entity);
  511.             switch ($versionFieldType) {
  512.                 case Types::SMALLINT:
  513.                 case Types::INTEGER:
  514.                 case Types::BIGINT:
  515.                     $set[] = $versionColumn . ' = ' . $versionColumn . ' + 1';
  516.                     break;
  518.                 case Types::DATETIME_MUTABLE:
  519.                     $set[] = $versionColumn . ' = CURRENT_TIMESTAMP';
  520.                     break;
  521.             }
  522.         }
  524.         $sql = 'UPDATE ' . $quotedTableName
  525.              . ' SET ' . implode(', ', $set)
  526.              . ' WHERE ' . implode(' = ? AND ', $where) . ' = ?';
  528.         $result = $this->conn->executeStatement($sql, $params, $types);
  530.         if ($versioned && ! $result) {
  531.             throw OptimisticLockException::lockFailed($entity);
  532.         }
  533.     }
  535.     /**
  536.      * @param array<mixed> $identifier
  537.      * @param string[]     $types
  538.      *
  539.      * @todo Add check for platform if it supports foreign keys/cascading.
  540.      */
  541.     protected function deleteJoinTableRecords(array $identifier, array $types): void
  542.     {
  543.         foreach ($this->class->associationMappings as $mapping) {
  544.             if ($mapping['type'] !== ClassMetadata::MANY_TO_MANY || isset($mapping['isOnDeleteCascade'])) {
  545.                 continue;
  546.             }
  548.             // @Todo this only covers scenarios with no inheritance or of the same level. Is there something
  549.             // like self-referential relationship between different levels of an inheritance hierarchy? I hope not!
  550.             $selfReferential = ($mapping['targetEntity'] === $mapping['sourceEntity']);
  551.             $class           = $this->class;
  552.             $association     = $mapping;
  553.             $otherColumns    = [];
  554.             $otherKeys       = [];
  555.             $keys            = [];
  557.             if (! $mapping['isOwningSide']) {
  558.                 $class       = $this->em->getClassMetadata($mapping['targetEntity']);
  559.                 $association = $class->associationMappings[$mapping['mappedBy']];
  560.             }
  562.             $joinColumns = $mapping['isOwningSide']
  563.                 ? $association['joinTable']['joinColumns']
  564.                 : $association['joinTable']['inverseJoinColumns'];
  566.             if ($selfReferential) {
  567.                 $otherColumns = ! $mapping['isOwningSide']
  568.                     ? $association['joinTable']['joinColumns']
  569.                     : $association['joinTable']['inverseJoinColumns'];
  570.             }
  572.             foreach ($joinColumns as $joinColumn) {
  573.                 $keys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  574.             }
  576.             foreach ($otherColumns as $joinColumn) {
  577.                 $otherKeys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  578.             }
  580.             $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  582.             $this->conn->delete($joinTableName, array_combine($keys, $identifier), $types);
  584.             if ($selfReferential) {
  585.                 $this->conn->delete($joinTableName, array_combine($otherKeys, $identifier), $types);
  586.             }
  587.         }
  588.     }
  590.     /**
  591.      * {@inheritDoc}
  592.      */
  593.     public function delete($entity)
  594.     {
  595.         $class      = $this->class;
  596.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  597.         $tableName  = $this->quoteStrategy->getTableName($class, $this->platform);
  598.         $idColumns  = $this->quoteStrategy->getIdentifierColumnNames($class, $this->platform);
  599.         $id         = array_combine($idColumns, $identifier);
  600.         $types      = $this->getClassIdentifiersTypes($class);
  602.         $this->deleteJoinTableRecords($identifier, $types);
  604.         return (bool) $this->conn->delete($tableName, $id, $types);
  605.     }
  607.     /**
  608.      * Prepares the changeset of an entity for database insertion (UPDATE).
  609.      *
  610.      * The changeset is obtained from the currently running UnitOfWork.
  611.      *
  612.      * During this preparation the array that is passed as the second parameter is filled with
  613.      * <columnName> => <value> pairs, grouped by table name.
  614.      *
  615.      * Example:
  616.      * <code>
  617.      * array(
  618.      *    'foo_table' => array('column1' => 'value1', 'column2' => 'value2', ...),
  619.      *    'bar_table' => array('columnX' => 'valueX', 'columnY' => 'valueY', ...),
  620.      *    ...
  621.      * )
  622.      * </code>
  623.      *
  624.      * @param object $entity   The entity for which to prepare the data.
  625.      * @param bool   $isInsert Whether the data to be prepared refers to an insert statement.
  626.      *
  627.      * @return mixed[][] The prepared data.
  628.      * @psalm-return array<string, array<array-key, mixed|null>>
  629.      */
  630.     protected function prepareUpdateData($entity, bool $isInsert = false)
  631.     {
  632.         $versionField = null;
  633.         $result       = [];
  634.         $uow          = $this->em->getUnitOfWork();
  636.         $versioned = $this->class->isVersioned;
  637.         if ($versioned !== false) {
  638.             $versionField = $this->class->versionField;
  639.         }
  641.         foreach ($uow->getEntityChangeSet($entity) as $field => $change) {
  642.             if (isset($versionField) && $versionField === $field) {
  643.                 continue;
  644.             }
  646.             if (isset($this->class->embeddedClasses[$field])) {
  647.                 continue;
  648.             }
  650.             $newVal = $change[1];
  652.             if (! isset($this->class->associationMappings[$field])) {
  653.                 $fieldMapping = $this->class->fieldMappings[$field];
  654.                 $columnName   = $fieldMapping['columnName'];
  656.                 if (! $isInsert && isset($fieldMapping['notUpdatable'])) {
  657.                     continue;
  658.                 }
  660.                 if ($isInsert && isset($fieldMapping['notInsertable'])) {
  661.                     continue;
  662.                 }
  664.                 $this->columnTypes[$columnName] = $fieldMapping['type'];
  666.                 $result[$this->getOwningTable($field)][$columnName] = $newVal;
  668.                 continue;
  669.             }
  671.             $assoc = $this->class->associationMappings[$field];
  673.             // Only owning side of x-1 associations can have a FK column.
  674.             if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
  675.                 continue;
  676.             }
  678.             if ($newVal !== null) {
  679.                 $oid = spl_object_id($newVal);
  681.                 // If the associated entity $newVal is not yet persisted and/or does not yet have
  682.                 // an ID assigned, we must set $newVal = null. This will insert a null value and
  683.                 // schedule an extra update on the UnitOfWork.
  684.                 //
  685.                 // This gives us extra time to a) possibly obtain a database-generated identifier
  686.                 // value for $newVal, and b) insert $newVal into the database before the foreign
  687.                 // key reference is being made.
  688.                 //
  689.                 // When looking at $this->queuedInserts and $uow->isScheduledForInsert, be aware
  690.                 // of the implementation details that our own executeInserts() method will remove
  691.                 // entities from the former as soon as the insert statement has been executed and
  692.                 // a post-insert ID has been assigned (if necessary), and that the UnitOfWork has
  693.                 // already removed entities from its own list at the time they were passed to our
  694.                 // addInsert() method.
  695.                 //
  696.                 // Then, there is one extra exception we can make: An entity that references back to itself
  697.                 // _and_ uses an application-provided ID (the "NONE" generator strategy) also does not
  698.                 // need the extra update, although it is still in the list of insertions itself.
  699.                 // This looks like a minor optimization at first, but is the capstone for being able to
  700.                 // use non-NULLable, self-referencing associations in applications that provide IDs (like UUIDs).
  701.                 if (
  702.                     (isset($this->queuedInserts[$oid]) || $uow->isScheduledForInsert($newVal))
  703.                     && ! ($newVal === $entity && $this->class->isIdentifierNatural())
  704.                 ) {
  705.                     $uow->scheduleExtraUpdate($entity, [$field => [null, $newVal]]);
  707.                     $newVal = null;
  708.                 }
  709.             }
  711.             $newValId = null;
  713.             if ($newVal !== null) {
  714.                 $newValId = $uow->getEntityIdentifier($newVal);
  715.             }
  717.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  718.             $owningTable = $this->getOwningTable($field);
  720.             foreach ($assoc['joinColumns'] as $joinColumn) {
  721.                 $sourceColumn = $joinColumn['name'];
  722.                 $targetColumn = $joinColumn['referencedColumnName'];
  723.                 $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  725.                 $this->quotedColumns[$sourceColumn]  = $quotedColumn;
  726.                 $this->columnTypes[$sourceColumn]    = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $this->em);
  727.                 $result[$owningTable][$sourceColumn] = $newValId
  728.                     ? $newValId[$targetClass->getFieldForColumn($targetColumn)]
  729.                     : null;
  730.             }
  731.         }
  733.         return $result;
  734.     }
  736.     /**
  737.      * Prepares the data changeset of a managed entity for database insertion (initial INSERT).
  738.      * The changeset of the entity is obtained from the currently running UnitOfWork.
  739.      *
  740.      * The default insert data preparation is the same as for updates.
  741.      *
  742.      * @see prepareUpdateData
  743.      *
  744.      * @param object $entity The entity for which to prepare the data.
  745.      *
  746.      * @return mixed[][] The prepared data for the tables to update.
  747.      * @psalm-return array<string, mixed[]>
  748.      */
  749.     protected function prepareInsertData($entity)
  750.     {
  751.         return $this->prepareUpdateData($entity, true);
  752.     }
  754.     /**
  755.      * {@inheritDoc}
  756.      */
  757.     public function getOwningTable($fieldName)
  758.     {
  759.         return $this->class->getTableName();
  760.     }
  762.     /**
  763.      * {@inheritDoc}
  764.      */
  765.     public function load(array $criteria, $entity = null, $assoc = null, array $hints = [], $lockMode = null, $limit = null, ?array $orderBy = null)
  766.     {
  767.         $this->switchPersisterContext(null, $limit);
  769.         $sql              = $this->getSelectSQL($criteria, $assoc, $lockMode, $limit, null, $orderBy);
  770.         [$params, $types] = $this->expandParameters($criteria);
  771.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  773.         if ($entity !== null) {
  774.             $hints[Query::HINT_REFRESH]        = true;
  775.             $hints[Query::HINT_REFRESH_ENTITY] = $entity;
  776.         }
  778.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  779.         $entities = $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, $hints);
  781.         return $entities ? $entities[0] : null;
  782.     }
  784.     /**
  785.      * {@inheritDoc}
  786.      */
  787.     public function loadById(array $identifier, $entity = null)
  788.     {
  789.         return $this->load($identifier, $entity);
  790.     }
  792.     /**
  793.      * {@inheritDoc}
  794.      */
  795.     public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = [])
  796.     {
  797.         $foundEntity = $this->em->getUnitOfWork()->tryGetById($identifier, $assoc['targetEntity']);
  798.         if ($foundEntity !== false) {
  799.             return $foundEntity;
  800.         }
  802.         $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  804.         if ($assoc['isOwningSide']) {
  805.             $isInverseSingleValued = $assoc['inversedBy'] && ! $targetClass->isCollectionValuedAssociation($assoc['inversedBy']);
  807.             // Mark inverse side as fetched in the hints, otherwise the UoW would
  808.             // try to load it in a separate query (remember: to-one inverse sides can not be lazy).
  809.             $hints = [];
  811.             if ($isInverseSingleValued) {
  812.                 $hints['fetched']['r'][$assoc['inversedBy']] = true;
  813.             }
  815.             $targetEntity = $this->load($identifier, null, $assoc, $hints);
  817.             // Complete bidirectional association, if necessary
  818.             if ($targetEntity !== null && $isInverseSingleValued) {
  819.                 $targetClass->reflFields[$assoc['inversedBy']]->setValue($targetEntity, $sourceEntity);
  820.             }
  822.             return $targetEntity;
  823.         }
  825.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  826.         $owningAssoc = $targetClass->getAssociationMapping($assoc['mappedBy']);
  828.         $computedIdentifier = [];
  830.         // TRICKY: since the association is specular source and target are flipped
  831.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  832.             if (! isset($sourceClass->fieldNames[$sourceKeyColumn])) {
  833.                 throw MappingException::joinColumnMustPointToMappedField(
  834.                     $sourceClass->name,
  835.                     $sourceKeyColumn
  836.                 );
  837.             }
  839.             $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  840.                 $sourceClass->reflFields[$sourceClass->fieldNames[$sourceKeyColumn]]->getValue($sourceEntity);
  841.         }
  843.         $targetEntity = $this->load($computedIdentifier, null, $assoc);
  845.         if ($targetEntity !== null) {
  846.             $targetClass->setFieldValue($targetEntity, $assoc['mappedBy'], $sourceEntity);
  847.         }
  849.         return $targetEntity;
  850.     }
  852.     /**
  853.      * {@inheritDoc}
  854.      */
  855.     public function refresh(array $id, $entity, $lockMode = null)
  856.     {
  857.         $sql              = $this->getSelectSQL($id, null, $lockMode);
  858.         [$params, $types] = $this->expandParameters($id);
  859.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  861.         $hydrator = $this->em->newHydrator(Query::HYDRATE_OBJECT);
  862.         $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [Query::HINT_REFRESH => true]);
  863.     }
  865.     /**
  866.      * {@inheritDoc}
  867.      */
  868.     public function count($criteria = [])
  869.     {
  870.         $sql = $this->getCountSQL($criteria);
  872.         [$params, $types] = $criteria instanceof Criteria
  873.             ? $this->expandCriteriaParameters($criteria)
  874.             : $this->expandParameters($criteria);
  876.         return (int) $this->conn->executeQuery($sql, $params, $types)->fetchOne();
  877.     }
  879.     /**
  880.      * {@inheritDoc}
  881.      */
  882.     public function loadCriteria(Criteria $criteria)
  883.     {
  884.         $orderBy = $criteria->getOrderings();
  885.         $limit   = $criteria->getMaxResults();
  886.         $offset  = $criteria->getFirstResult();
  887.         $query   = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  889.         [$params, $types] = $this->expandCriteriaParameters($criteria);
  891.         $stmt     = $this->conn->executeQuery($query, $params, $types);
  892.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  894.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  895.     }
  897.     /**
  898.      * {@inheritDoc}
  899.      */
  900.     public function expandCriteriaParameters(Criteria $criteria)
  901.     {
  902.         $expression = $criteria->getWhereExpression();
  903.         $sqlParams  = [];
  904.         $sqlTypes   = [];
  906.         if ($expression === null) {
  907.             return [$sqlParams, $sqlTypes];
  908.         }
  910.         $valueVisitor = new SqlValueVisitor();
  912.         $valueVisitor->dispatch($expression);
  914.         [, $types] = $valueVisitor->getParamsAndTypes();
  916.         foreach ($types as $type) {
  917.             [$field, $value, $operator] = $type;
  919.             if ($value === null && ($operator === Comparison::EQ || $operator === Comparison::NEQ)) {
  920.                 continue;
  921.             }
  923.             $sqlParams = array_merge($sqlParams, $this->getValues($value));
  924.             $sqlTypes  = array_merge($sqlTypes, $this->getTypes($field, $value, $this->class));
  925.         }
  927.         return [$sqlParams, $sqlTypes];
  928.     }
  930.     /**
  931.      * {@inheritDoc}
  932.      */
  933.     public function loadAll(array $criteria = [], ?array $orderBy = null, $limit = null, $offset = null)
  934.     {
  935.         $this->switchPersisterContext($offset, $limit);
  937.         $sql              = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  938.         [$params, $types] = $this->expandParameters($criteria);
  939.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  941.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  943.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  944.     }
  946.     /**
  947.      * {@inheritDoc}
  948.      */
  949.     public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  950.     {
  951.         $this->switchPersisterContext($offset, $limit);
  953.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity, $offset, $limit);
  955.         return $this->loadArrayFromResult($assoc, $stmt);
  956.     }
  958.     /**
  959.      * Loads an array of entities from a given DBAL statement.
  960.      *
  961.      * @param mixed[] $assoc
  962.      *
  963.      * @return mixed[]
  964.      */
  965.     private function loadArrayFromResult(array $assoc, Result $stmt): array
  966.     {
  967.         $rsm   = $this->currentPersisterContext->rsm;
  968.         $hints = [UnitOfWork::HINT_DEFEREAGERLOAD => true];
  970.         if (isset($assoc['indexBy'])) {
  971.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  972.             $rsm->addIndexBy('r', $assoc['indexBy']);
  973.         }
  975.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  976.     }
  978.     /**
  979.      * Hydrates a collection from a given DBAL statement.
  980.      *
  981.      * @param mixed[] $assoc
  982.      *
  983.      * @return mixed[]
  984.      */
  985.     private function loadCollectionFromStatement(
  986.         array $assoc,
  987.         Result $stmt,
  988.         PersistentCollection $coll
  989.     ): array {
  990.         $rsm   = $this->currentPersisterContext->rsm;
  991.         $hints = [
  992.             UnitOfWork::HINT_DEFEREAGERLOAD => true,
  993.             'collection' => $coll,
  994.         ];
  996.         if (isset($assoc['indexBy'])) {
  997.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  998.             $rsm->addIndexBy('r', $assoc['indexBy']);
  999.         }
  1001.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1002.     }
  1004.     /**
  1005.      * {@inheritDoc}
  1006.      */
  1007.     public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1008.     {
  1009.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity);
  1011.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1012.     }
  1014.     /**
  1015.      * @param object $sourceEntity
  1016.      * @psalm-param array<string, mixed> $assoc
  1017.      *
  1018.      * @return Result
  1019.      *
  1020.      * @throws MappingException
  1021.      */
  1022.     private function getManyToManyStatement(
  1023.         array $assoc,
  1024.         $sourceEntity,
  1025.         ?int $offset = null,
  1026.         ?int $limit = null
  1027.     ) {
  1028.         $this->switchPersisterContext($offset, $limit);
  1030.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1031.         $class       = $sourceClass;
  1032.         $association = $assoc;
  1033.         $criteria    = [];
  1034.         $parameters  = [];
  1036.         if (! $assoc['isOwningSide']) {
  1037.             $class       = $this->em->getClassMetadata($assoc['targetEntity']);
  1038.             $association = $class->associationMappings[$assoc['mappedBy']];
  1039.         }
  1041.         $joinColumns = $assoc['isOwningSide']
  1042.             ? $association['joinTable']['joinColumns']
  1043.             : $association['joinTable']['inverseJoinColumns'];
  1045.         $quotedJoinTable = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1047.         foreach ($joinColumns as $joinColumn) {
  1048.             $sourceKeyColumn = $joinColumn['referencedColumnName'];
  1049.             $quotedKeyColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1051.             switch (true) {
  1052.                 case $sourceClass->containsForeignIdentifier:
  1053.                     $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1054.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1056.                     if (isset($sourceClass->associationMappings[$field])) {
  1057.                         $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1058.                         $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1059.                     }
  1061.                     break;
  1063.                 case isset($sourceClass->fieldNames[$sourceKeyColumn]):
  1064.                     $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1065.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1067.                     break;
  1069.                 default:
  1070.                     throw MappingException::joinColumnMustPointToMappedField(
  1071.                         $sourceClass->name,
  1072.                         $sourceKeyColumn
  1073.                     );
  1074.             }
  1076.             $criteria[$quotedJoinTable . '.' . $quotedKeyColumn] = $value;
  1077.             $parameters[]                                        = [
  1078.                 'value' => $value,
  1079.                 'field' => $field,
  1080.                 'class' => $sourceClass,
  1081.             ];
  1082.         }
  1084.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1085.         [$params, $types] = $this->expandToManyParameters($parameters);
  1087.         return $this->conn->executeQuery($sql, $params, $types);
  1088.     }
  1090.     /**
  1091.      * {@inheritDoc}
  1092.      */
  1093.     public function getSelectSQL($criteria, $assoc = null, $lockMode = null, $limit = null, $offset = null, ?array $orderBy = null)
  1094.     {
  1095.         $this->switchPersisterContext($offset, $limit);
  1097.         $lockSql    = '';
  1098.         $joinSql    = '';
  1099.         $orderBySql = '';
  1101.         if ($assoc !== null && $assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  1102.             $joinSql = $this->getSelectManyToManyJoinSQL($assoc);
  1103.         }
  1105.         if (isset($assoc['orderBy'])) {
  1106.             $orderBy = $assoc['orderBy'];
  1107.         }
  1109.         if ($orderBy) {
  1110.             $orderBySql = $this->getOrderBySQL($orderBy, $this->getSQLTableAlias($this->class->name));
  1111.         }
  1113.         $conditionSql = $criteria instanceof Criteria
  1114.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1115.             : $this->getSelectConditionSQL($criteria, $assoc);
  1117.         switch ($lockMode) {
  1118.             case LockMode::PESSIMISTIC_READ:
  1119.                 $lockSql = ' ' . $this->platform->getReadLockSQL();
  1120.                 break;
  1122.             case LockMode::PESSIMISTIC_WRITE:
  1123.                 $lockSql = ' ' . $this->platform->getWriteLockSQL();
  1124.                 break;
  1125.         }
  1127.         $columnList = $this->getSelectColumnsSQL();
  1128.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1129.         $filterSql  = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1130.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1132.         if ($filterSql !== '') {
  1133.             $conditionSql = $conditionSql
  1134.                 ? $conditionSql . ' AND ' . $filterSql
  1135.                 : $filterSql;
  1136.         }
  1138.         $select = 'SELECT ' . $columnList;
  1139.         $from   = ' FROM ' . $tableName . ' ' . $tableAlias;
  1140.         $join   = $this->currentPersisterContext->selectJoinSql . $joinSql;
  1141.         $where  = ($conditionSql ? ' WHERE ' . $conditionSql : '');
  1142.         $lock   = $this->platform->appendLockHint($from, $lockMode ?? LockMode::NONE);
  1143.         $query  = $select
  1144.             . $lock
  1145.             . $join
  1146.             . $where
  1147.             . $orderBySql;
  1149.         return $this->platform->modifyLimitQuery($query, $limit, $offset ?? 0) . $lockSql;
  1150.     }
  1152.     /**
  1153.      * {@inheritDoc}
  1154.      */
  1155.     public function getCountSQL($criteria = [])
  1156.     {
  1157.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1158.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1160.         $conditionSql = $criteria instanceof Criteria
  1161.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1162.             : $this->getSelectConditionSQL($criteria);
  1164.         $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1166.         if ($filterSql !== '') {
  1167.             $conditionSql = $conditionSql
  1168.                 ? $conditionSql . ' AND ' . $filterSql
  1169.                 : $filterSql;
  1170.         }
  1172.         return 'SELECT COUNT(*) '
  1173.             . 'FROM ' . $tableName . ' ' . $tableAlias
  1174.             . (empty($conditionSql) ? '' : ' WHERE ' . $conditionSql);
  1175.     }
  1177.     /**
  1178.      * Gets the ORDER BY SQL snippet for ordered collections.
  1179.      *
  1180.      * @psalm-param array<string, string> $orderBy
  1181.      *
  1182.      * @throws InvalidOrientation
  1183.      * @throws InvalidFindByCall
  1184.      * @throws UnrecognizedField
  1185.      */
  1186.     final protected function getOrderBySQL(array $orderBy, string $baseTableAlias): string
  1187.     {
  1188.         $orderByList = [];
  1190.         foreach ($orderBy as $fieldName => $orientation) {
  1191.             $orientation = strtoupper(trim($orientation));
  1193.             if ($orientation !== 'ASC' && $orientation !== 'DESC') {
  1194.                 throw InvalidOrientation::fromClassNameAndField($this->class->name, $fieldName);
  1195.             }
  1197.             if (isset($this->class->fieldMappings[$fieldName])) {
  1198.                 $tableAlias = isset($this->class->fieldMappings[$fieldName]['inherited'])
  1199.                     ? $this->getSQLTableAlias($this->class->fieldMappings[$fieldName]['inherited'])
  1200.                     : $baseTableAlias;
  1202.                 $columnName    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  1203.                 $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1205.                 continue;
  1206.             }
  1208.             if (isset($this->class->associationMappings[$fieldName])) {
  1209.                 if (! $this->class->associationMappings[$fieldName]['isOwningSide']) {
  1210.                     throw InvalidFindByCall::fromInverseSideUsage($this->class->name, $fieldName);
  1211.                 }
  1213.                 $tableAlias = isset($this->class->associationMappings[$fieldName]['inherited'])
  1214.                     ? $this->getSQLTableAlias($this->class->associationMappings[$fieldName]['inherited'])
  1215.                     : $baseTableAlias;
  1217.                 foreach ($this->class->associationMappings[$fieldName]['joinColumns'] as $joinColumn) {
  1218.                     $columnName    = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1219.                     $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1220.                 }
  1222.                 continue;
  1223.             }
  1225.             throw UnrecognizedField::byFullyQualifiedName($this->class->name, $fieldName);
  1226.         }
  1228.         return ' ORDER BY ' . implode(', ', $orderByList);
  1229.     }
  1231.     /**
  1232.      * Gets the SQL fragment with the list of columns to select when querying for
  1233.      * an entity in this persister.
  1234.      *
  1235.      * Subclasses should override this method to alter or change the select column
  1236.      * list SQL fragment. Note that in the implementation of BasicEntityPersister
  1237.      * the resulting SQL fragment is generated only once and cached in {@link selectColumnListSql}.
  1238.      * Subclasses may or may not do the same.
  1239.      *
  1240.      * @return string The SQL fragment.
  1241.      */
  1242.     protected function getSelectColumnsSQL()
  1243.     {
  1244.         if ($this->currentPersisterContext->selectColumnListSql !== null) {
  1245.             return $this->currentPersisterContext->selectColumnListSql;
  1246.         }
  1248.         $columnList = [];
  1249.         $this->currentPersisterContext->rsm->addEntityResult($this->class->name, 'r'); // r for root
  1251.         // Add regular columns to select list
  1252.         foreach ($this->class->fieldNames as $field) {
  1253.             $columnList[] = $this->getSelectColumnSQL($field, $this->class);
  1254.         }
  1256.         $this->currentPersisterContext->selectJoinSql = '';
  1257.         $eagerAliasCounter                            = 0;
  1259.         foreach ($this->class->associationMappings as $assocField => $assoc) {
  1260.             $assocColumnSQL = $this->getSelectColumnAssociationSQL($assocField, $assoc, $this->class);
  1262.             if ($assocColumnSQL) {
  1263.                 $columnList[] = $assocColumnSQL;
  1264.             }
  1266.             $isAssocToOneInverseSide = $assoc['type'] & ClassMetadata::TO_ONE && ! $assoc['isOwningSide'];
  1267.             $isAssocFromOneEager     = $assoc['type'] & ClassMetadata::TO_ONE && $assoc['fetch'] === ClassMetadata::FETCH_EAGER;
  1269.             if (! ($isAssocFromOneEager || $isAssocToOneInverseSide)) {
  1270.                 continue;
  1271.             }
  1273.             if ((($assoc['type'] & ClassMetadata::TO_MANY) > 0) && $this->currentPersisterContext->handlesLimits) {
  1274.                 continue;
  1275.             }
  1277.             $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1279.             if ($eagerEntity->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  1280.                 continue; // now this is why you shouldn't use inheritance
  1281.             }
  1283.             $assocAlias = 'e' . ($eagerAliasCounter++);
  1284.             $this->currentPersisterContext->rsm->addJoinedEntityResult($assoc['targetEntity'], $assocAlias, 'r', $assocField);
  1286.             foreach ($eagerEntity->fieldNames as $field) {
  1287.                 $columnList[] = $this->getSelectColumnSQL($field, $eagerEntity, $assocAlias);
  1288.             }
  1290.             foreach ($eagerEntity->associationMappings as $eagerAssocField => $eagerAssoc) {
  1291.                 $eagerAssocColumnSQL = $this->getSelectColumnAssociationSQL(
  1292.                     $eagerAssocField,
  1293.                     $eagerAssoc,
  1294.                     $eagerEntity,
  1295.                     $assocAlias
  1296.                 );
  1298.                 if ($eagerAssocColumnSQL) {
  1299.                     $columnList[] = $eagerAssocColumnSQL;
  1300.                 }
  1301.             }
  1303.             $association   = $assoc;
  1304.             $joinCondition = [];
  1306.             if (isset($assoc['indexBy'])) {
  1307.                 $this->currentPersisterContext->rsm->addIndexBy($assocAlias, $assoc['indexBy']);
  1308.             }
  1310.             if (! $assoc['isOwningSide']) {
  1311.                 $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1312.                 $association = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
  1313.             }
  1315.             $joinTableAlias = $this->getSQLTableAlias($eagerEntity->name, $assocAlias);
  1316.             $joinTableName  = $this->quoteStrategy->getTableName($eagerEntity, $this->platform);
  1318.             if ($assoc['isOwningSide']) {
  1319.                 $tableAlias                                    = $this->getSQLTableAlias($association['targetEntity'], $assocAlias);
  1320.                 $this->currentPersisterContext->selectJoinSql .= ' ' . $this->getJoinSQLForJoinColumns($association['joinColumns']);
  1322.                 foreach ($association['joinColumns'] as $joinColumn) {
  1323.                     $sourceCol       = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1324.                     $targetCol       = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1325.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'])
  1326.                                         . '.' . $sourceCol . ' = ' . $tableAlias . '.' . $targetCol;
  1327.                 }
  1329.                 // Add filter SQL
  1330.                 $filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias);
  1331.                 if ($filterSql) {
  1332.                     $joinCondition[] = $filterSql;
  1333.                 }
  1334.             } else {
  1335.                 $this->currentPersisterContext->selectJoinSql .= ' LEFT JOIN';
  1337.                 foreach ($association['joinColumns'] as $joinColumn) {
  1338.                     $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1339.                     $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1341.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'], $assocAlias) . '.' . $sourceCol . ' = '
  1342.                         . $this->getSQLTableAlias($association['targetEntity']) . '.' . $targetCol;
  1343.                 }
  1344.             }
  1346.             $this->currentPersisterContext->selectJoinSql .= ' ' . $joinTableName . ' ' . $joinTableAlias . ' ON ';
  1347.             $this->currentPersisterContext->selectJoinSql .= implode(' AND ', $joinCondition);
  1348.         }
  1350.         $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  1352.         return $this->currentPersisterContext->selectColumnListSql;
  1353.     }
  1355.     /**
  1356.      * Gets the SQL join fragment used when selecting entities from an association.
  1357.      *
  1358.      * @param string             $field
  1359.      * @param AssociationMapping $assoc
  1360.      * @param string             $alias
  1361.      *
  1362.      * @return string
  1363.      */
  1364.     protected function getSelectColumnAssociationSQL($field, $assoc, ClassMetadata $class, $alias = 'r')
  1365.     {
  1366.         if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1367.             return '';
  1368.         }
  1370.         $columnList    = [];
  1371.         $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
  1372.         $isIdentifier  = isset($assoc['id']) && $assoc['id'] === true;
  1373.         $sqlTableAlias = $this->getSQLTableAlias($class->name, ($alias === 'r' ? '' : $alias));
  1375.         foreach ($assoc['joinColumns'] as $joinColumn) {
  1376.             $quotedColumn     = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1377.             $resultColumnName = $this->getSQLColumnAlias($joinColumn['name']);
  1378.             $type             = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  1380.             $this->currentPersisterContext->rsm->addMetaResult($alias, $resultColumnName, $joinColumn['name'], $isIdentifier, $type);
  1382.             $columnList[] = sprintf('%s.%s AS %s', $sqlTableAlias, $quotedColumn, $resultColumnName);
  1383.         }
  1385.         return implode(', ', $columnList);
  1386.     }
  1388.     /**
  1389.      * Gets the SQL join fragment used when selecting entities from a
  1390.      * many-to-many association.
  1391.      *
  1392.      * @psalm-param AssociationMapping $manyToMany
  1393.      *
  1394.      * @return string
  1395.      */
  1396.     protected function getSelectManyToManyJoinSQL(array $manyToMany)
  1397.     {
  1398.         $conditions       = [];
  1399.         $association      = $manyToMany;
  1400.         $sourceTableAlias = $this->getSQLTableAlias($this->class->name);
  1402.         if (! $manyToMany['isOwningSide']) {
  1403.             $targetEntity = $this->em->getClassMetadata($manyToMany['targetEntity']);
  1404.             $association  = $targetEntity->associationMappings[$manyToMany['mappedBy']];
  1405.         }
  1407.         $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  1408.         $joinColumns   = $manyToMany['isOwningSide']
  1409.             ? $association['joinTable']['inverseJoinColumns']
  1410.             : $association['joinTable']['joinColumns'];
  1412.         foreach ($joinColumns as $joinColumn) {
  1413.             $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1414.             $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1415.             $conditions[]       = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableName . '.' . $quotedSourceColumn;
  1416.         }
  1418.         return ' INNER JOIN ' . $joinTableName . ' ON ' . implode(' AND ', $conditions);
  1419.     }
  1421.     /**
  1422.      * {@inheritDoc}
  1423.      */
  1424.     public function getInsertSQL()
  1425.     {
  1426.         if ($this->insertSql !== null) {
  1427.             return $this->insertSql;
  1428.         }
  1430.         $columns   = $this->getInsertColumnList();
  1431.         $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1433.         if (empty($columns)) {
  1434.             $identityColumn  = $this->quoteStrategy->getColumnName($this->class->identifier[0], $this->class, $this->platform);
  1435.             $this->insertSql = $this->platform->getEmptyIdentityInsertSQL($tableName, $identityColumn);
  1437.             return $this->insertSql;
  1438.         }
  1440.         $values  = [];
  1441.         $columns = array_unique($columns);
  1443.         foreach ($columns as $column) {
  1444.             $placeholder = '?';
  1446.             if (
  1447.                 isset($this->class->fieldNames[$column])
  1448.                 && isset($this->columnTypes[$this->class->fieldNames[$column]])
  1449.                 && isset($this->class->fieldMappings[$this->class->fieldNames[$column]]['requireSQLConversion'])
  1450.             ) {
  1451.                 $type        = Type::getType($this->columnTypes[$this->class->fieldNames[$column]]);
  1452.                 $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  1453.             }
  1455.             $values[] = $placeholder;
  1456.         }
  1458.         $columns = implode(', ', $columns);
  1459.         $values  = implode(', ', $values);
  1461.         $this->insertSql = sprintf('INSERT INTO %s (%s) VALUES (%s)', $tableName, $columns, $values);
  1463.         return $this->insertSql;
  1464.     }
  1466.     /**
  1467.      * Gets the list of columns to put in the INSERT SQL statement.
  1468.      *
  1469.      * Subclasses should override this method to alter or change the list of
  1470.      * columns placed in the INSERT statements used by the persister.
  1471.      *
  1472.      * @return string[] The list of columns.
  1473.      * @psalm-return list<string>
  1474.      */
  1475.     protected function getInsertColumnList()
  1476.     {
  1477.         $columns = [];
  1479.         foreach ($this->class->reflFields as $name => $field) {
  1480.             if ($this->class->isVersioned && $this->class->versionField === $name) {
  1481.                 continue;
  1482.             }
  1484.             if (isset($this->class->embeddedClasses[$name])) {
  1485.                 continue;
  1486.             }
  1488.             if (isset($this->class->associationMappings[$name])) {
  1489.                 $assoc = $this->class->associationMappings[$name];
  1491.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  1492.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  1493.                         $columns[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1494.                     }
  1495.                 }
  1497.                 continue;
  1498.             }
  1500.             if (! $this->class->isIdGeneratorIdentity() || $this->class->identifier[0] !== $name) {
  1501.                 if (isset($this->class->fieldMappings[$name]['notInsertable'])) {
  1502.                     continue;
  1503.                 }
  1505.                 $columns[]                = $this->quoteStrategy->getColumnName($name, $this->class, $this->platform);
  1506.                 $this->columnTypes[$name] = $this->class->fieldMappings[$name]['type'];
  1507.             }
  1508.         }
  1510.         return $columns;
  1511.     }
  1513.     /**
  1514.      * Gets the SQL snippet of a qualified column name for the given field name.
  1515.      *
  1516.      * @param string        $field The field name.
  1517.      * @param ClassMetadata $class The class that declares this field. The table this class is
  1518.      *                             mapped to must own the column for the given field.
  1519.      * @param string        $alias
  1520.      *
  1521.      * @return string
  1522.      */
  1523.     protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  1524.     {
  1525.         $root         = $alias === 'r' ? '' : $alias;
  1526.         $tableAlias   = $this->getSQLTableAlias($class->name, $root);
  1527.         $fieldMapping = $class->fieldMappings[$field];
  1528.         $sql          = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
  1529.         $columnAlias  = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1531.         $this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
  1532.         if (! empty($fieldMapping['enumType'])) {
  1533.             $this->currentPersisterContext->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
  1534.         }
  1536.         if (isset($fieldMapping['requireSQLConversion'])) {
  1537.             $type = Type::getType($fieldMapping['type']);
  1538.             $sql  = $type->convertToPHPValueSQL($sql, $this->platform);
  1539.         }
  1541.         return $sql . ' AS ' . $columnAlias;
  1542.     }
  1544.     /**
  1545.      * Gets the SQL table alias for the given class name.
  1546.      *
  1547.      * @param string $className
  1548.      * @param string $assocName
  1549.      *
  1550.      * @return string The SQL table alias.
  1551.      *
  1552.      * @todo Reconsider. Binding table aliases to class names is not such a good idea.
  1553.      */
  1554.     protected function getSQLTableAlias($className, $assocName = '')
  1555.     {
  1556.         if ($assocName) {
  1557.             $className .= '#' . $assocName;
  1558.         }
  1560.         if (isset($this->currentPersisterContext->sqlTableAliases[$className])) {
  1561.             return $this->currentPersisterContext->sqlTableAliases[$className];
  1562.         }
  1564.         $tableAlias = 't' . $this->currentPersisterContext->sqlAliasCounter++;
  1566.         $this->currentPersisterContext->sqlTableAliases[$className] = $tableAlias;
  1568.         return $tableAlias;
  1569.     }
  1571.     /**
  1572.      * {@inheritDoc}
  1573.      */
  1574.     public function lock(array $criteria, $lockMode)
  1575.     {
  1576.         $lockSql      = '';
  1577.         $conditionSql = $this->getSelectConditionSQL($criteria);
  1579.         switch ($lockMode) {
  1580.             case LockMode::PESSIMISTIC_READ:
  1581.                 $lockSql = $this->platform->getReadLockSQL();
  1583.                 break;
  1584.             case LockMode::PESSIMISTIC_WRITE:
  1585.                 $lockSql = $this->platform->getWriteLockSQL();
  1586.                 break;
  1587.         }
  1589.         $lock  = $this->getLockTablesSql($lockMode);
  1590.         $where = ($conditionSql ? ' WHERE ' . $conditionSql : '') . ' ';
  1591.         $sql   = 'SELECT 1 '
  1592.              . $lock
  1593.              . $where
  1594.              . $lockSql;
  1596.         [$params, $types] = $this->expandParameters($criteria);
  1598.         $this->conn->executeQuery($sql, $params, $types);
  1599.     }
  1601.     /**
  1602.      * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
  1603.      *
  1604.      * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
  1605.      * @psalm-param LockMode::*|null $lockMode
  1606.      *
  1607.      * @return string
  1608.      */
  1609.     protected function getLockTablesSql($lockMode)
  1610.     {
  1611.         if ($lockMode === null) {
  1612.             Deprecation::trigger(
  1613.                 'doctrine/orm',
  1614.                 'https://github.com/doctrine/orm/pull/9466',
  1615.                 'Passing null as argument to %s is deprecated, pass LockMode::NONE instead.',
  1616.                 __METHOD__
  1617.             );
  1619.             $lockMode = LockMode::NONE;
  1620.         }
  1622.         return $this->platform->appendLockHint(
  1623.             'FROM '
  1624.             . $this->quoteStrategy->getTableName($this->class, $this->platform) . ' '
  1625.             . $this->getSQLTableAlias($this->class->name),
  1626.             $lockMode
  1627.         );
  1628.     }
  1630.     /**
  1631.      * Gets the Select Where Condition from a Criteria object.
  1632.      *
  1633.      * @return string
  1634.      */
  1635.     protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  1636.     {
  1637.         $expression = $criteria->getWhereExpression();
  1639.         if ($expression === null) {
  1640.             return '';
  1641.         }
  1643.         $visitor = new SqlExpressionVisitor($this, $this->class);
  1645.         return $visitor->dispatch($expression);
  1646.     }
  1648.     /**
  1649.      * {@inheritDoc}
  1650.      */
  1651.     public function getSelectConditionStatementSQL($field, $value, $assoc = null, $comparison = null)
  1652.     {
  1653.         $selectedColumns = [];
  1654.         $columns         = $this->getSelectConditionStatementColumnSQL($field, $assoc);
  1656.         if (count($columns) > 1 && $comparison === Comparison::IN) {
  1657.             /*
  1658.              *  @todo try to support multi-column IN expressions.
  1659.              *  Example: (col1, col2) IN (('val1A', 'val2A'), ('val1B', 'val2B'))
  1660.              */
  1661.             throw CantUseInOperatorOnCompositeKeys::create();
  1662.         }
  1664.         foreach ($columns as $column) {
  1665.             $placeholder = '?';
  1667.             if (isset($this->class->fieldMappings[$field]['requireSQLConversion'])) {
  1668.                 $type        = Type::getType($this->class->fieldMappings[$field]['type']);
  1669.                 $placeholder = $type->convertToDatabaseValueSQL($placeholder, $this->platform);
  1670.             }
  1672.             if ($comparison !== null) {
  1673.                 // special case null value handling
  1674.                 if (($comparison === Comparison::EQ || $comparison === Comparison::IS) && $value === null) {
  1675.                     $selectedColumns[] = $column . ' IS NULL';
  1677.                     continue;
  1678.                 }
  1680.                 if ($comparison === Comparison::NEQ && $value === null) {
  1681.                     $selectedColumns[] = $column . ' IS NOT NULL';
  1683.                     continue;
  1684.                 }
  1686.                 $selectedColumns[] = $column . ' ' . sprintf(self::$comparisonMap[$comparison], $placeholder);
  1688.                 continue;
  1689.             }
  1691.             if (is_array($value)) {
  1692.                 $in = sprintf('%s IN (%s)', $column, $placeholder);
  1694.                 if (array_search(null, $value, true) !== false) {
  1695.                     $selectedColumns[] = sprintf('(%s OR %s IS NULL)', $in, $column);
  1697.                     continue;
  1698.                 }
  1700.                 $selectedColumns[] = $in;
  1702.                 continue;
  1703.             }
  1705.             if ($value === null) {
  1706.                 $selectedColumns[] = sprintf('%s IS NULL', $column);
  1708.                 continue;
  1709.             }
  1711.             $selectedColumns[] = sprintf('%s = %s', $column, $placeholder);
  1712.         }
  1714.         return implode(' AND ', $selectedColumns);
  1715.     }
  1717.     /**
  1718.      * Builds the left-hand-side of a where condition statement.
  1719.      *
  1720.      * @psalm-param AssociationMapping|null $assoc
  1721.      *
  1722.      * @return string[]
  1723.      * @psalm-return list<string>
  1724.      *
  1725.      * @throws InvalidFindByCall
  1726.      * @throws UnrecognizedField
  1727.      */
  1728.     private function getSelectConditionStatementColumnSQL(
  1729.         string $field,
  1730.         ?array $assoc = null
  1731.     ): array {
  1732.         if (isset($this->class->fieldMappings[$field])) {
  1733.             $className = $this->class->fieldMappings[$field]['inherited'] ?? $this->class->name;
  1735.             return [$this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getColumnName($field, $this->class, $this->platform)];
  1736.         }
  1738.         if (isset($this->class->associationMappings[$field])) {
  1739.             $association = $this->class->associationMappings[$field];
  1740.             // Many-To-Many requires join table check for joinColumn
  1741.             $columns = [];
  1742.             $class   = $this->class;
  1744.             if ($association['type'] === ClassMetadata::MANY_TO_MANY) {
  1745.                 if (! $association['isOwningSide']) {
  1746.                     $association = $assoc;
  1747.                 }
  1749.                 $joinTableName = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1750.                 $joinColumns   = $assoc['isOwningSide']
  1751.                     ? $association['joinTable']['joinColumns']
  1752.                     : $association['joinTable']['inverseJoinColumns'];
  1754.                 foreach ($joinColumns as $joinColumn) {
  1755.                     $columns[] = $joinTableName . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1756.                 }
  1757.             } else {
  1758.                 if (! $association['isOwningSide']) {
  1759.                     throw InvalidFindByCall::fromInverseSideUsage(
  1760.                         $this->class->name,
  1761.                         $field
  1762.                     );
  1763.                 }
  1765.                 $className = $association['inherited'] ?? $this->class->name;
  1767.                 foreach ($association['joinColumns'] as $joinColumn) {
  1768.                     $columns[] = $this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1769.                 }
  1770.             }
  1772.             return $columns;
  1773.         }
  1775.         if ($assoc !== null && ! str_contains($field, ' ') && ! str_contains($field, '(')) {
  1776.             // very careless developers could potentially open up this normally hidden api for userland attacks,
  1777.             // therefore checking for spaces and function calls which are not allowed.
  1779.             // found a join column condition, not really a "field"
  1780.             return [$field];
  1781.         }
  1783.         throw UnrecognizedField::byFullyQualifiedName($this->class->name, $field);
  1784.     }
  1786.     /**
  1787.      * Gets the conditional SQL fragment used in the WHERE clause when selecting
  1788.      * entities in this persister.
  1789.      *
  1790.      * Subclasses are supposed to override this method if they intend to change
  1791.      * or alter the criteria by which entities are selected.
  1792.      *
  1793.      * @param AssociationMapping|null $assoc
  1794.      * @psalm-param array<string, mixed> $criteria
  1795.      * @psalm-param array<string, mixed>|null $assoc
  1796.      *
  1797.      * @return string
  1798.      */
  1799.     protected function getSelectConditionSQL(array $criteria, $assoc = null)
  1800.     {
  1801.         $conditions = [];
  1803.         foreach ($criteria as $field => $value) {
  1804.             $conditions[] = $this->getSelectConditionStatementSQL($field, $value, $assoc);
  1805.         }
  1807.         return implode(' AND ', $conditions);
  1808.     }
  1810.     /**
  1811.      * {@inheritDoc}
  1812.      */
  1813.     public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1814.     {
  1815.         $this->switchPersisterContext($offset, $limit);
  1817.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity, $offset, $limit);
  1819.         return $this->loadArrayFromResult($assoc, $stmt);
  1820.     }
  1822.     /**
  1823.      * {@inheritDoc}
  1824.      */
  1825.     public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1826.     {
  1827.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity);
  1829.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1830.     }
  1832.     /**
  1833.      * Builds criteria and execute SQL statement to fetch the one to many entities from.
  1834.      *
  1835.      * @param object $sourceEntity
  1836.      * @psalm-param AssociationMapping $assoc
  1837.      */
  1838.     private function getOneToManyStatement(
  1839.         array $assoc,
  1840.         $sourceEntity,
  1841.         ?int $offset = null,
  1842.         ?int $limit = null
  1843.     ): Result {
  1844.         $this->switchPersisterContext($offset, $limit);
  1846.         $criteria    = [];
  1847.         $parameters  = [];
  1848.         $owningAssoc = $this->class->associationMappings[$assoc['mappedBy']];
  1849.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1850.         $tableAlias  = $this->getSQLTableAlias($owningAssoc['inherited'] ?? $this->class->name);
  1852.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  1853.             if ($sourceClass->containsForeignIdentifier) {
  1854.                 $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1855.                 $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1857.                 if (isset($sourceClass->associationMappings[$field])) {
  1858.                     $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1859.                     $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1860.                 }
  1862.                 $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1863.                 $parameters[]                                   = [
  1864.                     'value' => $value,
  1865.                     'field' => $field,
  1866.                     'class' => $sourceClass,
  1867.                 ];
  1869.                 continue;
  1870.             }
  1872.             $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1873.             $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1875.             $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1876.             $parameters[]                                   = [
  1877.                 'value' => $value,
  1878.                 'field' => $field,
  1879.                 'class' => $sourceClass,
  1880.             ];
  1881.         }
  1883.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1884.         [$params, $types] = $this->expandToManyParameters($parameters);
  1886.         return $this->conn->executeQuery($sql, $params, $types);
  1887.     }
  1889.     /**
  1890.      * {@inheritDoc}
  1891.      */
  1892.     public function expandParameters($criteria)
  1893.     {
  1894.         $params = [];
  1895.         $types  = [];
  1897.         foreach ($criteria as $field => $value) {
  1898.             if ($value === null) {
  1899.                 continue; // skip null values.
  1900.             }
  1902.             $types  = array_merge($types, $this->getTypes($field, $value, $this->class));
  1903.             $params = array_merge($params, $this->getValues($value));
  1904.         }
  1906.         return [$params, $types];
  1907.     }
  1909.     /**
  1910.      * Expands the parameters from the given criteria and use the correct binding types if found,
  1911.      * specialized for OneToMany or ManyToMany associations.
  1912.      *
  1913.      * @param mixed[][] $criteria an array of arrays containing following:
  1914.      *                             - field to which each criterion will be bound
  1915.      *                             - value to be bound
  1916.      *                             - class to which the field belongs to
  1917.      *
  1918.      * @return mixed[][]
  1919.      * @psalm-return array{0: array, 1: list<int|string|null>}
  1920.      */
  1921.     private function expandToManyParameters(array $criteria): array
  1922.     {
  1923.         $params = [];
  1924.         $types  = [];
  1926.         foreach ($criteria as $criterion) {
  1927.             if ($criterion['value'] === null) {
  1928.                 continue; // skip null values.
  1929.             }
  1931.             $types  = array_merge($types, $this->getTypes($criterion['field'], $criterion['value'], $criterion['class']));
  1932.             $params = array_merge($params, $this->getValues($criterion['value']));
  1933.         }
  1935.         return [$params, $types];
  1936.     }
  1938.     /**
  1939.      * Infers field types to be used by parameter type casting.
  1940.      *
  1941.      * @param mixed $value
  1942.      *
  1943.      * @return int[]|null[]|string[]
  1944.      * @psalm-return list<int|string|null>
  1945.      *
  1946.      * @throws QueryException
  1947.      */
  1948.     private function getTypes(string $field, $value, ClassMetadata $class): array
  1949.     {
  1950.         $types = [];
  1952.         switch (true) {
  1953.             case isset($class->fieldMappings[$field]):
  1954.                 $types = array_merge($types, [$class->fieldMappings[$field]['type']]);
  1955.                 break;
  1957.             case isset($class->associationMappings[$field]):
  1958.                 $assoc = $class->associationMappings[$field];
  1959.                 $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1961.                 if (! $assoc['isOwningSide']) {
  1962.                     $assoc = $class->associationMappings[$assoc['mappedBy']];
  1963.                     $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1964.                 }
  1966.                 $columns = $assoc['type'] === ClassMetadata::MANY_TO_MANY
  1967.                     ? $assoc['relationToTargetKeyColumns']
  1968.                     : $assoc['sourceToTargetKeyColumns'];
  1970.                 foreach ($columns as $column) {
  1971.                     $types[] = PersisterHelper::getTypeOfColumn($column, $class, $this->em);
  1972.                 }
  1974.                 break;
  1976.             default:
  1977.                 $types[] = null;
  1978.                 break;
  1979.         }
  1981.         if (is_array($value)) {
  1982.             return array_map(static function ($type) {
  1983.                 $type = Type::getType($type);
  1985.                 return $type->getBindingType() + Connection::ARRAY_PARAM_OFFSET;
  1986.             }, $types);
  1987.         }
  1989.         return $types;
  1990.     }
  1992.     /**
  1993.      * Retrieves the parameters that identifies a value.
  1994.      *
  1995.      * @param mixed $value
  1996.      *
  1997.      * @return mixed[]
  1998.      */
  1999.     private function getValues($value): array
  2000.     {
  2001.         if (is_array($value)) {
  2002.             $newValue = [];
  2004.             foreach ($value as $itemValue) {
  2005.                 $newValue = array_merge($newValue, $this->getValues($itemValue));
  2006.             }
  2008.             return [$newValue];
  2009.         }
  2011.         return $this->getIndividualValue($value);
  2012.     }
  2014.     /**
  2015.      * Retrieves an individual parameter value.
  2016.      *
  2017.      * @param mixed $value
  2018.      *
  2019.      * @psalm-return list<mixed>
  2020.      */
  2021.     private function getIndividualValue($value): array
  2022.     {
  2023.         if (! is_object($value)) {
  2024.             return [$value];
  2025.         }
  2027.         if ($value instanceof BackedEnum) {
  2028.             return [$value->value];
  2029.         }
  2031.         $valueClass = DefaultProxyClassNameResolver::getClass($value);
  2033.         if ($this->em->getMetadataFactory()->isTransient($valueClass)) {
  2034.             return [$value];
  2035.         }
  2037.         $class = $this->em->getClassMetadata($valueClass);
  2039.         if ($class->isIdentifierComposite) {
  2040.             $newValue = [];
  2042.             foreach ($class->getIdentifierValues($value) as $innerValue) {
  2043.                 $newValue = array_merge($newValue, $this->getValues($innerValue));
  2044.             }
  2046.             return $newValue;
  2047.         }
  2049.         return [$this->em->getUnitOfWork()->getSingleIdentifierValue($value)];
  2050.     }
  2052.     /**
  2053.      * {@inheritDoc}
  2054.      */
  2055.     public function exists($entity, ?Criteria $extraConditions = null)
  2056.     {
  2057.         $criteria = $this->class->getIdentifierValues($entity);
  2059.         if (! $criteria) {
  2060.             return false;
  2061.         }
  2063.         $alias = $this->getSQLTableAlias($this->class->name);
  2065.         $sql = 'SELECT 1 '
  2066.              . $this->getLockTablesSql(LockMode::NONE)
  2067.              . ' WHERE ' . $this->getSelectConditionSQL($criteria);
  2069.         [$params, $types] = $this->expandParameters($criteria);
  2071.         if ($extraConditions !== null) {
  2072.             $sql                             .= ' AND ' . $this->getSelectConditionCriteriaSQL($extraConditions);
  2073.             [$criteriaParams, $criteriaTypes] = $this->expandCriteriaParameters($extraConditions);
  2075.             $params = array_merge($params, $criteriaParams);
  2076.             $types  = array_merge($types, $criteriaTypes);
  2077.         }
  2079.         $filterSql = $this->generateFilterConditionSQL($this->class, $alias);
  2080.         if ($filterSql) {
  2081.             $sql .= ' AND ' . $filterSql;
  2082.         }
  2084.         return (bool) $this->conn->fetchOne($sql, $params, $types);
  2085.     }
  2087.     /**
  2088.      * Generates the appropriate join SQL for the given join column.
  2089.      *
  2090.      * @param array[] $joinColumns The join columns definition of an association.
  2091.      * @psalm-param array<array<string, mixed>> $joinColumns
  2092.      *
  2093.      * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise.
  2094.      */
  2095.     protected function getJoinSQLForJoinColumns($joinColumns)
  2096.     {
  2097.         // if one of the join columns is nullable, return left join
  2098.         foreach ($joinColumns as $joinColumn) {
  2099.             if (! isset($joinColumn['nullable']) || $joinColumn['nullable']) {
  2100.                 return 'LEFT JOIN';
  2101.             }
  2102.         }
  2104.         return 'INNER JOIN';
  2105.     }
  2107.     /**
  2108.      * @param string $columnName
  2109.      *
  2110.      * @return string
  2111.      */
  2112.     public function getSQLColumnAlias($columnName)
  2113.     {
  2114.         return $this->quoteStrategy->getColumnAlias($columnName, $this->currentPersisterContext->sqlAliasCounter++, $this->platform);
  2115.     }
  2117.     /**
  2118.      * Generates the filter SQL for a given entity and table alias.
  2119.      *
  2120.      * @param ClassMetadata $targetEntity     Metadata of the target entity.
  2121.      * @param string        $targetTableAlias The table alias of the joined/selected table.
  2122.      *
  2123.      * @return string The SQL query part to add to a query.
  2124.      */
  2125.     protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  2126.     {
  2127.         $filterClauses = [];
  2129.         foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  2130.             $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
  2131.             if ($filterExpr !== '') {
  2132.                 $filterClauses[] = '(' . $filterExpr . ')';
  2133.             }
  2134.         }
  2136.         $sql = implode(' AND ', $filterClauses);
  2138.         return $sql ? '(' . $sql . ')' : ''; // Wrap again to avoid "X or Y and FilterConditionSQL"
  2139.     }
  2141.     /**
  2142.      * Switches persister context according to current query offset/limits
  2143.      *
  2144.      * This is due to the fact that to-many associations cannot be fetch-joined when a limit is involved
  2145.      *
  2146.      * @param int|null $offset
  2147.      * @param int|null $limit
  2148.      *
  2149.      * @return void
  2150.      */
  2151.     protected function switchPersisterContext($offset, $limit)
  2152.     {
  2153.         if ($offset === null && $limit === null) {
  2154.             $this->currentPersisterContext = $this->noLimitsContext;
  2156.             return;
  2157.         }
  2159.         $this->currentPersisterContext = $this->limitsHandlingContext;
  2160.     }
  2162.     /**
  2163.      * @return string[]
  2164.      * @psalm-return list<string>
  2165.      */
  2166.     protected function getClassIdentifiersTypes(ClassMetadata $class): array
  2167.     {
  2168.         $entityManager = $this->em;
  2170.         return array_map(
  2171.             static function ($fieldName) use ($class, $entityManager): string {
  2172.                 $types = PersisterHelper::getTypeOfField($fieldName, $class, $entityManager);
  2173.                 assert(isset($types[0]));
  2175.                 return $types[0];
  2176.             },
  2177.             $class->identifier
  2178.         );
  2179.     }
  2180. }