vendor/doctrine/orm/lib/Doctrine/ORM/Persisters/SingleTablePersister.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\ORM\Persisters;
  21
  22 use Doctrine\ORM\Mapping\ClassMetadata;
  23 use Doctrine\Common\Collections\Criteria;
  24
  25 /**
  26  * Persister for entities that participate in a hierarchy mapped with the
  27  * SINGLE_TABLE strategy.
  28  *
  29  * @author Roman Borschel <roman@code-factory.org>
  30  * @author Benjamin Eberlei <kontakt@beberlei.de>
  31  * @author Alexander <iam.asm89@gmail.com>
  32  * @since 2.0
  33  * @link http://martinfowler.com/eaaCatalog/singleTableInheritance.html
  34  */
  35 class SingleTablePersister extends AbstractEntityInheritancePersister
  36 {
  37     /** {@inheritdoc} */
  38     protected function _getDiscriminatorColumnTableName()
  39     {
  40         return $this->_class->getTableName();
  41     }
  42
  43     /** {@inheritdoc} */
  44     protected function _getSelectColumnListSQL()
  45     {
  46         if ($this->_selectColumnListSql !== null) {
  47             return $this->_selectColumnListSql;
  48         }
  49
  50         $columnList = parent::_getSelectColumnListSQL();
  51
  52         $rootClass  = $this->_em->getClassMetadata($this->_class->rootEntityName);
  53         $tableAlias = $this->_getSQLTableAlias($rootClass->name);
  54
  55          // Append discriminator column
  56         $discrColumn = $this->_class->discriminatorColumn['name'];
  57         $columnList .= ', ' . $tableAlias . '.' . $discrColumn;
  58
  59         $resultColumnName = $this->_platform->getSQLResultCasing($discrColumn);
  60
  61         $this->_rsm->setDiscriminatorColumn('r', $resultColumnName);
  62         $this->_rsm->addMetaResult('r', $resultColumnName, $discrColumn);
  63
  64         // Append subclass columns
  65         foreach ($this->_class->subClasses as $subClassName) {
  66             $subClass = $this->_em->getClassMetadata($subClassName);
  67
  68             // Regular columns
  69             foreach ($subClass->fieldMappings as $fieldName => $mapping) {
  70                 if ( ! isset($mapping['inherited'])) {
  71                     $columnList .= ', ' . $this->_getSelectColumnSQL($fieldName, $subClass);
  72                 }
  73             }
  74
  75             // Foreign key columns
  76             foreach ($subClass->associationMappings as $assoc) {
  77                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE && ! isset($assoc['inherited'])) {
  78                     foreach ($assoc['targetToSourceKeyColumns'] as $srcColumn) {
  79                         if ($columnList != '') $columnList .= ', ';
  80
  81                         $columnList .= $this->getSelectJoinColumnSQL(
  82                             $tableAlias,
  83                             $srcColumn,
  84                             isset($assoc['inherited']) ? $assoc['inherited'] : $this->_class->name
  85                         );
  86                     }
  87                 }
  88             }
  89         }
  90
  91         $this->_selectColumnListSql = $columnList;
  92         return $this->_selectColumnListSql;
  93     }
  94
  95     /** {@inheritdoc} */
  96     protected function _getInsertColumnList()
  97     {
  98         $columns = parent::_getInsertColumnList();
  99
 100         // Add discriminator column to the INSERT SQL
 101         $columns[] = $this->_class->discriminatorColumn['name'];
 102
 103         return $columns;
 104     }
 105
 106     /** {@inheritdoc} */
 107     protected function _getSQLTableAlias($className, $assocName = '')
 108     {
 109         return parent::_getSQLTableAlias($this->_class->rootEntityName, $assocName);
 110     }
 111
 112     /** {@inheritdoc} */
 113     protected function _getSelectConditionSQL(array $criteria, $assoc = null)
 114     {
 115         $conditionSql = parent::_getSelectConditionSQL($criteria, $assoc);
 116
 117         if ($conditionSql) {
 118             $conditionSql .= ' AND ';
 119         }
 120
 121         return $conditionSql . $this->_getSelectConditionDiscriminatorValueSQL();
 122     }
 123
 124     /** {@inheritdoc} */
 125     protected function _getSelectConditionCriteriaSQL(Criteria $criteria)
 126     {
 127         $conditionSql = parent::_getSelectConditionCriteriaSQL($criteria);
 128
 129         if ($conditionSql) {
 130             $conditionSql .= ' AND ';
 131         }
 132
 133         return $conditionSql . $this->_getSelectConditionDiscriminatorValueSQL();
 134     }
 135
 136     protected function _getSelectConditionDiscriminatorValueSQL()
 137     {
 138         $values = array();
 139
 140         if ($this->_class->discriminatorValue !== null) { // discriminators can be 0
 141             $values[] = $this->_conn->quote($this->_class->discriminatorValue);
 142         }
 143
 144         $discrValues = array_flip($this->_class->discriminatorMap);
 145
 146         foreach ($this->_class->subClasses as $subclassName) {
 147             $values[] = $this->_conn->quote($discrValues[$subclassName]);
 148         }
 149
 150         return $this->_getSQLTableAlias($this->_class->name) . '.' . $this->_class->discriminatorColumn['name']
 151                 . ' IN (' . implode(', ', $values) . ')';
 152     }
 153
 154     /** {@inheritdoc} */
 155     protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
 156     {
 157         // Ensure that the filters are applied to the root entity of the inheritance tree
 158         $targetEntity = $this->_em->getClassMetadata($targetEntity->rootEntityName);
 159         // we dont care about the $targetTableAlias, in a STI there is only one table.
 160
 161         return parent::generateFilterConditionSQL($targetEntity, $targetTableAlias);
 162     }
 163 }