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

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\Internal\CriteriaOrderings;
  19. use Doctrine\ORM\Mapping\ClassMetadata;
  20. use Doctrine\ORM\Mapping\MappingException;
  21. use Doctrine\ORM\Mapping\QuoteStrategy;
  22. use Doctrine\ORM\OptimisticLockException;
  23. use Doctrine\ORM\PersistentCollection;
  24. use Doctrine\ORM\Persisters\Exception\CantUseInOperatorOnCompositeKeys;
  25. use Doctrine\ORM\Persisters\Exception\InvalidOrientation;
  26. use Doctrine\ORM\Persisters\Exception\UnrecognizedField;
  27. use Doctrine\ORM\Persisters\SqlExpressionVisitor;
  28. use Doctrine\ORM\Persisters\SqlValueVisitor;
  29. use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
  30. use Doctrine\ORM\Query;
  31. use Doctrine\ORM\Query\QueryException;
  32. use Doctrine\ORM\Repository\Exception\InvalidFindByCall;
  33. use Doctrine\ORM\UnitOfWork;
  34. use Doctrine\ORM\Utility\IdentifierFlattener;
  35. use Doctrine\ORM\Utility\LockSqlHelper;
  36. use Doctrine\ORM\Utility\PersisterHelper;
  37. use LengthException;
  39. use function array_combine;
  40. use function array_keys;
  41. use function array_map;
  42. use function array_merge;
  43. use function array_search;
  44. use function array_unique;
  45. use function array_values;
  46. use function assert;
  47. use function count;
  48. use function implode;
  49. use function is_array;
  50. use function is_object;
  51. use function reset;
  52. use function spl_object_id;
  53. use function sprintf;
  54. use function str_contains;
  55. use function strtoupper;
  56. use function trim;
  58. /**
  59.  * A BasicEntityPersister maps an entity to a single table in a relational database.
  60.  *
  61.  * A persister is always responsible for a single entity type.
  62.  *
  63.  * EntityPersisters are used during a UnitOfWork to apply any changes to the persistent
  64.  * state of entities onto a relational database when the UnitOfWork is committed,
  65.  * as well as for basic querying of entities and their associations (not DQL).
  66.  *
  67.  * The persisting operations that are invoked during a commit of a UnitOfWork to
  68.  * persist the persistent entity state are:
  69.  *
  70.  *   - {@link addInsert} : To schedule an entity for insertion.
  71.  *   - {@link executeInserts} : To execute all scheduled insertions.
  72.  *   - {@link update} : To update the persistent state of an entity.
  73.  *   - {@link delete} : To delete the persistent state of an entity.
  74.  *
  75.  * As can be seen from the above list, insertions are batched and executed all at once
  76.  * for increased efficiency.
  77.  *
  78.  * The querying operations invoked during a UnitOfWork, either through direct find
  79.  * requests or lazy-loading, are the following:
  80.  *
  81.  *   - {@link load} : Loads (the state of) a single, managed entity.
  82.  *   - {@link loadAll} : Loads multiple, managed entities.
  83.  *   - {@link loadOneToOneEntity} : Loads a one/many-to-one entity association (lazy-loading).
  84.  *   - {@link loadOneToManyCollection} : Loads a one-to-many entity association (lazy-loading).
  85.  *   - {@link loadManyToManyCollection} : Loads a many-to-many entity association (lazy-loading).
  86.  *
  87.  * The BasicEntityPersister implementation provides the default behavior for
  88.  * persisting and querying entities that are mapped to a single database table.
  89.  *
  90.  * Subclasses can be created to provide custom persisting and querying strategies,
  91.  * i.e. spanning multiple tables.
  92.  *
  93.  * @phpstan-import-type AssociationMapping from ClassMetadata
  94.  */
  95. class BasicEntityPersister implements EntityPersister
  96. {
  97.     use CriteriaOrderings;
  98.     use LockSqlHelper;
  100.     /** @var array<string,string> */
  101.     private static $comparisonMap = [
  102.         Comparison::EQ          => '= %s',
  103.         Comparison::NEQ         => '!= %s',
  104.         Comparison::GT          => '> %s',
  105.         Comparison::GTE         => '>= %s',
  106.         Comparison::LT          => '< %s',
  107.         Comparison::LTE         => '<= %s',
  108.         Comparison::IN          => 'IN (%s)',
  109.         Comparison::NIN         => 'NOT IN (%s)',
  110.         Comparison::CONTAINS    => 'LIKE %s',
  111.         Comparison::STARTS_WITH => 'LIKE %s',
  112.         Comparison::ENDS_WITH   => 'LIKE %s',
  113.     ];
  115.     /**
  116.      * Metadata object that describes the mapping of the mapped entity class.
  117.      *
  118.      * @var ClassMetadata
  119.      */
  120.     protected $class;
  122.     /**
  123.      * The underlying DBAL Connection of the used EntityManager.
  124.      *
  125.      * @var Connection $conn
  126.      */
  127.     protected $conn;
  129.     /**
  130.      * The database platform.
  131.      *
  132.      * @var AbstractPlatform
  133.      */
  134.     protected $platform;
  136.     /**
  137.      * The EntityManager instance.
  138.      *
  139.      * @var EntityManagerInterface
  140.      */
  141.     protected $em;
  143.     /**
  144.      * Queued inserts.
  145.      *
  146.      * @phpstan-var array<int, object>
  147.      */
  148.     protected $queuedInserts = [];
  150.     /**
  151.      * The map of column names to DBAL mapping types of all prepared columns used
  152.      * when INSERTing or UPDATEing an entity.
  153.      *
  154.      * @see prepareInsertData($entity)
  155.      * @see prepareUpdateData($entity)
  156.      *
  157.      * @var mixed[]
  158.      */
  159.     protected $columnTypes = [];
  161.     /**
  162.      * The map of quoted column names.
  163.      *
  164.      * @see prepareInsertData($entity)
  165.      * @see prepareUpdateData($entity)
  166.      *
  167.      * @var mixed[]
  168.      */
  169.     protected $quotedColumns = [];
  171.     /**
  172.      * The INSERT SQL statement used for entities handled by this persister.
  173.      * This SQL is only generated once per request, if at all.
  174.      *
  175.      * @var string|null
  176.      */
  177.     private $insertSql;
  179.     /**
  180.      * The quote strategy.
  181.      *
  182.      * @var QuoteStrategy
  183.      */
  184.     protected $quoteStrategy;
  186.     /**
  187.      * The IdentifierFlattener used for manipulating identifiers
  188.      *
  189.      * @var IdentifierFlattener
  190.      */
  191.     protected $identifierFlattener;
  193.     /** @var CachedPersisterContext */
  194.     protected $currentPersisterContext;
  196.     /** @var CachedPersisterContext */
  197.     private $limitsHandlingContext;
  199.     /** @var CachedPersisterContext */
  200.     private $noLimitsContext;
  202.     /** @var ?string */
  203.     private $filterHash = null;
  205.     /**
  206.      * Initializes a new <tt>BasicEntityPersister</tt> that uses the given EntityManager
  207.      * and persists instances of the class described by the given ClassMetadata descriptor.
  208.      */
  209.     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  210.     {
  211.         $this->em                    = $em;
  212.         $this->class                 = $class;
  213.         $this->conn                  = $em->getConnection();
  214.         $this->platform              = $this->conn->getDatabasePlatform();
  215.         $this->quoteStrategy         = $em->getConfiguration()->getQuoteStrategy();
  216.         $this->identifierFlattener   = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
  217.         $this->noLimitsContext       = $this->currentPersisterContext = new CachedPersisterContext(
  218.             $class,
  219.             new Query\ResultSetMapping(),
  220.             false
  221.         );
  222.         $this->limitsHandlingContext = new CachedPersisterContext(
  223.             $class,
  224.             new Query\ResultSetMapping(),
  225.             true
  226.         );
  227.     }
  229.     /**
  230.      * {@inheritDoc}
  231.      */
  232.     public function getClassMetadata()
  233.     {
  234.         return $this->class;
  235.     }
  237.     /**
  238.      * {@inheritDoc}
  239.      */
  240.     public function getResultSetMapping()
  241.     {
  242.         return $this->currentPersisterContext->rsm;
  243.     }
  245.     /**
  246.      * {@inheritDoc}
  247.      */
  248.     public function addInsert($entity)
  249.     {
  250.         $this->queuedInserts[spl_object_id($entity)] = $entity;
  251.     }
  253.     /**
  254.      * {@inheritDoc}
  255.      */
  256.     public function getInserts()
  257.     {
  258.         return $this->queuedInserts;
  259.     }
  261.     /**
  262.      * {@inheritDoc}
  263.      */
  264.     public function executeInserts()
  265.     {
  266.         if (! $this->queuedInserts) {
  267.             return;
  268.         }
  270.         $uow            = $this->em->getUnitOfWork();
  271.         $idGenerator    = $this->class->idGenerator;
  272.         $isPostInsertId = $idGenerator->isPostInsertGenerator();
  274.         $stmt      = $this->conn->prepare($this->getInsertSQL());
  275.         $tableName = $this->class->getTableName();
  277.         foreach ($this->queuedInserts as $key => $entity) {
  278.             $insertData = $this->prepareInsertData($entity);
  280.             if (isset($insertData[$tableName])) {
  281.                 $paramIndex = 1;
  283.                 foreach ($insertData[$tableName] as $column => $value) {
  284.                     $stmt->bindValue($paramIndex++, $value, $this->columnTypes[$column]);
  285.                 }
  286.             }
  288.             $stmt->executeStatement();
  290.             if ($isPostInsertId) {
  291.                 $generatedId = $idGenerator->generateId($this->em, $entity);
  292.                 $id          = [$this->class->identifier[0] => $generatedId];
  294.                 $uow->assignPostInsertId($entity, $generatedId);
  295.             } else {
  296.                 $id = $this->class->getIdentifierValues($entity);
  297.             }
  299.             if ($this->class->requiresFetchAfterChange) {
  300.                 $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  301.             }
  303.             // Unset this queued insert, so that the prepareUpdateData() method knows right away
  304.             // (for the next entity already) that the current entity has been written to the database
  305.             // and no extra updates need to be scheduled to refer to it.
  306.             //
  307.             // In \Doctrine\ORM\UnitOfWork::executeInserts(), the UoW already removed entities
  308.             // from its own list (\Doctrine\ORM\UnitOfWork::$entityInsertions) right after they
  309.             // were given to our addInsert() method.
  310.             unset($this->queuedInserts[$key]);
  311.         }
  312.     }
  314.     /**
  315.      * Retrieves the default version value which was created
  316.      * by the preceding INSERT statement and assigns it back in to the
  317.      * entities version field if the given entity is versioned.
  318.      * Also retrieves values of columns marked as 'non insertable' and / or
  319.      * 'not updatable' and assigns them back to the entities corresponding fields.
  320.      *
  321.      * @param object  $entity
  322.      * @param mixed[] $id
  323.      *
  324.      * @return void
  325.      */
  326.     protected function assignDefaultVersionAndUpsertableValues($entity, array $id)
  327.     {
  328.         $values = $this->fetchVersionAndNotUpsertableValues($this->class, $id);
  330.         foreach ($values as $field => $value) {
  331.             $value = Type::getType($this->class->fieldMappings[$field]['type'])->convertToPHPValue($value, $this->platform);
  333.             $this->class->setFieldValue($entity, $field, $value);
  334.         }
  335.     }
  337.     /**
  338.      * Fetches the current version value of a versioned entity and / or the values of fields
  339.      * marked as 'not insertable' and / or 'not updatable'.
  340.      *
  341.      * @param ClassMetadata $versionedClass
  342.      * @param mixed[]       $id
  343.      *
  344.      * @return mixed
  345.      */
  346.     protected function fetchVersionAndNotUpsertableValues($versionedClass, array $id)
  347.     {
  348.         $columnNames = [];
  349.         foreach ($this->class->fieldMappings as $key => $column) {
  350.             if (isset($column['generated']) || ($this->class->isVersioned && $key === $versionedClass->versionField)) {
  351.                 $columnNames[$key] = $this->quoteStrategy->getColumnName($key, $versionedClass, $this->platform);
  352.             }
  353.         }
  355.         $tableName  = $this->quoteStrategy->getTableName($versionedClass, $this->platform);
  356.         $identifier = $this->quoteStrategy->getIdentifierColumnNames($versionedClass, $this->platform);
  358.         // FIXME: Order with composite keys might not be correct
  359.         $sql = 'SELECT ' . implode(', ', $columnNames)
  360.             . ' FROM ' . $tableName
  361.             . ' WHERE ' . implode(' = ? AND ', $identifier) . ' = ?';
  363.         $flatId = $this->identifierFlattener->flattenIdentifier($versionedClass, $id);
  365.         $values = $this->conn->fetchNumeric(
  366.             $sql,
  367.             array_values($flatId),
  368.             $this->extractIdentifierTypes($id, $versionedClass)
  369.         );
  371.         if ($values === false) {
  372.             throw new LengthException('Unexpected empty result for database query.');
  373.         }
  375.         $values = array_combine(array_keys($columnNames), $values);
  377.         if (! $values) {
  378.             throw new LengthException('Unexpected number of database columns.');
  379.         }
  381.         return $values;
  382.     }
  384.     /**
  385.      * @param mixed[] $id
  386.      *
  387.      * @return int[]|null[]|string[]
  388.      * @phpstan-return list<int|string|null>
  389.      */
  390.     final protected function extractIdentifierTypes(array $id, ClassMetadata $versionedClass): array
  391.     {
  392.         $types = [];
  394.         foreach ($id as $field => $value) {
  395.             $types = array_merge($types, $this->getTypes($field, $value, $versionedClass));
  396.         }
  398.         return $types;
  399.     }
  401.     /**
  402.      * {@inheritDoc}
  403.      */
  404.     public function update($entity)
  405.     {
  406.         $tableName  = $this->class->getTableName();
  407.         $updateData = $this->prepareUpdateData($entity);
  409.         if (! isset($updateData[$tableName])) {
  410.             return;
  411.         }
  413.         $data = $updateData[$tableName];
  415.         if (! $data) {
  416.             return;
  417.         }
  419.         $isVersioned     = $this->class->isVersioned;
  420.         $quotedTableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  422.         $this->updateTable($entity, $quotedTableName, $data, $isVersioned);
  424.         if ($this->class->requiresFetchAfterChange) {
  425.             $id = $this->class->getIdentifierValues($entity);
  427.             $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  428.         }
  429.     }
  431.     /**
  432.      * Performs an UPDATE statement for an entity on a specific table.
  433.      * The UPDATE can optionally be versioned, which requires the entity to have a version field.
  434.      *
  435.      * @param object  $entity          The entity object being updated.
  436.      * @param string  $quotedTableName The quoted name of the table to apply the UPDATE on.
  437.      * @param mixed[] $updateData      The map of columns to update (column => value).
  438.      * @param bool    $versioned       Whether the UPDATE should be versioned.
  439.      *
  440.      * @throws UnrecognizedField
  441.      * @throws OptimisticLockException
  442.      */
  443.     final protected function updateTable(
  444.         $entity,
  445.         $quotedTableName,
  446.         array $updateData,
  447.         $versioned = false
  448.     ): void {
  449.         $set    = [];
  450.         $types  = [];
  451.         $params = [];
  453.         foreach ($updateData as $columnName => $value) {
  454.             $placeholder = '?';
  455.             $column      = $columnName;
  457.             switch (true) {
  458.                 case isset($this->class->fieldNames[$columnName]):
  459.                     $fieldName = $this->class->fieldNames[$columnName];
  460.                     $column    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  462.                     if (isset($this->class->fieldMappings[$fieldName]['requireSQLConversion'])) {
  463.                         $type        = Type::getType($this->columnTypes[$columnName]);
  464.                         $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  465.                     }
  467.                     break;
  469.                 case isset($this->quotedColumns[$columnName]):
  470.                     $column = $this->quotedColumns[$columnName];
  472.                     break;
  473.             }
  475.             $params[] = $value;
  476.             $set[]    = $column . ' = ' . $placeholder;
  477.             $types[]  = $this->columnTypes[$columnName];
  478.         }
  480.         $where      = [];
  481.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  483.         foreach ($this->class->identifier as $idField) {
  484.             if (! isset($this->class->associationMappings[$idField])) {
  485.                 $params[] = $identifier[$idField];
  486.                 $types[]  = $this->class->fieldMappings[$idField]['type'];
  487.                 $where[]  = $this->quoteStrategy->getColumnName($idField, $this->class, $this->platform);
  489.                 continue;
  490.             }
  492.             $params[] = $identifier[$idField];
  493.             $where[]  = $this->quoteStrategy->getJoinColumnName(
  494.                 $this->class->associationMappings[$idField]['joinColumns'][0],
  495.                 $this->class,
  496.                 $this->platform
  497.             );
  499.             $targetMapping = $this->em->getClassMetadata($this->class->associationMappings[$idField]['targetEntity']);
  500.             $targetType    = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
  502.             if ($targetType === []) {
  503.                 throw UnrecognizedField::byFullyQualifiedName($this->class->name, $targetMapping->identifier[0]);
  504.             }
  506.             $types[] = reset($targetType);
  507.         }
  509.         if ($versioned) {
  510.             $versionField = $this->class->versionField;
  511.             assert($versionField !== null);
  512.             $versionFieldType = $this->class->fieldMappings[$versionField]['type'];
  513.             $versionColumn    = $this->quoteStrategy->getColumnName($versionField, $this->class, $this->platform);
  515.             $where[]  = $versionColumn;
  516.             $types[]  = $this->class->fieldMappings[$versionField]['type'];
  517.             $params[] = $this->class->reflFields[$versionField]->getValue($entity);
  519.             switch ($versionFieldType) {
  520.                 case Types::SMALLINT:
  521.                 case Types::INTEGER:
  522.                 case Types::BIGINT:
  523.                     $set[] = $versionColumn . ' = ' . $versionColumn . ' + 1';
  524.                     break;
  526.                 case Types::DATETIME_MUTABLE:
  527.                     $set[] = $versionColumn . ' = CURRENT_TIMESTAMP';
  528.                     break;
  529.             }
  530.         }
  532.         $sql = 'UPDATE ' . $quotedTableName
  533.              . ' SET ' . implode(', ', $set)
  534.              . ' WHERE ' . implode(' = ? AND ', $where) . ' = ?';
  536.         $result = $this->conn->executeStatement($sql, $params, $types);
  538.         if ($versioned && ! $result) {
  539.             throw OptimisticLockException::lockFailed($entity);
  540.         }
  541.     }
  543.     /**
  544.      * @param array<mixed> $identifier
  545.      * @param string[]     $types
  546.      *
  547.      * @todo Add check for platform if it supports foreign keys/cascading.
  548.      */
  549.     protected function deleteJoinTableRecords(array $identifier, array $types): void
  550.     {
  551.         foreach ($this->class->associationMappings as $mapping) {
  552.             if ($mapping['type'] !== ClassMetadata::MANY_TO_MANY || isset($mapping['isOnDeleteCascade'])) {
  553.                 continue;
  554.             }
  556.             // @Todo this only covers scenarios with no inheritance or of the same level. Is there something
  557.             // like self-referential relationship between different levels of an inheritance hierarchy? I hope not!
  558.             $selfReferential = ($mapping['targetEntity'] === $mapping['sourceEntity']);
  559.             $class           = $this->class;
  560.             $association     = $mapping;
  561.             $otherColumns    = [];
  562.             $otherKeys       = [];
  563.             $keys            = [];
  565.             if (! $mapping['isOwningSide']) {
  566.                 $class       = $this->em->getClassMetadata($mapping['targetEntity']);
  567.                 $association = $class->associationMappings[$mapping['mappedBy']];
  568.             }
  570.             $joinColumns = $mapping['isOwningSide']
  571.                 ? $association['joinTable']['joinColumns']
  572.                 : $association['joinTable']['inverseJoinColumns'];
  574.             if ($selfReferential) {
  575.                 $otherColumns = ! $mapping['isOwningSide']
  576.                     ? $association['joinTable']['joinColumns']
  577.                     : $association['joinTable']['inverseJoinColumns'];
  578.             }
  580.             foreach ($joinColumns as $joinColumn) {
  581.                 $keys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  582.             }
  584.             foreach ($otherColumns as $joinColumn) {
  585.                 $otherKeys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  586.             }
  588.             $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  590.             $this->conn->delete($joinTableName, array_combine($keys, $identifier), $types);
  592.             if ($selfReferential) {
  593.                 $this->conn->delete($joinTableName, array_combine($otherKeys, $identifier), $types);
  594.             }
  595.         }
  596.     }
  598.     /**
  599.      * {@inheritDoc}
  600.      */
  601.     public function delete($entity)
  602.     {
  603.         $class      = $this->class;
  604.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  605.         $tableName  = $this->quoteStrategy->getTableName($class, $this->platform);
  606.         $idColumns  = $this->quoteStrategy->getIdentifierColumnNames($class, $this->platform);
  607.         $id         = array_combine($idColumns, $identifier);
  608.         $types      = $this->getClassIdentifiersTypes($class);
  610.         $this->deleteJoinTableRecords($identifier, $types);
  612.         return (bool) $this->conn->delete($tableName, $id, $types);
  613.     }
  615.     /**
  616.      * Prepares the changeset of an entity for database insertion (UPDATE).
  617.      *
  618.      * The changeset is obtained from the currently running UnitOfWork.
  619.      *
  620.      * During this preparation the array that is passed as the second parameter is filled with
  621.      * <columnName> => <value> pairs, grouped by table name.
  622.      *
  623.      * Example:
  624.      * <code>
  625.      * array(
  626.      *    'foo_table' => array('column1' => 'value1', 'column2' => 'value2', ...),
  627.      *    'bar_table' => array('columnX' => 'valueX', 'columnY' => 'valueY', ...),
  628.      *    ...
  629.      * )
  630.      * </code>
  631.      *
  632.      * @param object $entity   The entity for which to prepare the data.
  633.      * @param bool   $isInsert Whether the data to be prepared refers to an insert statement.
  634.      *
  635.      * @return mixed[][] The prepared data.
  636.      * @phpstan-return array<string, array<array-key, mixed|null>>
  637.      */
  638.     protected function prepareUpdateData($entity, bool $isInsert = false)
  639.     {
  640.         $versionField = null;
  641.         $result       = [];
  642.         $uow          = $this->em->getUnitOfWork();
  644.         $versioned = $this->class->isVersioned;
  645.         if ($versioned !== false) {
  646.             $versionField = $this->class->versionField;
  647.         }
  649.         foreach ($uow->getEntityChangeSet($entity) as $field => $change) {
  650.             if (isset($versionField) && $versionField === $field) {
  651.                 continue;
  652.             }
  654.             if (isset($this->class->embeddedClasses[$field])) {
  655.                 continue;
  656.             }
  658.             $newVal = $change[1];
  660.             if (! isset($this->class->associationMappings[$field])) {
  661.                 $fieldMapping = $this->class->fieldMappings[$field];
  662.                 $columnName   = $fieldMapping['columnName'];
  664.                 if (! $isInsert && isset($fieldMapping['notUpdatable'])) {
  665.                     continue;
  666.                 }
  668.                 if ($isInsert && isset($fieldMapping['notInsertable'])) {
  669.                     continue;
  670.                 }
  672.                 $this->columnTypes[$columnName] = $fieldMapping['type'];
  674.                 $result[$this->getOwningTable($field)][$columnName] = $newVal;
  676.                 continue;
  677.             }
  679.             $assoc = $this->class->associationMappings[$field];
  681.             // Only owning side of x-1 associations can have a FK column.
  682.             if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
  683.                 continue;
  684.             }
  686.             if ($newVal !== null) {
  687.                 $oid = spl_object_id($newVal);
  689.                 // If the associated entity $newVal is not yet persisted and/or does not yet have
  690.                 // an ID assigned, we must set $newVal = null. This will insert a null value and
  691.                 // schedule an extra update on the UnitOfWork.
  692.                 //
  693.                 // This gives us extra time to a) possibly obtain a database-generated identifier
  694.                 // value for $newVal, and b) insert $newVal into the database before the foreign
  695.                 // key reference is being made.
  696.                 //
  697.                 // When looking at $this->queuedInserts and $uow->isScheduledForInsert, be aware
  698.                 // of the implementation details that our own executeInserts() method will remove
  699.                 // entities from the former as soon as the insert statement has been executed and
  700.                 // a post-insert ID has been assigned (if necessary), and that the UnitOfWork has
  701.                 // already removed entities from its own list at the time they were passed to our
  702.                 // addInsert() method.
  703.                 //
  704.                 // Then, there is one extra exception we can make: An entity that references back to itself
  705.                 // _and_ uses an application-provided ID (the "NONE" generator strategy) also does not
  706.                 // need the extra update, although it is still in the list of insertions itself.
  707.                 // This looks like a minor optimization at first, but is the capstone for being able to
  708.                 // use non-NULLable, self-referencing associations in applications that provide IDs (like UUIDs).
  709.                 if (
  710.                     (isset($this->queuedInserts[$oid]) || $uow->isScheduledForInsert($newVal))
  711.                     && ! ($newVal === $entity && $this->class->isIdentifierNatural())
  712.                 ) {
  713.                     $uow->scheduleExtraUpdate($entity, [$field => [null, $newVal]]);
  715.                     $newVal = null;
  716.                 }
  717.             }
  719.             $newValId = null;
  721.             if ($newVal !== null) {
  722.                 $newValId = $uow->getEntityIdentifier($newVal);
  723.             }
  725.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  726.             $owningTable = $this->getOwningTable($field);
  728.             foreach ($assoc['joinColumns'] as $joinColumn) {
  729.                 $sourceColumn = $joinColumn['name'];
  730.                 $targetColumn = $joinColumn['referencedColumnName'];
  731.                 $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  733.                 $this->quotedColumns[$sourceColumn]  = $quotedColumn;
  734.                 $this->columnTypes[$sourceColumn]    = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $this->em);
  735.                 $result[$owningTable][$sourceColumn] = $newValId
  736.                     ? $newValId[$targetClass->getFieldForColumn($targetColumn)]
  737.                     : null;
  738.             }
  739.         }
  741.         return $result;
  742.     }
  744.     /**
  745.      * Prepares the data changeset of a managed entity for database insertion (initial INSERT).
  746.      * The changeset of the entity is obtained from the currently running UnitOfWork.
  747.      *
  748.      * The default insert data preparation is the same as for updates.
  749.      *
  750.      * @see prepareUpdateData
  751.      *
  752.      * @param object $entity The entity for which to prepare the data.
  753.      *
  754.      * @return mixed[][] The prepared data for the tables to update.
  755.      * @phpstan-return array<string, mixed[]>
  756.      */
  757.     protected function prepareInsertData($entity)
  758.     {
  759.         return $this->prepareUpdateData($entity, true);
  760.     }
  762.     /**
  763.      * {@inheritDoc}
  764.      */
  765.     public function getOwningTable($fieldName)
  766.     {
  767.         return $this->class->getTableName();
  768.     }
  770.     /**
  771.      * {@inheritDoc}
  772.      */
  773.     public function load(array $criteria, $entity = null, $assoc = null, array $hints = [], $lockMode = null, $limit = null, ?array $orderBy = null)
  774.     {
  775.         $this->switchPersisterContext(null, $limit);
  777.         $sql              = $this->getSelectSQL($criteria, $assoc, $lockMode, $limit, null, $orderBy);
  778.         [$params, $types] = $this->expandParameters($criteria);
  779.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  781.         if ($entity !== null) {
  782.             $hints[Query::HINT_REFRESH]        = true;
  783.             $hints[Query::HINT_REFRESH_ENTITY] = $entity;
  784.         }
  786.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  787.         $entities = $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, $hints);
  789.         return $entities ? $entities[0] : null;
  790.     }
  792.     /**
  793.      * {@inheritDoc}
  794.      */
  795.     public function loadById(array $identifier, $entity = null)
  796.     {
  797.         return $this->load($identifier, $entity);
  798.     }
  800.     /**
  801.      * {@inheritDoc}
  802.      */
  803.     public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = [])
  804.     {
  805.         $foundEntity = $this->em->getUnitOfWork()->tryGetById($identifier, $assoc['targetEntity']);
  806.         if ($foundEntity !== false) {
  807.             return $foundEntity;
  808.         }
  810.         $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  812.         if ($assoc['isOwningSide']) {
  813.             $isInverseSingleValued = $assoc['inversedBy'] && ! $targetClass->isCollectionValuedAssociation($assoc['inversedBy']);
  815.             // Mark inverse side as fetched in the hints, otherwise the UoW would
  816.             // try to load it in a separate query (remember: to-one inverse sides can not be lazy).
  817.             $hints = [];
  819.             if ($isInverseSingleValued) {
  820.                 $hints['fetched']['r'][$assoc['inversedBy']] = true;
  821.             }
  823.             $targetEntity = $this->load($identifier, null, $assoc, $hints);
  825.             // Complete bidirectional association, if necessary
  826.             if ($targetEntity !== null && $isInverseSingleValued) {
  827.                 $targetClass->reflFields[$assoc['inversedBy']]->setValue($targetEntity, $sourceEntity);
  828.             }
  830.             return $targetEntity;
  831.         }
  833.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  834.         $owningAssoc = $targetClass->getAssociationMapping($assoc['mappedBy']);
  836.         $computedIdentifier = [];
  838.         /** @var array<string,mixed>|null $sourceEntityData */
  839.         $sourceEntityData = null;
  841.         // TRICKY: since the association is specular source and target are flipped
  842.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  843.             if (! isset($sourceClass->fieldNames[$sourceKeyColumn])) {
  844.                 // The likely case here is that the column is a join column
  845.                 // in an association mapping. However, there is no guarantee
  846.                 // at this point that a corresponding (generally identifying)
  847.                 // association has been mapped in the source entity. To handle
  848.                 // this case we directly reference the column-keyed data used
  849.                 // to initialize the source entity before throwing an exception.
  850.                 $resolvedSourceData = false;
  851.                 if (! isset($sourceEntityData)) {
  852.                     $sourceEntityData = $this->em->getUnitOfWork()->getOriginalEntityData($sourceEntity);
  853.                 }
  855.                 if (isset($sourceEntityData[$sourceKeyColumn])) {
  856.                     $dataValue = $sourceEntityData[$sourceKeyColumn];
  857.                     if ($dataValue !== null) {
  858.                         $resolvedSourceData                                                    = true;
  859.                         $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  860.                             $dataValue;
  861.                     }
  862.                 }
  864.                 if (! $resolvedSourceData) {
  865.                     throw MappingException::joinColumnMustPointToMappedField(
  866.                         $sourceClass->name,
  867.                         $sourceKeyColumn
  868.                     );
  869.                 }
  870.             } else {
  871.                 $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  872.                     $sourceClass->reflFields[$sourceClass->fieldNames[$sourceKeyColumn]]->getValue($sourceEntity);
  873.             }
  874.         }
  876.         $targetEntity = $this->load($computedIdentifier, null, $assoc);
  878.         if ($targetEntity !== null) {
  879.             $targetClass->setFieldValue($targetEntity, $assoc['mappedBy'], $sourceEntity);
  880.         }
  882.         return $targetEntity;
  883.     }
  885.     /**
  886.      * {@inheritDoc}
  887.      */
  888.     public function refresh(array $id, $entity, $lockMode = null)
  889.     {
  890.         $sql              = $this->getSelectSQL($id, null, $lockMode);
  891.         [$params, $types] = $this->expandParameters($id);
  892.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  894.         $hydrator = $this->em->newHydrator(Query::HYDRATE_OBJECT);
  895.         $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [Query::HINT_REFRESH => true]);
  896.     }
  898.     /**
  899.      * {@inheritDoc}
  900.      */
  901.     public function count($criteria = [])
  902.     {
  903.         $sql = $this->getCountSQL($criteria);
  905.         [$params, $types] = $criteria instanceof Criteria
  906.             ? $this->expandCriteriaParameters($criteria)
  907.             : $this->expandParameters($criteria);
  909.         return (int) $this->conn->executeQuery($sql, $params, $types)->fetchOne();
  910.     }
  912.     /**
  913.      * {@inheritDoc}
  914.      */
  915.     public function loadCriteria(Criteria $criteria)
  916.     {
  917.         $orderBy = self::getCriteriaOrderings($criteria);
  918.         $limit   = $criteria->getMaxResults();
  919.         $offset  = $criteria->getFirstResult();
  920.         $query   = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  922.         [$params, $types] = $this->expandCriteriaParameters($criteria);
  924.         $stmt     = $this->conn->executeQuery($query, $params, $types);
  925.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  927.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  928.     }
  930.     /**
  931.      * {@inheritDoc}
  932.      */
  933.     public function expandCriteriaParameters(Criteria $criteria)
  934.     {
  935.         $expression = $criteria->getWhereExpression();
  936.         $sqlParams  = [];
  937.         $sqlTypes   = [];
  939.         if ($expression === null) {
  940.             return [$sqlParams, $sqlTypes];
  941.         }
  943.         $valueVisitor = new SqlValueVisitor();
  945.         $valueVisitor->dispatch($expression);
  947.         [, $types] = $valueVisitor->getParamsAndTypes();
  949.         foreach ($types as $type) {
  950.             [$field, $value, $operator] = $type;
  952.             if ($value === null && ($operator === Comparison::EQ || $operator === Comparison::NEQ)) {
  953.                 continue;
  954.             }
  956.             $sqlParams = array_merge($sqlParams, $this->getValues($value));
  957.             $sqlTypes  = array_merge($sqlTypes, $this->getTypes($field, $value, $this->class));
  958.         }
  960.         return [$sqlParams, $sqlTypes];
  961.     }
  963.     /**
  964.      * {@inheritDoc}
  965.      */
  966.     public function loadAll(array $criteria = [], ?array $orderBy = null, $limit = null, $offset = null)
  967.     {
  968.         $this->switchPersisterContext($offset, $limit);
  970.         $sql              = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  971.         [$params, $types] = $this->expandParameters($criteria);
  972.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  974.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  976.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  977.     }
  979.     /**
  980.      * {@inheritDoc}
  981.      */
  982.     public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  983.     {
  984.         $this->switchPersisterContext($offset, $limit);
  986.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity, $offset, $limit);
  988.         return $this->loadArrayFromResult($assoc, $stmt);
  989.     }
  991.     /**
  992.      * Loads an array of entities from a given DBAL statement.
  993.      *
  994.      * @param mixed[] $assoc
  995.      *
  996.      * @return mixed[]
  997.      */
  998.     private function loadArrayFromResult(array $assoc, Result $stmt): array
  999.     {
  1000.         $rsm   = $this->currentPersisterContext->rsm;
  1001.         $hints = [UnitOfWork::HINT_DEFEREAGERLOAD => true];
  1003.         if (isset($assoc['indexBy'])) {
  1004.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  1005.             $rsm->addIndexBy('r', $assoc['indexBy']);
  1006.         }
  1008.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1009.     }
  1011.     /**
  1012.      * Hydrates a collection from a given DBAL statement.
  1013.      *
  1014.      * @param mixed[] $assoc
  1015.      *
  1016.      * @return mixed[]
  1017.      */
  1018.     private function loadCollectionFromStatement(
  1019.         array $assoc,
  1020.         Result $stmt,
  1021.         PersistentCollection $coll
  1022.     ): array {
  1023.         $rsm   = $this->currentPersisterContext->rsm;
  1024.         $hints = [
  1025.             UnitOfWork::HINT_DEFEREAGERLOAD => true,
  1026.             'collection' => $coll,
  1027.         ];
  1029.         if (isset($assoc['indexBy'])) {
  1030.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  1031.             $rsm->addIndexBy('r', $assoc['indexBy']);
  1032.         }
  1034.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1035.     }
  1037.     /**
  1038.      * {@inheritDoc}
  1039.      */
  1040.     public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1041.     {
  1042.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity);
  1044.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1045.     }
  1047.     /**
  1048.      * @param object $sourceEntity
  1049.      * @phpstan-param array<string, mixed> $assoc
  1050.      *
  1051.      * @return Result
  1052.      *
  1053.      * @throws MappingException
  1054.      */
  1055.     private function getManyToManyStatement(
  1056.         array $assoc,
  1057.         $sourceEntity,
  1058.         ?int $offset = null,
  1059.         ?int $limit = null
  1060.     ) {
  1061.         $this->switchPersisterContext($offset, $limit);
  1063.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1064.         $class       = $sourceClass;
  1065.         $association = $assoc;
  1066.         $criteria    = [];
  1067.         $parameters  = [];
  1069.         if (! $assoc['isOwningSide']) {
  1070.             $class       = $this->em->getClassMetadata($assoc['targetEntity']);
  1071.             $association = $class->associationMappings[$assoc['mappedBy']];
  1072.         }
  1074.         $joinColumns = $assoc['isOwningSide']
  1075.             ? $association['joinTable']['joinColumns']
  1076.             : $association['joinTable']['inverseJoinColumns'];
  1078.         $quotedJoinTable = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1080.         foreach ($joinColumns as $joinColumn) {
  1081.             $sourceKeyColumn = $joinColumn['referencedColumnName'];
  1082.             $quotedKeyColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1084.             switch (true) {
  1085.                 case $sourceClass->containsForeignIdentifier:
  1086.                     $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1087.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1089.                     if (isset($sourceClass->associationMappings[$field])) {
  1090.                         $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1091.                         $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1092.                     }
  1094.                     break;
  1096.                 case isset($sourceClass->fieldNames[$sourceKeyColumn]):
  1097.                     $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1098.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1100.                     break;
  1102.                 default:
  1103.                     throw MappingException::joinColumnMustPointToMappedField(
  1104.                         $sourceClass->name,
  1105.                         $sourceKeyColumn
  1106.                     );
  1107.             }
  1109.             $criteria[$quotedJoinTable . '.' . $quotedKeyColumn] = $value;
  1110.             $parameters[]                                        = [
  1111.                 'value' => $value,
  1112.                 'field' => $field,
  1113.                 'class' => $sourceClass,
  1114.             ];
  1115.         }
  1117.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1118.         [$params, $types] = $this->expandToManyParameters($parameters);
  1120.         return $this->conn->executeQuery($sql, $params, $types);
  1121.     }
  1123.     /**
  1124.      * {@inheritDoc}
  1125.      */
  1126.     public function getSelectSQL($criteria, $assoc = null, $lockMode = null, $limit = null, $offset = null, ?array $orderBy = null)
  1127.     {
  1128.         $this->switchPersisterContext($offset, $limit);
  1130.         $lockSql    = '';
  1131.         $joinSql    = '';
  1132.         $orderBySql = '';
  1134.         if ($assoc !== null && $assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  1135.             $joinSql = $this->getSelectManyToManyJoinSQL($assoc);
  1136.         }
  1138.         if (isset($assoc['orderBy'])) {
  1139.             $orderBy = $assoc['orderBy'];
  1140.         }
  1142.         if ($orderBy) {
  1143.             $orderBySql = $this->getOrderBySQL($orderBy, $this->getSQLTableAlias($this->class->name));
  1144.         }
  1146.         $conditionSql = $criteria instanceof Criteria
  1147.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1148.             : $this->getSelectConditionSQL($criteria, $assoc);
  1150.         switch ($lockMode) {
  1151.             case LockMode::PESSIMISTIC_READ:
  1152.                 $lockSql = ' ' . $this->getReadLockSQL($this->platform);
  1153.                 break;
  1155.             case LockMode::PESSIMISTIC_WRITE:
  1156.                 $lockSql = ' ' . $this->getWriteLockSQL($this->platform);
  1157.                 break;
  1158.         }
  1160.         $columnList = $this->getSelectColumnsSQL();
  1161.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1162.         $filterSql  = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1163.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1165.         if ($filterSql !== '') {
  1166.             $conditionSql = $conditionSql
  1167.                 ? $conditionSql . ' AND ' . $filterSql
  1168.                 : $filterSql;
  1169.         }
  1171.         $select = 'SELECT ' . $columnList;
  1172.         $from   = ' FROM ' . $tableName . ' ' . $tableAlias;
  1173.         $join   = $this->currentPersisterContext->selectJoinSql . $joinSql;
  1174.         $where  = ($conditionSql ? ' WHERE ' . $conditionSql : '');
  1175.         $lock   = $this->platform->appendLockHint($from, $lockMode ?? LockMode::NONE);
  1176.         $query  = $select
  1177.             . $lock
  1178.             . $join
  1179.             . $where
  1180.             . $orderBySql;
  1182.         return $this->platform->modifyLimitQuery($query, $limit, $offset ?? 0) . $lockSql;
  1183.     }
  1185.     /**
  1186.      * {@inheritDoc}
  1187.      */
  1188.     public function getCountSQL($criteria = [])
  1189.     {
  1190.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1191.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1193.         $conditionSql = $criteria instanceof Criteria
  1194.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1195.             : $this->getSelectConditionSQL($criteria);
  1197.         $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1199.         if ($filterSql !== '') {
  1200.             $conditionSql = $conditionSql
  1201.                 ? $conditionSql . ' AND ' . $filterSql
  1202.                 : $filterSql;
  1203.         }
  1205.         return 'SELECT COUNT(*) '
  1206.             . 'FROM ' . $tableName . ' ' . $tableAlias
  1207.             . (empty($conditionSql) ? '' : ' WHERE ' . $conditionSql);
  1208.     }
  1210.     /**
  1211.      * Gets the ORDER BY SQL snippet for ordered collections.
  1212.      *
  1213.      * @phpstan-param array<string, string> $orderBy
  1214.      *
  1215.      * @throws InvalidOrientation
  1216.      * @throws InvalidFindByCall
  1217.      * @throws UnrecognizedField
  1218.      */
  1219.     final protected function getOrderBySQL(array $orderBy, string $baseTableAlias): string
  1220.     {
  1221.         $orderByList = [];
  1223.         foreach ($orderBy as $fieldName => $orientation) {
  1224.             $orientation = strtoupper(trim($orientation));
  1226.             if ($orientation !== 'ASC' && $orientation !== 'DESC') {
  1227.                 throw InvalidOrientation::fromClassNameAndField($this->class->name, $fieldName);
  1228.             }
  1230.             if (isset($this->class->fieldMappings[$fieldName])) {
  1231.                 $tableAlias = isset($this->class->fieldMappings[$fieldName]['inherited'])
  1232.                     ? $this->getSQLTableAlias($this->class->fieldMappings[$fieldName]['inherited'])
  1233.                     : $baseTableAlias;
  1235.                 $columnName    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  1236.                 $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1238.                 continue;
  1239.             }
  1241.             if (isset($this->class->associationMappings[$fieldName])) {
  1242.                 if (! $this->class->associationMappings[$fieldName]['isOwningSide']) {
  1243.                     throw InvalidFindByCall::fromInverseSideUsage($this->class->name, $fieldName);
  1244.                 }
  1246.                 $tableAlias = isset($this->class->associationMappings[$fieldName]['inherited'])
  1247.                     ? $this->getSQLTableAlias($this->class->associationMappings[$fieldName]['inherited'])
  1248.                     : $baseTableAlias;
  1250.                 foreach ($this->class->associationMappings[$fieldName]['joinColumns'] as $joinColumn) {
  1251.                     $columnName    = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1252.                     $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1253.                 }
  1255.                 continue;
  1256.             }
  1258.             throw UnrecognizedField::byFullyQualifiedName($this->class->name, $fieldName);
  1259.         }
  1261.         return ' ORDER BY ' . implode(', ', $orderByList);
  1262.     }
  1264.     /**
  1265.      * Gets the SQL fragment with the list of columns to select when querying for
  1266.      * an entity in this persister.
  1267.      *
  1268.      * Subclasses should override this method to alter or change the select column
  1269.      * list SQL fragment. Note that in the implementation of BasicEntityPersister
  1270.      * the resulting SQL fragment is generated only once and cached in {@link selectColumnListSql}.
  1271.      * Subclasses may or may not do the same.
  1272.      *
  1273.      * @return string The SQL fragment.
  1274.      */
  1275.     protected function getSelectColumnsSQL()
  1276.     {
  1277.         if ($this->currentPersisterContext->selectColumnListSql !== null && $this->filterHash === $this->em->getFilters()->getHash()) {
  1278.             return $this->currentPersisterContext->selectColumnListSql;
  1279.         }
  1281.         $columnList = [];
  1282.         $this->currentPersisterContext->rsm->addEntityResult($this->class->name, 'r'); // r for root
  1284.         // Add regular columns to select list
  1285.         foreach ($this->class->fieldNames as $field) {
  1286.             $columnList[] = $this->getSelectColumnSQL($field, $this->class);
  1287.         }
  1289.         $this->currentPersisterContext->selectJoinSql = '';
  1290.         $eagerAliasCounter                            = 0;
  1292.         foreach ($this->class->associationMappings as $assocField => $assoc) {
  1293.             $assocColumnSQL = $this->getSelectColumnAssociationSQL($assocField, $assoc, $this->class);
  1295.             if ($assocColumnSQL) {
  1296.                 $columnList[] = $assocColumnSQL;
  1297.             }
  1299.             $isAssocToOneInverseSide = $assoc['type'] & ClassMetadata::TO_ONE && ! $assoc['isOwningSide'];
  1300.             $isAssocFromOneEager     = $assoc['type'] & ClassMetadata::TO_ONE && $assoc['fetch'] === ClassMetadata::FETCH_EAGER;
  1302.             if (! ($isAssocFromOneEager || $isAssocToOneInverseSide)) {
  1303.                 continue;
  1304.             }
  1306.             if ((($assoc['type'] & ClassMetadata::TO_MANY) > 0) && $this->currentPersisterContext->handlesLimits) {
  1307.                 continue;
  1308.             }
  1310.             $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1312.             if ($eagerEntity->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  1313.                 continue; // now this is why you shouldn't use inheritance
  1314.             }
  1316.             $assocAlias = 'e' . ($eagerAliasCounter++);
  1317.             $this->currentPersisterContext->rsm->addJoinedEntityResult($assoc['targetEntity'], $assocAlias, 'r', $assocField);
  1319.             foreach ($eagerEntity->fieldNames as $field) {
  1320.                 $columnList[] = $this->getSelectColumnSQL($field, $eagerEntity, $assocAlias);
  1321.             }
  1323.             foreach ($eagerEntity->associationMappings as $eagerAssocField => $eagerAssoc) {
  1324.                 $eagerAssocColumnSQL = $this->getSelectColumnAssociationSQL(
  1325.                     $eagerAssocField,
  1326.                     $eagerAssoc,
  1327.                     $eagerEntity,
  1328.                     $assocAlias
  1329.                 );
  1331.                 if ($eagerAssocColumnSQL) {
  1332.                     $columnList[] = $eagerAssocColumnSQL;
  1333.                 }
  1334.             }
  1336.             $association   = $assoc;
  1337.             $joinCondition = [];
  1339.             if (isset($assoc['indexBy'])) {
  1340.                 $this->currentPersisterContext->rsm->addIndexBy($assocAlias, $assoc['indexBy']);
  1341.             }
  1343.             if (! $assoc['isOwningSide']) {
  1344.                 $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1345.                 $association = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
  1346.             }
  1348.             $joinTableAlias = $this->getSQLTableAlias($eagerEntity->name, $assocAlias);
  1349.             $joinTableName  = $this->quoteStrategy->getTableName($eagerEntity, $this->platform);
  1351.             if ($assoc['isOwningSide']) {
  1352.                 $tableAlias                                    = $this->getSQLTableAlias($association['targetEntity'], $assocAlias);
  1353.                 $this->currentPersisterContext->selectJoinSql .= ' ' . $this->getJoinSQLForJoinColumns($association['joinColumns']);
  1355.                 foreach ($association['joinColumns'] as $joinColumn) {
  1356.                     $sourceCol       = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1357.                     $targetCol       = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1358.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'])
  1359.                                         . '.' . $sourceCol . ' = ' . $tableAlias . '.' . $targetCol;
  1360.                 }
  1362.                 // Add filter SQL
  1363.                 $filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias);
  1364.                 if ($filterSql) {
  1365.                     $joinCondition[] = $filterSql;
  1366.                 }
  1367.             } else {
  1368.                 $this->currentPersisterContext->selectJoinSql .= ' LEFT JOIN';
  1370.                 foreach ($association['joinColumns'] as $joinColumn) {
  1371.                     $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1372.                     $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1374.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'], $assocAlias) . '.' . $sourceCol . ' = '
  1375.                         . $this->getSQLTableAlias($association['targetEntity']) . '.' . $targetCol;
  1376.                 }
  1377.             }
  1379.             $this->currentPersisterContext->selectJoinSql .= ' ' . $joinTableName . ' ' . $joinTableAlias . ' ON ';
  1380.             $this->currentPersisterContext->selectJoinSql .= implode(' AND ', $joinCondition);
  1381.         }
  1383.         $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  1384.         $this->filterHash                                   = $this->em->getFilters()->getHash();
  1386.         return $this->currentPersisterContext->selectColumnListSql;
  1387.     }
  1389.     /**
  1390.      * Gets the SQL join fragment used when selecting entities from an association.
  1391.      *
  1392.      * @param string             $field
  1393.      * @param AssociationMapping $assoc
  1394.      * @param string             $alias
  1395.      *
  1396.      * @return string
  1397.      */
  1398.     protected function getSelectColumnAssociationSQL($field, $assoc, ClassMetadata $class, $alias = 'r')
  1399.     {
  1400.         if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1401.             return '';
  1402.         }
  1404.         $columnList    = [];
  1405.         $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
  1406.         $isIdentifier  = isset($assoc['id']) && $assoc['id'] === true;
  1407.         $sqlTableAlias = $this->getSQLTableAlias($class->name, ($alias === 'r' ? '' : $alias));
  1409.         foreach ($assoc['joinColumns'] as $joinColumn) {
  1410.             $quotedColumn     = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1411.             $resultColumnName = $this->getSQLColumnAlias($joinColumn['name']);
  1412.             $type             = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  1414.             $this->currentPersisterContext->rsm->addMetaResult($alias, $resultColumnName, $joinColumn['name'], $isIdentifier, $type);
  1416.             $columnList[] = sprintf('%s.%s AS %s', $sqlTableAlias, $quotedColumn, $resultColumnName);
  1417.         }
  1419.         return implode(', ', $columnList);
  1420.     }
  1422.     /**
  1423.      * Gets the SQL join fragment used when selecting entities from a
  1424.      * many-to-many association.
  1425.      *
  1426.      * @phpstan-param AssociationMapping $manyToMany
  1427.      *
  1428.      * @return string
  1429.      */
  1430.     protected function getSelectManyToManyJoinSQL(array $manyToMany)
  1431.     {
  1432.         $conditions       = [];
  1433.         $association      = $manyToMany;
  1434.         $sourceTableAlias = $this->getSQLTableAlias($this->class->name);
  1436.         if (! $manyToMany['isOwningSide']) {
  1437.             $targetEntity = $this->em->getClassMetadata($manyToMany['targetEntity']);
  1438.             $association  = $targetEntity->associationMappings[$manyToMany['mappedBy']];
  1439.         }
  1441.         $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  1442.         $joinColumns   = $manyToMany['isOwningSide']
  1443.             ? $association['joinTable']['inverseJoinColumns']
  1444.             : $association['joinTable']['joinColumns'];
  1446.         foreach ($joinColumns as $joinColumn) {
  1447.             $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1448.             $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1449.             $conditions[]       = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableName . '.' . $quotedSourceColumn;
  1450.         }
  1452.         return ' INNER JOIN ' . $joinTableName . ' ON ' . implode(' AND ', $conditions);
  1453.     }
  1455.     /**
  1456.      * {@inheritDoc}
  1457.      */
  1458.     public function getInsertSQL()
  1459.     {
  1460.         if ($this->insertSql !== null) {
  1461.             return $this->insertSql;
  1462.         }
  1464.         $columns   = $this->getInsertColumnList();
  1465.         $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1467.         if (empty($columns)) {
  1468.             $identityColumn  = $this->quoteStrategy->getColumnName($this->class->identifier[0], $this->class, $this->platform);
  1469.             $this->insertSql = $this->platform->getEmptyIdentityInsertSQL($tableName, $identityColumn);
  1471.             return $this->insertSql;
  1472.         }
  1474.         $values  = [];
  1475.         $columns = array_unique($columns);
  1477.         foreach ($columns as $column) {
  1478.             $placeholder = '?';
  1480.             if (
  1481.                 isset($this->class->fieldNames[$column])
  1482.                 && isset($this->columnTypes[$this->class->fieldNames[$column]])
  1483.                 && isset($this->class->fieldMappings[$this->class->fieldNames[$column]]['requireSQLConversion'])
  1484.             ) {
  1485.                 $type        = Type::getType($this->columnTypes[$this->class->fieldNames[$column]]);
  1486.                 $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  1487.             }
  1489.             $values[] = $placeholder;
  1490.         }
  1492.         $columns = implode(', ', $columns);
  1493.         $values  = implode(', ', $values);
  1495.         $this->insertSql = sprintf('INSERT INTO %s (%s) VALUES (%s)', $tableName, $columns, $values);
  1497.         return $this->insertSql;
  1498.     }
  1500.     /**
  1501.      * Gets the list of columns to put in the INSERT SQL statement.
  1502.      *
  1503.      * Subclasses should override this method to alter or change the list of
  1504.      * columns placed in the INSERT statements used by the persister.
  1505.      *
  1506.      * @return string[] The list of columns.
  1507.      * @phpstan-return list<string>
  1508.      */
  1509.     protected function getInsertColumnList()
  1510.     {
  1511.         $columns = [];
  1513.         foreach ($this->class->reflFields as $name => $field) {
  1514.             if ($this->class->isVersioned && $this->class->versionField === $name) {
  1515.                 continue;
  1516.             }
  1518.             if (isset($this->class->embeddedClasses[$name])) {
  1519.                 continue;
  1520.             }
  1522.             if (isset($this->class->associationMappings[$name])) {
  1523.                 $assoc = $this->class->associationMappings[$name];
  1525.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  1526.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  1527.                         $columns[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1528.                     }
  1529.                 }
  1531.                 continue;
  1532.             }
  1534.             if (! $this->class->isIdGeneratorIdentity() || $this->class->identifier[0] !== $name) {
  1535.                 if (isset($this->class->fieldMappings[$name]['notInsertable'])) {
  1536.                     continue;
  1537.                 }
  1539.                 $columns[]                = $this->quoteStrategy->getColumnName($name, $this->class, $this->platform);
  1540.                 $this->columnTypes[$name] = $this->class->fieldMappings[$name]['type'];
  1541.             }
  1542.         }
  1544.         return $columns;
  1545.     }
  1547.     /**
  1548.      * Gets the SQL snippet of a qualified column name for the given field name.
  1549.      *
  1550.      * @param string        $field The field name.
  1551.      * @param ClassMetadata $class The class that declares this field. The table this class is
  1552.      *                             mapped to must own the column for the given field.
  1553.      * @param string        $alias
  1554.      *
  1555.      * @return string
  1556.      */
  1557.     protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  1558.     {
  1559.         $root         = $alias === 'r' ? '' : $alias;
  1560.         $tableAlias   = $this->getSQLTableAlias($class->name, $root);
  1561.         $fieldMapping = $class->fieldMappings[$field];
  1562.         $sql          = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
  1563.         $columnAlias  = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1565.         $this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
  1566.         if (! empty($fieldMapping['enumType'])) {
  1567.             $this->currentPersisterContext->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
  1568.         }
  1570.         if (isset($fieldMapping['requireSQLConversion'])) {
  1571.             $type = Type::getType($fieldMapping['type']);
  1572.             $sql  = $type->convertToPHPValueSQL($sql, $this->platform);
  1573.         }
  1575.         return $sql . ' AS ' . $columnAlias;
  1576.     }
  1578.     /**
  1579.      * Gets the SQL table alias for the given class name.
  1580.      *
  1581.      * @param string $className
  1582.      * @param string $assocName
  1583.      *
  1584.      * @return string The SQL table alias.
  1585.      *
  1586.      * @todo Reconsider. Binding table aliases to class names is not such a good idea.
  1587.      */
  1588.     protected function getSQLTableAlias($className, $assocName = '')
  1589.     {
  1590.         if ($assocName) {
  1591.             $className .= '#' . $assocName;
  1592.         }
  1594.         if (isset($this->currentPersisterContext->sqlTableAliases[$className])) {
  1595.             return $this->currentPersisterContext->sqlTableAliases[$className];
  1596.         }
  1598.         $tableAlias = 't' . $this->currentPersisterContext->sqlAliasCounter++;
  1600.         $this->currentPersisterContext->sqlTableAliases[$className] = $tableAlias;
  1602.         return $tableAlias;
  1603.     }
  1605.     /**
  1606.      * {@inheritDoc}
  1607.      */
  1608.     public function lock(array $criteria, $lockMode)
  1609.     {
  1610.         $lockSql      = '';
  1611.         $conditionSql = $this->getSelectConditionSQL($criteria);
  1613.         switch ($lockMode) {
  1614.             case LockMode::PESSIMISTIC_READ:
  1615.                 $lockSql = $this->getReadLockSQL($this->platform);
  1617.                 break;
  1618.             case LockMode::PESSIMISTIC_WRITE:
  1619.                 $lockSql = $this->getWriteLockSQL($this->platform);
  1620.                 break;
  1621.         }
  1623.         $lock  = $this->getLockTablesSql($lockMode);
  1624.         $where = ($conditionSql ? ' WHERE ' . $conditionSql : '') . ' ';
  1625.         $sql   = 'SELECT 1 '
  1626.              . $lock
  1627.              . $where
  1628.              . $lockSql;
  1630.         [$params, $types] = $this->expandParameters($criteria);
  1632.         $this->conn->executeQuery($sql, $params, $types);
  1633.     }
  1635.     /**
  1636.      * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
  1637.      *
  1638.      * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
  1639.      * @phpstan-param LockMode::*|null $lockMode
  1640.      *
  1641.      * @return string
  1642.      */
  1643.     protected function getLockTablesSql($lockMode)
  1644.     {
  1645.         if ($lockMode === null) {
  1646.             Deprecation::trigger(
  1647.                 'doctrine/orm',
  1648.                 'https://github.com/doctrine/orm/pull/9466',
  1649.                 'Passing null as argument to %s is deprecated, pass LockMode::NONE instead.',
  1650.                 __METHOD__
  1651.             );
  1653.             $lockMode = LockMode::NONE;
  1654.         }
  1656.         return $this->platform->appendLockHint(
  1657.             'FROM '
  1658.             . $this->quoteStrategy->getTableName($this->class, $this->platform) . ' '
  1659.             . $this->getSQLTableAlias($this->class->name),
  1660.             $lockMode
  1661.         );
  1662.     }
  1664.     /**
  1665.      * Gets the Select Where Condition from a Criteria object.
  1666.      *
  1667.      * @return string
  1668.      */
  1669.     protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  1670.     {
  1671.         $expression = $criteria->getWhereExpression();
  1673.         if ($expression === null) {
  1674.             return '';
  1675.         }
  1677.         $visitor = new SqlExpressionVisitor($this, $this->class);
  1679.         return $visitor->dispatch($expression);
  1680.     }
  1682.     /**
  1683.      * {@inheritDoc}
  1684.      */
  1685.     public function getSelectConditionStatementSQL($field, $value, $assoc = null, $comparison = null)
  1686.     {
  1687.         $selectedColumns = [];
  1688.         $columns         = $this->getSelectConditionStatementColumnSQL($field, $assoc);
  1690.         if (count($columns) > 1 && $comparison === Comparison::IN) {
  1691.             /*
  1692.              *  @todo try to support multi-column IN expressions.
  1693.              *  Example: (col1, col2) IN (('val1A', 'val2A'), ('val1B', 'val2B'))
  1694.              */
  1695.             throw CantUseInOperatorOnCompositeKeys::create();
  1696.         }
  1698.         foreach ($columns as $column) {
  1699.             $placeholder = '?';
  1701.             if (isset($this->class->fieldMappings[$field]['requireSQLConversion'])) {
  1702.                 $type        = Type::getType($this->class->fieldMappings[$field]['type']);
  1703.                 $placeholder = $type->convertToDatabaseValueSQL($placeholder, $this->platform);
  1704.             }
  1706.             if ($comparison !== null) {
  1707.                 // special case null value handling
  1708.                 if (($comparison === Comparison::EQ || $comparison === Comparison::IS) && $value === null) {
  1709.                     $selectedColumns[] = $column . ' IS NULL';
  1711.                     continue;
  1712.                 }
  1714.                 if ($comparison === Comparison::NEQ && $value === null) {
  1715.                     $selectedColumns[] = $column . ' IS NOT NULL';
  1717.                     continue;
  1718.                 }
  1720.                 $selectedColumns[] = $column . ' ' . sprintf(self::$comparisonMap[$comparison], $placeholder);
  1722.                 continue;
  1723.             }
  1725.             if (is_array($value)) {
  1726.                 $in = sprintf('%s IN (%s)', $column, $placeholder);
  1728.                 if (array_search(null, $value, true) !== false) {
  1729.                     $selectedColumns[] = sprintf('(%s OR %s IS NULL)', $in, $column);
  1731.                     continue;
  1732.                 }
  1734.                 $selectedColumns[] = $in;
  1736.                 continue;
  1737.             }
  1739.             if ($value === null) {
  1740.                 $selectedColumns[] = sprintf('%s IS NULL', $column);
  1742.                 continue;
  1743.             }
  1745.             $selectedColumns[] = sprintf('%s = %s', $column, $placeholder);
  1746.         }
  1748.         return implode(' AND ', $selectedColumns);
  1749.     }
  1751.     /**
  1752.      * Builds the left-hand-side of a where condition statement.
  1753.      *
  1754.      * @phpstan-param AssociationMapping|null $assoc
  1755.      *
  1756.      * @return string[]
  1757.      * @phpstan-return list<string>
  1758.      *
  1759.      * @throws InvalidFindByCall
  1760.      * @throws UnrecognizedField
  1761.      */
  1762.     private function getSelectConditionStatementColumnSQL(
  1763.         string $field,
  1764.         ?array $assoc = null
  1765.     ): array {
  1766.         if (isset($this->class->fieldMappings[$field])) {
  1767.             $className = $this->class->fieldMappings[$field]['inherited'] ?? $this->class->name;
  1769.             return [$this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getColumnName($field, $this->class, $this->platform)];
  1770.         }
  1772.         if (isset($this->class->associationMappings[$field])) {
  1773.             $association = $this->class->associationMappings[$field];
  1774.             // Many-To-Many requires join table check for joinColumn
  1775.             $columns = [];
  1776.             $class   = $this->class;
  1778.             if ($association['type'] === ClassMetadata::MANY_TO_MANY) {
  1779.                 if (! $association['isOwningSide']) {
  1780.                     $association = $assoc;
  1781.                 }
  1783.                 $joinTableName = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1784.                 $joinColumns   = $assoc['isOwningSide']
  1785.                     ? $association['joinTable']['joinColumns']
  1786.                     : $association['joinTable']['inverseJoinColumns'];
  1788.                 foreach ($joinColumns as $joinColumn) {
  1789.                     $columns[] = $joinTableName . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1790.                 }
  1791.             } else {
  1792.                 if (! $association['isOwningSide']) {
  1793.                     throw InvalidFindByCall::fromInverseSideUsage(
  1794.                         $this->class->name,
  1795.                         $field
  1796.                     );
  1797.                 }
  1799.                 $className = $association['inherited'] ?? $this->class->name;
  1801.                 foreach ($association['joinColumns'] as $joinColumn) {
  1802.                     $columns[] = $this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1803.                 }
  1804.             }
  1806.             return $columns;
  1807.         }
  1809.         if ($assoc !== null && ! str_contains($field, ' ') && ! str_contains($field, '(')) {
  1810.             // very careless developers could potentially open up this normally hidden api for userland attacks,
  1811.             // therefore checking for spaces and function calls which are not allowed.
  1813.             // found a join column condition, not really a "field"
  1814.             return [$field];
  1815.         }
  1817.         throw UnrecognizedField::byFullyQualifiedName($this->class->name, $field);
  1818.     }
  1820.     /**
  1821.      * Gets the conditional SQL fragment used in the WHERE clause when selecting
  1822.      * entities in this persister.
  1823.      *
  1824.      * Subclasses are supposed to override this method if they intend to change
  1825.      * or alter the criteria by which entities are selected.
  1826.      *
  1827.      * @param AssociationMapping|null $assoc
  1828.      * @phpstan-param array<string, mixed> $criteria
  1829.      * @phpstan-param array<string, mixed>|null $assoc
  1830.      *
  1831.      * @return string
  1832.      */
  1833.     protected function getSelectConditionSQL(array $criteria, $assoc = null)
  1834.     {
  1835.         $conditions = [];
  1837.         foreach ($criteria as $field => $value) {
  1838.             $conditions[] = $this->getSelectConditionStatementSQL($field, $value, $assoc);
  1839.         }
  1841.         return implode(' AND ', $conditions);
  1842.     }
  1844.     /**
  1845.      * {@inheritDoc}
  1846.      */
  1847.     public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1848.     {
  1849.         $this->switchPersisterContext($offset, $limit);
  1851.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity, $offset, $limit);
  1853.         return $this->loadArrayFromResult($assoc, $stmt);
  1854.     }
  1856.     /**
  1857.      * {@inheritDoc}
  1858.      */
  1859.     public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1860.     {
  1861.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity);
  1863.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1864.     }
  1866.     /**
  1867.      * Builds criteria and execute SQL statement to fetch the one to many entities from.
  1868.      *
  1869.      * @param object $sourceEntity
  1870.      * @phpstan-param AssociationMapping $assoc
  1871.      */
  1872.     private function getOneToManyStatement(
  1873.         array $assoc,
  1874.         $sourceEntity,
  1875.         ?int $offset = null,
  1876.         ?int $limit = null
  1877.     ): Result {
  1878.         $this->switchPersisterContext($offset, $limit);
  1880.         $criteria    = [];
  1881.         $parameters  = [];
  1882.         $owningAssoc = $this->class->associationMappings[$assoc['mappedBy']];
  1883.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1884.         $tableAlias  = $this->getSQLTableAlias($owningAssoc['inherited'] ?? $this->class->name);
  1886.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  1887.             if ($sourceClass->containsForeignIdentifier) {
  1888.                 $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1889.                 $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1891.                 if (isset($sourceClass->associationMappings[$field])) {
  1892.                     $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1893.                     $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1894.                 }
  1896.                 $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1897.                 $parameters[]                                   = [
  1898.                     'value' => $value,
  1899.                     'field' => $field,
  1900.                     'class' => $sourceClass,
  1901.                 ];
  1903.                 continue;
  1904.             }
  1906.             $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1907.             $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1909.             $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1910.             $parameters[]                                   = [
  1911.                 'value' => $value,
  1912.                 'field' => $field,
  1913.                 'class' => $sourceClass,
  1914.             ];
  1915.         }
  1917.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1918.         [$params, $types] = $this->expandToManyParameters($parameters);
  1920.         return $this->conn->executeQuery($sql, $params, $types);
  1921.     }
  1923.     /**
  1924.      * {@inheritDoc}
  1925.      */
  1926.     public function expandParameters($criteria)
  1927.     {
  1928.         $params = [];
  1929.         $types  = [];
  1931.         foreach ($criteria as $field => $value) {
  1932.             if ($value === null) {
  1933.                 continue; // skip null values.
  1934.             }
  1936.             $types  = array_merge($types, $this->getTypes($field, $value, $this->class));
  1937.             $params = array_merge($params, $this->getValues($value));
  1938.         }
  1940.         return [$params, $types];
  1941.     }
  1943.     /**
  1944.      * Expands the parameters from the given criteria and use the correct binding types if found,
  1945.      * specialized for OneToMany or ManyToMany associations.
  1946.      *
  1947.      * @param mixed[][] $criteria an array of arrays containing following:
  1948.      *                             - field to which each criterion will be bound
  1949.      *                             - value to be bound
  1950.      *                             - class to which the field belongs to
  1951.      *
  1952.      * @return mixed[][]
  1953.      * @phpstan-return array{0: array, 1: list<int|string|null>}
  1954.      */
  1955.     private function expandToManyParameters(array $criteria): array
  1956.     {
  1957.         $params = [];
  1958.         $types  = [];
  1960.         foreach ($criteria as $criterion) {
  1961.             if ($criterion['value'] === null) {
  1962.                 continue; // skip null values.
  1963.             }
  1965.             $types  = array_merge($types, $this->getTypes($criterion['field'], $criterion['value'], $criterion['class']));
  1966.             $params = array_merge($params, $this->getValues($criterion['value']));
  1967.         }
  1969.         return [$params, $types];
  1970.     }
  1972.     /**
  1973.      * Infers field types to be used by parameter type casting.
  1974.      *
  1975.      * @param mixed $value
  1976.      *
  1977.      * @return int[]|null[]|string[]
  1978.      * @phpstan-return list<int|string|null>
  1979.      *
  1980.      * @throws QueryException
  1981.      */
  1982.     private function getTypes(string $field, $value, ClassMetadata $class): array
  1983.     {
  1984.         $types = [];
  1986.         switch (true) {
  1987.             case isset($class->fieldMappings[$field]):
  1988.                 $types = array_merge($types, [$class->fieldMappings[$field]['type']]);
  1989.                 break;
  1991.             case isset($class->associationMappings[$field]):
  1992.                 $assoc = $class->associationMappings[$field];
  1993.                 $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1995.                 if (! $assoc['isOwningSide']) {
  1996.                     $assoc = $class->associationMappings[$assoc['mappedBy']];
  1997.                     $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1998.                 }
  2000.                 $columns = $assoc['type'] === ClassMetadata::MANY_TO_MANY
  2001.                     ? $assoc['relationToTargetKeyColumns']
  2002.                     : $assoc['sourceToTargetKeyColumns'];
  2004.                 foreach ($columns as $column) {
  2005.                     $types[] = PersisterHelper::getTypeOfColumn($column, $class, $this->em);
  2006.                 }
  2008.                 break;
  2010.             default:
  2011.                 $types[] = null;
  2012.                 break;
  2013.         }
  2015.         if (is_array($value)) {
  2016.             return array_map(static function ($type) {
  2017.                 $type = Type::getType($type);
  2019.                 return $type->getBindingType() + Connection::ARRAY_PARAM_OFFSET;
  2020.             }, $types);
  2021.         }
  2023.         return $types;
  2024.     }
  2026.     /**
  2027.      * Retrieves the parameters that identifies a value.
  2028.      *
  2029.      * @param mixed $value
  2030.      *
  2031.      * @return mixed[]
  2032.      */
  2033.     private function getValues($value): array
  2034.     {
  2035.         if (is_array($value)) {
  2036.             $newValue = [];
  2038.             foreach ($value as $itemValue) {
  2039.                 $newValue = array_merge($newValue, $this->getValues($itemValue));
  2040.             }
  2042.             return [$newValue];
  2043.         }
  2045.         return $this->getIndividualValue($value);
  2046.     }
  2048.     /**
  2049.      * Retrieves an individual parameter value.
  2050.      *
  2051.      * @param mixed $value
  2052.      *
  2053.      * @phpstan-return list<mixed>
  2054.      */
  2055.     private function getIndividualValue($value): array
  2056.     {
  2057.         if (! is_object($value)) {
  2058.             return [$value];
  2059.         }
  2061.         if ($value instanceof BackedEnum) {
  2062.             return [$value->value];
  2063.         }
  2065.         $valueClass = DefaultProxyClassNameResolver::getClass($value);
  2067.         if ($this->em->getMetadataFactory()->isTransient($valueClass)) {
  2068.             return [$value];
  2069.         }
  2071.         $class = $this->em->getClassMetadata($valueClass);
  2073.         if ($class->isIdentifierComposite) {
  2074.             $newValue = [];
  2076.             foreach ($class->getIdentifierValues($value) as $innerValue) {
  2077.                 $newValue = array_merge($newValue, $this->getValues($innerValue));
  2078.             }
  2080.             return $newValue;
  2081.         }
  2083.         return [$this->em->getUnitOfWork()->getSingleIdentifierValue($value)];
  2084.     }
  2086.     /**
  2087.      * {@inheritDoc}
  2088.      */
  2089.     public function exists($entity, ?Criteria $extraConditions = null)
  2090.     {
  2091.         $criteria = $this->class->getIdentifierValues($entity);
  2093.         if (! $criteria) {
  2094.             return false;
  2095.         }
  2097.         $alias = $this->getSQLTableAlias($this->class->name);
  2099.         $sql = 'SELECT 1 '
  2100.              . $this->getLockTablesSql(LockMode::NONE)
  2101.              . ' WHERE ' . $this->getSelectConditionSQL($criteria);
  2103.         [$params, $types] = $this->expandParameters($criteria);
  2105.         if ($extraConditions !== null) {
  2106.             $sql                             .= ' AND ' . $this->getSelectConditionCriteriaSQL($extraConditions);
  2107.             [$criteriaParams, $criteriaTypes] = $this->expandCriteriaParameters($extraConditions);
  2109.             $params = array_merge($params, $criteriaParams);
  2110.             $types  = array_merge($types, $criteriaTypes);
  2111.         }
  2113.         $filterSql = $this->generateFilterConditionSQL($this->class, $alias);
  2114.         if ($filterSql) {
  2115.             $sql .= ' AND ' . $filterSql;
  2116.         }
  2118.         return (bool) $this->conn->fetchOne($sql, $params, $types);
  2119.     }
  2121.     /**
  2122.      * Generates the appropriate join SQL for the given join column.
  2123.      *
  2124.      * @param array[] $joinColumns The join columns definition of an association.
  2125.      * @phpstan-param array<array<string, mixed>> $joinColumns
  2126.      *
  2127.      * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise.
  2128.      */
  2129.     protected function getJoinSQLForJoinColumns($joinColumns)
  2130.     {
  2131.         // if one of the join columns is nullable, return left join
  2132.         foreach ($joinColumns as $joinColumn) {
  2133.             if (! isset($joinColumn['nullable']) || $joinColumn['nullable']) {
  2134.                 return 'LEFT JOIN';
  2135.             }
  2136.         }
  2138.         return 'INNER JOIN';
  2139.     }
  2141.     /**
  2142.      * @param string $columnName
  2143.      *
  2144.      * @return string
  2145.      */
  2146.     public function getSQLColumnAlias($columnName)
  2147.     {
  2148.         return $this->quoteStrategy->getColumnAlias($columnName, $this->currentPersisterContext->sqlAliasCounter++, $this->platform);
  2149.     }
  2151.     /**
  2152.      * Generates the filter SQL for a given entity and table alias.
  2153.      *
  2154.      * @param ClassMetadata $targetEntity     Metadata of the target entity.
  2155.      * @param string        $targetTableAlias The table alias of the joined/selected table.
  2156.      *
  2157.      * @return string The SQL query part to add to a query.
  2158.      */
  2159.     protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  2160.     {
  2161.         $filterClauses = [];
  2163.         foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  2164.             $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
  2165.             if ($filterExpr !== '') {
  2166.                 $filterClauses[] = '(' . $filterExpr . ')';
  2167.             }
  2168.         }
  2170.         $sql = implode(' AND ', $filterClauses);
  2172.         return $sql ? '(' . $sql . ')' : ''; // Wrap again to avoid "X or Y and FilterConditionSQL"
  2173.     }
  2175.     /**
  2176.      * Switches persister context according to current query offset/limits
  2177.      *
  2178.      * This is due to the fact that to-many associations cannot be fetch-joined when a limit is involved
  2179.      *
  2180.      * @param int|null $offset
  2181.      * @param int|null $limit
  2182.      *
  2183.      * @return void
  2184.      */
  2185.     protected function switchPersisterContext($offset, $limit)
  2186.     {
  2187.         if ($offset === null && $limit === null) {
  2188.             $this->currentPersisterContext = $this->noLimitsContext;
  2190.             return;
  2191.         }
  2193.         $this->currentPersisterContext = $this->limitsHandlingContext;
  2194.     }
  2196.     /**
  2197.      * @return string[]
  2198.      * @phpstan-return list<string>
  2199.      */
  2200.     protected function getClassIdentifiersTypes(ClassMetadata $class): array
  2201.     {
  2202.         $entityManager = $this->em;
  2204.         return array_map(
  2205.             static function ($fieldName) use ($class, $entityManager): string {
  2206.                 $types = PersisterHelper::getTypeOfField($fieldName, $class, $entityManager);
  2207.                 assert(isset($types[0]));
  2209.                 return $types[0];
  2210.             },
  2211.             $class->identifier
  2212.         );
  2213.     }
  2214. }