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

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. * @psalm-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. * @psalm-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. /**
  203. * Initializes a new <tt>BasicEntityPersister</tt> that uses the given EntityManager
  204. * and persists instances of the class described by the given ClassMetadata descriptor.
  205. */
  206. public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  207. {
  208. $this->em = $em;
  209. $this->class = $class;
  210. $this->conn = $em->getConnection();
  211. $this->platform = $this->conn->getDatabasePlatform();
  212. $this->quoteStrategy = $em->getConfiguration()->getQuoteStrategy();
  213. $this->identifierFlattener = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
  214. $this->noLimitsContext = $this->currentPersisterContext = new CachedPersisterContext(
  215. $class,
  216. new Query\ResultSetMapping(),
  217. false
  218. );
  219. $this->limitsHandlingContext = new CachedPersisterContext(
  220. $class,
  221. new Query\ResultSetMapping(),
  222. true
  223. );
  224. }
  226. /**
  227. * {@inheritDoc}
  228. */
  229. public function getClassMetadata()
  230. {
  231. return $this->class;
  232. }
  234. /**
  235. * {@inheritDoc}
  236. */
  237. public function getResultSetMapping()
  238. {
  239. return $this->currentPersisterContext->rsm;
  240. }
  242. /**
  243. * {@inheritDoc}
  244. */
  245. public function addInsert($entity)
  246. {
  247. $this->queuedInserts[spl_object_id($entity)] = $entity;
  248. }
  250. /**
  251. * {@inheritDoc}
  252. */
  253. public function getInserts()
  254. {
  255. return $this->queuedInserts;
  256. }
  258. /**
  259. * {@inheritDoc}
  260. */
  261. public function executeInserts()
  262. {
  263. if (! $this->queuedInserts) {
  264. return;
  265. }
  267. $uow = $this->em->getUnitOfWork();
  268. $idGenerator = $this->class->idGenerator;
  269. $isPostInsertId = $idGenerator->isPostInsertGenerator();
  271. $stmt = $this->conn->prepare($this->getInsertSQL());
  272. $tableName = $this->class->getTableName();
  274. foreach ($this->queuedInserts as $key => $entity) {
  275. $insertData = $this->prepareInsertData($entity);
  277. if (isset($insertData[$tableName])) {
  278. $paramIndex = 1;
  280. foreach ($insertData[$tableName] as $column => $value) {
  281. $stmt->bindValue($paramIndex++, $value, $this->columnTypes[$column]);
  282. }
  283. }
  285. $stmt->executeStatement();
  287. if ($isPostInsertId) {
  288. $generatedId = $idGenerator->generateId($this->em, $entity);
  289. $id = [$this->class->identifier[0] => $generatedId];
  291. $uow->assignPostInsertId($entity, $generatedId);
  292. } else {
  293. $id = $this->class->getIdentifierValues($entity);
  294. }
  296. if ($this->class->requiresFetchAfterChange) {
  297. $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  298. }
  300. // Unset this queued insert, so that the prepareUpdateData() method knows right away
  301. // (for the next entity already) that the current entity has been written to the database
  302. // and no extra updates need to be scheduled to refer to it.
  303. //
  304. // In \Doctrine\ORM\UnitOfWork::executeInserts(), the UoW already removed entities
  305. // from its own list (\Doctrine\ORM\UnitOfWork::$entityInsertions) right after they
  306. // were given to our addInsert() method.
  307. unset($this->queuedInserts[$key]);
  308. }
  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 if the given entity is versioned.
  315. * Also retrieves values of columns marked as 'non insertable' and / or
  316. * 'not updatable' and assigns them back to the entities corresponding fields.
  317. *
  318. * @param object $entity
  319. * @param mixed[] $id
  320. *
  321. * @return void
  322. */
  323. protected function assignDefaultVersionAndUpsertableValues($entity, array $id)
  324. {
  325. $values = $this->fetchVersionAndNotUpsertableValues($this->class, $id);
  327. foreach ($values as $field => $value) {
  328. $value = Type::getType($this->class->fieldMappings[$field]['type'])->convertToPHPValue($value, $this->platform);
  330. $this->class->setFieldValue($entity, $field, $value);
  331. }
  332. }
  334. /**
  335. * Fetches the current version value of a versioned entity and / or the values of fields
  336. * marked as 'not insertable' and / or 'not updatable'.
  337. *
  338. * @param ClassMetadata $versionedClass
  339. * @param mixed[] $id
  340. *
  341. * @return mixed
  342. */
  343. protected function fetchVersionAndNotUpsertableValues($versionedClass, array $id)
  344. {
  345. $columnNames = [];
  346. foreach ($this->class->fieldMappings as $key => $column) {
  347. if (isset($column['generated']) || ($this->class->isVersioned && $key === $versionedClass->versionField)) {
  348. $columnNames[$key] = $this->quoteStrategy->getColumnName($key, $versionedClass, $this->platform);
  349. }
  350. }
  352. $tableName = $this->quoteStrategy->getTableName($versionedClass, $this->platform);
  353. $identifier = $this->quoteStrategy->getIdentifierColumnNames($versionedClass, $this->platform);
  355. // FIXME: Order with composite keys might not be correct
  356. $sql = 'SELECT ' . implode(', ', $columnNames)
  357. . ' FROM ' . $tableName
  358. . ' WHERE ' . implode(' = ? AND ', $identifier) . ' = ?';
  360. $flatId = $this->identifierFlattener->flattenIdentifier($versionedClass, $id);
  362. $values = $this->conn->fetchNumeric(
  363. $sql,
  364. array_values($flatId),
  365. $this->extractIdentifierTypes($id, $versionedClass)
  366. );
  368. if ($values === false) {
  369. throw new LengthException('Unexpected empty result for database query.');
  370. }
  372. $values = array_combine(array_keys($columnNames), $values);
  374. if (! $values) {
  375. throw new LengthException('Unexpected number of database columns.');
  376. }
  378. return $values;
  379. }
  381. /**
  382. * @param mixed[] $id
  383. *
  384. * @return int[]|null[]|string[]
  385. * @psalm-return list<int|string|null>
  386. */
  387. final protected function extractIdentifierTypes(array $id, ClassMetadata $versionedClass): array
  388. {
  389. $types = [];
  391. foreach ($id as $field => $value) {
  392. $types = array_merge($types, $this->getTypes($field, $value, $versionedClass));
  393. }
  395. return $types;
  396. }
  398. /**
  399. * {@inheritDoc}
  400. */
  401. public function update($entity)
  402. {
  403. $tableName = $this->class->getTableName();
  404. $updateData = $this->prepareUpdateData($entity);
  406. if (! isset($updateData[$tableName])) {
  407. return;
  408. }
  410. $data = $updateData[$tableName];
  412. if (! $data) {
  413. return;
  414. }
  416. $isVersioned = $this->class->isVersioned;
  417. $quotedTableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  419. $this->updateTable($entity, $quotedTableName, $data, $isVersioned);
  421. if ($this->class->requiresFetchAfterChange) {
  422. $id = $this->class->getIdentifierValues($entity);
  424. $this->assignDefaultVersionAndUpsertableValues($entity, $id);
  425. }
  426. }
  428. /**
  429. * Performs an UPDATE statement for an entity on a specific table.
  430. * The UPDATE can optionally be versioned, which requires the entity to have a version field.
  431. *
  432. * @param object $entity The entity object being updated.
  433. * @param string $quotedTableName The quoted name of the table to apply the UPDATE on.
  434. * @param mixed[] $updateData The map of columns to update (column => value).
  435. * @param bool $versioned Whether the UPDATE should be versioned.
  436. *
  437. * @throws UnrecognizedField
  438. * @throws OptimisticLockException
  439. */
  440. final protected function updateTable(
  441. $entity,
  442. $quotedTableName,
  443. array $updateData,
  444. $versioned = false
  445. ): void {
  446. $set = [];
  447. $types = [];
  448. $params = [];
  450. foreach ($updateData as $columnName => $value) {
  451. $placeholder = '?';
  452. $column = $columnName;
  454. switch (true) {
  455. case isset($this->class->fieldNames[$columnName]):
  456. $fieldName = $this->class->fieldNames[$columnName];
  457. $column = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  459. if (isset($this->class->fieldMappings[$fieldName]['requireSQLConversion'])) {
  460. $type = Type::getType($this->columnTypes[$columnName]);
  461. $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  462. }
  464. break;
  466. case isset($this->quotedColumns[$columnName]):
  467. $column = $this->quotedColumns[$columnName];
  469. break;
  470. }
  472. $params[] = $value;
  473. $set[] = $column . ' = ' . $placeholder;
  474. $types[] = $this->columnTypes[$columnName];
  475. }
  477. $where = [];
  478. $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  480. foreach ($this->class->identifier as $idField) {
  481. if (! isset($this->class->associationMappings[$idField])) {
  482. $params[] = $identifier[$idField];
  483. $types[] = $this->class->fieldMappings[$idField]['type'];
  484. $where[] = $this->quoteStrategy->getColumnName($idField, $this->class, $this->platform);
  486. continue;
  487. }
  489. $params[] = $identifier[$idField];
  490. $where[] = $this->quoteStrategy->getJoinColumnName(
  491. $this->class->associationMappings[$idField]['joinColumns'][0],
  492. $this->class,
  493. $this->platform
  494. );
  496. $targetMapping = $this->em->getClassMetadata($this->class->associationMappings[$idField]['targetEntity']);
  497. $targetType = PersisterHelper::getTypeOfField($targetMapping->identifier[0], $targetMapping, $this->em);
  499. if ($targetType === []) {
  500. throw UnrecognizedField::byFullyQualifiedName($this->class->name, $targetMapping->identifier[0]);
  501. }
  503. $types[] = reset($targetType);
  504. }
  506. if ($versioned) {
  507. $versionField = $this->class->versionField;
  508. assert($versionField !== null);
  509. $versionFieldType = $this->class->fieldMappings[$versionField]['type'];
  510. $versionColumn = $this->quoteStrategy->getColumnName($versionField, $this->class, $this->platform);
  512. $where[] = $versionColumn;
  513. $types[] = $this->class->fieldMappings[$versionField]['type'];
  514. $params[] = $this->class->reflFields[$versionField]->getValue($entity);
  516. switch ($versionFieldType) {
  517. case Types::SMALLINT:
  518. case Types::INTEGER:
  519. case Types::BIGINT:
  520. $set[] = $versionColumn . ' = ' . $versionColumn . ' + 1';
  521. break;
  523. case Types::DATETIME_MUTABLE:
  524. $set[] = $versionColumn . ' = CURRENT_TIMESTAMP';
  525. break;
  526. }
  527. }
  529. $sql = 'UPDATE ' . $quotedTableName
  530. . ' SET ' . implode(', ', $set)
  531. . ' WHERE ' . implode(' = ? AND ', $where) . ' = ?';
  533. $result = $this->conn->executeStatement($sql, $params, $types);
  535. if ($versioned && ! $result) {
  536. throw OptimisticLockException::lockFailed($entity);
  537. }
  538. }
  540. /**
  541. * @param array<mixed> $identifier
  542. * @param string[] $types
  543. *
  544. * @todo Add check for platform if it supports foreign keys/cascading.
  545. */
  546. protected function deleteJoinTableRecords(array $identifier, array $types): void
  547. {
  548. foreach ($this->class->associationMappings as $mapping) {
  549. if ($mapping['type'] !== ClassMetadata::MANY_TO_MANY || isset($mapping['isOnDeleteCascade'])) {
  550. continue;
  551. }
  553. // @Todo this only covers scenarios with no inheritance or of the same level. Is there something
  554. // like self-referential relationship between different levels of an inheritance hierarchy? I hope not!
  555. $selfReferential = ($mapping['targetEntity'] === $mapping['sourceEntity']);
  556. $class = $this->class;
  557. $association = $mapping;
  558. $otherColumns = [];
  559. $otherKeys = [];
  560. $keys = [];
  562. if (! $mapping['isOwningSide']) {
  563. $class = $this->em->getClassMetadata($mapping['targetEntity']);
  564. $association = $class->associationMappings[$mapping['mappedBy']];
  565. }
  567. $joinColumns = $mapping['isOwningSide']
  568. ? $association['joinTable']['joinColumns']
  569. : $association['joinTable']['inverseJoinColumns'];
  571. if ($selfReferential) {
  572. $otherColumns = ! $mapping['isOwningSide']
  573. ? $association['joinTable']['joinColumns']
  574. : $association['joinTable']['inverseJoinColumns'];
  575. }
  577. foreach ($joinColumns as $joinColumn) {
  578. $keys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  579. }
  581. foreach ($otherColumns as $joinColumn) {
  582. $otherKeys[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  583. }
  585. $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  587. $this->conn->delete($joinTableName, array_combine($keys, $identifier), $types);
  589. if ($selfReferential) {
  590. $this->conn->delete($joinTableName, array_combine($otherKeys, $identifier), $types);
  591. }
  592. }
  593. }
  595. /**
  596. * {@inheritDoc}
  597. */
  598. public function delete($entity)
  599. {
  600. $class = $this->class;
  601. $identifier = $this->em->getUnitOfWork()->getEntityIdentifier($entity);
  602. $tableName = $this->quoteStrategy->getTableName($class, $this->platform);
  603. $idColumns = $this->quoteStrategy->getIdentifierColumnNames($class, $this->platform);
  604. $id = array_combine($idColumns, $identifier);
  605. $types = $this->getClassIdentifiersTypes($class);
  607. $this->deleteJoinTableRecords($identifier, $types);
  609. return (bool) $this->conn->delete($tableName, $id, $types);
  610. }
  612. /**
  613. * Prepares the changeset of an entity for database insertion (UPDATE).
  614. *
  615. * The changeset is obtained from the currently running UnitOfWork.
  616. *
  617. * During this preparation the array that is passed as the second parameter is filled with
  618. * <columnName> => <value> pairs, grouped by table name.
  619. *
  620. * Example:
  621. * <code>
  622. * array(
  623. * 'foo_table' => array('column1' => 'value1', 'column2' => 'value2', ...),
  624. * 'bar_table' => array('columnX' => 'valueX', 'columnY' => 'valueY', ...),
  625. * ...
  626. * )
  627. * </code>
  628. *
  629. * @param object $entity The entity for which to prepare the data.
  630. * @param bool $isInsert Whether the data to be prepared refers to an insert statement.
  631. *
  632. * @return mixed[][] The prepared data.
  633. * @psalm-return array<string, array<array-key, mixed|null>>
  634. */
  635. protected function prepareUpdateData($entity, bool $isInsert = false)
  636. {
  637. $versionField = null;
  638. $result = [];
  639. $uow = $this->em->getUnitOfWork();
  641. $versioned = $this->class->isVersioned;
  642. if ($versioned !== false) {
  643. $versionField = $this->class->versionField;
  644. }
  646. foreach ($uow->getEntityChangeSet($entity) as $field => $change) {
  647. if (isset($versionField) && $versionField === $field) {
  648. continue;
  649. }
  651. if (isset($this->class->embeddedClasses[$field])) {
  652. continue;
  653. }
  655. $newVal = $change[1];
  657. if (! isset($this->class->associationMappings[$field])) {
  658. $fieldMapping = $this->class->fieldMappings[$field];
  659. $columnName = $fieldMapping['columnName'];
  661. if (! $isInsert && isset($fieldMapping['notUpdatable'])) {
  662. continue;
  663. }
  665. if ($isInsert && isset($fieldMapping['notInsertable'])) {
  666. continue;
  667. }
  669. $this->columnTypes[$columnName] = $fieldMapping['type'];
  671. $result[$this->getOwningTable($field)][$columnName] = $newVal;
  673. continue;
  674. }
  676. $assoc = $this->class->associationMappings[$field];
  678. // Only owning side of x-1 associations can have a FK column.
  679. if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
  680. continue;
  681. }
  683. if ($newVal !== null) {
  684. $oid = spl_object_id($newVal);
  686. // If the associated entity $newVal is not yet persisted and/or does not yet have
  687. // an ID assigned, we must set $newVal = null. This will insert a null value and
  688. // schedule an extra update on the UnitOfWork.
  689. //
  690. // This gives us extra time to a) possibly obtain a database-generated identifier
  691. // value for $newVal, and b) insert $newVal into the database before the foreign
  692. // key reference is being made.
  693. //
  694. // When looking at $this->queuedInserts and $uow->isScheduledForInsert, be aware
  695. // of the implementation details that our own executeInserts() method will remove
  696. // entities from the former as soon as the insert statement has been executed and
  697. // a post-insert ID has been assigned (if necessary), and that the UnitOfWork has
  698. // already removed entities from its own list at the time they were passed to our
  699. // addInsert() method.
  700. //
  701. // Then, there is one extra exception we can make: An entity that references back to itself
  702. // _and_ uses an application-provided ID (the "NONE" generator strategy) also does not
  703. // need the extra update, although it is still in the list of insertions itself.
  704. // This looks like a minor optimization at first, but is the capstone for being able to
  705. // use non-NULLable, self-referencing associations in applications that provide IDs (like UUIDs).
  706. if (
  707. (isset($this->queuedInserts[$oid]) || $uow->isScheduledForInsert($newVal))
  708. && ! ($newVal === $entity && $this->class->isIdentifierNatural())
  709. ) {
  710. $uow->scheduleExtraUpdate($entity, [$field => [null, $newVal]]);
  712. $newVal = null;
  713. }
  714. }
  716. $newValId = null;
  718. if ($newVal !== null) {
  719. $newValId = $uow->getEntityIdentifier($newVal);
  720. }
  722. $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  723. $owningTable = $this->getOwningTable($field);
  725. foreach ($assoc['joinColumns'] as $joinColumn) {
  726. $sourceColumn = $joinColumn['name'];
  727. $targetColumn = $joinColumn['referencedColumnName'];
  728. $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  730. $this->quotedColumns[$sourceColumn] = $quotedColumn;
  731. $this->columnTypes[$sourceColumn] = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $this->em);
  732. $result[$owningTable][$sourceColumn] = $newValId
  733. ? $newValId[$targetClass->getFieldForColumn($targetColumn)]
  734. : null;
  735. }
  736. }
  738. return $result;
  739. }
  741. /**
  742. * Prepares the data changeset of a managed entity for database insertion (initial INSERT).
  743. * The changeset of the entity is obtained from the currently running UnitOfWork.
  744. *
  745. * The default insert data preparation is the same as for updates.
  746. *
  747. * @see prepareUpdateData
  748. *
  749. * @param object $entity The entity for which to prepare the data.
  750. *
  751. * @return mixed[][] The prepared data for the tables to update.
  752. * @psalm-return array<string, mixed[]>
  753. */
  754. protected function prepareInsertData($entity)
  755. {
  756. return $this->prepareUpdateData($entity, true);
  757. }
  759. /**
  760. * {@inheritDoc}
  761. */
  762. public function getOwningTable($fieldName)
  763. {
  764. return $this->class->getTableName();
  765. }
  767. /**
  768. * {@inheritDoc}
  769. */
  770. public function load(array $criteria, $entity = null, $assoc = null, array $hints = [], $lockMode = null, $limit = null, ?array $orderBy = null)
  771. {
  772. $this->switchPersisterContext(null, $limit);
  774. $sql = $this->getSelectSQL($criteria, $assoc, $lockMode, $limit, null, $orderBy);
  775. [$params, $types] = $this->expandParameters($criteria);
  776. $stmt = $this->conn->executeQuery($sql, $params, $types);
  778. if ($entity !== null) {
  779. $hints[Query::HINT_REFRESH] = true;
  780. $hints[Query::HINT_REFRESH_ENTITY] = $entity;
  781. }
  783. $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  784. $entities = $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, $hints);
  786. return $entities ? $entities[0] : null;
  787. }
  789. /**
  790. * {@inheritDoc}
  791. */
  792. public function loadById(array $identifier, $entity = null)
  793. {
  794. return $this->load($identifier, $entity);
  795. }
  797. /**
  798. * {@inheritDoc}
  799. */
  800. public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = [])
  801. {
  802. $foundEntity = $this->em->getUnitOfWork()->tryGetById($identifier, $assoc['targetEntity']);
  803. if ($foundEntity !== false) {
  804. return $foundEntity;
  805. }
  807. $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  809. if ($assoc['isOwningSide']) {
  810. $isInverseSingleValued = $assoc['inversedBy'] && ! $targetClass->isCollectionValuedAssociation($assoc['inversedBy']);
  812. // Mark inverse side as fetched in the hints, otherwise the UoW would
  813. // try to load it in a separate query (remember: to-one inverse sides can not be lazy).
  814. $hints = [];
  816. if ($isInverseSingleValued) {
  817. $hints['fetched']['r'][$assoc['inversedBy']] = true;
  818. }
  820. $targetEntity = $this->load($identifier, null, $assoc, $hints);
  822. // Complete bidirectional association, if necessary
  823. if ($targetEntity !== null && $isInverseSingleValued) {
  824. $targetClass->reflFields[$assoc['inversedBy']]->setValue($targetEntity, $sourceEntity);
  825. }
  827. return $targetEntity;
  828. }
  830. $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  831. $owningAssoc = $targetClass->getAssociationMapping($assoc['mappedBy']);
  833. $computedIdentifier = [];
  835. /** @var array<string,mixed>|null $sourceEntityData */
  836. $sourceEntityData = null;
  838. // TRICKY: since the association is specular source and target are flipped
  839. foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  840. if (! isset($sourceClass->fieldNames[$sourceKeyColumn])) {
  841. // The likely case here is that the column is a join column
  842. // in an association mapping. However, there is no guarantee
  843. // at this point that a corresponding (generally identifying)
  844. // association has been mapped in the source entity. To handle
  845. // this case we directly reference the column-keyed data used
  846. // to initialize the source entity before throwing an exception.
  847. $resolvedSourceData = false;
  848. if (! isset($sourceEntityData)) {
  849. $sourceEntityData = $this->em->getUnitOfWork()->getOriginalEntityData($sourceEntity);
  850. }
  852. if (isset($sourceEntityData[$sourceKeyColumn])) {
  853. $dataValue = $sourceEntityData[$sourceKeyColumn];
  854. if ($dataValue !== null) {
  855. $resolvedSourceData = true;
  856. $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  857. $dataValue;
  858. }
  859. }
  861. if (! $resolvedSourceData) {
  862. throw MappingException::joinColumnMustPointToMappedField(
  863. $sourceClass->name,
  864. $sourceKeyColumn
  865. );
  866. }
  867. } else {
  868. $computedIdentifier[$targetClass->getFieldForColumn($targetKeyColumn)] =
  869. $sourceClass->reflFields[$sourceClass->fieldNames[$sourceKeyColumn]]->getValue($sourceEntity);
  870. }
  871. }
  873. $targetEntity = $this->load($computedIdentifier, null, $assoc);
  875. if ($targetEntity !== null) {
  876. $targetClass->setFieldValue($targetEntity, $assoc['mappedBy'], $sourceEntity);
  877. }
  879. return $targetEntity;
  880. }
  882. /**
  883. * {@inheritDoc}
  884. */
  885. public function refresh(array $id, $entity, $lockMode = null)
  886. {
  887. $sql = $this->getSelectSQL($id, null, $lockMode);
  888. [$params, $types] = $this->expandParameters($id);
  889. $stmt = $this->conn->executeQuery($sql, $params, $types);
  891. $hydrator = $this->em->newHydrator(Query::HYDRATE_OBJECT);
  892. $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [Query::HINT_REFRESH => true]);
  893. }
  895. /**
  896. * {@inheritDoc}
  897. */
  898. public function count($criteria = [])
  899. {
  900. $sql = $this->getCountSQL($criteria);
  902. [$params, $types] = $criteria instanceof Criteria
  903. ? $this->expandCriteriaParameters($criteria)
  904. : $this->expandParameters($criteria);
  906. return (int) $this->conn->executeQuery($sql, $params, $types)->fetchOne();
  907. }
  909. /**
  910. * {@inheritDoc}
  911. */
  912. public function loadCriteria(Criteria $criteria)
  913. {
  914. $orderBy = self::getCriteriaOrderings($criteria);
  915. $limit = $criteria->getMaxResults();
  916. $offset = $criteria->getFirstResult();
  917. $query = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  919. [$params, $types] = $this->expandCriteriaParameters($criteria);
  921. $stmt = $this->conn->executeQuery($query, $params, $types);
  922. $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  924. return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  925. }
  927. /**
  928. * {@inheritDoc}
  929. */
  930. public function expandCriteriaParameters(Criteria $criteria)
  931. {
  932. $expression = $criteria->getWhereExpression();
  933. $sqlParams = [];
  934. $sqlTypes = [];
  936. if ($expression === null) {
  937. return [$sqlParams, $sqlTypes];
  938. }
  940. $valueVisitor = new SqlValueVisitor();
  942. $valueVisitor->dispatch($expression);
  944. [, $types] = $valueVisitor->getParamsAndTypes();
  946. foreach ($types as $type) {
  947. [$field, $value, $operator] = $type;
  949. if ($value === null && ($operator === Comparison::EQ || $operator === Comparison::NEQ)) {
  950. continue;
  951. }
  953. $sqlParams = array_merge($sqlParams, $this->getValues($value));
  954. $sqlTypes = array_merge($sqlTypes, $this->getTypes($field, $value, $this->class));
  955. }
  957. return [$sqlParams, $sqlTypes];
  958. }
  960. /**
  961. * {@inheritDoc}
  962. */
  963. public function loadAll(array $criteria = [], ?array $orderBy = null, $limit = null, $offset = null)
  964. {
  965. $this->switchPersisterContext($offset, $limit);
  967. $sql = $this->getSelectSQL($criteria, null, null, $limit, $offset, $orderBy);
  968. [$params, $types] = $this->expandParameters($criteria);
  969. $stmt = $this->conn->executeQuery($sql, $params, $types);
  971. $hydrator = $this->em->newHydrator($this->currentPersisterContext->selectJoinSql ? Query::HYDRATE_OBJECT : Query::HYDRATE_SIMPLEOBJECT);
  973. return $hydrator->hydrateAll($stmt, $this->currentPersisterContext->rsm, [UnitOfWork::HINT_DEFEREAGERLOAD => true]);
  974. }
  976. /**
  977. * {@inheritDoc}
  978. */
  979. public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  980. {
  981. $this->switchPersisterContext($offset, $limit);
  983. $stmt = $this->getManyToManyStatement($assoc, $sourceEntity, $offset, $limit);
  985. return $this->loadArrayFromResult($assoc, $stmt);
  986. }
  988. /**
  989. * Loads an array of entities from a given DBAL statement.
  990. *
  991. * @param mixed[] $assoc
  992. *
  993. * @return mixed[]
  994. */
  995. private function loadArrayFromResult(array $assoc, Result $stmt): array
  996. {
  997. $rsm = $this->currentPersisterContext->rsm;
  998. $hints = [UnitOfWork::HINT_DEFEREAGERLOAD => true];
  1000. if (isset($assoc['indexBy'])) {
  1001. $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  1002. $rsm->addIndexBy('r', $assoc['indexBy']);
  1003. }
  1005. return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1006. }
  1008. /**
  1009. * Hydrates a collection from a given DBAL statement.
  1010. *
  1011. * @param mixed[] $assoc
  1012. *
  1013. * @return mixed[]
  1014. */
  1015. private function loadCollectionFromStatement(
  1016. array $assoc,
  1017. Result $stmt,
  1018. PersistentCollection $coll
  1019. ): array {
  1020. $rsm = $this->currentPersisterContext->rsm;
  1021. $hints = [
  1022. UnitOfWork::HINT_DEFEREAGERLOAD => true,
  1023. 'collection' => $coll,
  1024. ];
  1026. if (isset($assoc['indexBy'])) {
  1027. $rsm = clone $this->currentPersisterContext->rsm; // this is necessary because the "default rsm" should be changed.
  1028. $rsm->addIndexBy('r', $assoc['indexBy']);
  1029. }
  1031. return $this->em->newHydrator(Query::HYDRATE_OBJECT)->hydrateAll($stmt, $rsm, $hints);
  1032. }
  1034. /**
  1035. * {@inheritDoc}
  1036. */
  1037. public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1038. {
  1039. $stmt = $this->getManyToManyStatement($assoc, $sourceEntity);
  1041. return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1042. }
  1044. /**
  1045. * @param object $sourceEntity
  1046. * @psalm-param array<string, mixed> $assoc
  1047. *
  1048. * @return Result
  1049. *
  1050. * @throws MappingException
  1051. */
  1052. private function getManyToManyStatement(
  1053. array $assoc,
  1054. $sourceEntity,
  1055. ?int $offset = null,
  1056. ?int $limit = null
  1057. ) {
  1058. $this->switchPersisterContext($offset, $limit);
  1060. $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1061. $class = $sourceClass;
  1062. $association = $assoc;
  1063. $criteria = [];
  1064. $parameters = [];
  1066. if (! $assoc['isOwningSide']) {
  1067. $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1068. $association = $class->associationMappings[$assoc['mappedBy']];
  1069. }
  1071. $joinColumns = $assoc['isOwningSide']
  1072. ? $association['joinTable']['joinColumns']
  1073. : $association['joinTable']['inverseJoinColumns'];
  1075. $quotedJoinTable = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1077. foreach ($joinColumns as $joinColumn) {
  1078. $sourceKeyColumn = $joinColumn['referencedColumnName'];
  1079. $quotedKeyColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1081. switch (true) {
  1082. case $sourceClass->containsForeignIdentifier:
  1083. $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1084. $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1086. if (isset($sourceClass->associationMappings[$field])) {
  1087. $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1088. $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1089. }
  1091. break;
  1093. case isset($sourceClass->fieldNames[$sourceKeyColumn]):
  1094. $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1095. $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1097. break;
  1099. default:
  1100. throw MappingException::joinColumnMustPointToMappedField(
  1101. $sourceClass->name,
  1102. $sourceKeyColumn
  1103. );
  1104. }
  1106. $criteria[$quotedJoinTable . '.' . $quotedKeyColumn] = $value;
  1107. $parameters[] = [
  1108. 'value' => $value,
  1109. 'field' => $field,
  1110. 'class' => $sourceClass,
  1111. ];
  1112. }
  1114. $sql = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1115. [$params, $types] = $this->expandToManyParameters($parameters);
  1117. return $this->conn->executeQuery($sql, $params, $types);
  1118. }
  1120. /**
  1121. * {@inheritDoc}
  1122. */
  1123. public function getSelectSQL($criteria, $assoc = null, $lockMode = null, $limit = null, $offset = null, ?array $orderBy = null)
  1124. {
  1125. $this->switchPersisterContext($offset, $limit);
  1127. $lockSql = '';
  1128. $joinSql = '';
  1129. $orderBySql = '';
  1131. if ($assoc !== null && $assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  1132. $joinSql = $this->getSelectManyToManyJoinSQL($assoc);
  1133. }
  1135. if (isset($assoc['orderBy'])) {
  1136. $orderBy = $assoc['orderBy'];
  1137. }
  1139. if ($orderBy) {
  1140. $orderBySql = $this->getOrderBySQL($orderBy, $this->getSQLTableAlias($this->class->name));
  1141. }
  1143. $conditionSql = $criteria instanceof Criteria
  1144. ? $this->getSelectConditionCriteriaSQL($criteria)
  1145. : $this->getSelectConditionSQL($criteria, $assoc);
  1147. switch ($lockMode) {
  1148. case LockMode::PESSIMISTIC_READ:
  1149. $lockSql = ' ' . $this->getReadLockSQL($this->platform);
  1150. break;
  1152. case LockMode::PESSIMISTIC_WRITE:
  1153. $lockSql = ' ' . $this->getWriteLockSQL($this->platform);
  1154. break;
  1155. }
  1157. $columnList = $this->getSelectColumnsSQL();
  1158. $tableAlias = $this->getSQLTableAlias($this->class->name);
  1159. $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1160. $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1162. if ($filterSql !== '') {
  1163. $conditionSql = $conditionSql
  1164. ? $conditionSql . ' AND ' . $filterSql
  1165. : $filterSql;
  1166. }
  1168. $select = 'SELECT ' . $columnList;
  1169. $from = ' FROM ' . $tableName . ' ' . $tableAlias;
  1170. $join = $this->currentPersisterContext->selectJoinSql . $joinSql;
  1171. $where = ($conditionSql ? ' WHERE ' . $conditionSql : '');
  1172. $lock = $this->platform->appendLockHint($from, $lockMode ?? LockMode::NONE);
  1173. $query = $select
  1174. . $lock
  1175. . $join
  1176. . $where
  1177. . $orderBySql;
  1179. return $this->platform->modifyLimitQuery($query, $limit, $offset ?? 0) . $lockSql;
  1180. }
  1182. /**
  1183. * {@inheritDoc}
  1184. */
  1185. public function getCountSQL($criteria = [])
  1186. {
  1187. $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1188. $tableAlias = $this->getSQLTableAlias($this->class->name);
  1190. $conditionSql = $criteria instanceof Criteria
  1191. ? $this->getSelectConditionCriteriaSQL($criteria)
  1192. : $this->getSelectConditionSQL($criteria);
  1194. $filterSql = $this->generateFilterConditionSQL($this->class, $tableAlias);
  1196. if ($filterSql !== '') {
  1197. $conditionSql = $conditionSql
  1198. ? $conditionSql . ' AND ' . $filterSql
  1199. : $filterSql;
  1200. }
  1202. return 'SELECT COUNT(*) '
  1203. . 'FROM ' . $tableName . ' ' . $tableAlias
  1204. . (empty($conditionSql) ? '' : ' WHERE ' . $conditionSql);
  1205. }
  1207. /**
  1208. * Gets the ORDER BY SQL snippet for ordered collections.
  1209. *
  1210. * @psalm-param array<string, string> $orderBy
  1211. *
  1212. * @throws InvalidOrientation
  1213. * @throws InvalidFindByCall
  1214. * @throws UnrecognizedField
  1215. */
  1216. final protected function getOrderBySQL(array $orderBy, string $baseTableAlias): string
  1217. {
  1218. $orderByList = [];
  1220. foreach ($orderBy as $fieldName => $orientation) {
  1221. $orientation = strtoupper(trim($orientation));
  1223. if ($orientation !== 'ASC' && $orientation !== 'DESC') {
  1224. throw InvalidOrientation::fromClassNameAndField($this->class->name, $fieldName);
  1225. }
  1227. if (isset($this->class->fieldMappings[$fieldName])) {
  1228. $tableAlias = isset($this->class->fieldMappings[$fieldName]['inherited'])
  1229. ? $this->getSQLTableAlias($this->class->fieldMappings[$fieldName]['inherited'])
  1230. : $baseTableAlias;
  1232. $columnName = $this->quoteStrategy->getColumnName($fieldName, $this->class, $this->platform);
  1233. $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1235. continue;
  1236. }
  1238. if (isset($this->class->associationMappings[$fieldName])) {
  1239. if (! $this->class->associationMappings[$fieldName]['isOwningSide']) {
  1240. throw InvalidFindByCall::fromInverseSideUsage($this->class->name, $fieldName);
  1241. }
  1243. $tableAlias = isset($this->class->associationMappings[$fieldName]['inherited'])
  1244. ? $this->getSQLTableAlias($this->class->associationMappings[$fieldName]['inherited'])
  1245. : $baseTableAlias;
  1247. foreach ($this->class->associationMappings[$fieldName]['joinColumns'] as $joinColumn) {
  1248. $columnName = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1249. $orderByList[] = $tableAlias . '.' . $columnName . ' ' . $orientation;
  1250. }
  1252. continue;
  1253. }
  1255. throw UnrecognizedField::byFullyQualifiedName($this->class->name, $fieldName);
  1256. }
  1258. return ' ORDER BY ' . implode(', ', $orderByList);
  1259. }
  1261. /**
  1262. * Gets the SQL fragment with the list of columns to select when querying for
  1263. * an entity in this persister.
  1264. *
  1265. * Subclasses should override this method to alter or change the select column
  1266. * list SQL fragment. Note that in the implementation of BasicEntityPersister
  1267. * the resulting SQL fragment is generated only once and cached in {@link selectColumnListSql}.
  1268. * Subclasses may or may not do the same.
  1269. *
  1270. * @return string The SQL fragment.
  1271. */
  1272. protected function getSelectColumnsSQL()
  1273. {
  1274. if ($this->currentPersisterContext->selectColumnListSql !== null) {
  1275. return $this->currentPersisterContext->selectColumnListSql;
  1276. }
  1278. $columnList = [];
  1279. $this->currentPersisterContext->rsm->addEntityResult($this->class->name, 'r'); // r for root
  1281. // Add regular columns to select list
  1282. foreach ($this->class->fieldNames as $field) {
  1283. $columnList[] = $this->getSelectColumnSQL($field, $this->class);
  1284. }
  1286. $this->currentPersisterContext->selectJoinSql = '';
  1287. $eagerAliasCounter = 0;
  1289. foreach ($this->class->associationMappings as $assocField => $assoc) {
  1290. $assocColumnSQL = $this->getSelectColumnAssociationSQL($assocField, $assoc, $this->class);
  1292. if ($assocColumnSQL) {
  1293. $columnList[] = $assocColumnSQL;
  1294. }
  1296. $isAssocToOneInverseSide = $assoc['type'] & ClassMetadata::TO_ONE && ! $assoc['isOwningSide'];
  1297. $isAssocFromOneEager = $assoc['type'] & ClassMetadata::TO_ONE && $assoc['fetch'] === ClassMetadata::FETCH_EAGER;
  1299. if (! ($isAssocFromOneEager || $isAssocToOneInverseSide)) {
  1300. continue;
  1301. }
  1303. if ((($assoc['type'] & ClassMetadata::TO_MANY) > 0) && $this->currentPersisterContext->handlesLimits) {
  1304. continue;
  1305. }
  1307. $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1309. if ($eagerEntity->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  1310. continue; // now this is why you shouldn't use inheritance
  1311. }
  1313. $assocAlias = 'e' . ($eagerAliasCounter++);
  1314. $this->currentPersisterContext->rsm->addJoinedEntityResult($assoc['targetEntity'], $assocAlias, 'r', $assocField);
  1316. foreach ($eagerEntity->fieldNames as $field) {
  1317. $columnList[] = $this->getSelectColumnSQL($field, $eagerEntity, $assocAlias);
  1318. }
  1320. foreach ($eagerEntity->associationMappings as $eagerAssocField => $eagerAssoc) {
  1321. $eagerAssocColumnSQL = $this->getSelectColumnAssociationSQL(
  1322. $eagerAssocField,
  1323. $eagerAssoc,
  1324. $eagerEntity,
  1325. $assocAlias
  1326. );
  1328. if ($eagerAssocColumnSQL) {
  1329. $columnList[] = $eagerAssocColumnSQL;
  1330. }
  1331. }
  1333. $association = $assoc;
  1334. $joinCondition = [];
  1336. if (isset($assoc['indexBy'])) {
  1337. $this->currentPersisterContext->rsm->addIndexBy($assocAlias, $assoc['indexBy']);
  1338. }
  1340. if (! $assoc['isOwningSide']) {
  1341. $eagerEntity = $this->em->getClassMetadata($assoc['targetEntity']);
  1342. $association = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
  1343. }
  1345. $joinTableAlias = $this->getSQLTableAlias($eagerEntity->name, $assocAlias);
  1346. $joinTableName = $this->quoteStrategy->getTableName($eagerEntity, $this->platform);
  1348. if ($assoc['isOwningSide']) {
  1349. $tableAlias = $this->getSQLTableAlias($association['targetEntity'], $assocAlias);
  1350. $this->currentPersisterContext->selectJoinSql .= ' ' . $this->getJoinSQLForJoinColumns($association['joinColumns']);
  1352. foreach ($association['joinColumns'] as $joinColumn) {
  1353. $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1354. $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1355. $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'])
  1356. . '.' . $sourceCol . ' = ' . $tableAlias . '.' . $targetCol;
  1357. }
  1359. // Add filter SQL
  1360. $filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias);
  1361. if ($filterSql) {
  1362. $joinCondition[] = $filterSql;
  1363. }
  1364. } else {
  1365. $this->currentPersisterContext->selectJoinSql .= ' LEFT JOIN';
  1367. foreach ($association['joinColumns'] as $joinColumn) {
  1368. $sourceCol = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1369. $targetCol = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1371. $joinCondition[] = $this->getSQLTableAlias($association['sourceEntity'], $assocAlias) . '.' . $sourceCol . ' = '
  1372. . $this->getSQLTableAlias($association['targetEntity']) . '.' . $targetCol;
  1373. }
  1374. }
  1376. $this->currentPersisterContext->selectJoinSql .= ' ' . $joinTableName . ' ' . $joinTableAlias . ' ON ';
  1377. $this->currentPersisterContext->selectJoinSql .= implode(' AND ', $joinCondition);
  1378. }
  1380. $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  1382. return $this->currentPersisterContext->selectColumnListSql;
  1383. }
  1385. /**
  1386. * Gets the SQL join fragment used when selecting entities from an association.
  1387. *
  1388. * @param string $field
  1389. * @param AssociationMapping $assoc
  1390. * @param string $alias
  1391. *
  1392. * @return string
  1393. */
  1394. protected function getSelectColumnAssociationSQL($field, $assoc, ClassMetadata $class, $alias = 'r')
  1395. {
  1396. if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1397. return '';
  1398. }
  1400. $columnList = [];
  1401. $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  1402. $isIdentifier = isset($assoc['id']) && $assoc['id'] === true;
  1403. $sqlTableAlias = $this->getSQLTableAlias($class->name, ($alias === 'r' ? '' : $alias));
  1405. foreach ($assoc['joinColumns'] as $joinColumn) {
  1406. $quotedColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1407. $resultColumnName = $this->getSQLColumnAlias($joinColumn['name']);
  1408. $type = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  1410. $this->currentPersisterContext->rsm->addMetaResult($alias, $resultColumnName, $joinColumn['name'], $isIdentifier, $type);
  1412. $columnList[] = sprintf('%s.%s AS %s', $sqlTableAlias, $quotedColumn, $resultColumnName);
  1413. }
  1415. return implode(', ', $columnList);
  1416. }
  1418. /**
  1419. * Gets the SQL join fragment used when selecting entities from a
  1420. * many-to-many association.
  1421. *
  1422. * @psalm-param AssociationMapping $manyToMany
  1423. *
  1424. * @return string
  1425. */
  1426. protected function getSelectManyToManyJoinSQL(array $manyToMany)
  1427. {
  1428. $conditions = [];
  1429. $association = $manyToMany;
  1430. $sourceTableAlias = $this->getSQLTableAlias($this->class->name);
  1432. if (! $manyToMany['isOwningSide']) {
  1433. $targetEntity = $this->em->getClassMetadata($manyToMany['targetEntity']);
  1434. $association = $targetEntity->associationMappings[$manyToMany['mappedBy']];
  1435. }
  1437. $joinTableName = $this->quoteStrategy->getJoinTableName($association, $this->class, $this->platform);
  1438. $joinColumns = $manyToMany['isOwningSide']
  1439. ? $association['joinTable']['inverseJoinColumns']
  1440. : $association['joinTable']['joinColumns'];
  1442. foreach ($joinColumns as $joinColumn) {
  1443. $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1444. $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $this->class, $this->platform);
  1445. $conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableName . '.' . $quotedSourceColumn;
  1446. }
  1448. return ' INNER JOIN ' . $joinTableName . ' ON ' . implode(' AND ', $conditions);
  1449. }
  1451. /**
  1452. * {@inheritDoc}
  1453. */
  1454. public function getInsertSQL()
  1455. {
  1456. if ($this->insertSql !== null) {
  1457. return $this->insertSql;
  1458. }
  1460. $columns = $this->getInsertColumnList();
  1461. $tableName = $this->quoteStrategy->getTableName($this->class, $this->platform);
  1463. if (empty($columns)) {
  1464. $identityColumn = $this->quoteStrategy->getColumnName($this->class->identifier[0], $this->class, $this->platform);
  1465. $this->insertSql = $this->platform->getEmptyIdentityInsertSQL($tableName, $identityColumn);
  1467. return $this->insertSql;
  1468. }
  1470. $values = [];
  1471. $columns = array_unique($columns);
  1473. foreach ($columns as $column) {
  1474. $placeholder = '?';
  1476. if (
  1477. isset($this->class->fieldNames[$column])
  1478. && isset($this->columnTypes[$this->class->fieldNames[$column]])
  1479. && isset($this->class->fieldMappings[$this->class->fieldNames[$column]]['requireSQLConversion'])
  1480. ) {
  1481. $type = Type::getType($this->columnTypes[$this->class->fieldNames[$column]]);
  1482. $placeholder = $type->convertToDatabaseValueSQL('?', $this->platform);
  1483. }
  1485. $values[] = $placeholder;
  1486. }
  1488. $columns = implode(', ', $columns);
  1489. $values = implode(', ', $values);
  1491. $this->insertSql = sprintf('INSERT INTO %s (%s) VALUES (%s)', $tableName, $columns, $values);
  1493. return $this->insertSql;
  1494. }
  1496. /**
  1497. * Gets the list of columns to put in the INSERT SQL statement.
  1498. *
  1499. * Subclasses should override this method to alter or change the list of
  1500. * columns placed in the INSERT statements used by the persister.
  1501. *
  1502. * @return string[] The list of columns.
  1503. * @psalm-return list<string>
  1504. */
  1505. protected function getInsertColumnList()
  1506. {
  1507. $columns = [];
  1509. foreach ($this->class->reflFields as $name => $field) {
  1510. if ($this->class->isVersioned && $this->class->versionField === $name) {
  1511. continue;
  1512. }
  1514. if (isset($this->class->embeddedClasses[$name])) {
  1515. continue;
  1516. }
  1518. if (isset($this->class->associationMappings[$name])) {
  1519. $assoc = $this->class->associationMappings[$name];
  1521. if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  1522. foreach ($assoc['joinColumns'] as $joinColumn) {
  1523. $columns[] = $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1524. }
  1525. }
  1527. continue;
  1528. }
  1530. if (! $this->class->isIdGeneratorIdentity() || $this->class->identifier[0] !== $name) {
  1531. if (isset($this->class->fieldMappings[$name]['notInsertable'])) {
  1532. continue;
  1533. }
  1535. $columns[] = $this->quoteStrategy->getColumnName($name, $this->class, $this->platform);
  1536. $this->columnTypes[$name] = $this->class->fieldMappings[$name]['type'];
  1537. }
  1538. }
  1540. return $columns;
  1541. }
  1543. /**
  1544. * Gets the SQL snippet of a qualified column name for the given field name.
  1545. *
  1546. * @param string $field The field name.
  1547. * @param ClassMetadata $class The class that declares this field. The table this class is
  1548. * mapped to must own the column for the given field.
  1549. * @param string $alias
  1550. *
  1551. * @return string
  1552. */
  1553. protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  1554. {
  1555. $root = $alias === 'r' ? '' : $alias;
  1556. $tableAlias = $this->getSQLTableAlias($class->name, $root);
  1557. $fieldMapping = $class->fieldMappings[$field];
  1558. $sql = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
  1559. $columnAlias = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1561. $this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
  1562. if (! empty($fieldMapping['enumType'])) {
  1563. $this->currentPersisterContext->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
  1564. }
  1566. if (isset($fieldMapping['requireSQLConversion'])) {
  1567. $type = Type::getType($fieldMapping['type']);
  1568. $sql = $type->convertToPHPValueSQL($sql, $this->platform);
  1569. }
  1571. return $sql . ' AS ' . $columnAlias;
  1572. }
  1574. /**
  1575. * Gets the SQL table alias for the given class name.
  1576. *
  1577. * @param string $className
  1578. * @param string $assocName
  1579. *
  1580. * @return string The SQL table alias.
  1581. *
  1582. * @todo Reconsider. Binding table aliases to class names is not such a good idea.
  1583. */
  1584. protected function getSQLTableAlias($className, $assocName = '')
  1585. {
  1586. if ($assocName) {
  1587. $className .= '#' . $assocName;
  1588. }
  1590. if (isset($this->currentPersisterContext->sqlTableAliases[$className])) {
  1591. return $this->currentPersisterContext->sqlTableAliases[$className];
  1592. }
  1594. $tableAlias = 't' . $this->currentPersisterContext->sqlAliasCounter++;
  1596. $this->currentPersisterContext->sqlTableAliases[$className] = $tableAlias;
  1598. return $tableAlias;
  1599. }
  1601. /**
  1602. * {@inheritDoc}
  1603. */
  1604. public function lock(array $criteria, $lockMode)
  1605. {
  1606. $lockSql = '';
  1607. $conditionSql = $this->getSelectConditionSQL($criteria);
  1609. switch ($lockMode) {
  1610. case LockMode::PESSIMISTIC_READ:
  1611. $lockSql = $this->getReadLockSQL($this->platform);
  1613. break;
  1614. case LockMode::PESSIMISTIC_WRITE:
  1615. $lockSql = $this->getWriteLockSQL($this->platform);
  1616. break;
  1617. }
  1619. $lock = $this->getLockTablesSql($lockMode);
  1620. $where = ($conditionSql ? ' WHERE ' . $conditionSql : '') . ' ';
  1621. $sql = 'SELECT 1 '
  1622. . $lock
  1623. . $where
  1624. . $lockSql;
  1626. [$params, $types] = $this->expandParameters($criteria);
  1628. $this->conn->executeQuery($sql, $params, $types);
  1629. }
  1631. /**
  1632. * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
  1633. *
  1634. * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
  1635. * @psalm-param LockMode::*|null $lockMode
  1636. *
  1637. * @return string
  1638. */
  1639. protected function getLockTablesSql($lockMode)
  1640. {
  1641. if ($lockMode === null) {
  1642. Deprecation::trigger(
  1643. 'doctrine/orm',
  1644. 'https://github.com/doctrine/orm/pull/9466',
  1645. 'Passing null as argument to %s is deprecated, pass LockMode::NONE instead.',
  1646. __METHOD__
  1647. );
  1649. $lockMode = LockMode::NONE;
  1650. }
  1652. return $this->platform->appendLockHint(
  1653. 'FROM '
  1654. . $this->quoteStrategy->getTableName($this->class, $this->platform) . ' '
  1655. . $this->getSQLTableAlias($this->class->name),
  1656. $lockMode
  1657. );
  1658. }
  1660. /**
  1661. * Gets the Select Where Condition from a Criteria object.
  1662. *
  1663. * @return string
  1664. */
  1665. protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  1666. {
  1667. $expression = $criteria->getWhereExpression();
  1669. if ($expression === null) {
  1670. return '';
  1671. }
  1673. $visitor = new SqlExpressionVisitor($this, $this->class);
  1675. return $visitor->dispatch($expression);
  1676. }
  1678. /**
  1679. * {@inheritDoc}
  1680. */
  1681. public function getSelectConditionStatementSQL($field, $value, $assoc = null, $comparison = null)
  1682. {
  1683. $selectedColumns = [];
  1684. $columns = $this->getSelectConditionStatementColumnSQL($field, $assoc);
  1686. if (count($columns) > 1 && $comparison === Comparison::IN) {
  1687. /*
  1688. * @todo try to support multi-column IN expressions.
  1689. * Example: (col1, col2) IN (('val1A', 'val2A'), ('val1B', 'val2B'))
  1690. */
  1691. throw CantUseInOperatorOnCompositeKeys::create();
  1692. }
  1694. foreach ($columns as $column) {
  1695. $placeholder = '?';
  1697. if (isset($this->class->fieldMappings[$field]['requireSQLConversion'])) {
  1698. $type = Type::getType($this->class->fieldMappings[$field]['type']);
  1699. $placeholder = $type->convertToDatabaseValueSQL($placeholder, $this->platform);
  1700. }
  1702. if ($comparison !== null) {
  1703. // special case null value handling
  1704. if (($comparison === Comparison::EQ || $comparison === Comparison::IS) && $value === null) {
  1705. $selectedColumns[] = $column . ' IS NULL';
  1707. continue;
  1708. }
  1710. if ($comparison === Comparison::NEQ && $value === null) {
  1711. $selectedColumns[] = $column . ' IS NOT NULL';
  1713. continue;
  1714. }
  1716. $selectedColumns[] = $column . ' ' . sprintf(self::$comparisonMap[$comparison], $placeholder);
  1718. continue;
  1719. }
  1721. if (is_array($value)) {
  1722. $in = sprintf('%s IN (%s)', $column, $placeholder);
  1724. if (array_search(null, $value, true) !== false) {
  1725. $selectedColumns[] = sprintf('(%s OR %s IS NULL)', $in, $column);
  1727. continue;
  1728. }
  1730. $selectedColumns[] = $in;
  1732. continue;
  1733. }
  1735. if ($value === null) {
  1736. $selectedColumns[] = sprintf('%s IS NULL', $column);
  1738. continue;
  1739. }
  1741. $selectedColumns[] = sprintf('%s = %s', $column, $placeholder);
  1742. }
  1744. return implode(' AND ', $selectedColumns);
  1745. }
  1747. /**
  1748. * Builds the left-hand-side of a where condition statement.
  1749. *
  1750. * @psalm-param AssociationMapping|null $assoc
  1751. *
  1752. * @return string[]
  1753. * @psalm-return list<string>
  1754. *
  1755. * @throws InvalidFindByCall
  1756. * @throws UnrecognizedField
  1757. */
  1758. private function getSelectConditionStatementColumnSQL(
  1759. string $field,
  1760. ?array $assoc = null
  1761. ): array {
  1762. if (isset($this->class->fieldMappings[$field])) {
  1763. $className = $this->class->fieldMappings[$field]['inherited'] ?? $this->class->name;
  1765. return [$this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getColumnName($field, $this->class, $this->platform)];
  1766. }
  1768. if (isset($this->class->associationMappings[$field])) {
  1769. $association = $this->class->associationMappings[$field];
  1770. // Many-To-Many requires join table check for joinColumn
  1771. $columns = [];
  1772. $class = $this->class;
  1774. if ($association['type'] === ClassMetadata::MANY_TO_MANY) {
  1775. if (! $association['isOwningSide']) {
  1776. $association = $assoc;
  1777. }
  1779. $joinTableName = $this->quoteStrategy->getJoinTableName($association, $class, $this->platform);
  1780. $joinColumns = $assoc['isOwningSide']
  1781. ? $association['joinTable']['joinColumns']
  1782. : $association['joinTable']['inverseJoinColumns'];
  1784. foreach ($joinColumns as $joinColumn) {
  1785. $columns[] = $joinTableName . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  1786. }
  1787. } else {
  1788. if (! $association['isOwningSide']) {
  1789. throw InvalidFindByCall::fromInverseSideUsage(
  1790. $this->class->name,
  1791. $field
  1792. );
  1793. }
  1795. $className = $association['inherited'] ?? $this->class->name;
  1797. foreach ($association['joinColumns'] as $joinColumn) {
  1798. $columns[] = $this->getSQLTableAlias($className) . '.' . $this->quoteStrategy->getJoinColumnName($joinColumn, $this->class, $this->platform);
  1799. }
  1800. }
  1802. return $columns;
  1803. }
  1805. if ($assoc !== null && ! str_contains($field, ' ') && ! str_contains($field, '(')) {
  1806. // very careless developers could potentially open up this normally hidden api for userland attacks,
  1807. // therefore checking for spaces and function calls which are not allowed.
  1809. // found a join column condition, not really a "field"
  1810. return [$field];
  1811. }
  1813. throw UnrecognizedField::byFullyQualifiedName($this->class->name, $field);
  1814. }
  1816. /**
  1817. * Gets the conditional SQL fragment used in the WHERE clause when selecting
  1818. * entities in this persister.
  1819. *
  1820. * Subclasses are supposed to override this method if they intend to change
  1821. * or alter the criteria by which entities are selected.
  1822. *
  1823. * @param AssociationMapping|null $assoc
  1824. * @psalm-param array<string, mixed> $criteria
  1825. * @psalm-param array<string, mixed>|null $assoc
  1826. *
  1827. * @return string
  1828. */
  1829. protected function getSelectConditionSQL(array $criteria, $assoc = null)
  1830. {
  1831. $conditions = [];
  1833. foreach ($criteria as $field => $value) {
  1834. $conditions[] = $this->getSelectConditionStatementSQL($field, $value, $assoc);
  1835. }
  1837. return implode(' AND ', $conditions);
  1838. }
  1840. /**
  1841. * {@inheritDoc}
  1842. */
  1843. public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null)
  1844. {
  1845. $this->switchPersisterContext($offset, $limit);
  1847. $stmt = $this->getOneToManyStatement($assoc, $sourceEntity, $offset, $limit);
  1849. return $this->loadArrayFromResult($assoc, $stmt);
  1850. }
  1852. /**
  1853. * {@inheritDoc}
  1854. */
  1855. public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $collection)
  1856. {
  1857. $stmt = $this->getOneToManyStatement($assoc, $sourceEntity);
  1859. return $this->loadCollectionFromStatement($assoc, $stmt, $collection);
  1860. }
  1862. /**
  1863. * Builds criteria and execute SQL statement to fetch the one to many entities from.
  1864. *
  1865. * @param object $sourceEntity
  1866. * @psalm-param AssociationMapping $assoc
  1867. */
  1868. private function getOneToManyStatement(
  1869. array $assoc,
  1870. $sourceEntity,
  1871. ?int $offset = null,
  1872. ?int $limit = null
  1873. ): Result {
  1874. $this->switchPersisterContext($offset, $limit);
  1876. $criteria = [];
  1877. $parameters = [];
  1878. $owningAssoc = $this->class->associationMappings[$assoc['mappedBy']];
  1879. $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']);
  1880. $tableAlias = $this->getSQLTableAlias($owningAssoc['inherited'] ?? $this->class->name);
  1882. foreach ($owningAssoc['targetToSourceKeyColumns'] as $sourceKeyColumn => $targetKeyColumn) {
  1883. if ($sourceClass->containsForeignIdentifier) {
  1884. $field = $sourceClass->getFieldForColumn($sourceKeyColumn);
  1885. $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1887. if (isset($sourceClass->associationMappings[$field])) {
  1888. $value = $this->em->getUnitOfWork()->getEntityIdentifier($value);
  1889. $value = $value[$this->em->getClassMetadata($sourceClass->associationMappings[$field]['targetEntity'])->identifier[0]];
  1890. }
  1892. $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1893. $parameters[] = [
  1894. 'value' => $value,
  1895. 'field' => $field,
  1896. 'class' => $sourceClass,
  1897. ];
  1899. continue;
  1900. }
  1902. $field = $sourceClass->fieldNames[$sourceKeyColumn];
  1903. $value = $sourceClass->reflFields[$field]->getValue($sourceEntity);
  1905. $criteria[$tableAlias . '.' . $targetKeyColumn] = $value;
  1906. $parameters[] = [
  1907. 'value' => $value,
  1908. 'field' => $field,
  1909. 'class' => $sourceClass,
  1910. ];
  1911. }
  1913. $sql = $this->getSelectSQL($criteria, $assoc, null, $limit, $offset);
  1914. [$params, $types] = $this->expandToManyParameters($parameters);
  1916. return $this->conn->executeQuery($sql, $params, $types);
  1917. }
  1919. /**
  1920. * {@inheritDoc}
  1921. */
  1922. public function expandParameters($criteria)
  1923. {
  1924. $params = [];
  1925. $types = [];
  1927. foreach ($criteria as $field => $value) {
  1928. if ($value === null) {
  1929. continue; // skip null values.
  1930. }
  1932. $types = array_merge($types, $this->getTypes($field, $value, $this->class));
  1933. $params = array_merge($params, $this->getValues($value));
  1934. }
  1936. return [$params, $types];
  1937. }
  1939. /**
  1940. * Expands the parameters from the given criteria and use the correct binding types if found,
  1941. * specialized for OneToMany or ManyToMany associations.
  1942. *
  1943. * @param mixed[][] $criteria an array of arrays containing following:
  1944. * - field to which each criterion will be bound
  1945. * - value to be bound
  1946. * - class to which the field belongs to
  1947. *
  1948. * @return mixed[][]
  1949. * @psalm-return array{0: array, 1: list<int|string|null>}
  1950. */
  1951. private function expandToManyParameters(array $criteria): array
  1952. {
  1953. $params = [];
  1954. $types = [];
  1956. foreach ($criteria as $criterion) {
  1957. if ($criterion['value'] === null) {
  1958. continue; // skip null values.
  1959. }
  1961. $types = array_merge($types, $this->getTypes($criterion['field'], $criterion['value'], $criterion['class']));
  1962. $params = array_merge($params, $this->getValues($criterion['value']));
  1963. }
  1965. return [$params, $types];
  1966. }
  1968. /**
  1969. * Infers field types to be used by parameter type casting.
  1970. *
  1971. * @param mixed $value
  1972. *
  1973. * @return int[]|null[]|string[]
  1974. * @psalm-return list<int|string|null>
  1975. *
  1976. * @throws QueryException
  1977. */
  1978. private function getTypes(string $field, $value, ClassMetadata $class): array
  1979. {
  1980. $types = [];
  1982. switch (true) {
  1983. case isset($class->fieldMappings[$field]):
  1984. $types = array_merge($types, [$class->fieldMappings[$field]['type']]);
  1985. break;
  1987. case isset($class->associationMappings[$field]):
  1988. $assoc = $class->associationMappings[$field];
  1989. $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1991. if (! $assoc['isOwningSide']) {
  1992. $assoc = $class->associationMappings[$assoc['mappedBy']];
  1993. $class = $this->em->getClassMetadata($assoc['targetEntity']);
  1994. }
  1996. $columns = $assoc['type'] === ClassMetadata::MANY_TO_MANY
  1997. ? $assoc['relationToTargetKeyColumns']
  1998. : $assoc['sourceToTargetKeyColumns'];
  2000. foreach ($columns as $column) {
  2001. $types[] = PersisterHelper::getTypeOfColumn($column, $class, $this->em);
  2002. }
  2004. break;
  2006. default:
  2007. $types[] = null;
  2008. break;
  2009. }
  2011. if (is_array($value)) {
  2012. return array_map(static function ($type) {
  2013. $type = Type::getType($type);
  2015. return $type->getBindingType() + Connection::ARRAY_PARAM_OFFSET;
  2016. }, $types);
  2017. }
  2019. return $types;
  2020. }
  2022. /**
  2023. * Retrieves the parameters that identifies a value.
  2024. *
  2025. * @param mixed $value
  2026. *
  2027. * @return mixed[]
  2028. */
  2029. private function getValues($value): array
  2030. {
  2031. if (is_array($value)) {
  2032. $newValue = [];
  2034. foreach ($value as $itemValue) {
  2035. $newValue = array_merge($newValue, $this->getValues($itemValue));
  2036. }
  2038. return [$newValue];
  2039. }
  2041. return $this->getIndividualValue($value);
  2042. }
  2044. /**
  2045. * Retrieves an individual parameter value.
  2046. *
  2047. * @param mixed $value
  2048. *
  2049. * @psalm-return list<mixed>
  2050. */
  2051. private function getIndividualValue($value): array
  2052. {
  2053. if (! is_object($value)) {
  2054. return [$value];
  2055. }
  2057. if ($value instanceof BackedEnum) {
  2058. return [$value->value];
  2059. }
  2061. $valueClass = DefaultProxyClassNameResolver::getClass($value);
  2063. if ($this->em->getMetadataFactory()->isTransient($valueClass)) {
  2064. return [$value];
  2065. }
  2067. $class = $this->em->getClassMetadata($valueClass);
  2069. if ($class->isIdentifierComposite) {
  2070. $newValue = [];
  2072. foreach ($class->getIdentifierValues($value) as $innerValue) {
  2073. $newValue = array_merge($newValue, $this->getValues($innerValue));
  2074. }
  2076. return $newValue;
  2077. }
  2079. return [$this->em->getUnitOfWork()->getSingleIdentifierValue($value)];
  2080. }
  2082. /**
  2083. * {@inheritDoc}
  2084. */
  2085. public function exists($entity, ?Criteria $extraConditions = null)
  2086. {
  2087. $criteria = $this->class->getIdentifierValues($entity);
  2089. if (! $criteria) {
  2090. return false;
  2091. }
  2093. $alias = $this->getSQLTableAlias($this->class->name);
  2095. $sql = 'SELECT 1 '
  2096. . $this->getLockTablesSql(LockMode::NONE)
  2097. . ' WHERE ' . $this->getSelectConditionSQL($criteria);
  2099. [$params, $types] = $this->expandParameters($criteria);
  2101. if ($extraConditions !== null) {
  2102. $sql .= ' AND ' . $this->getSelectConditionCriteriaSQL($extraConditions);
  2103. [$criteriaParams, $criteriaTypes] = $this->expandCriteriaParameters($extraConditions);
  2105. $params = array_merge($params, $criteriaParams);
  2106. $types = array_merge($types, $criteriaTypes);
  2107. }
  2109. $filterSql = $this->generateFilterConditionSQL($this->class, $alias);
  2110. if ($filterSql) {
  2111. $sql .= ' AND ' . $filterSql;
  2112. }
  2114. return (bool) $this->conn->fetchOne($sql, $params, $types);
  2115. }
  2117. /**
  2118. * Generates the appropriate join SQL for the given join column.
  2119. *
  2120. * @param array[] $joinColumns The join columns definition of an association.
  2121. * @psalm-param array<array<string, mixed>> $joinColumns
  2122. *
  2123. * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise.
  2124. */
  2125. protected function getJoinSQLForJoinColumns($joinColumns)
  2126. {
  2127. // if one of the join columns is nullable, return left join
  2128. foreach ($joinColumns as $joinColumn) {
  2129. if (! isset($joinColumn['nullable']) || $joinColumn['nullable']) {
  2130. return 'LEFT JOIN';
  2131. }
  2132. }
  2134. return 'INNER JOIN';
  2135. }
  2137. /**
  2138. * @param string $columnName
  2139. *
  2140. * @return string
  2141. */
  2142. public function getSQLColumnAlias($columnName)
  2143. {
  2144. return $this->quoteStrategy->getColumnAlias($columnName, $this->currentPersisterContext->sqlAliasCounter++, $this->platform);
  2145. }
  2147. /**
  2148. * Generates the filter SQL for a given entity and table alias.
  2149. *
  2150. * @param ClassMetadata $targetEntity Metadata of the target entity.
  2151. * @param string $targetTableAlias The table alias of the joined/selected table.
  2152. *
  2153. * @return string The SQL query part to add to a query.
  2154. */
  2155. protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  2156. {
  2157. $filterClauses = [];
  2159. foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  2160. $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
  2161. if ($filterExpr !== '') {
  2162. $filterClauses[] = '(' . $filterExpr . ')';
  2163. }
  2164. }
  2166. $sql = implode(' AND ', $filterClauses);
  2168. return $sql ? '(' . $sql . ')' : ''; // Wrap again to avoid "X or Y and FilterConditionSQL"
  2169. }
  2171. /**
  2172. * Switches persister context according to current query offset/limits
  2173. *
  2174. * This is due to the fact that to-many associations cannot be fetch-joined when a limit is involved
  2175. *
  2176. * @param int|null $offset
  2177. * @param int|null $limit
  2178. *
  2179. * @return void
  2180. */
  2181. protected function switchPersisterContext($offset, $limit)
  2182. {
  2183. if ($offset === null && $limit === null) {
  2184. $this->currentPersisterContext = $this->noLimitsContext;
  2186. return;
  2187. }
  2189. $this->currentPersisterContext = $this->limitsHandlingContext;
  2190. }
  2192. /**
  2193. * @return string[]
  2194. * @psalm-return list<string>
  2195. */
  2196. protected function getClassIdentifiersTypes(ClassMetadata $class): array
  2197. {
  2198. $entityManager = $this->em;
  2200. return array_map(
  2201. static function ($fieldName) use ($class, $entityManager): string {
  2202. $types = PersisterHelper::getTypeOfField($fieldName, $class, $entityManager);
  2203. assert(isset($types[0]));
  2205. return $types[0];
  2206. },
  2207. $class->identifier
  2208. );
  2209. }
  2210. }