vendor/doctrine/orm/lib/Doctrine/ORM/Internal/Hydration/SimpleObjectHydrator.php line 146

Open in your IDE?
  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.  */
  20. namespace Doctrine\ORM\Internal\Hydration;
  22. use PDO;
  23. use Doctrine\ORM\Mapping\ClassMetadata;
  24. use Doctrine\ORM\Query;
  26. class SimpleObjectHydrator extends AbstractHydrator
  27. {
  28.     /**
  29.      * @var ClassMetadata
  30.      */
  31.     private $class;
  33.     /**
  34.      * {@inheritdoc}
  35.      */
  36.     protected function prepare()
  37.     {
  38.         if (count($this->_rsm->aliasMap) !== 1) {
  39.             throw new \RuntimeException("Cannot use SimpleObjectHydrator with a ResultSetMapping that contains more than one object result.");
  40.         }
  42.         if ($this->_rsm->scalarMappings) {
  43.             throw new \RuntimeException("Cannot use SimpleObjectHydrator with a ResultSetMapping that contains scalar mappings.");
  44.         }
  46.         $this->class = $this->getClassMetadata(reset($this->_rsm->aliasMap));
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     protected function cleanup()
  53.     {
  54.         parent::cleanup();
  56.         $this->_uow->triggerEagerLoads();
  57.         $this->_uow->hydrationComplete();
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      */
  63.     protected function hydrateAllData()
  64.     {
  65.         $result = [];
  67.         while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) {
  68.             $this->hydrateRowData($row, $result);
  69.         }
  71.         $this->_em->getUnitOfWork()->triggerEagerLoads();
  73.         return $result;
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     protected function hydrateRowData(array $sqlResult, array &$result)
  80.     {
  81.         $entityName = $this->class->name;
  82.         $data       = [];
  84.         // We need to find the correct entity class name if we have inheritance in resultset
  85.         if ($this->class->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  86.             $discrColumnName = $this->_platform->getSQLResultCasing($this->class->discriminatorColumn['name']);
  88.             // Find mapped discriminator column from the result set.
  89.             if ($metaMappingDiscrColumnName = array_search($discrColumnName, $this->_rsm->metaMappings)) {
  90.                 $discrColumnName = $metaMappingDiscrColumnName;
  91.             }
  93.             if ( ! isset($sqlResult[$discrColumnName])) {
  94.                 throw HydrationException::missingDiscriminatorColumn($entityName, $discrColumnName, key($this->_rsm->aliasMap));
  95.             }
  97.             if ($sqlResult[$discrColumnName] === '') {
  98.                 throw HydrationException::emptyDiscriminatorValue(key($this->_rsm->aliasMap));
  99.             }
  101.             $discrMap = $this->class->discriminatorMap;
  103.             if ( ! isset($discrMap[$sqlResult[$discrColumnName]])) {
  104.                 throw HydrationException::invalidDiscriminatorValue($sqlResult[$discrColumnName], array_keys($discrMap));
  105.             }
  107.             $entityName = $discrMap[$sqlResult[$discrColumnName]];
  109.             unset($sqlResult[$discrColumnName]);
  110.         }
  112.         foreach ($sqlResult as $column => $value) {
  113.             // An ObjectHydrator should be used instead of SimpleObjectHydrator
  114.             if (isset($this->_rsm->relationMap[$column])) {
  115.                 throw new \Exception(sprintf('Unable to retrieve association information for column "%s"', $column));
  116.             }
  118.             $cacheKeyInfo = $this->hydrateColumnInfo($column);
  120.             if ( ! $cacheKeyInfo) {
  121.                 continue;
  122.             }
  124.             // Check if value is null before conversion (because some types convert null to something else)
  125.             $valueIsNull = null === $value;
  127.             // Convert field to a valid PHP value
  128.             if (isset($cacheKeyInfo['type'])) {
  129.                 $type  = $cacheKeyInfo['type'];
  130.                 $value = $type->convertToPHPValue($value, $this->_platform);
  131.             }
  133.             $fieldName = $cacheKeyInfo['fieldName'];
  135.             // Prevent overwrite in case of inherit classes using same property name (See AbstractHydrator)
  136.             if ( ! isset($data[$fieldName]) || ! $valueIsNull) {
  137.                 $data[$fieldName] = $value;
  138.             }
  139.         }
  141.         if (isset($this->_hints[Query::HINT_REFRESH_ENTITY])) {
  142.             $this->registerManaged($this->class, $this->_hints[Query::HINT_REFRESH_ENTITY], $data);
  143.         }
  145.         $uow    = $this->_em->getUnitOfWork();
  146.         $entity = $uow->createEntity($entityName, $data, $this->_hints);
  148.         $result[] = $entity;
  150.         if (isset($this->_hints[Query::HINT_INTERNAL_ITERATION]) && $this->_hints[Query::HINT_INTERNAL_ITERATION]) {
  151.             $this->_uow->hydrationComplete();
  152.         }
  153.     }
  154. }