addiks /
symfony_rdm
| Total Complexity | 49 |
| Total Lines | 320 |
| Duplicated Lines | 0 % |
| Coverage | 35.7% |
| Changes | 4 | ||
| Bugs | 2 | Features | 1 |
Complex classes like BlackMagicDataLoader often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use BlackMagicDataLoader, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 54 | class BlackMagicDataLoader implements DataLoaderInterface |
||
| 55 | { |
||
| 56 | |||
| 57 | /** @var MappingDriverInterface */ |
||
| 58 | private $mappingDriver; |
||
| 59 | |||
| 60 | /** @var array<string, mixed>|null */ |
||
| 61 | private $entityDataCached; |
||
| 62 | |||
| 63 | /** @var array<string, Column>|null */ |
||
| 64 | private $dbalColumnsCached; |
||
| 65 | |||
| 66 | /** @var object|null */ |
||
| 67 | private $entityDataCacheSource; |
||
| 68 | |||
| 69 | private bool $hasBooted = false; |
||
| 70 | |||
| 71 | 1 | public function __construct(MappingDriverInterface $mappingDriver) |
|
| 72 | { |
||
| 73 | 1 | $this->mappingDriver = $mappingDriver; |
|
| 74 | } |
||
| 75 | |||
| 76 | 1 | public function boot(EntityManagerInterface $entityManager): void |
|
| 97 | } |
||
| 98 | } |
||
| 99 | } |
||
| 100 | } |
||
| 101 | |||
| 102 | public function loadDBALDataForEntity($entity, EntityManagerInterface $entityManager): array |
||
| 103 | { |
||
| 104 | /** @var array<string, string> $dbalData */ |
||
| 105 | $dbalData = array(); |
||
| 106 | |||
| 107 | /** @var class-string $className */ |
||
| 108 | $className = get_class($entity); |
||
| 109 | |||
| 110 | if (class_exists(ClassUtils::class)) { |
||
| 111 | $className = ClassUtils::getRealClass($className); |
||
| 112 | Assert::classExists($className); |
||
| 113 | } |
||
| 114 | |||
| 115 | /** @var ClassMetadata $classMetaData */ |
||
| 116 | $classMetaData = $entityManager->getClassMetadata($className); |
||
|
Unused Code
introduced
by
|
|||
| 117 | |||
| 118 | /** @var EntityMappingInterface|null $entityMapping */ |
||
| 119 | $entityMapping = $this->mappingDriver->loadRDMMetadataForClass($className); |
||
| 120 | |||
| 121 | if ($entityMapping instanceof EntityMappingInterface) { |
||
| 122 | /** @var array<Column> $columns */ |
||
| 123 | $columns = $entityMapping->collectDBALColumns(); |
||
| 124 | |||
| 125 | if (!empty($columns)) { |
||
| 126 | /** @var UnitOfWork $unitOfWork */ |
||
| 127 | $unitOfWork = $entityManager->getUnitOfWork(); |
||
| 128 | |||
| 129 | /** @var array<string, mixed> $originalEntityData */ |
||
| 130 | $originalEntityData = $unitOfWork->getOriginalEntityData($entity); |
||
| 131 | |||
| 132 | /** @var Column $column */ |
||
| 133 | foreach ($columns as $column) { |
||
| 134 | /** @var string $columnName */ |
||
| 135 | $columnName = $column->getName(); |
||
| 136 | |||
| 137 | /** @var string $fieldName */ |
||
| 138 | $fieldName = $this->columnToFieldName($column); |
||
| 139 | |||
| 140 | if (array_key_exists($fieldName, $originalEntityData)) { |
||
| 141 | $dbalData[$columnName] = $originalEntityData[$fieldName]; |
||
| 142 | |||
| 143 | } elseif (array_key_exists($columnName, $originalEntityData)) { |
||
| 144 | $dbalData[$columnName] = $originalEntityData[$columnName]; |
||
| 145 | } |
||
| 146 | } |
||
| 147 | } |
||
| 148 | } |
||
| 149 | |||
| 150 | return $dbalData; |
||
| 151 | } |
||
| 152 | |||
| 153 | public function storeDBALDataForEntity($entity, EntityManagerInterface $entityManager) |
||
| 154 | { |
||
| 155 | # This happens after doctrine has already UPDATE'd the row itself, do nothing here. |
||
| 156 | } |
||
| 157 | |||
| 158 | public function removeDBALDataForEntity($entity, EntityManagerInterface $entityManager) |
||
| 159 | { |
||
| 160 | # Doctrine DELETE's the row for us, we dont need to do anything here. |
||
| 161 | } |
||
| 162 | |||
| 163 | 1 | public function prepareOnMetadataLoad(EntityManagerInterface $entityManager, ClassMetadata $classMetadata) |
|
| 164 | { |
||
| 165 | 1 | $this->boot($entityManager); |
|
| 166 | |||
| 167 | /** @var class-string $className */ |
||
| 168 | 1 | $className = $classMetadata->getName(); |
|
| 169 | |||
| 170 | /** @var EntityMappingInterface|null $entityMapping */ |
||
| 171 | 1 | $entityMapping = $this->mappingDriver->loadRDMMetadataForClass($className); |
|
| 172 | |||
| 173 | 1 | if ($entityMapping instanceof EntityMappingInterface) { |
|
| 174 | /** @var array<Column> $dbalColumns */ |
||
| 175 | 1 | $dbalColumns = $entityMapping->collectDBALColumns(); |
|
| 176 | |||
| 177 | /** @var Column $column */ |
||
| 178 | 1 | foreach ($dbalColumns as $column) { |
|
| 179 | /** @var string $columnName */ |
||
| 180 | 1 | $columnName = $column->getName(); |
|
| 181 | |||
| 182 | /** @var string $fieldName */ |
||
| 183 | 1 | $fieldName = $this->columnToFieldName($column); |
|
| 184 | |||
| 185 | /** @psalm-suppress DeprecatedProperty */ |
||
| 186 | 1 | if (isset ($classMetadata->fieldNames) && isset($classMetadata->fieldNames[$columnName])) { |
|
| 187 | # This is a native doctrine column, do not touch! Otherwise the column might get unwanted UPDATE's. |
||
| 188 | continue; |
||
| 189 | } |
||
| 190 | |||
| 191 | /** @psalm-suppress DeprecatedProperty */ |
||
| 192 | 1 | $classMetadata->fieldNames[$columnName] = $fieldName; |
|
| 193 | |||
| 194 | /** @psalm-suppress DeprecatedProperty */ |
||
| 195 | 1 | if (isset ($classMetadata->columnNames) && !isset($classMetadata->columnNames[$fieldName])) { |
|
| 196 | 1 | $classMetadata->columnNames[$fieldName] = $columnName; |
|
| 197 | } |
||
| 198 | |||
| 199 | 1 | if (!isset($classMetadata->reflFields[$fieldName])) { |
|
| 200 | 1 | $classMetadata->reflFields[$fieldName] = new BlackMagicColumnReflectionPropertyMock( |
|
| 201 | $entityManager, |
||
| 202 | $classMetadata, |
||
| 203 | $column, |
||
| 204 | $fieldName, |
||
| 205 | $this |
||
| 206 | ); |
||
| 207 | } |
||
| 208 | |||
| 209 | 1 | if (!isset($classMetadata->fieldMappings[$fieldName])) { |
|
| 210 | /** @var FieldMapping $mapping */ |
||
| 211 | 1 | $mapping = array_merge( |
|
| 212 | 1 | $column->toArray(), |
|
| 213 | [ |
||
| 214 | 1 | 'columnName' => $columnName, |
|
| 215 | 'fieldName' => $fieldName, |
||
| 216 | 1 | 'nullable' => !$column->getNotnull(), |
|
| 217 | ] |
||
| 218 | ); |
||
| 219 | |||
| 220 | 1 | if (isset($mapping['type']) && $mapping['type'] instanceof Type) { |
|
| 221 | 1 | $mapping['type'] = $mapping['type']->getName(); |
|
| 222 | } |
||
| 223 | |||
| 224 | #$classMetadata->mapField($mapping); |
||
| 225 | 1 | $classMetadata->fieldMappings[$fieldName] = $mapping; |
|
| 226 | } |
||
| 227 | } |
||
| 228 | } |
||
| 229 | } |
||
| 230 | |||
| 231 | public function onColumnValueSetOnEntity( |
||
| 232 | EntityManagerInterface $entityManager, |
||
| 233 | ?object $entity, |
||
| 234 | string $columnName, |
||
| 235 | $value = null |
||
| 236 | ): void { |
||
| 237 | # Do nothing here, we first let doctrine collect all the data and the use that in "loadDBALDataForEntity" above. |
||
| 238 | } |
||
| 239 | |||
| 240 | public function onColumnValueRequestedFromEntity( |
||
| 241 | EntityManagerInterface $entityManager, |
||
| 242 | $entity, |
||
| 243 | string $columnName |
||
| 244 | ) { |
||
| 245 | /** @var array<string, mixed> $entityData */ |
||
| 246 | $entityData = array(); |
||
| 247 | |||
| 248 | /** @var array<string, Column> $dbalColumns */ |
||
| 249 | $dbalColumns = array(); |
||
| 250 | |||
| 251 | if (is_object($entity)) { |
||
| 252 | if ($entity === $this->entityDataCacheSource |
||
| 253 | && is_array($this->entityDataCached) |
||
| 254 | && array_key_exists($columnName, $this->entityDataCached)) { |
||
| 255 | # This caching mechanism stores only the data of the current entity |
||
| 256 | # and relies on doctrine only reading one entity at a time. |
||
| 257 | |||
| 258 | $entityData = $this->entityDataCached; |
||
| 259 | $dbalColumns = $this->dbalColumnsCached; |
||
| 260 | |||
| 261 | unset($this->entityDataCached[$columnName]); |
||
| 262 | |||
| 263 | } else { |
||
| 264 | /** @var class-string $className */ |
||
| 265 | $className = get_class($entity); |
||
| 266 | |||
| 267 | if (class_exists(ClassUtils::class)) { |
||
| 268 | $className = ClassUtils::getRealClass($className); |
||
| 269 | Assert::classExists($className); |
||
| 270 | } |
||
| 271 | |||
| 272 | /** @var EntityMappingInterface|null $entityMapping */ |
||
| 273 | $entityMapping = $this->mappingDriver->loadRDMMetadataForClass($className); |
||
| 274 | |||
| 275 | if ($entityMapping instanceof EntityMappingInterface) { |
||
| 276 | $context = new HydrationContext($entity, $entityManager); |
||
| 277 | |||
| 278 | $entityData = $entityMapping->revertValue($context, $entity); |
||
| 279 | |||
| 280 | /** @var Column $column */ |
||
| 281 | foreach ($entityMapping->collectDBALColumns() as $column) { |
||
| 282 | $dbalColumns[$column->getName()] = $column; |
||
| 283 | } |
||
| 284 | } |
||
| 285 | |||
| 286 | $this->entityDataCached = $entityData; |
||
| 287 | $this->entityDataCacheSource = $entity; |
||
| 288 | $this->dbalColumnsCached = $dbalColumns; |
||
| 289 | } |
||
| 290 | } |
||
| 291 | |||
| 292 | $value = $entityData[$columnName] ?? null; |
||
| 293 | |||
| 294 | if (!is_null($value) && isset($dbalColumns[$columnName])) { |
||
| 295 | /** @var AbstractPlatform $platform */ |
||
| 296 | $platform = $entityManager->getConnection()->getDatabasePlatform(); |
||
| 297 | |||
| 298 | /** @var Column $column */ |
||
| 299 | $column = $dbalColumns[$columnName]; |
||
| 300 | |||
| 301 | /** @var Type $type */ |
||
| 302 | $type = $column->getType(); |
||
| 303 | |||
| 304 | $value = $type->convertToPHPValue($value, $platform); |
||
| 305 | |||
| 306 | if (is_int($value) && $type->getName() === 'string') { |
||
| 307 | $value = (string)$value; |
||
| 308 | |||
| 309 | } elseif ($value instanceof DateTime) { |
||
| 310 | /** @var UnitOfWork $unitOfWork */ |
||
| 311 | $unitOfWork = $entityManager->getUnitOfWork(); |
||
| 312 | |||
| 313 | /** @var mixed $originalValue */ |
||
| 314 | $originalValue = null; |
||
| 315 | |||
| 316 | if ($this->isDateTimeEqualToValueFromUnitOfWorkButNotSame($value, $unitOfWork, $column, $entity, $originalValue)) { |
||
| 317 | # Because doctrine uses '===' to compute changesets when compaing original with actual, |
||
| 318 | # we need to keep the identity of DateTime objects if they are actually the "same". |
||
| 319 | $value = $originalValue; |
||
| 320 | } |
||
| 321 | } |
||
| 322 | } |
||
| 323 | |||
| 324 | return $value; |
||
| 325 | } |
||
| 326 | |||
| 327 | 1 | public function columnToFieldName(Column $column): string |
|
| 328 | { |
||
| 329 | /** @var string $columnName */ |
||
| 330 | 1 | $columnName = $column->getName(); |
|
| 331 | |||
| 332 | /** @var string $fieldName */ |
||
| 333 | 1 | $fieldName = '__COLUMN__' . $columnName; |
|
| 334 | |||
| 335 | 1 | return $fieldName; |
|
| 336 | } |
||
| 337 | |||
| 338 | private function isDateTimeEqualToValueFromUnitOfWorkButNotSame( |
||
| 374 | } |
||
| 375 | |||
| 376 | } |
||
| 377 |
Loading history...