vendor/doctrine/orm/src/Persisters/Entity/BasicEntityPersister.php line 768

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\LockSqlHelper;
  35. use Doctrine\ORM\Utility\PersisterHelper;
  36. use LengthException;
  38. use function array_combine;
  39. use function array_keys;
  40. use function array_map;
  41. use function array_merge;
  42. use function array_search;
  43. use function array_unique;
  44. use function array_values;
  45. use function assert;
  46. use function count;
  47. use function implode;
  48. use function is_array;
  49. use function is_object;
  50. use function reset;
  51. use function spl_object_id;
  52. use function sprintf;
  53. use function str_contains;
  54. use function strtoupper;
  55. use function trim;
  57. /**
  58.  * A BasicEntityPersister maps an entity to a single table in a relational database.
  59.  *
  60.  * A persister is always responsible for a single entity type.
  61.  *
  62.  * EntityPersisters are used during a UnitOfWork to apply any changes to the persistent
  63.  * state of entities onto a relational database when the UnitOfWork is committed,
  64.  * as well as for basic querying of entities and their associations (not DQL).
  65.  *
  66.  * The persisting operations that are invoked during a commit of a UnitOfWork to
  67.  * persist the persistent entity state are:
  68.  *
  69.  *   - {@link addInsert} : To schedule an entity for insertion.
  70.  *   - {@link executeInserts} : To execute all scheduled insertions.
  71.  *   - {@link update} : To update the persistent state of an entity.
  72.  *   - {@link delete} : To delete the persistent state of an entity.
  73.  *
  74.  * As can be seen from the above list, insertions are batched and executed all at once
  75.  * for increased efficiency.
  76.  *
  77.  * The querying operations invoked during a UnitOfWork, either through direct find
  78.  * requests or lazy-loading, are the following:
  79.  *
  80.  *   - {@link load} : Loads (the state of) a single, managed entity.
  81.  *   - {@link loadAll} : Loads multiple, managed entities.
  82.  *   - {@link loadOneToOneEntity} : Loads a one/many-to-one entity association (lazy-loading).
  83.  *   - {@link loadOneToManyCollection} : Loads a one-to-many entity association (lazy-loading).
  84.  *   - {@link loadManyToManyCollection} : Loads a many-to-many entity association (lazy-loading).
  85.  *
  86.  * The BasicEntityPersister implementation provides the default behavior for
  87.  * persisting and querying entities that are mapped to a single database table.
  88.  *
  89.  * Subclasses can be created to provide custom persisting and querying strategies,
  90.  * i.e. spanning multiple tables.
  91.  *
  92.  * @psalm-import-type AssociationMapping from ClassMetadata
  93.  */
  94. class BasicEntityPersister implements EntityPersister
  95. {
  96.     use LockSqlHelper;
  98.     /** @var array<string,string> */
  99.     private static $comparisonMap = [
  100.         Comparison::EQ          => '= %s',
  101.         Comparison::NEQ         => '!= %s',
  102.         Comparison::GT          => '> %s',
  103.         Comparison::GTE         => '>= %s',
  104.         Comparison::LT          => '< %s',
  105.         Comparison::LTE         => '<= %s',
  106.         Comparison::IN          => 'IN (%s)',
  107.         Comparison::NIN         => 'NOT IN (%s)',
  108.         Comparison::CONTAINS    => 'LIKE %s',
  109.         Comparison::STARTS_WITH => 'LIKE %s',
  110.         Comparison::ENDS_WITH   => 'LIKE %s',
  111.     ];
  113.     /**
  114.      * Metadata object that describes the mapping of the mapped entity class.
  115.      *
  116.      * @var ClassMetadata
  117.      */
  118.     protected $class;
  120.     /**
  121.      * The underlying DBAL Connection of the used EntityManager.
  122.      *
  123.      * @var Connection $conn
  124.      */
  125.     protected $conn;
  127.     /**
  128.      * The database platform.
  129.      *
  130.      * @var AbstractPlatform
  131.      */
  132.     protected $platform;
  134.     /**
  135.      * The EntityManager instance.
  136.      *
  137.      * @var EntityManagerInterface
  138.      */
  139.     protected $em;
  141.     /**
  142.      * Queued inserts.
  143.      *
  144.      * @psalm-var array<int, object>
  145.      */
  146.     protected $queuedInserts = [];
  148.     /**
  149.      * The map of column names to DBAL mapping types of all prepared columns used
  150.      * when INSERTing or UPDATEing an entity.
  151.      *
  152.      * @see prepareInsertData($entity)
  153.      * @see prepareUpdateData($entity)
  154.      *
  155.      * @var mixed[]
  156.      */
  157.     protected $columnTypes = [];
  159.     /**
  160.      * The map of quoted column names.
  161.      *
  162.      * @see prepareInsertData($entity)
  163.      * @see prepareUpdateData($entity)
  164.      *
  165.      * @var mixed[]
  166.      */
  167.     protected $quotedColumns = [];
  169.     /**
  170.      * The INSERT SQL statement used for entities handled by this persister.
  171.      * This SQL is only generated once per request, if at all.
  172.      *
  173.      * @var string|null
  174.      */
  175.     private $insertSql;
  177.     /**
  178.      * The quote strategy.
  179.      *
  180.      * @var QuoteStrategy
  181.      */
  182.     protected $quoteStrategy;
  184.     /**
  185.      * The IdentifierFlattener used for manipulating identifiers
  186.      *
  187.      * @var IdentifierFlattener
  188.      */
  189.     protected $identifierFlattener;
  191.     /** @var CachedPersisterContext */
  192.     protected $currentPersisterContext;
  194.     /** @var CachedPersisterContext */
  195.     private $limitsHandlingContext;
  197.     /** @var CachedPersisterContext */
  198.     private $noLimitsContext;
  200.     /**
  201.      * Initializes a new <tt>BasicEntityPersister</tt> that uses the given EntityManager
  202.      * and persists instances of the class described by the given ClassMetadata descriptor.
  203.      */
  204.     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  205.     {
  206.         $this->em                    = $em;
  207.         $this->class                 = $class;
  208.         $this->conn                  = $em->getConnection();
  209.         $this->platform              = $this->conn->getDatabasePlatform();
  210.         $this->quoteStrategy         = $em->getConfiguration()->getQuoteStrategy();
  211.         $this->identifierFlattener   = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
  212.         $this->noLimitsContext       = $this->currentPersisterContext = new CachedPersisterContext(
  213.             $class,
  214.             new Query\ResultSetMapping(),
  215.             false
  216.         );
  217.         $this->limitsHandlingContext = new CachedPersisterContext(
  218.             $class,
  219.             new Query\ResultSetMapping(),
  220.             true
  221.         );
  222.     }
  224.     /**
  225.      * {@inheritDoc}
  226.      */
  227.     public function getClassMetadata()
  228.     {
  229.         return $this->class;
  230.     }
  232.     /**
  233.      * {@inheritDoc}
  234.      */
  235.     public function getResultSetMapping()
  236.     {
  237.         return $this->currentPersisterContext->rsm;
  238.     }
  240.     /**
  241.      * {@inheritDoc}
  242.      */
  243.     public function addInsert($entity)
  244.     {
  245.         $this->queuedInserts[spl_object_id($entity)] = $entity;
  246.     }
  248.     /**
  249.      * {@inheritDoc}
  250.      */
  251.     public function getInserts()
  252.     {
  253.         return $this->queuedInserts;
  254.     }
  256.     /**
  257.      * {@inheritDoc}
  258.      */
  259.     public function executeInserts()
  260.     {
  261.         if (! $this->queuedInserts) {
  262.             return;
  263.         }
  265.         $uow            = $this->em->getUnitOfWork();
  266.         $idGenerator    = $this->class->idGenerator;
  267.         $isPostInsertId = $idGenerator->isPostInsertGenerator();
  269.         $stmt      = $this->conn->prepare($this->getInsertSQL());
  270.         $tableName = $this->class->getTableName();
  272.         foreach ($this->queuedInserts as $key => $entity) {
  273.             $insertData = $this->prepareInsertData($entity);
  275.             if (isset($insertData[$tableName])) {
  276.                 $paramIndex = 1;
  278.                 foreach ($insertData[$tableName] as $column => $value) {
  279.                     $stmt->bindValue($paramIndex++, $value, $this->columnTypes[$column]);
  280.                 }
  281.             }
  283.             $stmt->executeStatement();
  285.             if ($isPostInsertId) {
  286.                 $generatedId = $idGenerator->generateId($this->em, $entity);
  287.                 $id          = [$this->class->identifier[0] => $generatedId];
  289.                 $uow->assignPostInsertId($entity, $generatedId);
  290.             } else {
  291.                 $id = $this->class->getIdentifierValues($entity);
  292.             }
  294.             if ($this->class->requiresFetchAfterChange) {
  295.                 $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  296.             }
  298.             // Unset this queued insert, so that the prepareUpdateData() method knows right away
  299.             // (for the next entity already) that the current entity has been written to the database
  300.             // and no extra updates need to be scheduled to refer to it.
  301.             //
  302.             // In \Doctrine\ORM\UnitOfWork::executeInserts(), the UoW already removed entities
  303.             // from its own list (\Doctrine\ORM\UnitOfWork::$entityInsertions) right after they
  304.             // were given to our addInsert() method.
  305.             unset($this->queuedInserts[$key]);
  306.         }
  307.     }
  309.     /**
  310.      * Retrieves the default version value which was created
  311.      * by the preceding INSERT statement and assigns it back in to the
  312.      * entities version field if the given entity is versioned.
  313.      * Also retrieves values of columns marked as 'non insertable' and / or
  314.      * 'not updatable' and assigns them back to the entities corresponding fields.
  315.      *
  316.      * @param object  $entity
  317.      * @param mixed[] $id
  318.      *
  319.      * @return void
  320.      */
  321.     protected function assignDefaultVersionAndUpsertableValues($entity, array $id)
  322.     {
  323.         $values = $this->fetchVersionAndNotUpsertableValues($this->class, $id);
  325.         foreach ($values as $field => $value) {
  326.             $value = Type::getType($this->class->fieldMappings[$field]['type'])->convertToPHPValue($value, $this->platform);
  328.             $this->class->setFieldValue($entity, $field, $value);
  329.         }
  330.     }
  332.     /**
  333.      * Fetches the current version value of a versioned entity and / or the values of fields
  334.      * marked as 'not insertable' and / or 'not updatable'.
  335.      *
  336.      * @param ClassMetadata $versionedClass
  337.      * @param mixed[]       $id
  338.      *
  339.      * @return mixed
  340.      */
  341.     protected function fetchVersionAndNotUpsertableValues($versionedClass, array $id)
  342.     {
  343.         $columnNames = [];
  344.         foreach ($this->class->fieldMappings as $key => $column) {
  345.             if (isset($column['generated']) || ($this->class->isVersioned && $key === $versionedClass->versionField)) {
  346.                 $columnNames[$key] = $this->quoteStrategy->getColumnName($key, $versionedClass, $this->platform);
  347.             }
  348.         }
  350.         $tableName  = $this->quoteStrategy->getTableName($versionedClass, $this->platform);
  351.         $identifier = $this->quoteStrategy->getIdentifierColumnNames($versionedClass, $this->platform);
  353.         // FIXME: Order with composite keys might not be correct
  354.         $sql = 'SELECT ' . implode(', ', $columnNames)
  355.             . ' FROM ' . $tableName
  356.             . ' WHERE ' . implode(' = ? AND ', $identifier) . ' = ?';
  358.         $flatId = $this->identifierFlattener->flattenIdentifier($versionedClass, $id);
  360.         $values = $this->conn->fetchNumeric(
  361.             $sql,
  362.             array_values($flatId),
  363.             $this->extractIdentifierTypes($id, $versionedClass)
  364.         );
  366.         if ($values === false) {
  367.             throw new LengthException('Unexpected empty result for database query.');
  368.         }
  370.         $values = array_combine(array_keys($columnNames), $values);
  372.         if (! $values) {
  373.             throw new LengthException('Unexpected number of database columns.');
  374.         }
  376.         return $values;
  377.     }
  379.     /**
  380.      * @param mixed[] $id
  381.      *
  382.      * @return int[]|null[]|string[]
  383.      * @psalm-return list<int|string|null>
  384.      */
  385.     final protected function extractIdentifierTypes(array $id, ClassMetadata $versionedClass): array
  386.     {
  387.         $types = [];
  389.         foreach ($id as $field => $value) {
  390.             $types = array_merge($types, $this->getTypes($field, $value, $versionedClass));
  391.         }
  393.         return $types;
  394.     }
  396.     /**
  397.      * {@inheritDoc}
  398.      */
  399.     public function update($entity)
  400.     {
  401.         $tableName  = $this->class->getTableName();
  402.         $updateData = $this->prepareUpdateData($entity);
  404.         if (! isset($updateData[$tableName])) {
  405.             return;
  406.         }
  408.         $data = $updateData[$tableName];
  410.         if (! $data) {
  411.             return;
  412.         }
  414.         $isVersioned     = $this->class->isVersioned;
  415.         $quotedTableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  417.         $this->updateTable($entity, $quotedTableName, $data, $isVersioned);
  419.         if ($this->class->requiresFetchAfterChange) {
  420.             $id = $this->class->getIdentifierValues($entity);
  422.             $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  423.         }
  424.     }
  426.     /**
  427.      * Performs an UPDATE statement for an entity on a specific table.
  428.      * The UPDATE can optionally be versioned, which requires the entity to have a version field.
  429.      *
  430.      * @param object  $entity          The entity object being updated.
  431.      * @param string  $quotedTableName The quoted name of the table to apply the UPDATE on.
  432.      * @param mixed[] $updateData      The map of columns to update (column => value).
  433.      * @param bool    $versioned       Whether the UPDATE should be versioned.
  434.      *
  435.      * @throws UnrecognizedField
  436.      * @throws OptimisticLockException
  437.      */
  438.     final protected function updateTable(
  439.         $entity,
  440.         $quotedTableName,
  441.         array $updateData,
  442.         $versioned = false
  443.     ): void {
  444.         $set    = [];
  445.         $types  = [];
  446.         $params = [];
  448.         foreach ($updateData as $columnName => $value) {
  449.             $placeholder = '?';
  450.             $column      = $columnName;
  452.             switch (true) {
  453.                 case isset($this->class->fieldNames[$columnName]):
  454.                     $fieldName = $this->class->fieldNames[$columnName];
  455.                     $column    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  457.                     if (isset($this->class->fieldMappings[$fieldName]['requireSQLConversion'])) {
  458.                         $type        = Type::getType($this->columnTypes[$columnName]);
  459.                         $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  460.                     }
  462.                     break;
  464.                 case isset($this->quotedColumns[$columnName]):
  465.                     $column = $this->quotedColumns[$columnName];
  467.                     break;
  468.             }
  470.             $params[] = $value;
  471.             $set[]    = $column . ' = ' . $placeholder;
  472.             $types[]  = $this->columnTypes[$columnName];
  473.         }
  475.         $where      = [];
  476.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  478.         foreach ($this->class->identifier as $idField) {
  479.             if (! isset($this->class->associationMappings[$idField])) {
  480.                 $params[] = $identifier[$idField];
  481.                 $types[]  = $this->class->fieldMappings[$idField]['type'];
  482.                 $where[]  = $this->quoteStrategy->getColumnName($idField, $this->class, $this->platform);
  484.                 continue;
  485.             }
  487.             $params[] = $identifier[$idField];
  488.             $where[]  = $this->quoteStrategy->getJoinColumnName(
  489.                 $this->class->associationMappings[$idField]['joinColumns'][0],
  490.                 $this->class,
  491.                 $this->platform
  492.             );
  494.             $targetMapping = $this->em->getClassMetadata($this->class->associationMappings[$idField]['targetEntity']);
  495.             $targetType    = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
  497.             if ($targetType === []) {
  498.                 throw UnrecognizedField::byFullyQualifiedName($this->class->name, $targetMapping->identifier[0]);
  499.             }
  501.             $types[] = reset($targetType);
  502.         }
  504.         if ($versioned) {
  505.             $versionField = $this->class->versionField;
  506.             assert($versionField !== null);
  507.             $versionFieldType = $this->class->fieldMappings[$versionField]['type'];
  508.             $versionColumn    = $this->quoteStrategy->getColumnName($versionField, $this->class, $this->platform);
  510.             $where[]  = $versionColumn;
  511.             $types[]  = $this->class->fieldMappings[$versionField]['type'];
  512.             $params[] = $this->class->reflFields[$versionField]->getValue($entity);
  514.             switch ($versionFieldType) {
  515.                 case Types::SMALLINT:
  516.                 case Types::INTEGER:
  517.                 case Types::BIGINT:
  518.                     $set[] = $versionColumn . ' = ' . $versionColumn . ' + 1';
  519.                     break;
  521.                 case Types::DATETIME_MUTABLE:
  522.                     $set[] = $versionColumn . ' = CURRENT_TIMESTAMP';
  523.                     break;
  524.             }
  525.         }
  527.         $sql = 'UPDATE ' . $quotedTableName
  528.              . ' SET ' . implode(', ', $set)
  529.              . ' WHERE ' . implode(' = ? AND ', $where) . ' = ?';
  531.         $result = $this->conn->executeStatement($sql, $params, $types);
  533.         if ($versioned && ! $result) {
  534.             throw OptimisticLockException::lockFailed($entity);
  535.         }
  536.     }
  538.     /**
  539.      * @param array<mixed> $identifier
  540.      * @param string[]     $types
  541.      *
  542.      * @todo Add check for platform if it supports foreign keys/cascading.
  543.      */
  544.     protected function deleteJoinTableRecords(array $identifier, array $types): void
  545.     {
  546.         foreach ($this->class->associationMappings as $mapping) {
  547.             if ($mapping['type'] !== ClassMetadata::MANY_TO_MANY || isset($mapping['isOnDeleteCascade'])) {
  548.                 continue;
  549.             }
  551.             // @Todo this only covers scenarios with no inheritance or of the same level. Is there something
  552.             // like self-referential relationship between different levels of an inheritance hierarchy? I hope not!
  553.             $selfReferential = ($mapping['targetEntity'] === $mapping['sourceEntity']);
  554.             $class           = $this->class;
  555.             $association     = $mapping;
  556.             $otherColumns    = [];
  557.             $otherKeys       = [];
  558.             $keys            = [];
  560.             if (! $mapping['isOwningSide']) {
  561.                 $class       = $this->em->getClassMetadata($mapping['targetEntity']);
  562.                 $association = $class->associationMappings[$mapping['mappedBy']];
  563.             }
  565.             $joinColumns = $mapping['isOwningSide']
  566.                 ? $association['joinTable']['joinColumns']
  567.                 : $association['joinTable']['inverseJoinColumns'];
  569.             if ($selfReferential) {
  570.                 $otherColumns = ! $mapping['isOwningSide']
  571.                     ? $association['joinTable']['joinColumns']
  572.                     : $association['joinTable']['inverseJoinColumns'];
  573.             }
  575.             foreach ($joinColumns as $joinColumn) {
  576.                 $keys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  577.             }
  579.             foreach ($otherColumns as $joinColumn) {
  580.                 $otherKeys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  581.             }
  583.             $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  585.             $this->conn->delete($joinTableName, array_combine($keys, $identifier), $types);
  587.             if ($selfReferential) {
  588.                 $this->conn->delete($joinTableName, array_combine($otherKeys, $identifier), $types);
  589.             }
  590.         }
  591.     }
  593.     /**
  594.      * {@inheritDoc}
  595.      */
  596.     public function delete($entity)
  597.     {
  598.         $class      = $this->class;
  599.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  600.         $tableName  = $this->quoteStrategy->getTableName($class, $this->platform);
  601.         $idColumns  = $this->quoteStrategy->getIdentifierColumnNames($class, $this->platform);
  602.         $id         = array_combine($idColumns, $identifier);
  603.         $types      = $this->getClassIdentifiersTypes($class);
  605.         $this->deleteJoinTableRecords($identifier, $types);
  607.         return (bool) $this->conn->delete($tableName, $id, $types);
  608.     }
  610.     /**
  611.      * Prepares the changeset of an entity for database insertion (UPDATE).
  612.      *
  613.      * The changeset is obtained from the currently running UnitOfWork.
  614.      *
  615.      * During this preparation the array that is passed as the second parameter is filled with
  616.      * <columnName> => <value> pairs, grouped by table name.
  617.      *
  618.      * Example:
  619.      * <code>
  620.      * array(
  621.      *    'foo_table' => array('column1' => 'value1', 'column2' => 'value2', ...),
  622.      *    'bar_table' => array('columnX' => 'valueX', 'columnY' => 'valueY', ...),
  623.      *    ...
  624.      * )
  625.      * </code>
  626.      *
  627.      * @param object $entity   The entity for which to prepare the data.
  628.      * @param bool   $isInsert Whether the data to be prepared refers to an insert statement.
  629.      *
  630.      * @return mixed[][] The prepared data.
  631.      * @psalm-return array<string, array<array-key, mixed|null>>
  632.      */
  633.     protected function prepareUpdateData($entity, bool $isInsert = false)
  634.     {
  635.         $versionField = null;
  636.         $result       = [];
  637.         $uow          = $this->em->getUnitOfWork();
  639.         $versioned = $this->class->isVersioned;
  640.         if ($versioned !== false) {
  641.             $versionField = $this->class->versionField;
  642.         }
  644.         foreach ($uow->getEntityChangeSet($entity) as $field => $change) {
  645.             if (isset($versionField) && $versionField === $field) {
  646.                 continue;
  647.             }
  649.             if (isset($this->class->embeddedClasses[$field])) {
  650.                 continue;
  651.             }
  653.             $newVal = $change[1];
  655.             if (! isset($this->class->associationMappings[$field])) {
  656.                 $fieldMapping = $this->class->fieldMappings[$field];
  657.                 $columnName   = $fieldMapping['columnName'];
  659.                 if (! $isInsert && isset($fieldMapping['notUpdatable'])) {
  660.                     continue;
  661.                 }
  663.                 if ($isInsert && isset($fieldMapping['notInsertable'])) {
  664.                     continue;
  665.                 }
  667.                 $this->columnTypes[$columnName] = $fieldMapping['type'];
  669.                 $result[$this->getOwningTable($field)][$columnName] = $newVal;
  671.                 continue;
  672.             }
  674.             $assoc = $this->class->associationMappings[$field];
  676.             // Only owning side of x-1 associations can have a FK column.
  677.             if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
  678.                 continue;
  679.             }
  681.             if ($newVal !== null) {
  682.                 $oid = spl_object_id($newVal);
  684.                 // If the associated entity $newVal is not yet persisted and/or does not yet have
  685.                 // an ID assigned, we must set $newVal = null. This will insert a null value and
  686.                 // schedule an extra update on the UnitOfWork.
  687.                 //
  688.                 // This gives us extra time to a) possibly obtain a database-generated identifier
  689.                 // value for $newVal, and b) insert $newVal into the database before the foreign
  690.                 // key reference is being made.
  691.                 //
  692.                 // When looking at $this->queuedInserts and $uow->isScheduledForInsert, be aware
  693.                 // of the implementation details that our own executeInserts() method will remove
  694.                 // entities from the former as soon as the insert statement has been executed and
  695.                 // a post-insert ID has been assigned (if necessary), and that the UnitOfWork has
  696.                 // already removed entities from its own list at the time they were passed to our
  697.                 // addInsert() method.
  698.                 //
  699.                 // Then, there is one extra exception we can make: An entity that references back to itself
  700.                 // _and_ uses an application-provided ID (the "NONE" generator strategy) also does not
  701.                 // need the extra update, although it is still in the list of insertions itself.
  702.                 // This looks like a minor optimization at first, but is the capstone for being able to
  703.                 // use non-NULLable, self-referencing associations in applications that provide IDs (like UUIDs).
  704.                 if (
  705.                     (isset($this->queuedInserts[$oid]) || $uow->isScheduledForInsert($newVal))
  706.                     && ! ($newVal === $entity && $this->class->isIdentifierNatural())
  707.                 ) {
  708.                     $uow->scheduleExtraUpdate($entity, [$field => [null, $newVal]]);
  710.                     $newVal = null;
  711.                 }
  712.             }
  714.             $newValId = null;
  716.             if ($newVal !== null) {
  717.                 $newValId = $uow->getEntityIdentifier($newVal);
  718.             }
  720.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  721.             $owningTable = $this->getOwningTable($field);
  723.             foreach ($assoc['joinColumns'] as $joinColumn) {
  724.                 $sourceColumn = $joinColumn['name'];
  725.                 $targetColumn = $joinColumn['referencedColumnName'];
  726.                 $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  728.                 $this->quotedColumns[$sourceColumn]  = $quotedColumn;
  729.                 $this->columnTypes[$sourceColumn]    = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $this->em);
  730.                 $result[$owningTable][$sourceColumn] = $newValId
  731.                     ? $newValId[$targetClass->getFieldForColumn($targetColumn)]
  732.                     : null;
  733.             }
  734.         }
  736.         return $result;
  737.     }
  739.     /**
  740.      * Prepares the data changeset of a managed entity for database insertion (initial INSERT).
  741.      * The changeset of the entity is obtained from the currently running UnitOfWork.
  742.      *
  743.      * The default insert data preparation is the same as for updates.
  744.      *
  745.      * @see prepareUpdateData
  746.      *
  747.      * @param object $entity The entity for which to prepare the data.
  748.      *
  749.      * @return mixed[][] The prepared data for the tables to update.
  750.      * @psalm-return array<string, mixed[]>
  751.      */
  752.     protected function prepareInsertData($entity)
  753.     {
  754.         return $this->prepareUpdateData($entity, true);
  755.     }
  757.     /**
  758.      * {@inheritDoc}
  759.      */
  760.     public function getOwningTable($fieldName)
  761.     {
  762.         return $this->class->getTableName();
  763.     }
  765.     /**
  766.      * {@inheritDoc}
  767.      */
  768.     public function load(array $criteria, $entity = null, $assoc = null, array $hints = [], $lockMode = null, $limit = null, ?array $orderBy = null)
  769.     {
  770.         $this->switchPersisterContext(null, $limit);
  772.         $sql              = $this->getSelectSQL($criteria, $assoc, $lockMode, $limit, null, $orderBy);
  773.         [$params, $types] = $this->expandParameters($criteria);
  774.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  776.         if ($entity !== null) {
  777.             $hints[Query::HINT_REFRESH]        = true;
  778.             $hints[Query::HINT_REFRESH_ENTITY] = $entity;
  779.         }
  781.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  782.         $entities = $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, $hints);
  784.         return $entities ? $entities[0] : null;
  785.     }
  787.     /**
  788.      * {@inheritDoc}
  789.      */
  790.     public function loadById(array $identifier, $entity = null)
  791.     {
  792.         return $this->load($identifier, $entity);
  793.     }
  795.     /**
  796.      * {@inheritDoc}
  797.      */
  798.     public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = [])
  799.     {
  800.         $foundEntity = $this->em->getUnitOfWork()->tryGetById($identifier, $assoc['targetEntity']);
  801.         if ($foundEntity !== false) {
  802.             return $foundEntity;
  803.         }
  805.         $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  807.         if ($assoc['isOwningSide']) {
  808.             $isInverseSingleValued = $assoc['inversedBy'] && ! $targetClass->isCollectionValuedAssociation($assoc['inversedBy']);
  810.             // Mark inverse side as fetched in the hints, otherwise the UoW would
  811.             // try to load it in a separate query (remember: to-one inverse sides can not be lazy).
  812.             $hints = [];
  814.             if ($isInverseSingleValued) {
  815.                 $hints['fetched']['r'][$assoc['inversedBy']] = true;
  816.             }
  818.             $targetEntity = $this->load($identifier, null, $assoc, $hints);
  820.             // Complete bidirectional association, if necessary
  821.             if ($targetEntity !== null && $isInverseSingleValued) {
  822.                 $targetClass->reflFields[$assoc['inversedBy']]->setValue($targetEntity, $sourceEntity);
  823.             }
  825.             return $targetEntity;
  826.         }
  828.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  829.         $owningAssoc = $targetClass->getAssociationMapping($assoc['mappedBy']);
  831.         $computedIdentifier = [];
  833.         // TRICKY: since the association is specular source and target are flipped
  834.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  835.             if (! isset($sourceClass->fieldNames[$sourceKeyColumn])) {
  836.                 throw MappingException::joinColumnMustPointToMappedField(
  837.                     $sourceClass->name,
  838.                     $sourceKeyColumn
  839.                 );
  840.             }
  842.             $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  843.                 $sourceClass->reflFields[$sourceClass->fieldNames[$sourceKeyColumn]]->getValue($sourceEntity);
  844.         }
  846.         $targetEntity = $this->load($computedIdentifier, null, $assoc);
  848.         if ($targetEntity !== null) {
  849.             $targetClass->setFieldValue($targetEntity, $assoc['mappedBy'], $sourceEntity);
  850.         }
  852.         return $targetEntity;
  853.     }
  855.     /**
  856.      * {@inheritDoc}
  857.      */
  858.     public function refresh(array $id, $entity, $lockMode = null)
  859.     {
  860.         $sql              = $this->getSelectSQL($id, null, $lockMode);
  861.         [$params, $types] = $this->expandParameters($id);
  862.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  864.         $hydrator = $this->em->newHydrator(Query::HYDRATE_OBJECT);
  865.         $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [Query::HINT_REFRESH => true]);
  866.     }
  868.     /**
  869.      * {@inheritDoc}
  870.      */
  871.     public function count($criteria = [])
  872.     {
  873.         $sql = $this->getCountSQL($criteria);
  875.         [$params, $types] = $criteria instanceof Criteria
  876.             ? $this->expandCriteriaParameters($criteria)
  877.             : $this->expandParameters($criteria);
  879.         return (int) $this->conn->executeQuery($sql, $params, $types)->fetchOne();
  880.     }
  882.     /**
  883.      * {@inheritDoc}
  884.      */
  885.     public function loadCriteria(Criteria $criteria)
  886.     {
  887.         $orderBy = $criteria->getOrderings();
  888.         $limit   = $criteria->getMaxResults();
  889.         $offset  = $criteria->getFirstResult();
  890.         $query   = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  892.         [$params, $types] = $this->expandCriteriaParameters($criteria);
  894.         $stmt     = $this->conn->executeQuery($query, $params, $types);
  895.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  897.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  898.     }
  900.     /**
  901.      * {@inheritDoc}
  902.      */
  903.     public function expandCriteriaParameters(Criteria $criteria)
  904.     {
  905.         $expression = $criteria->getWhereExpression();
  906.         $sqlParams  = [];
  907.         $sqlTypes   = [];
  909.         if ($expression === null) {
  910.             return [$sqlParams, $sqlTypes];
  911.         }
  913.         $valueVisitor = new SqlValueVisitor();
  915.         $valueVisitor->dispatch($expression);
  917.         [, $types] = $valueVisitor->getParamsAndTypes();
  919.         foreach ($types as $type) {
  920.             [$field, $value, $operator] = $type;
  922.             if ($value === null && ($operator === Comparison::EQ || $operator === Comparison::NEQ)) {
  923.                 continue;
  924.             }
  926.             $sqlParams = array_merge($sqlParams, $this->getValues($value));
  927.             $sqlTypes  = array_merge($sqlTypes, $this->getTypes($field, $value, $this->class));
  928.         }
  930.         return [$sqlParams, $sqlTypes];
  931.     }
  933.     /**
  934.      * {@inheritDoc}
  935.      */
  936.     public function loadAll(array $criteria = [], ?array $orderBy = null, $limit = null, $offset = null)
  937.     {
  938.         $this->switchPersisterContext($offset, $limit);
  940.         $sql              = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  941.         [$params, $types] = $this->expandParameters($criteria);
  942.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  944.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  946.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  947.     }
  949.     /**
  950.      * {@inheritDoc}
  951.      */
  952.     public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  953.     {
  954.         $this->switchPersisterContext($offset, $limit);
  956.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity, $offset, $limit);
  958.         return $this->loadArrayFromResult($assoc, $stmt);
  959.     }
  961.     /**
  962.      * Loads an array of entities from a given DBAL statement.
  963.      *
  964.      * @param mixed[] $assoc
  965.      *
  966.      * @return mixed[]
  967.      */
  968.     private function loadArrayFromResult(array $assoc, Result $stmt): array
  969.     {
  970.         $rsm   = $this->currentPersisterContext->rsm;
  971.         $hints = [UnitOfWork::HINT_DEFEREAGERLOAD => true];
  973.         if (isset($assoc['indexBy'])) {
  974.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  975.             $rsm->addIndexBy('r', $assoc['indexBy']);
  976.         }
  978.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  979.     }
  981.     /**
  982.      * Hydrates a collection from a given DBAL statement.
  983.      *
  984.      * @param mixed[] $assoc
  985.      *
  986.      * @return mixed[]
  987.      */
  988.     private function loadCollectionFromStatement(
  989.         array $assoc,
  990.         Result $stmt,
  991.         PersistentCollection $coll
  992.     ): array {
  993.         $rsm   = $this->currentPersisterContext->rsm;
  994.         $hints = [
  995.             UnitOfWork::HINT_DEFEREAGERLOAD => true,
  996.             'collection' => $coll,
  997.         ];
  999.         if (isset($assoc['indexBy'])) {
  1000.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  1001.             $rsm->addIndexBy('r', $assoc['indexBy']);
  1002.         }
  1004.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1005.     }
  1007.     /**
  1008.      * {@inheritDoc}
  1009.      */
  1010.     public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1011.     {
  1012.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity);
  1014.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1015.     }
  1017.     /**
  1018.      * @param object $sourceEntity
  1019.      * @psalm-param array<string, mixed> $assoc
  1020.      *
  1021.      * @return Result
  1022.      *
  1023.      * @throws MappingException
  1024.      */
  1025.     private function getManyToManyStatement(
  1026.         array $assoc,
  1027.         $sourceEntity,
  1028.         ?int $offset = null,
  1029.         ?int $limit = null
  1030.     ) {
  1031.         $this->switchPersisterContext($offset, $limit);
  1033.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1034.         $class       = $sourceClass;
  1035.         $association = $assoc;
  1036.         $criteria    = [];
  1037.         $parameters  = [];
  1039.         if (! $assoc['isOwningSide']) {
  1040.             $class       = $this->em->getClassMetadata($assoc['targetEntity']);
  1041.             $association = $class->associationMappings[$assoc['mappedBy']];
  1042.         }
  1044.         $joinColumns = $assoc['isOwningSide']
  1045.             ? $association['joinTable']['joinColumns']
  1046.             : $association['joinTable']['inverseJoinColumns'];
  1048.         $quotedJoinTable = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1050.         foreach ($joinColumns as $joinColumn) {
  1051.             $sourceKeyColumn = $joinColumn['referencedColumnName'];
  1052.             $quotedKeyColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1054.             switch (true) {
  1055.                 case $sourceClass->containsForeignIdentifier:
  1056.                     $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1057.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1059.                     if (isset($sourceClass->associationMappings[$field])) {
  1060.                         $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1061.                         $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1062.                     }
  1064.                     break;
  1066.                 case isset($sourceClass->fieldNames[$sourceKeyColumn]):
  1067.                     $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1068.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1070.                     break;
  1072.                 default:
  1073.                     throw MappingException::joinColumnMustPointToMappedField(
  1074.                         $sourceClass->name,
  1075.                         $sourceKeyColumn
  1076.                     );
  1077.             }
  1079.             $criteria[$quotedJoinTable . '.' . $quotedKeyColumn] = $value;
  1080.             $parameters[]                                        = [
  1081.                 'value' => $value,
  1082.                 'field' => $field,
  1083.                 'class' => $sourceClass,
  1084.             ];
  1085.         }
  1087.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1088.         [$params, $types] = $this->expandToManyParameters($parameters);
  1090.         return $this->conn->executeQuery($sql, $params, $types);
  1091.     }
  1093.     /**
  1094.      * {@inheritDoc}
  1095.      */
  1096.     public function getSelectSQL($criteria, $assoc = null, $lockMode = null, $limit = null, $offset = null, ?array $orderBy = null)
  1097.     {
  1098.         $this->switchPersisterContext($offset, $limit);
  1100.         $lockSql    = '';
  1101.         $joinSql    = '';
  1102.         $orderBySql = '';
  1104.         if ($assoc !== null && $assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  1105.             $joinSql = $this->getSelectManyToManyJoinSQL($assoc);
  1106.         }
  1108.         if (isset($assoc['orderBy'])) {
  1109.             $orderBy = $assoc['orderBy'];
  1110.         }
  1112.         if ($orderBy) {
  1113.             $orderBySql = $this->getOrderBySQL($orderBy, $this->getSQLTableAlias($this->class->name));
  1114.         }
  1116.         $conditionSql = $criteria instanceof Criteria
  1117.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1118.             : $this->getSelectConditionSQL($criteria, $assoc);
  1120.         switch ($lockMode) {
  1121.             case LockMode::PESSIMISTIC_READ:
  1122.                 $lockSql = ' ' . $this->getReadLockSQL($this->platform);
  1123.                 break;
  1125.             case LockMode::PESSIMISTIC_WRITE:
  1126.                 $lockSql = ' ' . $this->getWriteLockSQL($this->platform);
  1127.                 break;
  1128.         }
  1130.         $columnList = $this->getSelectColumnsSQL();
  1131.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1132.         $filterSql  = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1133.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1135.         if ($filterSql !== '') {
  1136.             $conditionSql = $conditionSql
  1137.                 ? $conditionSql . ' AND ' . $filterSql
  1138.                 : $filterSql;
  1139.         }
  1141.         $select = 'SELECT ' . $columnList;
  1142.         $from   = ' FROM ' . $tableName . ' ' . $tableAlias;
  1143.         $join   = $this->currentPersisterContext->selectJoinSql . $joinSql;
  1144.         $where  = ($conditionSql ? ' WHERE ' . $conditionSql : '');
  1145.         $lock   = $this->platform->appendLockHint($from, $lockMode ?? LockMode::NONE);
  1146.         $query  = $select
  1147.             . $lock
  1148.             . $join
  1149.             . $where
  1150.             . $orderBySql;
  1152.         return $this->platform->modifyLimitQuery($query, $limit, $offset ?? 0) . $lockSql;
  1153.     }
  1155.     /**
  1156.      * {@inheritDoc}
  1157.      */
  1158.     public function getCountSQL($criteria = [])
  1159.     {
  1160.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1161.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1163.         $conditionSql = $criteria instanceof Criteria
  1164.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1165.             : $this->getSelectConditionSQL($criteria);
  1167.         $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1169.         if ($filterSql !== '') {
  1170.             $conditionSql = $conditionSql
  1171.                 ? $conditionSql . ' AND ' . $filterSql
  1172.                 : $filterSql;
  1173.         }
  1175.         return 'SELECT COUNT(*) '
  1176.             . 'FROM ' . $tableName . ' ' . $tableAlias
  1177.             . (empty($conditionSql) ? '' : ' WHERE ' . $conditionSql);
  1178.     }
  1180.     /**
  1181.      * Gets the ORDER BY SQL snippet for ordered collections.
  1182.      *
  1183.      * @psalm-param array<string, string> $orderBy
  1184.      *
  1185.      * @throws InvalidOrientation
  1186.      * @throws InvalidFindByCall
  1187.      * @throws UnrecognizedField
  1188.      */
  1189.     final protected function getOrderBySQL(array $orderBy, string $baseTableAlias): string
  1190.     {
  1191.         $orderByList = [];
  1193.         foreach ($orderBy as $fieldName => $orientation) {
  1194.             $orientation = strtoupper(trim($orientation));
  1196.             if ($orientation !== 'ASC' && $orientation !== 'DESC') {
  1197.                 throw InvalidOrientation::fromClassNameAndField($this->class->name, $fieldName);
  1198.             }
  1200.             if (isset($this->class->fieldMappings[$fieldName])) {
  1201.                 $tableAlias = isset($this->class->fieldMappings[$fieldName]['inherited'])
  1202.                     ? $this->getSQLTableAlias($this->class->fieldMappings[$fieldName]['inherited'])
  1203.                     : $baseTableAlias;
  1205.                 $columnName    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  1206.                 $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1208.                 continue;
  1209.             }
  1211.             if (isset($this->class->associationMappings[$fieldName])) {
  1212.                 if (! $this->class->associationMappings[$fieldName]['isOwningSide']) {
  1213.                     throw InvalidFindByCall::fromInverseSideUsage($this->class->name, $fieldName);
  1214.                 }
  1216.                 $tableAlias = isset($this->class->associationMappings[$fieldName]['inherited'])
  1217.                     ? $this->getSQLTableAlias($this->class->associationMappings[$fieldName]['inherited'])
  1218.                     : $baseTableAlias;
  1220.                 foreach ($this->class->associationMappings[$fieldName]['joinColumns'] as $joinColumn) {
  1221.                     $columnName    = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1222.                     $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1223.                 }
  1225.                 continue;
  1226.             }
  1228.             throw UnrecognizedField::byFullyQualifiedName($this->class->name, $fieldName);
  1229.         }
  1231.         return ' ORDER BY ' . implode(', ', $orderByList);
  1232.     }
  1234.     /**
  1235.      * Gets the SQL fragment with the list of columns to select when querying for
  1236.      * an entity in this persister.
  1237.      *
  1238.      * Subclasses should override this method to alter or change the select column
  1239.      * list SQL fragment. Note that in the implementation of BasicEntityPersister
  1240.      * the resulting SQL fragment is generated only once and cached in {@link selectColumnListSql}.
  1241.      * Subclasses may or may not do the same.
  1242.      *
  1243.      * @return string The SQL fragment.
  1244.      */
  1245.     protected function getSelectColumnsSQL()
  1246.     {
  1247.         if ($this->currentPersisterContext->selectColumnListSql !== null) {
  1248.             return $this->currentPersisterContext->selectColumnListSql;
  1249.         }
  1251.         $columnList = [];
  1252.         $this->currentPersisterContext->rsm->addEntityResult($this->class->name, 'r'); // r for root
  1254.         // Add regular columns to select list
  1255.         foreach ($this->class->fieldNames as $field) {
  1256.             $columnList[] = $this->getSelectColumnSQL($field, $this->class);
  1257.         }
  1259.         $this->currentPersisterContext->selectJoinSql = '';
  1260.         $eagerAliasCounter                            = 0;
  1262.         foreach ($this->class->associationMappings as $assocField => $assoc) {
  1263.             $assocColumnSQL = $this->getSelectColumnAssociationSQL($assocField, $assoc, $this->class);
  1265.             if ($assocColumnSQL) {
  1266.                 $columnList[] = $assocColumnSQL;
  1267.             }
  1269.             $isAssocToOneInverseSide = $assoc['type'] & ClassMetadata::TO_ONE && ! $assoc['isOwningSide'];
  1270.             $isAssocFromOneEager     = $assoc['type'] & ClassMetadata::TO_ONE && $assoc['fetch'] === ClassMetadata::FETCH_EAGER;
  1272.             if (! ($isAssocFromOneEager || $isAssocToOneInverseSide)) {
  1273.                 continue;
  1274.             }
  1276.             if ((($assoc['type'] & ClassMetadata::TO_MANY) > 0) && $this->currentPersisterContext->handlesLimits) {
  1277.                 continue;
  1278.             }
  1280.             $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1282.             if ($eagerEntity->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  1283.                 continue; // now this is why you shouldn't use inheritance
  1284.             }
  1286.             $assocAlias = 'e' . ($eagerAliasCounter++);
  1287.             $this->currentPersisterContext->rsm->addJoinedEntityResult($assoc['targetEntity'], $assocAlias, 'r', $assocField);
  1289.             foreach ($eagerEntity->fieldNames as $field) {
  1290.                 $columnList[] = $this->getSelectColumnSQL($field, $eagerEntity, $assocAlias);
  1291.             }
  1293.             foreach ($eagerEntity->associationMappings as $eagerAssocField => $eagerAssoc) {
  1294.                 $eagerAssocColumnSQL = $this->getSelectColumnAssociationSQL(
  1295.                     $eagerAssocField,
  1296.                     $eagerAssoc,
  1297.                     $eagerEntity,
  1298.                     $assocAlias
  1299.                 );
  1301.                 if ($eagerAssocColumnSQL) {
  1302.                     $columnList[] = $eagerAssocColumnSQL;
  1303.                 }
  1304.             }
  1306.             $association   = $assoc;
  1307.             $joinCondition = [];
  1309.             if (isset($assoc['indexBy'])) {
  1310.                 $this->currentPersisterContext->rsm->addIndexBy($assocAlias, $assoc['indexBy']);
  1311.             }
  1313.             if (! $assoc['isOwningSide']) {
  1314.                 $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1315.                 $association = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
  1316.             }
  1318.             $joinTableAlias = $this->getSQLTableAlias($eagerEntity->name, $assocAlias);
  1319.             $joinTableName  = $this->quoteStrategy->getTableName($eagerEntity, $this->platform);
  1321.             if ($assoc['isOwningSide']) {
  1322.                 $tableAlias                                    = $this->getSQLTableAlias($association['targetEntity'], $assocAlias);
  1323.                 $this->currentPersisterContext->selectJoinSql .= ' ' . $this->getJoinSQLForJoinColumns($association['joinColumns']);
  1325.                 foreach ($association['joinColumns'] as $joinColumn) {
  1326.                     $sourceCol       = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1327.                     $targetCol       = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1328.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'])
  1329.                                         . '.' . $sourceCol . ' = ' . $tableAlias . '.' . $targetCol;
  1330.                 }
  1332.                 // Add filter SQL
  1333.                 $filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias);
  1334.                 if ($filterSql) {
  1335.                     $joinCondition[] = $filterSql;
  1336.                 }
  1337.             } else {
  1338.                 $this->currentPersisterContext->selectJoinSql .= ' LEFT JOIN';
  1340.                 foreach ($association['joinColumns'] as $joinColumn) {
  1341.                     $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1342.                     $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1344.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'], $assocAlias) . '.' . $sourceCol . ' = '
  1345.                         . $this->getSQLTableAlias($association['targetEntity']) . '.' . $targetCol;
  1346.                 }
  1347.             }
  1349.             $this->currentPersisterContext->selectJoinSql .= ' ' . $joinTableName . ' ' . $joinTableAlias . ' ON ';
  1350.             $this->currentPersisterContext->selectJoinSql .= implode(' AND ', $joinCondition);
  1351.         }
  1353.         $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  1355.         return $this->currentPersisterContext->selectColumnListSql;
  1356.     }
  1358.     /**
  1359.      * Gets the SQL join fragment used when selecting entities from an association.
  1360.      *
  1361.      * @param string             $field
  1362.      * @param AssociationMapping $assoc
  1363.      * @param string             $alias
  1364.      *
  1365.      * @return string
  1366.      */
  1367.     protected function getSelectColumnAssociationSQL($field, $assoc, ClassMetadata $class, $alias = 'r')
  1368.     {
  1369.         if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1370.             return '';
  1371.         }
  1373.         $columnList    = [];
  1374.         $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
  1375.         $isIdentifier  = isset($assoc['id']) && $assoc['id'] === true;
  1376.         $sqlTableAlias = $this->getSQLTableAlias($class->name, ($alias === 'r' ? '' : $alias));
  1378.         foreach ($assoc['joinColumns'] as $joinColumn) {
  1379.             $quotedColumn     = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1380.             $resultColumnName = $this->getSQLColumnAlias($joinColumn['name']);
  1381.             $type             = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  1383.             $this->currentPersisterContext->rsm->addMetaResult($alias, $resultColumnName, $joinColumn['name'], $isIdentifier, $type);
  1385.             $columnList[] = sprintf('%s.%s AS %s', $sqlTableAlias, $quotedColumn, $resultColumnName);
  1386.         }
  1388.         return implode(', ', $columnList);
  1389.     }
  1391.     /**
  1392.      * Gets the SQL join fragment used when selecting entities from a
  1393.      * many-to-many association.
  1394.      *
  1395.      * @psalm-param AssociationMapping $manyToMany
  1396.      *
  1397.      * @return string
  1398.      */
  1399.     protected function getSelectManyToManyJoinSQL(array $manyToMany)
  1400.     {
  1401.         $conditions       = [];
  1402.         $association      = $manyToMany;
  1403.         $sourceTableAlias = $this->getSQLTableAlias($this->class->name);
  1405.         if (! $manyToMany['isOwningSide']) {
  1406.             $targetEntity = $this->em->getClassMetadata($manyToMany['targetEntity']);
  1407.             $association  = $targetEntity->associationMappings[$manyToMany['mappedBy']];
  1408.         }
  1410.         $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  1411.         $joinColumns   = $manyToMany['isOwningSide']
  1412.             ? $association['joinTable']['inverseJoinColumns']
  1413.             : $association['joinTable']['joinColumns'];
  1415.         foreach ($joinColumns as $joinColumn) {
  1416.             $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1417.             $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1418.             $conditions[]       = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableName . '.' . $quotedSourceColumn;
  1419.         }
  1421.         return ' INNER JOIN ' . $joinTableName . ' ON ' . implode(' AND ', $conditions);
  1422.     }
  1424.     /**
  1425.      * {@inheritDoc}
  1426.      */
  1427.     public function getInsertSQL()
  1428.     {
  1429.         if ($this->insertSql !== null) {
  1430.             return $this->insertSql;
  1431.         }
  1433.         $columns   = $this->getInsertColumnList();
  1434.         $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1436.         if (empty($columns)) {
  1437.             $identityColumn  = $this->quoteStrategy->getColumnName($this->class->identifier[0], $this->class, $this->platform);
  1438.             $this->insertSql = $this->platform->getEmptyIdentityInsertSQL($tableName, $identityColumn);
  1440.             return $this->insertSql;
  1441.         }
  1443.         $values  = [];
  1444.         $columns = array_unique($columns);
  1446.         foreach ($columns as $column) {
  1447.             $placeholder = '?';
  1449.             if (
  1450.                 isset($this->class->fieldNames[$column])
  1451.                 && isset($this->columnTypes[$this->class->fieldNames[$column]])
  1452.                 && isset($this->class->fieldMappings[$this->class->fieldNames[$column]]['requireSQLConversion'])
  1453.             ) {
  1454.                 $type        = Type::getType($this->columnTypes[$this->class->fieldNames[$column]]);
  1455.                 $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  1456.             }
  1458.             $values[] = $placeholder;
  1459.         }
  1461.         $columns = implode(', ', $columns);
  1462.         $values  = implode(', ', $values);
  1464.         $this->insertSql = sprintf('INSERT INTO %s (%s) VALUES (%s)', $tableName, $columns, $values);
  1466.         return $this->insertSql;
  1467.     }
  1469.     /**
  1470.      * Gets the list of columns to put in the INSERT SQL statement.
  1471.      *
  1472.      * Subclasses should override this method to alter or change the list of
  1473.      * columns placed in the INSERT statements used by the persister.
  1474.      *
  1475.      * @return string[] The list of columns.
  1476.      * @psalm-return list<string>
  1477.      */
  1478.     protected function getInsertColumnList()
  1479.     {
  1480.         $columns = [];
  1482.         foreach ($this->class->reflFields as $name => $field) {
  1483.             if ($this->class->isVersioned && $this->class->versionField === $name) {
  1484.                 continue;
  1485.             }
  1487.             if (isset($this->class->embeddedClasses[$name])) {
  1488.                 continue;
  1489.             }
  1491.             if (isset($this->class->associationMappings[$name])) {
  1492.                 $assoc = $this->class->associationMappings[$name];
  1494.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  1495.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  1496.                         $columns[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1497.                     }
  1498.                 }
  1500.                 continue;
  1501.             }
  1503.             if (! $this->class->isIdGeneratorIdentity() || $this->class->identifier[0] !== $name) {
  1504.                 if (isset($this->class->fieldMappings[$name]['notInsertable'])) {
  1505.                     continue;
  1506.                 }
  1508.                 $columns[]                = $this->quoteStrategy->getColumnName($name, $this->class, $this->platform);
  1509.                 $this->columnTypes[$name] = $this->class->fieldMappings[$name]['type'];
  1510.             }
  1511.         }
  1513.         return $columns;
  1514.     }
  1516.     /**
  1517.      * Gets the SQL snippet of a qualified column name for the given field name.
  1518.      *
  1519.      * @param string        $field The field name.
  1520.      * @param ClassMetadata $class The class that declares this field. The table this class is
  1521.      *                             mapped to must own the column for the given field.
  1522.      * @param string        $alias
  1523.      *
  1524.      * @return string
  1525.      */
  1526.     protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  1527.     {
  1528.         $root         = $alias === 'r' ? '' : $alias;
  1529.         $tableAlias   = $this->getSQLTableAlias($class->name, $root);
  1530.         $fieldMapping = $class->fieldMappings[$field];
  1531.         $sql          = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
  1532.         $columnAlias  = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1534.         $this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
  1535.         if (! empty($fieldMapping['enumType'])) {
  1536.             $this->currentPersisterContext->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
  1537.         }
  1539.         if (isset($fieldMapping['requireSQLConversion'])) {
  1540.             $type = Type::getType($fieldMapping['type']);
  1541.             $sql  = $type->convertToPHPValueSQL($sql, $this->platform);
  1542.         }
  1544.         return $sql . ' AS ' . $columnAlias;
  1545.     }
  1547.     /**
  1548.      * Gets the SQL table alias for the given class name.
  1549.      *
  1550.      * @param string $className
  1551.      * @param string $assocName
  1552.      *
  1553.      * @return string The SQL table alias.
  1554.      *
  1555.      * @todo Reconsider. Binding table aliases to class names is not such a good idea.
  1556.      */
  1557.     protected function getSQLTableAlias($className, $assocName = '')
  1558.     {
  1559.         if ($assocName) {
  1560.             $className .= '#' . $assocName;
  1561.         }
  1563.         if (isset($this->currentPersisterContext->sqlTableAliases[$className])) {
  1564.             return $this->currentPersisterContext->sqlTableAliases[$className];
  1565.         }
  1567.         $tableAlias = 't' . $this->currentPersisterContext->sqlAliasCounter++;
  1569.         $this->currentPersisterContext->sqlTableAliases[$className] = $tableAlias;
  1571.         return $tableAlias;
  1572.     }
  1574.     /**
  1575.      * {@inheritDoc}
  1576.      */
  1577.     public function lock(array $criteria, $lockMode)
  1578.     {
  1579.         $lockSql      = '';
  1580.         $conditionSql = $this->getSelectConditionSQL($criteria);
  1582.         switch ($lockMode) {
  1583.             case LockMode::PESSIMISTIC_READ:
  1584.                 $lockSql = $this->getReadLockSQL($this->platform);
  1586.                 break;
  1587.             case LockMode::PESSIMISTIC_WRITE:
  1588.                 $lockSql = $this->getWriteLockSQL($this->platform);
  1589.                 break;
  1590.         }
  1592.         $lock  = $this->getLockTablesSql($lockMode);
  1593.         $where = ($conditionSql ? ' WHERE ' . $conditionSql : '') . ' ';
  1594.         $sql   = 'SELECT 1 '
  1595.              . $lock
  1596.              . $where
  1597.              . $lockSql;
  1599.         [$params, $types] = $this->expandParameters($criteria);
  1601.         $this->conn->executeQuery($sql, $params, $types);
  1602.     }
  1604.     /**
  1605.      * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
  1606.      *
  1607.      * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
  1608.      * @psalm-param LockMode::*|null $lockMode
  1609.      *
  1610.      * @return string
  1611.      */
  1612.     protected function getLockTablesSql($lockMode)
  1613.     {
  1614.         if ($lockMode === null) {
  1615.             Deprecation::trigger(
  1616.                 'doctrine/orm',
  1617.                 'https://github.com/doctrine/orm/pull/9466',
  1618.                 'Passing null as argument to %s is deprecated, pass LockMode::NONE instead.',
  1619.                 __METHOD__
  1620.             );
  1622.             $lockMode = LockMode::NONE;
  1623.         }
  1625.         return $this->platform->appendLockHint(
  1626.             'FROM '
  1627.             . $this->quoteStrategy->getTableName($this->class, $this->platform) . ' '
  1628.             . $this->getSQLTableAlias($this->class->name),
  1629.             $lockMode
  1630.         );
  1631.     }
  1633.     /**
  1634.      * Gets the Select Where Condition from a Criteria object.
  1635.      *
  1636.      * @return string
  1637.      */
  1638.     protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  1639.     {
  1640.         $expression = $criteria->getWhereExpression();
  1642.         if ($expression === null) {
  1643.             return '';
  1644.         }
  1646.         $visitor = new SqlExpressionVisitor($this, $this->class);
  1648.         return $visitor->dispatch($expression);
  1649.     }
  1651.     /**
  1652.      * {@inheritDoc}
  1653.      */
  1654.     public function getSelectConditionStatementSQL($field, $value, $assoc = null, $comparison = null)
  1655.     {
  1656.         $selectedColumns = [];
  1657.         $columns         = $this->getSelectConditionStatementColumnSQL($field, $assoc);
  1659.         if (count($columns) > 1 && $comparison === Comparison::IN) {
  1660.             /*
  1661.              *  @todo try to support multi-column IN expressions.
  1662.              *  Example: (col1, col2) IN (('val1A', 'val2A'), ('val1B', 'val2B'))
  1663.              */
  1664.             throw CantUseInOperatorOnCompositeKeys::create();
  1665.         }
  1667.         foreach ($columns as $column) {
  1668.             $placeholder = '?';
  1670.             if (isset($this->class->fieldMappings[$field]['requireSQLConversion'])) {
  1671.                 $type        = Type::getType($this->class->fieldMappings[$field]['type']);
  1672.                 $placeholder = $type->convertToDatabaseValueSQL($placeholder, $this->platform);
  1673.             }
  1675.             if ($comparison !== null) {
  1676.                 // special case null value handling
  1677.                 if (($comparison === Comparison::EQ || $comparison === Comparison::IS) && $value === null) {
  1678.                     $selectedColumns[] = $column . ' IS NULL';
  1680.                     continue;
  1681.                 }
  1683.                 if ($comparison === Comparison::NEQ && $value === null) {
  1684.                     $selectedColumns[] = $column . ' IS NOT NULL';
  1686.                     continue;
  1687.                 }
  1689.                 $selectedColumns[] = $column . ' ' . sprintf(self::$comparisonMap[$comparison], $placeholder);
  1691.                 continue;
  1692.             }
  1694.             if (is_array($value)) {
  1695.                 $in = sprintf('%s IN (%s)', $column, $placeholder);
  1697.                 if (array_search(null, $value, true) !== false) {
  1698.                     $selectedColumns[] = sprintf('(%s OR %s IS NULL)', $in, $column);
  1700.                     continue;
  1701.                 }
  1703.                 $selectedColumns[] = $in;
  1705.                 continue;
  1706.             }
  1708.             if ($value === null) {
  1709.                 $selectedColumns[] = sprintf('%s IS NULL', $column);
  1711.                 continue;
  1712.             }
  1714.             $selectedColumns[] = sprintf('%s = %s', $column, $placeholder);
  1715.         }
  1717.         return implode(' AND ', $selectedColumns);
  1718.     }
  1720.     /**
  1721.      * Builds the left-hand-side of a where condition statement.
  1722.      *
  1723.      * @psalm-param AssociationMapping|null $assoc
  1724.      *
  1725.      * @return string[]
  1726.      * @psalm-return list<string>
  1727.      *
  1728.      * @throws InvalidFindByCall
  1729.      * @throws UnrecognizedField
  1730.      */
  1731.     private function getSelectConditionStatementColumnSQL(
  1732.         string $field,
  1733.         ?array $assoc = null
  1734.     ): array {
  1735.         if (isset($this->class->fieldMappings[$field])) {
  1736.             $className = $this->class->fieldMappings[$field]['inherited'] ?? $this->class->name;
  1738.             return [$this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getColumnName($field, $this->class, $this->platform)];
  1739.         }
  1741.         if (isset($this->class->associationMappings[$field])) {
  1742.             $association = $this->class->associationMappings[$field];
  1743.             // Many-To-Many requires join table check for joinColumn
  1744.             $columns = [];
  1745.             $class   = $this->class;
  1747.             if ($association['type'] === ClassMetadata::MANY_TO_MANY) {
  1748.                 if (! $association['isOwningSide']) {
  1749.                     $association = $assoc;
  1750.                 }
  1752.                 $joinTableName = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1753.                 $joinColumns   = $assoc['isOwningSide']
  1754.                     ? $association['joinTable']['joinColumns']
  1755.                     : $association['joinTable']['inverseJoinColumns'];
  1757.                 foreach ($joinColumns as $joinColumn) {
  1758.                     $columns[] = $joinTableName . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1759.                 }
  1760.             } else {
  1761.                 if (! $association['isOwningSide']) {
  1762.                     throw InvalidFindByCall::fromInverseSideUsage(
  1763.                         $this->class->name,
  1764.                         $field
  1765.                     );
  1766.                 }
  1768.                 $className = $association['inherited'] ?? $this->class->name;
  1770.                 foreach ($association['joinColumns'] as $joinColumn) {
  1771.                     $columns[] = $this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1772.                 }
  1773.             }
  1775.             return $columns;
  1776.         }
  1778.         if ($assoc !== null && ! str_contains($field, ' ') && ! str_contains($field, '(')) {
  1779.             // very careless developers could potentially open up this normally hidden api for userland attacks,
  1780.             // therefore checking for spaces and function calls which are not allowed.
  1782.             // found a join column condition, not really a "field"
  1783.             return [$field];
  1784.         }
  1786.         throw UnrecognizedField::byFullyQualifiedName($this->class->name, $field);
  1787.     }
  1789.     /**
  1790.      * Gets the conditional SQL fragment used in the WHERE clause when selecting
  1791.      * entities in this persister.
  1792.      *
  1793.      * Subclasses are supposed to override this method if they intend to change
  1794.      * or alter the criteria by which entities are selected.
  1795.      *
  1796.      * @param AssociationMapping|null $assoc
  1797.      * @psalm-param array<string, mixed> $criteria
  1798.      * @psalm-param array<string, mixed>|null $assoc
  1799.      *
  1800.      * @return string
  1801.      */
  1802.     protected function getSelectConditionSQL(array $criteria, $assoc = null)
  1803.     {
  1804.         $conditions = [];
  1806.         foreach ($criteria as $field => $value) {
  1807.             $conditions[] = $this->getSelectConditionStatementSQL($field, $value, $assoc);
  1808.         }
  1810.         return implode(' AND ', $conditions);
  1811.     }
  1813.     /**
  1814.      * {@inheritDoc}
  1815.      */
  1816.     public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1817.     {
  1818.         $this->switchPersisterContext($offset, $limit);
  1820.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity, $offset, $limit);
  1822.         return $this->loadArrayFromResult($assoc, $stmt);
  1823.     }
  1825.     /**
  1826.      * {@inheritDoc}
  1827.      */
  1828.     public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1829.     {
  1830.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity);
  1832.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1833.     }
  1835.     /**
  1836.      * Builds criteria and execute SQL statement to fetch the one to many entities from.
  1837.      *
  1838.      * @param object $sourceEntity
  1839.      * @psalm-param AssociationMapping $assoc
  1840.      */
  1841.     private function getOneToManyStatement(
  1842.         array $assoc,
  1843.         $sourceEntity,
  1844.         ?int $offset = null,
  1845.         ?int $limit = null
  1846.     ): Result {
  1847.         $this->switchPersisterContext($offset, $limit);
  1849.         $criteria    = [];
  1850.         $parameters  = [];
  1851.         $owningAssoc = $this->class->associationMappings[$assoc['mappedBy']];
  1852.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1853.         $tableAlias  = $this->getSQLTableAlias($owningAssoc['inherited'] ?? $this->class->name);
  1855.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  1856.             if ($sourceClass->containsForeignIdentifier) {
  1857.                 $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1858.                 $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1860.                 if (isset($sourceClass->associationMappings[$field])) {
  1861.                     $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1862.                     $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1863.                 }
  1865.                 $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1866.                 $parameters[]                                   = [
  1867.                     'value' => $value,
  1868.                     'field' => $field,
  1869.                     'class' => $sourceClass,
  1870.                 ];
  1872.                 continue;
  1873.             }
  1875.             $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1876.             $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1878.             $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1879.             $parameters[]                                   = [
  1880.                 'value' => $value,
  1881.                 'field' => $field,
  1882.                 'class' => $sourceClass,
  1883.             ];
  1884.         }
  1886.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1887.         [$params, $types] = $this->expandToManyParameters($parameters);
  1889.         return $this->conn->executeQuery($sql, $params, $types);
  1890.     }
  1892.     /**
  1893.      * {@inheritDoc}
  1894.      */
  1895.     public function expandParameters($criteria)
  1896.     {
  1897.         $params = [];
  1898.         $types  = [];
  1900.         foreach ($criteria as $field => $value) {
  1901.             if ($value === null) {
  1902.                 continue; // skip null values.
  1903.             }
  1905.             $types  = array_merge($types, $this->getTypes($field, $value, $this->class));
  1906.             $params = array_merge($params, $this->getValues($value));
  1907.         }
  1909.         return [$params, $types];
  1910.     }
  1912.     /**
  1913.      * Expands the parameters from the given criteria and use the correct binding types if found,
  1914.      * specialized for OneToMany or ManyToMany associations.
  1915.      *
  1916.      * @param mixed[][] $criteria an array of arrays containing following:
  1917.      *                             - field to which each criterion will be bound
  1918.      *                             - value to be bound
  1919.      *                             - class to which the field belongs to
  1920.      *
  1921.      * @return mixed[][]
  1922.      * @psalm-return array{0: array, 1: list<int|string|null>}
  1923.      */
  1924.     private function expandToManyParameters(array $criteria): array
  1925.     {
  1926.         $params = [];
  1927.         $types  = [];
  1929.         foreach ($criteria as $criterion) {
  1930.             if ($criterion['value'] === null) {
  1931.                 continue; // skip null values.
  1932.             }
  1934.             $types  = array_merge($types, $this->getTypes($criterion['field'], $criterion['value'], $criterion['class']));
  1935.             $params = array_merge($params, $this->getValues($criterion['value']));
  1936.         }
  1938.         return [$params, $types];
  1939.     }
  1941.     /**
  1942.      * Infers field types to be used by parameter type casting.
  1943.      *
  1944.      * @param mixed $value
  1945.      *
  1946.      * @return int[]|null[]|string[]
  1947.      * @psalm-return list<int|string|null>
  1948.      *
  1949.      * @throws QueryException
  1950.      */
  1951.     private function getTypes(string $field, $value, ClassMetadata $class): array
  1952.     {
  1953.         $types = [];
  1955.         switch (true) {
  1956.             case isset($class->fieldMappings[$field]):
  1957.                 $types = array_merge($types, [$class->fieldMappings[$field]['type']]);
  1958.                 break;
  1960.             case isset($class->associationMappings[$field]):
  1961.                 $assoc = $class->associationMappings[$field];
  1962.                 $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1964.                 if (! $assoc['isOwningSide']) {
  1965.                     $assoc = $class->associationMappings[$assoc['mappedBy']];
  1966.                     $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1967.                 }
  1969.                 $columns = $assoc['type'] === ClassMetadata::MANY_TO_MANY
  1970.                     ? $assoc['relationToTargetKeyColumns']
  1971.                     : $assoc['sourceToTargetKeyColumns'];
  1973.                 foreach ($columns as $column) {
  1974.                     $types[] = PersisterHelper::getTypeOfColumn($column, $class, $this->em);
  1975.                 }
  1977.                 break;
  1979.             default:
  1980.                 $types[] = null;
  1981.                 break;
  1982.         }
  1984.         if (is_array($value)) {
  1985.             return array_map(static function ($type) {
  1986.                 $type = Type::getType($type);
  1988.                 return $type->getBindingType() + Connection::ARRAY_PARAM_OFFSET;
  1989.             }, $types);
  1990.         }
  1992.         return $types;
  1993.     }
  1995.     /**
  1996.      * Retrieves the parameters that identifies a value.
  1997.      *
  1998.      * @param mixed $value
  1999.      *
  2000.      * @return mixed[]
  2001.      */
  2002.     private function getValues($value): array
  2003.     {
  2004.         if (is_array($value)) {
  2005.             $newValue = [];
  2007.             foreach ($value as $itemValue) {
  2008.                 $newValue = array_merge($newValue, $this->getValues($itemValue));
  2009.             }
  2011.             return [$newValue];
  2012.         }
  2014.         return $this->getIndividualValue($value);
  2015.     }
  2017.     /**
  2018.      * Retrieves an individual parameter value.
  2019.      *
  2020.      * @param mixed $value
  2021.      *
  2022.      * @psalm-return list<mixed>
  2023.      */
  2024.     private function getIndividualValue($value): array
  2025.     {
  2026.         if (! is_object($value)) {
  2027.             return [$value];
  2028.         }
  2030.         if ($value instanceof BackedEnum) {
  2031.             return [$value->value];
  2032.         }
  2034.         $valueClass = DefaultProxyClassNameResolver::getClass($value);
  2036.         if ($this->em->getMetadataFactory()->isTransient($valueClass)) {
  2037.             return [$value];
  2038.         }
  2040.         $class = $this->em->getClassMetadata($valueClass);
  2042.         if ($class->isIdentifierComposite) {
  2043.             $newValue = [];
  2045.             foreach ($class->getIdentifierValues($value) as $innerValue) {
  2046.                 $newValue = array_merge($newValue, $this->getValues($innerValue));
  2047.             }
  2049.             return $newValue;
  2050.         }
  2052.         return [$this->em->getUnitOfWork()->getSingleIdentifierValue($value)];
  2053.     }
  2055.     /**
  2056.      * {@inheritDoc}
  2057.      */
  2058.     public function exists($entity, ?Criteria $extraConditions = null)
  2059.     {
  2060.         $criteria = $this->class->getIdentifierValues($entity);
  2062.         if (! $criteria) {
  2063.             return false;
  2064.         }
  2066.         $alias = $this->getSQLTableAlias($this->class->name);
  2068.         $sql = 'SELECT 1 '
  2069.              . $this->getLockTablesSql(LockMode::NONE)
  2070.              . ' WHERE ' . $this->getSelectConditionSQL($criteria);
  2072.         [$params, $types] = $this->expandParameters($criteria);
  2074.         if ($extraConditions !== null) {
  2075.             $sql                             .= ' AND ' . $this->getSelectConditionCriteriaSQL($extraConditions);
  2076.             [$criteriaParams, $criteriaTypes] = $this->expandCriteriaParameters($extraConditions);
  2078.             $params = array_merge($params, $criteriaParams);
  2079.             $types  = array_merge($types, $criteriaTypes);
  2080.         }
  2082.         $filterSql = $this->generateFilterConditionSQL($this->class, $alias);
  2083.         if ($filterSql) {
  2084.             $sql .= ' AND ' . $filterSql;
  2085.         }
  2087.         return (bool) $this->conn->fetchOne($sql, $params, $types);
  2088.     }
  2090.     /**
  2091.      * Generates the appropriate join SQL for the given join column.
  2092.      *
  2093.      * @param array[] $joinColumns The join columns definition of an association.
  2094.      * @psalm-param array<array<string, mixed>> $joinColumns
  2095.      *
  2096.      * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise.
  2097.      */
  2098.     protected function getJoinSQLForJoinColumns($joinColumns)
  2099.     {
  2100.         // if one of the join columns is nullable, return left join
  2101.         foreach ($joinColumns as $joinColumn) {
  2102.             if (! isset($joinColumn['nullable']) || $joinColumn['nullable']) {
  2103.                 return 'LEFT JOIN';
  2104.             }
  2105.         }
  2107.         return 'INNER JOIN';
  2108.     }
  2110.     /**
  2111.      * @param string $columnName
  2112.      *
  2113.      * @return string
  2114.      */
  2115.     public function getSQLColumnAlias($columnName)
  2116.     {
  2117.         return $this->quoteStrategy->getColumnAlias($columnName, $this->currentPersisterContext->sqlAliasCounter++, $this->platform);
  2118.     }
  2120.     /**
  2121.      * Generates the filter SQL for a given entity and table alias.
  2122.      *
  2123.      * @param ClassMetadata $targetEntity     Metadata of the target entity.
  2124.      * @param string        $targetTableAlias The table alias of the joined/selected table.
  2125.      *
  2126.      * @return string The SQL query part to add to a query.
  2127.      */
  2128.     protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  2129.     {
  2130.         $filterClauses = [];
  2132.         foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  2133.             $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
  2134.             if ($filterExpr !== '') {
  2135.                 $filterClauses[] = '(' . $filterExpr . ')';
  2136.             }
  2137.         }
  2139.         $sql = implode(' AND ', $filterClauses);
  2141.         return $sql ? '(' . $sql . ')' : ''; // Wrap again to avoid "X or Y and FilterConditionSQL"
  2142.     }
  2144.     /**
  2145.      * Switches persister context according to current query offset/limits
  2146.      *
  2147.      * This is due to the fact that to-many associations cannot be fetch-joined when a limit is involved
  2148.      *
  2149.      * @param int|null $offset
  2150.      * @param int|null $limit
  2151.      *
  2152.      * @return void
  2153.      */
  2154.     protected function switchPersisterContext($offset, $limit)
  2155.     {
  2156.         if ($offset === null && $limit === null) {
  2157.             $this->currentPersisterContext = $this->noLimitsContext;
  2159.             return;
  2160.         }
  2162.         $this->currentPersisterContext = $this->limitsHandlingContext;
  2163.     }
  2165.     /**
  2166.      * @return string[]
  2167.      * @psalm-return list<string>
  2168.      */
  2169.     protected function getClassIdentifiersTypes(ClassMetadata $class): array
  2170.     {
  2171.         $entityManager = $this->em;
  2173.         return array_map(
  2174.             static function ($fieldName) use ($class, $entityManager): string {
  2175.                 $types = PersisterHelper::getTypeOfField($fieldName, $class, $entityManager);
  2176.                 assert(isset($types[0]));
  2178.                 return $types[0];
  2179.             },
  2180.             $class->identifier
  2181.         );
  2182.     }
  2183. }