AbstractHydrator.php
9 months ago
ArrayHydrator.php
9 months ago
HydrationException.php
9 months ago
IterableResult.php
9 months ago
ObjectHydrator.php
9 months ago
ScalarColumnHydrator.php
9 months ago
ScalarHydrator.php
9 months ago
SimpleObjectHydrator.php
9 months ago
SingleScalarHydrator.php
9 months ago
index.php
9 months ago
AbstractHydrator.php
324 lines
| 1 | <?php |
| 2 | declare (strict_types=1); |
| 3 | namespace MailPoetVendor\Doctrine\ORM\Internal\Hydration; |
| 4 | if (!defined('ABSPATH')) exit; |
| 5 | use BackedEnum; |
| 6 | use MailPoetVendor\Doctrine\DBAL\Driver\ResultStatement; |
| 7 | use MailPoetVendor\Doctrine\DBAL\ForwardCompatibility\Result as ForwardCompatibilityResult; |
| 8 | use MailPoetVendor\Doctrine\DBAL\Platforms\AbstractPlatform; |
| 9 | use MailPoetVendor\Doctrine\DBAL\Result; |
| 10 | use MailPoetVendor\Doctrine\DBAL\Types\Type; |
| 11 | use MailPoetVendor\Doctrine\Deprecations\Deprecation; |
| 12 | use MailPoetVendor\Doctrine\ORM\EntityManagerInterface; |
| 13 | use MailPoetVendor\Doctrine\ORM\Events; |
| 14 | use MailPoetVendor\Doctrine\ORM\Mapping\ClassMetadata; |
| 15 | use MailPoetVendor\Doctrine\ORM\Query\ResultSetMapping; |
| 16 | use MailPoetVendor\Doctrine\ORM\Tools\Pagination\LimitSubqueryWalker; |
| 17 | use MailPoetVendor\Doctrine\ORM\UnitOfWork; |
| 18 | use Generator; |
| 19 | use LogicException; |
| 20 | use ReflectionClass; |
| 21 | use TypeError; |
| 22 | use function array_map; |
| 23 | use function array_merge; |
| 24 | use function count; |
| 25 | use function current; |
| 26 | use function end; |
| 27 | use function get_debug_type; |
| 28 | use function in_array; |
| 29 | use function is_array; |
| 30 | use function is_object; |
| 31 | use function sprintf; |
| 32 | abstract class AbstractHydrator |
| 33 | { |
| 34 | protected $_rsm; |
| 35 | protected $_em; |
| 36 | protected $_platform; |
| 37 | protected $_uow; |
| 38 | protected $_metadataCache = []; |
| 39 | protected $_cache = []; |
| 40 | protected $_stmt; |
| 41 | protected $_hints = []; |
| 42 | public function __construct(EntityManagerInterface $em) |
| 43 | { |
| 44 | $this->_em = $em; |
| 45 | $this->_platform = $em->getConnection()->getDatabasePlatform(); |
| 46 | $this->_uow = $em->getUnitOfWork(); |
| 47 | } |
| 48 | public function iterate($stmt, $resultSetMapping, array $hints = []) |
| 49 | { |
| 50 | Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8463', 'Method %s() is deprecated and will be removed in Doctrine ORM 3.0. Use toIterable() instead.', __METHOD__); |
| 51 | $this->_stmt = $stmt instanceof ResultStatement ? ForwardCompatibilityResult::ensure($stmt) : $stmt; |
| 52 | $this->_rsm = $resultSetMapping; |
| 53 | $this->_hints = $hints; |
| 54 | $evm = $this->_em->getEventManager(); |
| 55 | $evm->addEventListener([Events::onClear], $this); |
| 56 | $this->prepare(); |
| 57 | return new IterableResult($this); |
| 58 | } |
| 59 | public function toIterable($stmt, ResultSetMapping $resultSetMapping, array $hints = []) : iterable |
| 60 | { |
| 61 | if (!$stmt instanceof Result) { |
| 62 | if (!$stmt instanceof ResultStatement) { |
| 63 | throw new TypeError(sprintf('%s: Expected parameter $stmt to be an instance of %s or %s, got %s', __METHOD__, Result::class, ResultStatement::class, get_debug_type($stmt))); |
| 64 | } |
| 65 | Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/8796', '%s: Passing a result as $stmt that does not implement %s is deprecated and will cause a TypeError on 3.0', __METHOD__, Result::class); |
| 66 | $stmt = ForwardCompatibilityResult::ensure($stmt); |
| 67 | } |
| 68 | $this->_stmt = $stmt; |
| 69 | $this->_rsm = $resultSetMapping; |
| 70 | $this->_hints = $hints; |
| 71 | $evm = $this->_em->getEventManager(); |
| 72 | $evm->addEventListener([Events::onClear], $this); |
| 73 | $this->prepare(); |
| 74 | try { |
| 75 | while (\true) { |
| 76 | $row = $this->statement()->fetchAssociative(); |
| 77 | if ($row === \false) { |
| 78 | break; |
| 79 | } |
| 80 | $result = []; |
| 81 | $this->hydrateRowData($row, $result); |
| 82 | $this->cleanupAfterRowIteration(); |
| 83 | if (count($result) === 1) { |
| 84 | if (count($resultSetMapping->indexByMap) === 0) { |
| 85 | (yield end($result)); |
| 86 | } else { |
| 87 | yield from $result; |
| 88 | } |
| 89 | } elseif (is_object(current($result))) { |
| 90 | (yield $result); |
| 91 | } else { |
| 92 | (yield array_merge(...$result)); |
| 93 | } |
| 94 | } |
| 95 | } finally { |
| 96 | $this->cleanup(); |
| 97 | } |
| 98 | } |
| 99 | protected final function statement() : Result |
| 100 | { |
| 101 | if ($this->_stmt === null) { |
| 102 | throw new LogicException('Uninitialized _stmt property'); |
| 103 | } |
| 104 | return $this->_stmt; |
| 105 | } |
| 106 | protected final function resultSetMapping() : ResultSetMapping |
| 107 | { |
| 108 | if ($this->_rsm === null) { |
| 109 | throw new LogicException('Uninitialized _rsm property'); |
| 110 | } |
| 111 | return $this->_rsm; |
| 112 | } |
| 113 | public function hydrateAll($stmt, $resultSetMapping, array $hints = []) |
| 114 | { |
| 115 | if (!$stmt instanceof Result) { |
| 116 | if (!$stmt instanceof ResultStatement) { |
| 117 | throw new TypeError(sprintf('%s: Expected parameter $stmt to be an instance of %s or %s, got %s', __METHOD__, Result::class, ResultStatement::class, get_debug_type($stmt))); |
| 118 | } |
| 119 | Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/8796', '%s: Passing a result as $stmt that does not implement %s is deprecated and will cause a TypeError on 3.0', __METHOD__, Result::class); |
| 120 | $stmt = ForwardCompatibilityResult::ensure($stmt); |
| 121 | } |
| 122 | $this->_stmt = $stmt; |
| 123 | $this->_rsm = $resultSetMapping; |
| 124 | $this->_hints = $hints; |
| 125 | $this->_em->getEventManager()->addEventListener([Events::onClear], $this); |
| 126 | $this->prepare(); |
| 127 | try { |
| 128 | $result = $this->hydrateAllData(); |
| 129 | } finally { |
| 130 | $this->cleanup(); |
| 131 | } |
| 132 | return $result; |
| 133 | } |
| 134 | public function hydrateRow() |
| 135 | { |
| 136 | Deprecation::triggerIfCalledFromOutside('doctrine/orm', 'https://github.com/doctrine/orm/pull/9072', '%s is deprecated.', __METHOD__); |
| 137 | $row = $this->statement()->fetchAssociative(); |
| 138 | if ($row === \false) { |
| 139 | $this->cleanup(); |
| 140 | return \false; |
| 141 | } |
| 142 | $result = []; |
| 143 | $this->hydrateRowData($row, $result); |
| 144 | return $result; |
| 145 | } |
| 146 | public function onClear($eventArgs) |
| 147 | { |
| 148 | } |
| 149 | protected function prepare() |
| 150 | { |
| 151 | } |
| 152 | protected function cleanup() |
| 153 | { |
| 154 | $this->statement()->free(); |
| 155 | $this->_stmt = null; |
| 156 | $this->_rsm = null; |
| 157 | $this->_cache = []; |
| 158 | $this->_metadataCache = []; |
| 159 | $this->_em->getEventManager()->removeEventListener([Events::onClear], $this); |
| 160 | } |
| 161 | protected function cleanupAfterRowIteration() : void |
| 162 | { |
| 163 | } |
| 164 | protected function hydrateRowData(array $row, array &$result) |
| 165 | { |
| 166 | throw new HydrationException('hydrateRowData() not implemented by this hydrator.'); |
| 167 | } |
| 168 | protected abstract function hydrateAllData(); |
| 169 | protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents) |
| 170 | { |
| 171 | $rowData = ['data' => []]; |
| 172 | foreach ($data as $key => $value) { |
| 173 | $cacheKeyInfo = $this->hydrateColumnInfo($key); |
| 174 | if ($cacheKeyInfo === null) { |
| 175 | continue; |
| 176 | } |
| 177 | $fieldName = $cacheKeyInfo['fieldName']; |
| 178 | switch (\true) { |
| 179 | case isset($cacheKeyInfo['isNewObjectParameter']): |
| 180 | $argIndex = $cacheKeyInfo['argIndex']; |
| 181 | $objIndex = $cacheKeyInfo['objIndex']; |
| 182 | $type = $cacheKeyInfo['type']; |
| 183 | $value = $type->convertToPHPValue($value, $this->_platform); |
| 184 | if ($value !== null && isset($cacheKeyInfo['enumType'])) { |
| 185 | $value = $this->buildEnum($value, $cacheKeyInfo['enumType']); |
| 186 | } |
| 187 | $rowData['newObjects'][$objIndex]['class'] = $cacheKeyInfo['class']; |
| 188 | $rowData['newObjects'][$objIndex]['args'][$argIndex] = $value; |
| 189 | break; |
| 190 | case isset($cacheKeyInfo['isScalar']): |
| 191 | $type = $cacheKeyInfo['type']; |
| 192 | $value = $type->convertToPHPValue($value, $this->_platform); |
| 193 | if ($value !== null && isset($cacheKeyInfo['enumType'])) { |
| 194 | $value = $this->buildEnum($value, $cacheKeyInfo['enumType']); |
| 195 | } |
| 196 | $rowData['scalars'][$fieldName] = $value; |
| 197 | break; |
| 198 | //case (isset($cacheKeyInfo['isMetaColumn'])): |
| 199 | default: |
| 200 | $dqlAlias = $cacheKeyInfo['dqlAlias']; |
| 201 | $type = $cacheKeyInfo['type']; |
| 202 | // If there are field name collisions in the child class, then we need |
| 203 | // to only hydrate if we are looking at the correct discriminator value |
| 204 | if (isset($cacheKeyInfo['discriminatorColumn'], $data[$cacheKeyInfo['discriminatorColumn']]) && !in_array((string) $data[$cacheKeyInfo['discriminatorColumn']], $cacheKeyInfo['discriminatorValues'], \true)) { |
| 205 | break; |
| 206 | } |
| 207 | // in an inheritance hierarchy the same field could be defined several times. |
| 208 | // We overwrite this value so long we don't have a non-null value, that value we keep. |
| 209 | // Per definition it cannot be that a field is defined several times and has several values. |
| 210 | if (isset($rowData['data'][$dqlAlias][$fieldName])) { |
| 211 | break; |
| 212 | } |
| 213 | $rowData['data'][$dqlAlias][$fieldName] = $type ? $type->convertToPHPValue($value, $this->_platform) : $value; |
| 214 | if ($rowData['data'][$dqlAlias][$fieldName] !== null && isset($cacheKeyInfo['enumType'])) { |
| 215 | $rowData['data'][$dqlAlias][$fieldName] = $this->buildEnum($rowData['data'][$dqlAlias][$fieldName], $cacheKeyInfo['enumType']); |
| 216 | } |
| 217 | if ($cacheKeyInfo['isIdentifier'] && $value !== null) { |
| 218 | $id[$dqlAlias] .= '|' . $value; |
| 219 | $nonemptyComponents[$dqlAlias] = \true; |
| 220 | } |
| 221 | break; |
| 222 | } |
| 223 | } |
| 224 | return $rowData; |
| 225 | } |
| 226 | protected function gatherScalarRowData(&$data) |
| 227 | { |
| 228 | $rowData = []; |
| 229 | foreach ($data as $key => $value) { |
| 230 | $cacheKeyInfo = $this->hydrateColumnInfo($key); |
| 231 | if ($cacheKeyInfo === null) { |
| 232 | continue; |
| 233 | } |
| 234 | $fieldName = $cacheKeyInfo['fieldName']; |
| 235 | // WARNING: BC break! We know this is the desired behavior to type convert values, but this |
| 236 | // erroneous behavior exists since 2.0 and we're forced to keep compatibility. |
| 237 | if (!isset($cacheKeyInfo['isScalar'])) { |
| 238 | $type = $cacheKeyInfo['type']; |
| 239 | $value = $type ? $type->convertToPHPValue($value, $this->_platform) : $value; |
| 240 | $fieldName = $cacheKeyInfo['dqlAlias'] . '_' . $fieldName; |
| 241 | } |
| 242 | $rowData[$fieldName] = $value; |
| 243 | } |
| 244 | return $rowData; |
| 245 | } |
| 246 | protected function hydrateColumnInfo($key) |
| 247 | { |
| 248 | if (isset($this->_cache[$key])) { |
| 249 | return $this->_cache[$key]; |
| 250 | } |
| 251 | switch (\true) { |
| 252 | // NOTE: Most of the times it's a field mapping, so keep it first!!! |
| 253 | case isset($this->_rsm->fieldMappings[$key]): |
| 254 | $classMetadata = $this->getClassMetadata($this->_rsm->declaringClasses[$key]); |
| 255 | $fieldName = $this->_rsm->fieldMappings[$key]; |
| 256 | $fieldMapping = $classMetadata->fieldMappings[$fieldName]; |
| 257 | $ownerMap = $this->_rsm->columnOwnerMap[$key]; |
| 258 | $columnInfo = ['isIdentifier' => in_array($fieldName, $classMetadata->identifier, \true), 'fieldName' => $fieldName, 'type' => Type::getType($fieldMapping['type']), 'dqlAlias' => $ownerMap, 'enumType' => $this->_rsm->enumMappings[$key] ?? null]; |
| 259 | // the current discriminator value must be saved in order to disambiguate fields hydration, |
| 260 | // should there be field name collisions |
| 261 | if ($classMetadata->parentClasses && isset($this->_rsm->discriminatorColumns[$ownerMap])) { |
| 262 | return $this->_cache[$key] = array_merge($columnInfo, ['discriminatorColumn' => $this->_rsm->discriminatorColumns[$ownerMap], 'discriminatorValue' => $classMetadata->discriminatorValue, 'discriminatorValues' => $this->getDiscriminatorValues($classMetadata)]); |
| 263 | } |
| 264 | return $this->_cache[$key] = $columnInfo; |
| 265 | case isset($this->_rsm->newObjectMappings[$key]): |
| 266 | // WARNING: A NEW object is also a scalar, so it must be declared before! |
| 267 | $mapping = $this->_rsm->newObjectMappings[$key]; |
| 268 | return $this->_cache[$key] = ['isScalar' => \true, 'isNewObjectParameter' => \true, 'fieldName' => $this->_rsm->scalarMappings[$key], 'type' => Type::getType($this->_rsm->typeMappings[$key]), 'argIndex' => $mapping['argIndex'], 'objIndex' => $mapping['objIndex'], 'class' => new ReflectionClass($mapping['className']), 'enumType' => $this->_rsm->enumMappings[$key] ?? null]; |
| 269 | case isset($this->_rsm->scalarMappings[$key], $this->_hints[LimitSubqueryWalker::FORCE_DBAL_TYPE_CONVERSION]): |
| 270 | return $this->_cache[$key] = ['fieldName' => $this->_rsm->scalarMappings[$key], 'type' => Type::getType($this->_rsm->typeMappings[$key]), 'dqlAlias' => '', 'enumType' => $this->_rsm->enumMappings[$key] ?? null]; |
| 271 | case isset($this->_rsm->scalarMappings[$key]): |
| 272 | return $this->_cache[$key] = ['isScalar' => \true, 'fieldName' => $this->_rsm->scalarMappings[$key], 'type' => Type::getType($this->_rsm->typeMappings[$key]), 'enumType' => $this->_rsm->enumMappings[$key] ?? null]; |
| 273 | case isset($this->_rsm->metaMappings[$key]): |
| 274 | // Meta column (has meaning in relational schema only, i.e. foreign keys or discriminator columns). |
| 275 | $fieldName = $this->_rsm->metaMappings[$key]; |
| 276 | $dqlAlias = $this->_rsm->columnOwnerMap[$key]; |
| 277 | $type = isset($this->_rsm->typeMappings[$key]) ? Type::getType($this->_rsm->typeMappings[$key]) : null; |
| 278 | // Cache metadata fetch |
| 279 | $this->getClassMetadata($this->_rsm->aliasMap[$dqlAlias]); |
| 280 | return $this->_cache[$key] = ['isIdentifier' => isset($this->_rsm->isIdentifierColumn[$dqlAlias][$key]), 'isMetaColumn' => \true, 'fieldName' => $fieldName, 'type' => $type, 'dqlAlias' => $dqlAlias, 'enumType' => $this->_rsm->enumMappings[$key] ?? null]; |
| 281 | } |
| 282 | // this column is a left over, maybe from a LIMIT query hack for example in Oracle or DB2 |
| 283 | // maybe from an additional column that has not been defined in a NativeQuery ResultSetMapping. |
| 284 | return null; |
| 285 | } |
| 286 | private function getDiscriminatorValues(ClassMetadata $classMetadata) : array |
| 287 | { |
| 288 | $values = array_map(function (string $subClass) : string { |
| 289 | return (string) $this->getClassMetadata($subClass)->discriminatorValue; |
| 290 | }, $classMetadata->subClasses); |
| 291 | $values[] = (string) $classMetadata->discriminatorValue; |
| 292 | return $values; |
| 293 | } |
| 294 | protected function getClassMetadata($className) |
| 295 | { |
| 296 | if (!isset($this->_metadataCache[$className])) { |
| 297 | $this->_metadataCache[$className] = $this->_em->getClassMetadata($className); |
| 298 | } |
| 299 | return $this->_metadataCache[$className]; |
| 300 | } |
| 301 | protected function registerManaged(ClassMetadata $class, $entity, array $data) |
| 302 | { |
| 303 | if ($class->isIdentifierComposite) { |
| 304 | $id = []; |
| 305 | foreach ($class->identifier as $fieldName) { |
| 306 | $id[$fieldName] = isset($class->associationMappings[$fieldName]) ? $data[$class->associationMappings[$fieldName]['joinColumns'][0]['name']] : $data[$fieldName]; |
| 307 | } |
| 308 | } else { |
| 309 | $fieldName = $class->identifier[0]; |
| 310 | $id = [$fieldName => isset($class->associationMappings[$fieldName]) ? $data[$class->associationMappings[$fieldName]['joinColumns'][0]['name']] : $data[$fieldName]]; |
| 311 | } |
| 312 | $this->_em->getUnitOfWork()->registerManaged($entity, $id, $data); |
| 313 | } |
| 314 | protected final function buildEnum($value, string $enumType) |
| 315 | { |
| 316 | if (is_array($value)) { |
| 317 | return array_map(static function ($value) use($enumType) : BackedEnum { |
| 318 | return $enumType::from($value); |
| 319 | }, $value); |
| 320 | } |
| 321 | return $enumType::from($value); |
| 322 | } |
| 323 | } |
| 324 |