vendor/doctrine/orm/lib/Doctrine/ORM/Persisters/Entity/SingleTablePersister.php line 36

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Persisters\Entity;
  7. use Doctrine\Common\Collections\Criteria;
  8. use Doctrine\ORM\Internal\SQLResultCasing;
  9. use Doctrine\ORM\Mapping\ClassMetadata;
  10. use Doctrine\ORM\Utility\PersisterHelper;
  12. use function array_flip;
  13. use function implode;
  15. /**
  16. * Persister for entities that participate in a hierarchy mapped with the
  17. * SINGLE_TABLE strategy.
  18. *
  19. * @link https://martinfowler.com/eaaCatalog/singleTableInheritance.html
  20. */
  21. class SingleTablePersister extends AbstractEntityInheritancePersister
  22. {
  23. use SQLResultCasing;
  25. /**
  26. * {@inheritdoc}
  27. */
  28. protected function getDiscriminatorColumnTableName()
  29. {
  30. return $this->class->getTableName();
  31. }
  33. /**
  34. * {@inheritdoc}
  35. */
  36. protected function getSelectColumnsSQL()
  37. {
  38. if ($this->currentPersisterContext->selectColumnListSql !== null) {
  39. return $this->currentPersisterContext->selectColumnListSql;
  40. }
  42. $columnList[] = parent::getSelectColumnsSQL();
  44. $rootClass = $this->em->getClassMetadata($this->class->rootEntityName);
  45. $tableAlias = $this->getSQLTableAlias($rootClass->name);
  47. // Append discriminator column
  48. $discrColumn = $this->class->getDiscriminatorColumn();
  49. $discrColumnName = $discrColumn['name'];
  50. $discrColumnType = $discrColumn['type'];
  52. $columnList[] = $tableAlias . '.' . $discrColumnName;
  54. $resultColumnName = $this->getSQLResultCasing($this->platform, $discrColumnName);
  56. $this->currentPersisterContext->rsm->setDiscriminatorColumn('r', $resultColumnName);
  57. $this->currentPersisterContext->rsm->addMetaResult('r', $resultColumnName, $discrColumnName, false, $discrColumnType);
  59. // Append subclass columns
  60. foreach ($this->class->subClasses as $subClassName) {
  61. $subClass = $this->em->getClassMetadata($subClassName);
  63. // Regular columns
  64. foreach ($subClass->fieldMappings as $fieldName => $mapping) {
  65. if (isset($mapping['inherited'])) {
  66. continue;
  67. }
  69. $columnList[] = $this->getSelectColumnSQL($fieldName, $subClass);
  70. }
  72. // Foreign key columns
  73. foreach ($subClass->associationMappings as $assoc) {
  74. if (! $assoc['isOwningSide'] || ! ($assoc['type'] & ClassMetadata::TO_ONE) || isset($assoc['inherited'])) {
  75. continue;
  76. }
  78. $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  80. foreach ($assoc['joinColumns'] as $joinColumn) {
  81. $columnList[] = $this->getSelectJoinColumnSQL(
  82. $tableAlias,
  83. $joinColumn['name'],
  84. $this->quoteStrategy->getJoinColumnName($joinColumn, $subClass, $this->platform),
  85. PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em)
  86. );
  87. }
  88. }
  89. }
  91. $this->currentPersisterContext->selectColumnListSql = implode(', ', $columnList);
  93. return $this->currentPersisterContext->selectColumnListSql;
  94. }
  96. /**
  97. * {@inheritdoc}
  98. */
  99. protected function getInsertColumnList()
  100. {
  101. $columns = parent::getInsertColumnList();
  103. // Add discriminator column to the INSERT SQL
  104. $columns[] = $this->class->getDiscriminatorColumn()['name'];
  106. return $columns;
  107. }
  109. /**
  110. * {@inheritdoc}
  111. */
  112. protected function getSQLTableAlias($className, $assocName = '')
  113. {
  114. return parent::getSQLTableAlias($this->class->rootEntityName, $assocName);
  115. }
  117. /**
  118. * {@inheritdoc}
  119. */
  120. protected function getSelectConditionSQL(array $criteria, $assoc = null)
  121. {
  122. $conditionSql = parent::getSelectConditionSQL($criteria, $assoc);
  124. if ($conditionSql) {
  125. $conditionSql .= ' AND ';
  126. }
  128. return $conditionSql . $this->getSelectConditionDiscriminatorValueSQL();
  129. }
  131. /**
  132. * {@inheritdoc}
  133. */
  134. protected function getSelectConditionCriteriaSQL(Criteria $criteria)
  135. {
  136. $conditionSql = parent::getSelectConditionCriteriaSQL($criteria);
  138. if ($conditionSql) {
  139. $conditionSql .= ' AND ';
  140. }
  142. return $conditionSql . $this->getSelectConditionDiscriminatorValueSQL();
  143. }
  145. /** @return string */
  146. protected function getSelectConditionDiscriminatorValueSQL()
  147. {
  148. $values = [];
  150. if ($this->class->discriminatorValue !== null) { // discriminators can be 0
  151. $values[] = $this->conn->quote($this->class->discriminatorValue);
  152. }
  154. $discrValues = array_flip($this->class->discriminatorMap);
  156. foreach ($this->class->subClasses as $subclassName) {
  157. $values[] = $this->conn->quote($discrValues[$subclassName]);
  158. }
  160. $discColumnName = $this->class->getDiscriminatorColumn()['name'];
  162. $values = implode(', ', $values);
  163. $tableAlias = $this->getSQLTableAlias($this->class->name);
  165. return $tableAlias . '.' . $discColumnName . ' IN (' . $values . ')';
  166. }
  168. /**
  169. * {@inheritdoc}
  170. */
  171. protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
  172. {
  173. // Ensure that the filters are applied to the root entity of the inheritance tree
  174. $targetEntity = $this->em->getClassMetadata($targetEntity->rootEntityName);
  175. // we don't care about the $targetTableAlias, in a STI there is only one table.
  177. return parent::generateFilterConditionSQL($targetEntity, $targetTableAlias);
  178. }
  179. }