vendor/doctrine/orm/lib/Doctrine/ORM/Persisters/AbstractEntityInheritancePersister.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     Doctrine\DBAL\Types\Type;
  24
  25 /**
  26  * Base class for entity persisters that implement a certain inheritance mapping strategy.
  27  * All these persisters are assumed to use a discriminator column to discriminate entity
  28  * types in the hierarchy.
  29  *
  30  * @author Roman Borschel <roman@code-factory.org>
  31  * @author Benjamin Eberlei <kontakt@beberlei.de>
  32  * @since 2.0
  33  */
  34 abstract class AbstractEntityInheritancePersister extends BasicEntityPersister
  35 {
  36     /**
  37      * {@inheritdoc}
  38      */
  39     protected function _prepareInsertData($entity)
  40     {
  41         $data = parent::_prepareInsertData($entity);
  42
  43         // Populate the discriminator column
  44         $discColumn = $this->_class->discriminatorColumn;
  45         $this->_columnTypes[$discColumn['name']] = $discColumn['type'];
  46         $data[$this->_getDiscriminatorColumnTableName()][$discColumn['name']] = $this->_class->discriminatorValue;
  47
  48         return $data;
  49     }
  50
  51     /**
  52      * Gets the name of the table that contains the discriminator column.
  53      *
  54      * @return string The table name.
  55      */
  56     abstract protected function _getDiscriminatorColumnTableName();
  57
  58     /**
  59      * {@inheritdoc}
  60      */
  61     protected function _getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r')
  62     {
  63         $columnName = $class->columnNames[$field];
  64         $sql = $this->_getSQLTableAlias($class->name, $alias == 'r' ? '' : $alias) . '.' . $this->quoteStrategy->getColumnName($field, $class, $this->_platform);
  65         $columnAlias = $this->getSQLColumnAlias($columnName);
  66         $this->_rsm->addFieldResult($alias, $columnAlias, $field, $class->name);
  67
  68         if (isset($class->fieldMappings[$field]['requireSQLConversion'])) {
  69             $type = Type::getType($class->getTypeOfField($field));
  70             $sql = $type->convertToPHPValueSQL($sql, $this->_platform);
  71         }
  72
  73         return $sql . ' AS ' . $columnAlias;
  74     }
  75
  76     protected function getSelectJoinColumnSQL($tableAlias, $joinColumnName, $className)
  77     {
  78         $columnAlias = $this->getSQLColumnAlias($joinColumnName);
  79         $this->_rsm->addMetaResult('r', $columnAlias, $joinColumnName);
  80
  81         return $tableAlias . '.' . $joinColumnName . ' AS ' . $columnAlias;
  82     }
  83 }