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

Open in your IDE?
  1. <?php
  3. /*
  4.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  5.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  6.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  7.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  8.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  9.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15.  *
  16.  * This software consists of voluntary contributions made by many individuals
  17.  * and is licensed under the MIT license. For more information, see
  18.  * <http://www.doctrine-project.org>.
  19.  */
  21. namespace Doctrine\ORM\Persisters\Entity;
  23. use Doctrine\Common\Collections\Criteria;
  24. use Doctrine\Common\Collections\Expr\Comparison;
  25. use Doctrine\Common\Util\ClassUtils;
  26. use Doctrine\DBAL\Connection;
  27. use Doctrine\DBAL\LockMode;
  28. use Doctrine\DBAL\Platforms\AbstractPlatform;
  29. use Doctrine\DBAL\Statement;
  30. use Doctrine\DBAL\Types\Type;
  31. use Doctrine\ORM\EntityManagerInterface;
  32. use Doctrine\ORM\Mapping\ClassMetadata;
  33. use Doctrine\ORM\Mapping\MappingException;
  34. use Doctrine\ORM\Mapping\QuoteStrategy;
  35. use Doctrine\ORM\OptimisticLockException;
  36. use Doctrine\ORM\ORMException;
  37. use Doctrine\ORM\PersistentCollection;
  38. use Doctrine\ORM\Persisters\SqlExpressionVisitor;
  39. use Doctrine\ORM\Persisters\SqlValueVisitor;
  40. use Doctrine\ORM\Query;
  41. use Doctrine\ORM\Query\QueryException;
  42. use Doctrine\ORM\UnitOfWork;
  43. use Doctrine\ORM\Utility\IdentifierFlattener;
  44. use Doctrine\ORM\Utility\PersisterHelper;
  46. use function array_combine;
  47. use function array_map;
  48. use function array_merge;
  49. use function array_search;
  50. use function array_unique;
  51. use function array_values;
  52. use function assert;
  53. use function count;
  54. use function get_class;
  55. use function implode;
  56. use function is_array;
  57. use function is_object;
  58. use function reset;
  59. use function spl_object_hash;
  60. use function sprintf;
  61. use function strpos;
  62. use function strtoupper;
  63. use function trim;
  65. /**
  66.  * A BasicEntityPersister maps an entity to a single table in a relational database.
  67.  *
  68.  * A persister is always responsible for a single entity type.
  69.  *
  70.  * EntityPersisters are used during a UnitOfWork to apply any changes to the persistent
  71.  * state of entities onto a relational database when the UnitOfWork is committed,
  72.  * as well as for basic querying of entities and their associations (not DQL).
  73.  *
  74.  * The persisting operations that are invoked during a commit of a UnitOfWork to
  75.  * persist the persistent entity state are:
  76.  *
  77.  *   - {@link addInsert} : To schedule an entity for insertion.
  78.  *   - {@link executeInserts} : To execute all scheduled insertions.
  79.  *   - {@link update} : To update the persistent state of an entity.
  80.  *   - {@link delete} : To delete the persistent state of an entity.
  81.  *
  82.  * As can be seen from the above list, insertions are batched and executed all at once
  83.  * for increased efficiency.
  84.  *
  85.  * The querying operations invoked during a UnitOfWork, either through direct find
  86.  * requests or lazy-loading, are the following:
  87.  *
  88.  *   - {@link load} : Loads (the state of) a single, managed entity.
  89.  *   - {@link loadAll} : Loads multiple, managed entities.
  90.  *   - {@link loadOneToOneEntity} : Loads a one/many-to-one entity association (lazy-loading).
  91.  *   - {@link loadOneToManyCollection} : Loads a one-to-many entity association (lazy-loading).
  92.  *   - {@link loadManyToManyCollection} : Loads a many-to-many entity association (lazy-loading).
  93.  *
  94.  * The BasicEntityPersister implementation provides the default behavior for
  95.  * persisting and querying entities that are mapped to a single database table.
  96.  *
  97.  * Subclasses can be created to provide custom persisting and querying strategies,
  98.  * i.e. spanning multiple tables.
  99.  */
  100. class BasicEntityPersister implements EntityPersister
  101. {
  102.     /** @var array<string,string> */
  103.     private static $comparisonMap = [
  104.         Comparison::EQ          => '= %s',
  105.         Comparison::NEQ         => '!= %s',
  106.         Comparison::GT          => '> %s',
  107.         Comparison::GTE         => '>= %s',
  108.         Comparison::LT          => '< %s',
  109.         Comparison::LTE         => '<= %s',
  110.         Comparison::IN          => 'IN (%s)',
  111.         Comparison::NIN         => 'NOT IN (%s)',
  112.         Comparison::CONTAINS    => 'LIKE %s',
  113.         Comparison::STARTS_WITH => 'LIKE %s',
  114.         Comparison::ENDS_WITH   => 'LIKE %s',
  115.     ];
  117.     /**
  118.      * Metadata object that describes the mapping of the mapped entity class.
  119.      *
  120.      * @var ClassMetadata
  121.      */
  122.     protected $class;
  124.     /**
  125.      * The underlying DBAL Connection of the used EntityManager.
  126.      *
  127.      * @var Connection $conn
  128.      */
  129.     protected $conn;
  131.     /**
  132.      * The database platform.
  133.      *
  134.      * @var AbstractPlatform
  135.      */
  136.     protected $platform;
  138.     /**
  139.      * The EntityManager instance.
  140.      *
  141.      * @var EntityManagerInterface
  142.      */
  143.     protected $em;
  145.     /**
  146.      * Queued inserts.
  147.      *
  148.      * @var array
  149.      */
  150.     protected $queuedInserts = [];
  152.     /**
  153.      * The map of column names to DBAL mapping types of all prepared columns used
  154.      * when INSERTing or UPDATEing an entity.
  155.      *
  156.      * @see prepareInsertData($entity)
  157.      * @see prepareUpdateData($entity)
  158.      *
  159.      * @var mixed[]
  160.      */
  161.     protected $columnTypes = [];
  163.     /**
  164.      * The map of quoted column names.
  165.      *
  166.      * @see prepareInsertData($entity)
  167.      * @see prepareUpdateData($entity)
  168.      *
  169.      * @var mixed[]
  170.      */
  171.     protected $quotedColumns = [];
  173.     /**
  174.      * The INSERT SQL statement used for entities handled by this persister.
  175.      * This SQL is only generated once per request, if at all.
  176.      *
  177.      * @var string
  178.      */
  179.     private $insertSql;
  181.     /**
  182.      * The quote strategy.
  183.      *
  184.      * @var QuoteStrategy
  185.      */
  186.     protected $quoteStrategy;
  188.     /**
  189.      * The IdentifierFlattener used for manipulating identifiers
  190.      *
  191.      * @var IdentifierFlattener
  192.      */
  193.     private $identifierFlattener;
  195.     /** @var CachedPersisterContext */
  196.     protected $currentPersisterContext;
  198.     /** @var CachedPersisterContext */
  199.     private $limitsHandlingContext;
  201.     /** @var CachedPersisterContext */
  202.     private $noLimitsContext;
  204.     /**
  205.      * Initializes a new <tt>BasicEntityPersister</tt> that uses the given EntityManager
  206.      * and persists instances of the class described by the given ClassMetadata descriptor.
  207.      */
  208.     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  209.     {
  210.         $this->em                    = $em;
  211.         $this->class                 = $class;
  212.         $this->conn                  = $em->getConnection();
  213.         $this->platform              = $this->conn->getDatabasePlatform();
  214.         $this->quoteStrategy         = $em->getConfiguration()->getQuoteStrategy();
  215.         $this->identifierFlattener   = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
  216.         $this->noLimitsContext       = $this->currentPersisterContext = new CachedPersisterContext(
  217.             $class,
  218.             new Query\ResultSetMapping(),
  219.             false
  220.         );
  221.         $this->limitsHandlingContext = new CachedPersisterContext(
  222.             $class,
  223.             new Query\ResultSetMapping(),
  224.             true
  225.         );
  226.     }
  228.     /**
  229.      * {@inheritdoc}
  230.      */
  231.     public function getClassMetadata()
  232.     {
  233.         return $this->class;
  234.     }
  236.     /**
  237.      * {@inheritdoc}
  238.      */
  239.     public function getResultSetMapping()
  240.     {
  241.         return $this->currentPersisterContext->rsm;
  242.     }
  244.     /**
  245.      * {@inheritdoc}
  246.      */
  247.     public function addInsert($entity)
  248.     {
  249.         $this->queuedInserts[spl_object_hash($entity)] = $entity;
  250.     }
  252.     /**
  253.      * {@inheritdoc}
  254.      */
  255.     public function getInserts()
  256.     {
  257.         return $this->queuedInserts;
  258.     }
  260.     /**
  261.      * {@inheritdoc}
  262.      */
  263.     public function executeInserts()
  264.     {
  265.         if (! $this->queuedInserts) {
  266.             return [];
  267.         }
  269.         $postInsertIds  = [];
  270.         $idGenerator    = $this->class->idGenerator;
  271.         $isPostInsertId = $idGenerator->isPostInsertGenerator();
  273.         $stmt      = $this->conn->prepare($this->getInsertSQL());
  274.         $tableName = $this->class->getTableName();
  276.         foreach ($this->queuedInserts as $entity) {
  277.             $insertData = $this->prepareInsertData($entity);
  279.             if (isset($insertData[$tableName])) {
  280.                 $paramIndex = 1;
  282.                 foreach ($insertData[$tableName] as $column => $value) {
  283.                     $stmt->bindValue($paramIndex++, $value, $this->columnTypes[$column]);
  284.                 }
  285.             }
  287.             $stmt->execute();
  289.             if ($isPostInsertId) {
  290.                 $generatedId     = $idGenerator->generate($this->em, $entity);
  291.                 $id              = [$this->class->identifier[0] => $generatedId];
  292.                 $postInsertIds[] = [
  293.                     'generatedId' => $generatedId,
  294.                     'entity' => $entity,
  295.                 ];
  296.             } else {
  297.                 $id = $this->class->getIdentifierValues($entity);
  298.             }
  300.             if ($this->class->isVersioned) {
  301.                 $this->assignDefaultVersionValue($entity, $id);
  302.             }
  303.         }
  305.         $stmt->closeCursor();
  306.         $this->queuedInserts = [];
  308.         return $postInsertIds;
  309.     }
  311.     /**
  312.      * Retrieves the default version value which was created
  313.      * by the preceding INSERT statement and assigns it back in to the
  314.      * entities version field.
  315.      *
  316.      * @param object $entity
  317.      * @param array  $id
  318.      *
  319.      * @return void
  320.      */
  321.     protected function assignDefaultVersionValue($entity, array $id)
  322.     {
  323.         $value = $this->fetchVersionValue($this->class, $id);
  325.         $this->class->setFieldValue($entity, $this->class->versionField, $value);
  326.     }
  328.     /**
  329.      * Fetches the current version value of a versioned entity.
  330.      *
  331.      * @param ClassMetadata $versionedClass
  332.      * @param mixed[]       $id
  333.      *
  334.      * @return mixed
  335.      */
  336.     protected function fetchVersionValue($versionedClass, array $id)
  337.     {
  338.         $versionField = $versionedClass->versionField;
  339.         $fieldMapping = $versionedClass->fieldMappings[$versionField];
  340.         $tableName    = $this->quoteStrategy->getTableName($versionedClass, $this->platform);
  341.         $identifier   = $this->quoteStrategy->getIdentifierColumnNames($versionedClass, $this->platform);
  342.         $columnName   = $this->quoteStrategy->getColumnName($versionField, $versionedClass, $this->platform);
  344.         // FIXME: Order with composite keys might not be correct
  345.         $sql = 'SELECT ' . $columnName
  346.              . ' FROM ' . $tableName
  347.              . ' WHERE ' . implode(' = ? AND ', $identifier) . ' = ?';
  349.         $flatId = $this->identifierFlattener->flattenIdentifier($versionedClass, $id);
  351.         $value = $this->conn->fetchColumn(
  352.             $sql,
  353.             array_values($flatId),
  354.             0,
  355.             $this->extractIdentifierTypes($id, $versionedClass)
  356.         );
  358.         return Type::getType($fieldMapping['type'])->convertToPHPValue($value, $this->platform);
  359.     }
  361.     /**
  362.      * @return int[]|null[]|string[]
  363.      *
  364.      * @psalm-return list<(int|string|null)>
  365.      */
  366.     private function extractIdentifierTypes(array $id, ClassMetadata $versionedClass): array
  367.     {
  368.         $types = [];
  370.         foreach ($id as $field => $value) {
  371.             $types = array_merge($types, $this->getTypes($field, $value, $versionedClass));
  372.         }
  374.         return $types;
  375.     }
  377.     /**
  378.      * {@inheritdoc}
  379.      */
  380.     public function update($entity)
  381.     {
  382.         $tableName  = $this->class->getTableName();
  383.         $updateData = $this->prepareUpdateData($entity);
  385.         if (! isset($updateData[$tableName])) {
  386.             return;
  387.         }
  389.         $data = $updateData[$tableName];
  391.         if (! $data) {
  392.             return;
  393.         }
  395.         $isVersioned     = $this->class->isVersioned;
  396.         $quotedTableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  398.         $this->updateTable($entity, $quotedTableName, $data, $isVersioned);
  400.         if ($isVersioned) {
  401.             $id = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  403.             $this->assignDefaultVersionValue($entity, $id);
  404.         }
  405.     }
  407.     /**
  408.      * Performs an UPDATE statement for an entity on a specific table.
  409.      * The UPDATE can optionally be versioned, which requires the entity to have a version field.
  410.      *
  411.      * @param object  $entity          The entity object being updated.
  412.      * @param string  $quotedTableName The quoted name of the table to apply the UPDATE on.
  413.      * @param mixed[] $updateData      The map of columns to update (column => value).
  414.      * @param bool    $versioned       Whether the UPDATE should be versioned.
  415.      *
  416.      * @return void
  417.      *
  418.      * @throws ORMException
  419.      * @throws OptimisticLockException
  420.      */
  421.     final protected function updateTable($entity, $quotedTableName, array $updateData, $versioned = false)
  422.     {
  423.         $set    = [];
  424.         $types  = [];
  425.         $params = [];
  427.         foreach ($updateData as $columnName => $value) {
  428.             $placeholder = '?';
  429.             $column      = $columnName;
  431.             switch (true) {
  432.                 case isset($this->class->fieldNames[$columnName]):
  433.                     $fieldName = $this->class->fieldNames[$columnName];
  434.                     $column    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  436.                     if (isset($this->class->fieldMappings[$fieldName]['requireSQLConversion'])) {
  437.                         $type        = Type::getType($this->columnTypes[$columnName]);
  438.                         $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  439.                     }
  441.                     break;
  443.                 case isset($this->quotedColumns[$columnName]):
  444.                     $column = $this->quotedColumns[$columnName];
  446.                     break;
  447.             }
  449.             $params[] = $value;
  450.             $set[]    = $column . ' = ' . $placeholder;
  451.             $types[]  = $this->columnTypes[$columnName];
  452.         }
  454.         $where      = [];
  455.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  457.         foreach ($this->class->identifier as $idField) {
  458.             if (! isset($this->class->associationMappings[$idField])) {
  459.                 $params[] = $identifier[$idField];
  460.                 $types[]  = $this->class->fieldMappings[$idField]['type'];
  461.                 $where[]  = $this->quoteStrategy->getColumnName($idField, $this->class, $this->platform);
  463.                 continue;
  464.             }
  466.             $params[] = $identifier[$idField];
  467.             $where[]  = $this->quoteStrategy->getJoinColumnName(
  468.                 $this->class->associationMappings[$idField]['joinColumns'][0],
  469.                 $this->class,
  470.                 $this->platform
  471.             );
  473.             $targetMapping = $this->em->getClassMetadata($this->class->associationMappings[$idField]['targetEntity']);
  474.             $targetType    = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
  476.             if ($targetType === []) {
  477.                 throw ORMException::unrecognizedField($targetMapping->identifier[0]);
  478.             }
  480.             $types[] = reset($targetType);
  481.         }
  483.         if ($versioned) {
  484.             $versionField     = $this->class->versionField;
  485.             $versionFieldType = $this->class->fieldMappings[$versionField]['type'];
  486.             $versionColumn    = $this->quoteStrategy->getColumnName($versionField, $this->class, $this->platform);
  488.             $where[]  = $versionColumn;
  489.             $types[]  = $this->class->fieldMappings[$versionField]['type'];
  490.             $params[] = $this->class->reflFields[$versionField]->getValue($entity);
  492.             switch ($versionFieldType) {
  493.                 case Type::SMALLINT:
  494.                 case Type::INTEGER:
  495.                 case Type::BIGINT:
  496.                     $set[] = $versionColumn . ' = ' . $versionColumn . ' + 1';
  497.                     break;
  499.                 case Type::DATETIME:
  500.                     $set[] = $versionColumn . ' = CURRENT_TIMESTAMP';
  501.                     break;
  502.             }
  503.         }
  505.         $sql = 'UPDATE ' . $quotedTableName
  506.              . ' SET ' . implode(', ', $set)
  507.              . ' WHERE ' . implode(' = ? AND ', $where) . ' = ?';
  509.         $result = $this->conn->executeUpdate($sql, $params, $types);
  511.         if ($versioned && ! $result) {
  512.             throw OptimisticLockException::lockFailed($entity);
  513.         }
  514.     }
  516.     /**
  517.      * @param array<mixed> $identifier
  518.      * @param string[]     $types
  519.      *
  520.      * @todo Add check for platform if it supports foreign keys/cascading.
  521.      */
  522.     protected function deleteJoinTableRecords(array $identifier, array $types): void
  523.     {
  524.         foreach ($this->class->associationMappings as $mapping) {
  525.             if ($mapping['type'] !== ClassMetadata::MANY_TO_MANY) {
  526.                 continue;
  527.             }
  529.             // @Todo this only covers scenarios with no inheritance or of the same level. Is there something
  530.             // like self-referential relationship between different levels of an inheritance hierarchy? I hope not!
  531.             $selfReferential = ($mapping['targetEntity'] === $mapping['sourceEntity']);
  532.             $class           = $this->class;
  533.             $association     = $mapping;
  534.             $otherColumns    = [];
  535.             $otherKeys       = [];
  536.             $keys            = [];
  538.             if (! $mapping['isOwningSide']) {
  539.                 $class       = $this->em->getClassMetadata($mapping['targetEntity']);
  540.                 $association = $class->associationMappings[$mapping['mappedBy']];
  541.             }
  543.             $joinColumns = $mapping['isOwningSide']
  544.                 ? $association['joinTable']['joinColumns']
  545.                 : $association['joinTable']['inverseJoinColumns'];
  547.             if ($selfReferential) {
  548.                 $otherColumns = ! $mapping['isOwningSide']
  549.                     ? $association['joinTable']['joinColumns']
  550.                     : $association['joinTable']['inverseJoinColumns'];
  551.             }
  553.             foreach ($joinColumns as $joinColumn) {
  554.                 $keys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  555.             }
  557.             foreach ($otherColumns as $joinColumn) {
  558.                 $otherKeys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  559.             }
  561.             if (isset($mapping['isOnDeleteCascade'])) {
  562.                 continue;
  563.             }
  565.             $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  567.             $this->conn->delete($joinTableName, array_combine($keys, $identifier), $types);
  569.             if ($selfReferential) {
  570.                 $this->conn->delete($joinTableName, array_combine($otherKeys, $identifier), $types);
  571.             }
  572.         }
  573.     }
  575.     /**
  576.      * {@inheritdoc}
  577.      */
  578.     public function delete($entity)
  579.     {
  580.         $class      = $this->class;
  581.         $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  582.         $tableName  = $this->quoteStrategy->getTableName($class, $this->platform);
  583.         $idColumns  = $this->quoteStrategy->getIdentifierColumnNames($class, $this->platform);
  584.         $id         = array_combine($idColumns, $identifier);
  585.         $types      = $this->getClassIdentifiersTypes($class);
  587.         $this->deleteJoinTableRecords($identifier, $types);
  589.         return (bool) $this->conn->delete($tableName, $id, $types);
  590.     }
  592.     /**
  593.      * Prepares the changeset of an entity for database insertion (UPDATE).
  594.      *
  595.      * The changeset is obtained from the currently running UnitOfWork.
  596.      *
  597.      * During this preparation the array that is passed as the second parameter is filled with
  598.      * <columnName> => <value> pairs, grouped by table name.
  599.      *
  600.      * Example:
  601.      * <code>
  602.      * array(
  603.      *    'foo_table' => array('column1' => 'value1', 'column2' => 'value2', ...),
  604.      *    'bar_table' => array('columnX' => 'valueX', 'columnY' => 'valueY', ...),
  605.      *    ...
  606.      * )
  607.      * </code>
  608.      *
  609.      * @param object $entity The entity for which to prepare the data.
  610.      *
  611.      * @return mixed[][] The prepared data.
  612.      *
  613.      * @psalm-return array<string, array<array-key, mixed|null>>
  614.      */
  615.     protected function prepareUpdateData($entity)
  616.     {
  617.         $versionField = null;
  618.         $result       = [];
  619.         $uow          = $this->em->getUnitOfWork();
  621.         $versioned = $this->class->isVersioned;
  622.         if ($versioned !== false) {
  623.             $versionField = $this->class->versionField;
  624.         }
  626.         foreach ($uow->getEntityChangeSet($entity) as $field => $change) {
  627.             if (isset($versionField) && $versionField === $field) {
  628.                 continue;
  629.             }
  631.             if (isset($this->class->embeddedClasses[$field])) {
  632.                 continue;
  633.             }
  635.             $newVal = $change[1];
  637.             if (! isset($this->class->associationMappings[$field])) {
  638.                 $fieldMapping = $this->class->fieldMappings[$field];
  639.                 $columnName   = $fieldMapping['columnName'];
  641.                 $this->columnTypes[$columnName] = $fieldMapping['type'];
  643.                 $result[$this->getOwningTable($field)][$columnName] = $newVal;
  645.                 continue;
  646.             }
  648.             $assoc = $this->class->associationMappings[$field];
  650.             // Only owning side of x-1 associations can have a FK column.
  651.             if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
  652.                 continue;
  653.             }
  655.             if ($newVal !== null) {
  656.                 $oid = spl_object_hash($newVal);
  658.                 if (isset($this->queuedInserts[$oid]) || $uow->isScheduledForInsert($newVal)) {
  659.                     // The associated entity $newVal is not yet persisted, so we must
  660.                     // set $newVal = null, in order to insert a null value and schedule an
  661.                     // extra update on the UnitOfWork.
  662.                     $uow->scheduleExtraUpdate($entity, [$field => [null, $newVal]]);
  664.                     $newVal = null;
  665.                 }
  666.             }
  668.             $newValId = null;
  670.             if ($newVal !== null) {
  671.                 $newValId = $uow->getEntityIdentifier($newVal);
  672.             }
  674.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  675.             $owningTable = $this->getOwningTable($field);
  677.             foreach ($assoc['joinColumns'] as $joinColumn) {
  678.                 $sourceColumn = $joinColumn['name'];
  679.                 $targetColumn = $joinColumn['referencedColumnName'];
  680.                 $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  682.                 $this->quotedColumns[$sourceColumn]  = $quotedColumn;
  683.                 $this->columnTypes[$sourceColumn]    = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $this->em);
  684.                 $result[$owningTable][$sourceColumn] = $newValId
  685.                     ? $newValId[$targetClass->getFieldForColumn($targetColumn)]
  686.                     : null;
  687.             }
  688.         }
  690.         return $result;
  691.     }
  693.     /**
  694.      * Prepares the data changeset of a managed entity for database insertion (initial INSERT).
  695.      * The changeset of the entity is obtained from the currently running UnitOfWork.
  696.      *
  697.      * The default insert data preparation is the same as for updates.
  698.      *
  699.      * @see prepareUpdateData
  700.      *
  701.      * @param object $entity The entity for which to prepare the data.
  702.      *
  703.      * @return mixed[][] The prepared data for the tables to update.
  704.      *
  705.      * @psalm-return array<string, mixed[]>
  706.      */
  707.     protected function prepareInsertData($entity)
  708.     {
  709.         return $this->prepareUpdateData($entity);
  710.     }
  712.     /**
  713.      * {@inheritdoc}
  714.      */
  715.     public function getOwningTable($fieldName)
  716.     {
  717.         return $this->class->getTableName();
  718.     }
  720.     /**
  721.      * {@inheritdoc}
  722.      */
  723.     public function load(array $criteria, $entity = null, $assoc = null, array $hints = [], $lockMode = null, $limit = null, ?array $orderBy = null)
  724.     {
  725.         $this->switchPersisterContext(null, $limit);
  727.         $sql              = $this->getSelectSQL($criteria, $assoc, $lockMode, $limit, null, $orderBy);
  728.         [$params, $types] = $this->expandParameters($criteria);
  729.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  731.         if ($entity !== null) {
  732.             $hints[Query::HINT_REFRESH]        = true;
  733.             $hints[Query::HINT_REFRESH_ENTITY] = $entity;
  734.         }
  736.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  737.         $entities = $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, $hints);
  739.         return $entities ? $entities[0] : null;
  740.     }
  742.     /**
  743.      * {@inheritdoc}
  744.      */
  745.     public function loadById(array $identifier, $entity = null)
  746.     {
  747.         return $this->load($identifier, $entity);
  748.     }
  750.     /**
  751.      * {@inheritdoc}
  752.      */
  753.     public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = [])
  754.     {
  755.         $foundEntity = $this->em->getUnitOfWork()->tryGetById($identifier, $assoc['targetEntity']);
  756.         if ($foundEntity !== false) {
  757.             return $foundEntity;
  758.         }
  760.         $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  762.         if ($assoc['isOwningSide']) {
  763.             $isInverseSingleValued = $assoc['inversedBy'] && ! $targetClass->isCollectionValuedAssociation($assoc['inversedBy']);
  765.             // Mark inverse side as fetched in the hints, otherwise the UoW would
  766.             // try to load it in a separate query (remember: to-one inverse sides can not be lazy).
  767.             $hints = [];
  769.             if ($isInverseSingleValued) {
  770.                 $hints['fetched']['r'][$assoc['inversedBy']] = true;
  771.             }
  773.             /* cascade read-only status
  774.             if ($this->em->getUnitOfWork()->isReadOnly($sourceEntity)) {
  775.                 $hints[Query::HINT_READ_ONLY] = true;
  776.             }
  777.             */
  779.             $targetEntity = $this->load($identifier, null, $assoc, $hints);
  781.             // Complete bidirectional association, if necessary
  782.             if ($targetEntity !== null && $isInverseSingleValued) {
  783.                 $targetClass->reflFields[$assoc['inversedBy']]->setValue($targetEntity, $sourceEntity);
  784.             }
  786.             return $targetEntity;
  787.         }
  789.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  790.         $owningAssoc = $targetClass->getAssociationMapping($assoc['mappedBy']);
  792.         $computedIdentifier = [];
  794.         // TRICKY: since the association is specular source and target are flipped
  795.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  796.             if (! isset($sourceClass->fieldNames[$sourceKeyColumn])) {
  797.                 throw MappingException::joinColumnMustPointToMappedField(
  798.                     $sourceClass->name,
  799.                     $sourceKeyColumn
  800.                 );
  801.             }
  803.             $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  804.                 $sourceClass->reflFields[$sourceClass->fieldNames[$sourceKeyColumn]]->getValue($sourceEntity);
  805.         }
  807.         $targetEntity = $this->load($computedIdentifier, null, $assoc);
  809.         if ($targetEntity !== null) {
  810.             $targetClass->setFieldValue($targetEntity, $assoc['mappedBy'], $sourceEntity);
  811.         }
  813.         return $targetEntity;
  814.     }
  816.     /**
  817.      * {@inheritdoc}
  818.      */
  819.     public function refresh(array $id, $entity, $lockMode = null)
  820.     {
  821.         $sql              = $this->getSelectSQL($id, null, $lockMode);
  822.         [$params, $types] = $this->expandParameters($id);
  823.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  825.         $hydrator = $this->em->newHydrator(Query::HYDRATE_OBJECT);
  826.         $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [Query::HINT_REFRESH => true]);
  827.     }
  829.     /**
  830.      * {@inheritDoc}
  831.      */
  832.     public function count($criteria = [])
  833.     {
  834.         $sql = $this->getCountSQL($criteria);
  836.         [$params, $types] = $criteria instanceof Criteria
  837.             ? $this->expandCriteriaParameters($criteria)
  838.             : $this->expandParameters($criteria);
  840.         return (int) $this->conn->executeQuery($sql, $params, $types)->fetchColumn();
  841.     }
  843.     /**
  844.      * {@inheritdoc}
  845.      */
  846.     public function loadCriteria(Criteria $criteria)
  847.     {
  848.         $orderBy = $criteria->getOrderings();
  849.         $limit   = $criteria->getMaxResults();
  850.         $offset  = $criteria->getFirstResult();
  851.         $query   = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  853.         [$params, $types] = $this->expandCriteriaParameters($criteria);
  855.         $stmt     = $this->conn->executeQuery($query, $params, $types);
  856.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  858.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  859.     }
  861.     /**
  862.      * {@inheritdoc}
  863.      */
  864.     public function expandCriteriaParameters(Criteria $criteria)
  865.     {
  866.         $expression = $criteria->getWhereExpression();
  867.         $sqlParams  = [];
  868.         $sqlTypes   = [];
  870.         if ($expression === null) {
  871.             return [$sqlParams, $sqlTypes];
  872.         }
  874.         $valueVisitor = new SqlValueVisitor();
  876.         $valueVisitor->dispatch($expression);
  878.         [$params, $types] = $valueVisitor->getParamsAndTypes();
  880.         foreach ($params as $param) {
  881.             $sqlParams = array_merge($sqlParams, $this->getValues($param));
  882.         }
  884.         foreach ($types as $type) {
  885.             [$field, $value] = $type;
  886.             $sqlTypes        = array_merge($sqlTypes, $this->getTypes($field, $value, $this->class));
  887.         }
  889.         return [$sqlParams, $sqlTypes];
  890.     }
  892.     /**
  893.      * {@inheritdoc}
  894.      */
  895.     public function loadAll(array $criteria = [], ?array $orderBy = null, $limit = null, $offset = null)
  896.     {
  897.         $this->switchPersisterContext($offset, $limit);
  899.         $sql              = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  900.         [$params, $types] = $this->expandParameters($criteria);
  901.         $stmt             = $this->conn->executeQuery($sql, $params, $types);
  903.         $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  905.         return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  906.     }
  908.     /**
  909.      * {@inheritdoc}
  910.      */
  911.     public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  912.     {
  913.         $this->switchPersisterContext($offset, $limit);
  915.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity, $offset, $limit);
  917.         return $this->loadArrayFromStatement($assoc, $stmt);
  918.     }
  920.     /**
  921.      * Loads an array of entities from a given DBAL statement.
  922.      *
  923.      * @param mixed[]   $assoc
  924.      * @param Statement $stmt
  925.      *
  926.      * @return mixed[]
  927.      */
  928.     private function loadArrayFromStatement($assoc, $stmt)
  929.     {
  930.         $rsm   = $this->currentPersisterContext->rsm;
  931.         $hints = [UnitOfWork::HINT_DEFEREAGERLOAD => true];
  933.         if (isset($assoc['indexBy'])) {
  934.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  935.             $rsm->addIndexBy('r', $assoc['indexBy']);
  936.         }
  938.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  939.     }
  941.     /**
  942.      * Hydrates a collection from a given DBAL statement.
  943.      *
  944.      * @param mixed[]              $assoc
  945.      * @param Statement            $stmt
  946.      * @param PersistentCollection $coll
  947.      *
  948.      * @return mixed[]
  949.      */
  950.     private function loadCollectionFromStatement($assoc, $stmt, $coll)
  951.     {
  952.         $rsm   = $this->currentPersisterContext->rsm;
  953.         $hints = [
  954.             UnitOfWork::HINT_DEFEREAGERLOAD => true,
  955.             'collection' => $coll,
  956.         ];
  958.         if (isset($assoc['indexBy'])) {
  959.             $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  960.             $rsm->addIndexBy('r', $assoc['indexBy']);
  961.         }
  963.         return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  964.     }
  966.     /**
  967.      * {@inheritdoc}
  968.      */
  969.     public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  970.     {
  971.         $stmt = $this->getManyToManyStatement($assoc, $sourceEntity);
  973.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  974.     }
  976.     /**
  977.      * @param array    $assoc
  978.      * @param object   $sourceEntity
  979.      * @param int|null $offset
  980.      * @param int|null $limit
  981.      *
  982.      * @return \Doctrine\DBAL\Driver\Statement
  983.      *
  984.      * @throws MappingException
  985.      */
  986.     private function getManyToManyStatement(array $assoc, $sourceEntity, $offset = null, $limit = null)
  987.     {
  988.         $this->switchPersisterContext($offset, $limit);
  990.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  991.         $class       = $sourceClass;
  992.         $association = $assoc;
  993.         $criteria    = [];
  994.         $parameters  = [];
  996.         if (! $assoc['isOwningSide']) {
  997.             $class       = $this->em->getClassMetadata($assoc['targetEntity']);
  998.             $association = $class->associationMappings[$assoc['mappedBy']];
  999.         }
  1001.         $joinColumns = $assoc['isOwningSide']
  1002.             ? $association['joinTable']['joinColumns']
  1003.             : $association['joinTable']['inverseJoinColumns'];
  1005.         $quotedJoinTable = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1007.         foreach ($joinColumns as $joinColumn) {
  1008.             $sourceKeyColumn = $joinColumn['referencedColumnName'];
  1009.             $quotedKeyColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1011.             switch (true) {
  1012.                 case $sourceClass->containsForeignIdentifier:
  1013.                     $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1014.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1016.                     if (isset($sourceClass->associationMappings[$field])) {
  1017.                         $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1018.                         $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1019.                     }
  1021.                     break;
  1023.                 case isset($sourceClass->fieldNames[$sourceKeyColumn]):
  1024.                     $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1025.                     $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1027.                     break;
  1029.                 default:
  1030.                     throw MappingException::joinColumnMustPointToMappedField(
  1031.                         $sourceClass->name,
  1032.                         $sourceKeyColumn
  1033.                     );
  1034.             }
  1036.             $criteria[$quotedJoinTable . '.' . $quotedKeyColumn] = $value;
  1037.             $parameters[]                                        = [
  1038.                 'value' => $value,
  1039.                 'field' => $field,
  1040.                 'class' => $sourceClass,
  1041.             ];
  1042.         }
  1044.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1045.         [$params, $types] = $this->expandToManyParameters($parameters);
  1047.         return $this->conn->executeQuery($sql, $params, $types);
  1048.     }
  1050.     /**
  1051.      * {@inheritdoc}
  1052.      */
  1053.     public function getSelectSQL($criteria, $assoc = null, $lockMode = null, $limit = null, $offset = null, ?array $orderBy = null)
  1054.     {
  1055.         $this->switchPersisterContext($offset, $limit);
  1057.         $lockSql    = '';
  1058.         $joinSql    = '';
  1059.         $orderBySql = '';
  1061.         if ($assoc !== null && $assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  1062.             $joinSql = $this->getSelectManyToManyJoinSQL($assoc);
  1063.         }
  1065.         if (isset($assoc['orderBy'])) {
  1066.             $orderBy = $assoc['orderBy'];
  1067.         }
  1069.         if ($orderBy) {
  1070.             $orderBySql = $this->getOrderBySQL($orderBy, $this->getSQLTableAlias($this->class->name));
  1071.         }
  1073.         $conditionSql = $criteria instanceof Criteria
  1074.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1075.             : $this->getSelectConditionSQL($criteria, $assoc);
  1077.         switch ($lockMode) {
  1078.             case LockMode::PESSIMISTIC_READ:
  1079.                 $lockSql = ' ' . $this->platform->getReadLockSQL();
  1080.                 break;
  1082.             case LockMode::PESSIMISTIC_WRITE:
  1083.                 $lockSql = ' ' . $this->platform->getWriteLockSQL();
  1084.                 break;
  1085.         }
  1087.         $columnList = $this->getSelectColumnsSQL();
  1088.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1089.         $filterSql  = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1090.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1092.         if ($filterSql !== '') {
  1093.             $conditionSql = $conditionSql
  1094.                 ? $conditionSql . ' AND ' . $filterSql
  1095.                 : $filterSql;
  1096.         }
  1098.         $select = 'SELECT ' . $columnList;
  1099.         $from   = ' FROM ' . $tableName . ' ' . $tableAlias;
  1100.         $join   = $this->currentPersisterContext->selectJoinSql . $joinSql;
  1101.         $where  = ($conditionSql ? ' WHERE ' . $conditionSql : '');
  1102.         $lock   = $this->platform->appendLockHint($from, $lockMode);
  1103.         $query  = $select
  1104.             . $lock
  1105.             . $join
  1106.             . $where
  1107.             . $orderBySql;
  1109.         return $this->platform->modifyLimitQuery($query, $limit, $offset) . $lockSql;
  1110.     }
  1112.     /**
  1113.      * {@inheritDoc}
  1114.      */
  1115.     public function getCountSQL($criteria = [])
  1116.     {
  1117.         $tableName  = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1118.         $tableAlias = $this->getSQLTableAlias($this->class->name);
  1120.         $conditionSql = $criteria instanceof Criteria
  1121.             ? $this->getSelectConditionCriteriaSQL($criteria)
  1122.             : $this->getSelectConditionSQL($criteria);
  1124.         $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1126.         if ($filterSql !== '') {
  1127.             $conditionSql = $conditionSql
  1128.                 ? $conditionSql . ' AND ' . $filterSql
  1129.                 : $filterSql;
  1130.         }
  1132.         return 'SELECT COUNT(*) '
  1133.             . 'FROM ' . $tableName . ' ' . $tableAlias
  1134.             . (empty($conditionSql) ? '' : ' WHERE ' . $conditionSql);
  1135.     }
  1137.     /**
  1138.      * Gets the ORDER BY SQL snippet for ordered collections.
  1139.      *
  1140.      * @param array  $orderBy
  1141.      * @param string $baseTableAlias
  1142.      *
  1143.      * @throws ORMException
  1144.      */
  1145.     final protected function getOrderBySQL(array $orderBy, $baseTableAlias): string
  1146.     {
  1147.         $orderByList = [];
  1149.         foreach ($orderBy as $fieldName => $orientation) {
  1150.             $orientation = strtoupper(trim($orientation));
  1152.             if ($orientation !== 'ASC' && $orientation !== 'DESC') {
  1153.                 throw ORMException::invalidOrientation($this->class->name, $fieldName);
  1154.             }
  1156.             if (isset($this->class->fieldMappings[$fieldName])) {
  1157.                 $tableAlias = isset($this->class->fieldMappings[$fieldName]['inherited'])
  1158.                     ? $this->getSQLTableAlias($this->class->fieldMappings[$fieldName]['inherited'])
  1159.                     : $baseTableAlias;
  1161.                 $columnName    = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  1162.                 $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1164.                 continue;
  1165.             }
  1167.             if (isset($this->class->associationMappings[$fieldName])) {
  1168.                 if (! $this->class->associationMappings[$fieldName]['isOwningSide']) {
  1169.                     throw ORMException::invalidFindByInverseAssociation($this->class->name, $fieldName);
  1170.                 }
  1172.                 $tableAlias = isset($this->class->associationMappings[$fieldName]['inherited'])
  1173.                     ? $this->getSQLTableAlias($this->class->associationMappings[$fieldName]['inherited'])
  1174.                     : $baseTableAlias;
  1176.                 foreach ($this->class->associationMappings[$fieldName]['joinColumns'] as $joinColumn) {
  1177.                     $columnName    = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1178.                     $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1179.                 }
  1181.                 continue;
  1182.             }
  1184.             throw ORMException::unrecognizedField($fieldName);
  1185.         }
  1187.         return ' ORDER BY ' . implode(', ', $orderByList);
  1188.     }
  1190.     /**
  1191.      * Gets the SQL fragment with the list of columns to select when querying for
  1192.      * an entity in this persister.
  1193.      *
  1194.      * Subclasses should override this method to alter or change the select column
  1195.      * list SQL fragment. Note that in the implementation of BasicEntityPersister
  1196.      * the resulting SQL fragment is generated only once and cached in {@link selectColumnListSql}.
  1197.      * Subclasses may or may not do the same.
  1198.      *
  1199.      * @return string The SQL fragment.
  1200.      */
  1201.     protected function getSelectColumnsSQL()
  1202.     {
  1203.         if ($this->currentPersisterContext->selectColumnListSql !== null) {
  1204.             return $this->currentPersisterContext->selectColumnListSql;
  1205.         }
  1207.         $columnList = [];
  1208.         $this->currentPersisterContext->rsm->addEntityResult($this->class->name, 'r'); // r for root
  1210.         // Add regular columns to select list
  1211.         foreach ($this->class->fieldNames as $field) {
  1212.             $columnList[] = $this->getSelectColumnSQL($field, $this->class);
  1213.         }
  1215.         $this->currentPersisterContext->selectJoinSql = '';
  1216.         $eagerAliasCounter                            = 0;
  1218.         foreach ($this->class->associationMappings as $assocField => $assoc) {
  1219.             $assocColumnSQL = $this->getSelectColumnAssociationSQL($assocField, $assoc, $this->class);
  1221.             if ($assocColumnSQL) {
  1222.                 $columnList[] = $assocColumnSQL;
  1223.             }
  1225.             $isAssocToOneInverseSide = $assoc['type'] & ClassMetadata::TO_ONE && ! $assoc['isOwningSide'];
  1226.             $isAssocFromOneEager     = $assoc['type'] !== ClassMetadata::MANY_TO_MANY && $assoc['fetch'] === ClassMetadata::FETCH_EAGER;
  1228.             if (! ($isAssocFromOneEager || $isAssocToOneInverseSide)) {
  1229.                 continue;
  1230.             }
  1232.             if ((($assoc['type'] & ClassMetadata::TO_MANY) > 0) && $this->currentPersisterContext->handlesLimits) {
  1233.                 continue;
  1234.             }
  1236.             $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1238.             if ($eagerEntity->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  1239.                 continue; // now this is why you shouldn't use inheritance
  1240.             }
  1242.             $assocAlias = 'e' . ($eagerAliasCounter++);
  1243.             $this->currentPersisterContext->rsm->addJoinedEntityResult($assoc['targetEntity'], $assocAlias, 'r', $assocField);
  1245.             foreach ($eagerEntity->fieldNames as $field) {
  1246.                 $columnList[] = $this->getSelectColumnSQL($field, $eagerEntity, $assocAlias);
  1247.             }
  1249.             foreach ($eagerEntity->associationMappings as $eagerAssocField => $eagerAssoc) {
  1250.                 $eagerAssocColumnSQL = $this->getSelectColumnAssociationSQL(
  1251.                     $eagerAssocField,
  1252.                     $eagerAssoc,
  1253.                     $eagerEntity,
  1254.                     $assocAlias
  1255.                 );
  1257.                 if ($eagerAssocColumnSQL) {
  1258.                     $columnList[] = $eagerAssocColumnSQL;
  1259.                 }
  1260.             }
  1262.             $association   = $assoc;
  1263.             $joinCondition = [];
  1265.             if (isset($assoc['indexBy'])) {
  1266.                 $this->currentPersisterContext->rsm->addIndexBy($assocAlias, $assoc['indexBy']);
  1267.             }
  1269.             if (! $assoc['isOwningSide']) {
  1270.                 $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1271.                 $association = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
  1272.             }
  1274.             $joinTableAlias = $this->getSQLTableAlias($eagerEntity->name, $assocAlias);
  1275.             $joinTableName  = $this->quoteStrategy->getTableName($eagerEntity, $this->platform);
  1277.             if ($assoc['isOwningSide']) {
  1278.                 $tableAlias                                    = $this->getSQLTableAlias($association['targetEntity'], $assocAlias);
  1279.                 $this->currentPersisterContext->selectJoinSql .= ' ' . $this->getJoinSQLForJoinColumns($association['joinColumns']);
  1281.                 foreach ($association['joinColumns'] as $joinColumn) {
  1282.                     $sourceCol       = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1283.                     $targetCol       = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1284.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'])
  1285.                                         . '.' . $sourceCol . ' = ' . $tableAlias . '.' . $targetCol;
  1286.                 }
  1288.                 // Add filter SQL
  1289.                 if ($filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias)) {
  1290.                     $joinCondition[] = $filterSql;
  1291.                 }
  1292.             } else {
  1293.                 $this->currentPersisterContext->selectJoinSql .= ' LEFT JOIN';
  1295.                 foreach ($association['joinColumns'] as $joinColumn) {
  1296.                     $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1297.                     $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1299.                     $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'], $assocAlias) . '.' . $sourceCol . ' = '
  1300.                         . $this->getSQLTableAlias($association['targetEntity']) . '.' . $targetCol;
  1301.                 }
  1302.             }
  1304.             $this->currentPersisterContext->selectJoinSql .= ' ' . $joinTableName . ' ' . $joinTableAlias . ' ON ';
  1305.             $this->currentPersisterContext->selectJoinSql .= implode(' AND ', $joinCondition);
  1306.         }
  1308.         $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  1310.         return $this->currentPersisterContext->selectColumnListSql;
  1311.     }
  1313.     /**
  1314.      * Gets the SQL join fragment used when selecting entities from an association.
  1315.      *
  1316.      * @param string  $field
  1317.      * @param mixed[] $assoc
  1318.      * @param string  $alias
  1319.      *
  1320.      * @return string
  1321.      */
  1322.     protected function getSelectColumnAssociationSQL($field, $assoc, ClassMetadata $class, $alias = 'r')
  1323.     {
  1324.         if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1325.             return '';
  1326.         }
  1328.         $columnList    = [];
  1329.         $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
  1330.         $isIdentifier  = isset($assoc['id']) && $assoc['id'] === true;
  1331.         $sqlTableAlias = $this->getSQLTableAlias($class->name, ($alias === 'r' ? '' : $alias));
  1333.         foreach ($assoc['joinColumns'] as $joinColumn) {
  1334.             $quotedColumn     = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1335.             $resultColumnName = $this->getSQLColumnAlias($joinColumn['name']);
  1336.             $type             = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  1338.             $this->currentPersisterContext->rsm->addMetaResult($alias, $resultColumnName, $joinColumn['name'], $isIdentifier, $type);
  1340.             $columnList[] = sprintf('%s.%s AS %s', $sqlTableAlias, $quotedColumn, $resultColumnName);
  1341.         }
  1343.         return implode(', ', $columnList);
  1344.     }
  1346.     /**
  1347.      * Gets the SQL join fragment used when selecting entities from a
  1348.      * many-to-many association.
  1349.      *
  1350.      * @param array $manyToMany
  1351.      *
  1352.      * @return string
  1353.      */
  1354.     protected function getSelectManyToManyJoinSQL(array $manyToMany)
  1355.     {
  1356.         $conditions       = [];
  1357.         $association      = $manyToMany;
  1358.         $sourceTableAlias = $this->getSQLTableAlias($this->class->name);
  1360.         if (! $manyToMany['isOwningSide']) {
  1361.             $targetEntity = $this->em->getClassMetadata($manyToMany['targetEntity']);
  1362.             $association  = $targetEntity->associationMappings[$manyToMany['mappedBy']];
  1363.         }
  1365.         $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  1366.         $joinColumns   = $manyToMany['isOwningSide']
  1367.             ? $association['joinTable']['inverseJoinColumns']
  1368.             : $association['joinTable']['joinColumns'];
  1370.         foreach ($joinColumns as $joinColumn) {
  1371.             $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1372.             $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1373.             $conditions[]       = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableName . '.' . $quotedSourceColumn;
  1374.         }
  1376.         return ' INNER JOIN ' . $joinTableName . ' ON ' . implode(' AND ', $conditions);
  1377.     }
  1379.     /**
  1380.      * {@inheritdoc}
  1381.      */
  1382.     public function getInsertSQL()
  1383.     {
  1384.         if ($this->insertSql !== null) {
  1385.             return $this->insertSql;
  1386.         }
  1388.         $columns   = $this->getInsertColumnList();
  1389.         $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1391.         if (empty($columns)) {
  1392.             $identityColumn  = $this->quoteStrategy->getColumnName($this->class->identifier[0], $this->class, $this->platform);
  1393.             $this->insertSql = $this->platform->getEmptyIdentityInsertSQL($tableName, $identityColumn);
  1395.             return $this->insertSql;
  1396.         }
  1398.         $values  = [];
  1399.         $columns = array_unique($columns);
  1401.         foreach ($columns as $column) {
  1402.             $placeholder = '?';
  1404.             if (
  1405.                 isset($this->class->fieldNames[$column])
  1406.                 && isset($this->columnTypes[$this->class->fieldNames[$column]])
  1407.                 && isset($this->class->fieldMappings[$this->class->fieldNames[$column]]['requireSQLConversion'])
  1408.             ) {
  1409.                 $type        = Type::getType($this->columnTypes[$this->class->fieldNames[$column]]);
  1410.                 $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  1411.             }
  1413.             $values[] = $placeholder;
  1414.         }
  1416.         $columns = implode(', ', $columns);
  1417.         $values  = implode(', ', $values);
  1419.         $this->insertSql = sprintf('INSERT INTO %s (%s) VALUES (%s)', $tableName, $columns, $values);
  1421.         return $this->insertSql;
  1422.     }
  1424.     /**
  1425.      * Gets the list of columns to put in the INSERT SQL statement.
  1426.      *
  1427.      * Subclasses should override this method to alter or change the list of
  1428.      * columns placed in the INSERT statements used by the persister.
  1429.      *
  1430.      * @return string[] The list of columns.
  1431.      *
  1432.      * @psalm-return list<string>
  1433.      */
  1434.     protected function getInsertColumnList()
  1435.     {
  1436.         $columns = [];
  1438.         foreach ($this->class->reflFields as $name => $field) {
  1439.             if ($this->class->isVersioned && $this->class->versionField === $name) {
  1440.                 continue;
  1441.             }
  1443.             if (isset($this->class->embeddedClasses[$name])) {
  1444.                 continue;
  1445.             }
  1447.             if (isset($this->class->associationMappings[$name])) {
  1448.                 $assoc = $this->class->associationMappings[$name];
  1450.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  1451.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  1452.                         $columns[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1453.                     }
  1454.                 }
  1456.                 continue;
  1457.             }
  1459.             if (! $this->class->isIdGeneratorIdentity() || $this->class->identifier[0] !== $name) {
  1460.                 $columns[]                = $this->quoteStrategy->getColumnName($name, $this->class, $this->platform);
  1461.                 $this->columnTypes[$name] = $this->class->fieldMappings[$name]['type'];
  1462.             }
  1463.         }
  1465.         return $columns;
  1466.     }
  1468.     /**
  1469.      * Gets the SQL snippet of a qualified column name for the given field name.
  1470.      *
  1471.      * @param string        $field The field name.
  1472.      * @param ClassMetadata $class The class that declares this field. The table this class is
  1473.      *                             mapped to must own the column for the given field.
  1474.      * @param string        $alias
  1475.      *
  1476.      * @return string
  1477.      */
  1478.     protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  1479.     {
  1480.         $root         = $alias === 'r' ? '' : $alias;
  1481.         $tableAlias   = $this->getSQLTableAlias($class->name, $root);
  1482.         $fieldMapping = $class->fieldMappings[$field];
  1483.         $sql          = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
  1484.         $columnAlias  = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1486.         $this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
  1488.         if (isset($fieldMapping['requireSQLConversion'])) {
  1489.             $type = Type::getType($fieldMapping['type']);
  1490.             $sql  = $type->convertToPHPValueSQL($sql, $this->platform);
  1491.         }
  1493.         return $sql . ' AS ' . $columnAlias;
  1494.     }
  1496.     /**
  1497.      * Gets the SQL table alias for the given class name.
  1498.      *
  1499.      * @param string $className
  1500.      * @param string $assocName
  1501.      *
  1502.      * @return string The SQL table alias.
  1503.      *
  1504.      * @todo Reconsider. Binding table aliases to class names is not such a good idea.
  1505.      */
  1506.     protected function getSQLTableAlias($className, $assocName = '')
  1507.     {
  1508.         if ($assocName) {
  1509.             $className .= '#' . $assocName;
  1510.         }
  1512.         if (isset($this->currentPersisterContext->sqlTableAliases[$className])) {
  1513.             return $this->currentPersisterContext->sqlTableAliases[$className];
  1514.         }
  1516.         $tableAlias = 't' . $this->currentPersisterContext->sqlAliasCounter++;
  1518.         $this->currentPersisterContext->sqlTableAliases[$className] = $tableAlias;
  1520.         return $tableAlias;
  1521.     }
  1523.     /**
  1524.      * {@inheritdoc}
  1525.      */
  1526.     public function lock(array $criteria, $lockMode)
  1527.     {
  1528.         $lockSql      = '';
  1529.         $conditionSql = $this->getSelectConditionSQL($criteria);
  1531.         switch ($lockMode) {
  1532.             case LockMode::PESSIMISTIC_READ:
  1533.                 $lockSql = $this->platform->getReadLockSQL();
  1535.                 break;
  1536.             case LockMode::PESSIMISTIC_WRITE:
  1537.                 $lockSql = $this->platform->getWriteLockSQL();
  1538.                 break;
  1539.         }
  1541.         $lock  = $this->getLockTablesSql($lockMode);
  1542.         $where = ($conditionSql ? ' WHERE ' . $conditionSql : '') . ' ';
  1543.         $sql   = 'SELECT 1 '
  1544.              . $lock
  1545.              . $where
  1546.              . $lockSql;
  1548.         [$params, $types] = $this->expandParameters($criteria);
  1550.         $this->conn->executeQuery($sql, $params, $types);
  1551.     }
  1553.     /**
  1554.      * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
  1555.      *
  1556.      * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
  1557.      *
  1558.      * @return string
  1559.      */
  1560.     protected function getLockTablesSql($lockMode)
  1561.     {
  1562.         return $this->platform->appendLockHint(
  1563.             'FROM '
  1564.             . $this->quoteStrategy->getTableName($this->class, $this->platform) . ' '
  1565.             . $this->getSQLTableAlias($this->class->name),
  1566.             $lockMode
  1567.         );
  1568.     }
  1570.     /**
  1571.      * Gets the Select Where Condition from a Criteria object.
  1572.      *
  1573.      * @return string
  1574.      */
  1575.     protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  1576.     {
  1577.         $expression = $criteria->getWhereExpression();
  1579.         if ($expression === null) {
  1580.             return '';
  1581.         }
  1583.         $visitor = new SqlExpressionVisitor($this, $this->class);
  1585.         return $visitor->dispatch($expression);
  1586.     }
  1588.     /**
  1589.      * {@inheritdoc}
  1590.      */
  1591.     public function getSelectConditionStatementSQL($field, $value, $assoc = null, $comparison = null)
  1592.     {
  1593.         $selectedColumns = [];
  1594.         $columns         = $this->getSelectConditionStatementColumnSQL($field, $assoc);
  1596.         if (count($columns) > 1 && $comparison === Comparison::IN) {
  1597.             /*
  1598.              *  @todo try to support multi-column IN expressions.
  1599.              *  Example: (col1, col2) IN (('val1A', 'val2A'), ('val1B', 'val2B'))
  1600.              */
  1601.             throw ORMException::cantUseInOperatorOnCompositeKeys();
  1602.         }
  1604.         foreach ($columns as $column) {
  1605.             $placeholder = '?';
  1607.             if (isset($this->class->fieldMappings[$field]['requireSQLConversion'])) {
  1608.                 $type        = Type::getType($this->class->fieldMappings[$field]['type']);
  1609.                 $placeholder = $type->convertToDatabaseValueSQL($placeholder, $this->platform);
  1610.             }
  1612.             if ($comparison !== null) {
  1613.                 // special case null value handling
  1614.                 if (($comparison === Comparison::EQ || $comparison === Comparison::IS) && $value === null) {
  1615.                     $selectedColumns[] = $column . ' IS NULL';
  1617.                     continue;
  1618.                 }
  1620.                 if ($comparison === Comparison::NEQ && $value === null) {
  1621.                     $selectedColumns[] = $column . ' IS NOT NULL';
  1623.                     continue;
  1624.                 }
  1626.                 $selectedColumns[] = $column . ' ' . sprintf(self::$comparisonMap[$comparison], $placeholder);
  1628.                 continue;
  1629.             }
  1631.             if (is_array($value)) {
  1632.                 $in = sprintf('%s IN (%s)', $column, $placeholder);
  1634.                 if (array_search(null, $value, true) !== false) {
  1635.                     $selectedColumns[] = sprintf('(%s OR %s IS NULL)', $in, $column);
  1637.                     continue;
  1638.                 }
  1640.                 $selectedColumns[] = $in;
  1642.                 continue;
  1643.             }
  1645.             if ($value === null) {
  1646.                 $selectedColumns[] = sprintf('%s IS NULL', $column);
  1648.                 continue;
  1649.             }
  1651.             $selectedColumns[] = sprintf('%s = %s', $column, $placeholder);
  1652.         }
  1654.         return implode(' AND ', $selectedColumns);
  1655.     }
  1657.     /**
  1658.      * Builds the left-hand-side of a where condition statement.
  1659.      *
  1660.      * @param string     $field
  1661.      * @param array|null $assoc
  1662.      *
  1663.      * @return string[]
  1664.      *
  1665.      * @throws ORMException
  1666.      *
  1667.      * @psalm-return list<string>
  1668.      */
  1669.     private function getSelectConditionStatementColumnSQL($field, $assoc = null)
  1670.     {
  1671.         if (isset($this->class->fieldMappings[$field])) {
  1672.             $className = $this->class->fieldMappings[$field]['inherited'] ?? $this->class->name;
  1674.             return [$this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getColumnName($field, $this->class, $this->platform)];
  1675.         }
  1677.         if (isset($this->class->associationMappings[$field])) {
  1678.             $association = $this->class->associationMappings[$field];
  1679.             // Many-To-Many requires join table check for joinColumn
  1680.             $columns = [];
  1681.             $class   = $this->class;
  1683.             if ($association['type'] === ClassMetadata::MANY_TO_MANY) {
  1684.                 if (! $association['isOwningSide']) {
  1685.                     $association = $assoc;
  1686.                 }
  1688.                 $joinTableName = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1689.                 $joinColumns   = $assoc['isOwningSide']
  1690.                     ? $association['joinTable']['joinColumns']
  1691.                     : $association['joinTable']['inverseJoinColumns'];
  1693.                 foreach ($joinColumns as $joinColumn) {
  1694.                     $columns[] = $joinTableName . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1695.                 }
  1696.             } else {
  1697.                 if (! $association['isOwningSide']) {
  1698.                     throw ORMException::invalidFindByInverseAssociation($this->class->name, $field);
  1699.                 }
  1701.                 $className = $association['inherited'] ?? $this->class->name;
  1703.                 foreach ($association['joinColumns'] as $joinColumn) {
  1704.                     $columns[] = $this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1705.                 }
  1706.             }
  1708.             return $columns;
  1709.         }
  1711.         if ($assoc !== null && strpos($field, ' ') === false && strpos($field, '(') === false) {
  1712.             // very careless developers could potentially open up this normally hidden api for userland attacks,
  1713.             // therefore checking for spaces and function calls which are not allowed.
  1715.             // found a join column condition, not really a "field"
  1716.             return [$field];
  1717.         }
  1719.         throw ORMException::unrecognizedField($field);
  1720.     }
  1722.     /**
  1723.      * Gets the conditional SQL fragment used in the WHERE clause when selecting
  1724.      * entities in this persister.
  1725.      *
  1726.      * Subclasses are supposed to override this method if they intend to change
  1727.      * or alter the criteria by which entities are selected.
  1728.      *
  1729.      * @param array      $criteria
  1730.      * @param array|null $assoc
  1731.      *
  1732.      * @return string
  1733.      */
  1734.     protected function getSelectConditionSQL(array $criteria, $assoc = null)
  1735.     {
  1736.         $conditions = [];
  1738.         foreach ($criteria as $field => $value) {
  1739.             $conditions[] = $this->getSelectConditionStatementSQL($field, $value, $assoc);
  1740.         }
  1742.         return implode(' AND ', $conditions);
  1743.     }
  1745.     /**
  1746.      * {@inheritdoc}
  1747.      */
  1748.     public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1749.     {
  1750.         $this->switchPersisterContext($offset, $limit);
  1752.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity, $offset, $limit);
  1754.         return $this->loadArrayFromStatement($assoc, $stmt);
  1755.     }
  1757.     /**
  1758.      * {@inheritdoc}
  1759.      */
  1760.     public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1761.     {
  1762.         $stmt = $this->getOneToManyStatement($assoc, $sourceEntity);
  1764.         return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1765.     }
  1767.     /**
  1768.      * Builds criteria and execute SQL statement to fetch the one to many entities from.
  1769.      *
  1770.      * @param array    $assoc
  1771.      * @param object   $sourceEntity
  1772.      * @param int|null $offset
  1773.      * @param int|null $limit
  1774.      *
  1775.      * @return Statement
  1776.      */
  1777.     private function getOneToManyStatement(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1778.     {
  1779.         $this->switchPersisterContext($offset, $limit);
  1781.         $criteria    = [];
  1782.         $parameters  = [];
  1783.         $owningAssoc = $this->class->associationMappings[$assoc['mappedBy']];
  1784.         $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1785.         $tableAlias  = $this->getSQLTableAlias($owningAssoc['inherited'] ?? $this->class->name);
  1787.         foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  1788.             if ($sourceClass->containsForeignIdentifier) {
  1789.                 $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1790.                 $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1792.                 if (isset($sourceClass->associationMappings[$field])) {
  1793.                     $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1794.                     $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1795.                 }
  1797.                 $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1798.                 $parameters[]                                   = [
  1799.                     'value' => $value,
  1800.                     'field' => $field,
  1801.                     'class' => $sourceClass,
  1802.                 ];
  1804.                 continue;
  1805.             }
  1807.             $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1808.             $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1810.             $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1811.             $parameters[]                                   = [
  1812.                 'value' => $value,
  1813.                 'field' => $field,
  1814.                 'class' => $sourceClass,
  1815.             ];
  1816.         }
  1818.         $sql              = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1819.         [$params, $types] = $this->expandToManyParameters($parameters);
  1821.         return $this->conn->executeQuery($sql, $params, $types);
  1822.     }
  1824.     /**
  1825.      * {@inheritdoc}
  1826.      */
  1827.     public function expandParameters($criteria)
  1828.     {
  1829.         $params = [];
  1830.         $types  = [];
  1832.         foreach ($criteria as $field => $value) {
  1833.             if ($value === null) {
  1834.                 continue; // skip null values.
  1835.             }
  1837.             $types  = array_merge($types, $this->getTypes($field, $value, $this->class));
  1838.             $params = array_merge($params, $this->getValues($value));
  1839.         }
  1841.         return [$params, $types];
  1842.     }
  1844.     /**
  1845.      * Expands the parameters from the given criteria and use the correct binding types if found,
  1846.      * specialized for OneToMany or ManyToMany associations.
  1847.      *
  1848.      * @param mixed[][] $criteria an array of arrays containing following:
  1849.      *                             - field to which each criterion will be bound
  1850.      *                             - value to be bound
  1851.      *                             - class to which the field belongs to
  1852.      *
  1853.      * @return mixed[][]
  1854.      *
  1855.      * @psalm-return array{0: array, 1: list<mixed>}
  1856.      */
  1857.     private function expandToManyParameters($criteria)
  1858.     {
  1859.         $params = [];
  1860.         $types  = [];
  1862.         foreach ($criteria as $criterion) {
  1863.             if ($criterion['value'] === null) {
  1864.                 continue; // skip null values.
  1865.             }
  1867.             $types  = array_merge($types, $this->getTypes($criterion['field'], $criterion['value'], $criterion['class']));
  1868.             $params = array_merge($params, $this->getValues($criterion['value']));
  1869.         }
  1871.         return [$params, $types];
  1872.     }
  1874.     /**
  1875.      * Infers field types to be used by parameter type casting.
  1876.      *
  1877.      * @param string $field
  1878.      * @param mixed  $value
  1879.      *
  1880.      * @return int[]|null[]|string[]
  1881.      *
  1882.      * @throws QueryException
  1883.      *
  1884.      * @psalm-return list<(int|string|null)>
  1885.      */
  1886.     private function getTypes($field, $value, ClassMetadata $class)
  1887.     {
  1888.         $types = [];
  1890.         switch (true) {
  1891.             case isset($class->fieldMappings[$field]):
  1892.                 $types = array_merge($types, [$class->fieldMappings[$field]['type']]);
  1893.                 break;
  1895.             case isset($class->associationMappings[$field]):
  1896.                 $assoc = $class->associationMappings[$field];
  1897.                 $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1899.                 if (! $assoc['isOwningSide']) {
  1900.                     $assoc = $class->associationMappings[$assoc['mappedBy']];
  1901.                     $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1902.                 }
  1904.                 $columns = $assoc['type'] === ClassMetadata::MANY_TO_MANY
  1905.                     ? $assoc['relationToTargetKeyColumns']
  1906.                     : $assoc['sourceToTargetKeyColumns'];
  1908.                 foreach ($columns as $column) {
  1909.                     $types[] = PersisterHelper::getTypeOfColumn($column, $class, $this->em);
  1910.                 }
  1912.                 break;
  1914.             default:
  1915.                 $types[] = null;
  1916.                 break;
  1917.         }
  1919.         if (is_array($value)) {
  1920.             return array_map(static function ($type) {
  1921.                 $type = Type::getType($type);
  1923.                 return $type->getBindingType() + Connection::ARRAY_PARAM_OFFSET;
  1924.             }, $types);
  1925.         }
  1927.         return $types;
  1928.     }
  1930.     /**
  1931.      * Retrieves the parameters that identifies a value.
  1932.      *
  1933.      * @param mixed $value
  1934.      *
  1935.      * @return array
  1936.      */
  1937.     private function getValues($value)
  1938.     {
  1939.         if (is_array($value)) {
  1940.             $newValue = [];
  1942.             foreach ($value as $itemValue) {
  1943.                 $newValue = array_merge($newValue, $this->getValues($itemValue));
  1944.             }
  1946.             return [$newValue];
  1947.         }
  1949.         if (is_object($value) && $this->em->getMetadataFactory()->hasMetadataFor(ClassUtils::getClass($value))) {
  1950.             $class = $this->em->getClassMetadata(get_class($value));
  1951.             if ($class->isIdentifierComposite) {
  1952.                 $newValue = [];
  1954.                 foreach ($class->getIdentifierValues($value) as $innerValue) {
  1955.                     $newValue = array_merge($newValue, $this->getValues($innerValue));
  1956.                 }
  1958.                 return $newValue;
  1959.             }
  1960.         }
  1962.         return [$this->getIndividualValue($value)];
  1963.     }
  1965.     /**
  1966.      * Retrieves an individual parameter value.
  1967.      *
  1968.      * @param mixed $value
  1969.      *
  1970.      * @return mixed
  1971.      */
  1972.     private function getIndividualValue($value)
  1973.     {
  1974.         if (! is_object($value) || ! $this->em->getMetadataFactory()->hasMetadataFor(ClassUtils::getClass($value))) {
  1975.             return $value;
  1976.         }
  1978.         return $this->em->getUnitOfWork()->getSingleIdentifierValue($value);
  1979.     }
  1981.     /**
  1982.      * {@inheritdoc}
  1983.      */
  1984.     public function exists($entity, ?Criteria $extraConditions = null)
  1985.     {
  1986.         $criteria = $this->class->getIdentifierValues($entity);
  1988.         if (! $criteria) {
  1989.             return false;
  1990.         }
  1992.         $alias = $this->getSQLTableAlias($this->class->name);
  1994.         $sql = 'SELECT 1 '
  1995.              . $this->getLockTablesSql(null)
  1996.              . ' WHERE ' . $this->getSelectConditionSQL($criteria);
  1998.         [$params, $types] = $this->expandParameters($criteria);
  2000.         if ($extraConditions !== null) {
  2001.             $sql                             .= ' AND ' . $this->getSelectConditionCriteriaSQL($extraConditions);
  2002.             [$criteriaParams, $criteriaTypes] = $this->expandCriteriaParameters($extraConditions);
  2004.             $params = array_merge($params, $criteriaParams);
  2005.             $types  = array_merge($types, $criteriaTypes);
  2006.         }
  2008.         if ($filterSql = $this->generateFilterConditionSQL($this->class, $alias)) {
  2009.             $sql .= ' AND ' . $filterSql;
  2010.         }
  2012.         return (bool) $this->conn->fetchColumn($sql, $params, 0, $types);
  2013.     }
  2015.     /**
  2016.      * Generates the appropriate join SQL for the given join column.
  2017.      *
  2018.      * @param array $joinColumns The join columns definition of an association.
  2019.      *
  2020.      * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise.
  2021.      */
  2022.     protected function getJoinSQLForJoinColumns($joinColumns)
  2023.     {
  2024.         // if one of the join columns is nullable, return left join
  2025.         foreach ($joinColumns as $joinColumn) {
  2026.             if (! isset($joinColumn['nullable']) || $joinColumn['nullable']) {
  2027.                 return 'LEFT JOIN';
  2028.             }
  2029.         }
  2031.         return 'INNER JOIN';
  2032.     }
  2034.     /**
  2035.      * @param string $columnName
  2036.      *
  2037.      * @return string
  2038.      */
  2039.     public function getSQLColumnAlias($columnName)
  2040.     {
  2041.         return $this->quoteStrategy->getColumnAlias($columnName, $this->currentPersisterContext->sqlAliasCounter++, $this->platform);
  2042.     }
  2044.     /**
  2045.      * Generates the filter SQL for a given entity and table alias.
  2046.      *
  2047.      * @param ClassMetadata $targetEntity     Metadata of the target entity.
  2048.      * @param string        $targetTableAlias The table alias of the joined/selected table.
  2049.      *
  2050.      * @return string The SQL query part to add to a query.
  2051.      */
  2052.     protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  2053.     {
  2054.         $filterClauses = [];
  2056.         foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  2057.             if ('' !== $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias)) {
  2058.                 $filterClauses[] = '(' . $filterExpr . ')';
  2059.             }
  2060.         }
  2062.         $sql = implode(' AND ', $filterClauses);
  2064.         return $sql ? '(' . $sql . ')' : ''; // Wrap again to avoid "X or Y and FilterConditionSQL"
  2065.     }
  2067.     /**
  2068.      * Switches persister context according to current query offset/limits
  2069.      *
  2070.      * This is due to the fact that to-many associations cannot be fetch-joined when a limit is involved
  2071.      *
  2072.      * @param int|null $offset
  2073.      * @param int|null $limit
  2074.      */
  2075.     protected function switchPersisterContext($offset, $limit)
  2076.     {
  2077.         if ($offset === null && $limit === null) {
  2078.             $this->currentPersisterContext = $this->noLimitsContext;
  2080.             return;
  2081.         }
  2083.         $this->currentPersisterContext = $this->limitsHandlingContext;
  2084.     }
  2086.     /**
  2087.      * @return string[]
  2088.      */
  2089.     protected function getClassIdentifiersTypes(ClassMetadata $class): array
  2090.     {
  2091.         $entityManager = $this->em;
  2093.         return array_map(
  2094.             static function ($fieldName) use ($class, $entityManager): string {
  2095.                 $types = PersisterHelper::getTypeOfField($fieldName, $class, $entityManager);
  2096.                 assert(isset($types[0]));
  2098.                 return $types[0];
  2099.             },
  2100.             $class->identifier
  2101.         );
  2102.     }
  2103. }