SimpleSelectDataLoader::prepareOnMetadataLoad() - Code Metrics - addiks/symfony_rdm - Measure and Improve Code Quality continuously with Scrutinizer

SimpleSelectDataLoader::prepareOnMetadataLoad() A
last analyzed 2024-11-12 10:58 UTC

↳ Parent: SimpleSelectDataLoader
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	0
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	1
eloc	0
c	1
b	0
f	1
nc	1
nop	2
dl	0
loc	2
ccs	0
cts	0
cp	0
crap	2
rs	10
<?php
/**
 * Copyright (C) 2018 Gerrit Addiks.
 * This package (including this file) was released under the terms of the GPL-3.0.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
 * @license GPL-3.0
 * @author Gerrit Addiks <[email protected]>
 */

namespace Addiks\RDMBundle\DataLoader;

use Addiks\RDMBundle\DataLoader\DataLoaderInterface;
use Addiks\RDMBundle\Mapping\Drivers\MappingDriverInterface;
use Addiks\RDMBundle\Mapping\EntityMappingInterface;
use Closure;
use Doctrine\Common\Util\ClassUtils;
use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Query\QueryBuilder;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadata;
use ReflectionClass;
use ReflectionProperty;
use Doctrine\ORM\Query\Expr;
use Doctrine\DBAL\Driver\Statement;
use PDO;
use Addiks\RDMBundle\Mapping\MappingInterface;
use Addiks\RDMBundle\Hydration\HydrationContext;
use Webmozart\Assert\Assert;
use ErrorException;

/**
 * A very simple loader that just executes one simple select statement for every entity to load the data for.
 *
 * Because it executes one query for every entity to load data for, this could (and probably will) have an bad impact on
 * performance.
 *
 * TODO: This may be replaced in the future by integrating that data-loading into the select(s) executed by doctrine.
 */
final class SimpleSelectDataLoader implements DataLoaderInterface
{

    /**
     * @var MappingDriverInterface
     */
    private $mappingDriver;

    /**
     * @var array<array<string, string>>
     */
    private $originalData = array();

    public function __construct(
        MappingDriverInterface $mappingDriver
    ) {
        $this->mappingDriver = $mappingDriver;
    }

    public function boot(EntityManagerInterface|Closure $entityManager): void
    {
    }

    /**
     * @param object $entity
     *
     * @return array<string, string>
     */
    public function loadDBALDataForEntity($entity, EntityManagerInterface $entityManager): array
    {
        /** @var class-string $className */
        $className = get_class($entity);

        /** @var string $entityObjectHash */
        $entityObjectHash = spl_object_hash($entity);

        $this->originalData[$entityObjectHash] = [];

        /** @var array<string> $additionalData */
        $additionalData = array();


        do {
            if (class_exists(ClassUtils::class)) {
                $className = ClassUtils::getRealClass($className);
                Assert::classExists($className);
            }

            if (!$entityManager->getMetadataFactory()->isTransient($className)) {
                /** @var ClassMetadata $classMetaData */
                $classMetaData = $entityManager->getClassMetadata($className);

                /** @var ?EntityMappingInterface $entityMapping */
                $entityMapping = $this->mappingDriver->loadRDMMetadataForClass($className);

                if ($entityMapping instanceof EntityMappingInterface) {
                    /** @var array<Column> $additionalColumns */
                    $additionalColumns = $entityMapping->collectDBALColumns();

                    if (!empty($additionalColumns)) {
                        /** @var Connection $connection */
                        $connection = $entityManager->getConnection();

                        /** @var QueryBuilder $queryBuilder */
                        $queryBuilder = $connection->createQueryBuilder();

                        /** @var Expr $expr */
                        $expr = $queryBuilder->expr();

                        foreach ($additionalColumns as $column) {
                            /** @var Column $column */

                            $queryBuilder->addSelect($column->getName());
                        }

                        $reflectionClass = new ReflectionClass($className);

                        /** @var bool $hasId */
                        $hasId = false;

                        foreach ($classMetaData->identifier as $idFieldName) {
                            /** @var string $idFieldName */

                            /** @var array $idColumn */
                            $idColumn = $classMetaData->fieldMappings[$idFieldName];

                            /** @var ReflectionProperty $reflectionProperty */
                            $reflectionProperty = $reflectionClass->getProperty($idFieldName);

                            $reflectionProperty->setAccessible(true);

                            $idValue = $reflectionProperty->getValue($entity);

                            if (!empty($idValue)) {
                                $hasId = true;
                                if (!is_numeric($idValue) || empty($idValue)) {
                                    $idValue = "'{$idValue}'";
                                }
                                $queryBuilder->andWhere($expr->eq($idColumn['columnName'], $idValue));
                            }
                        }

                        if ($hasId) {
                            $queryBuilder->from($classMetaData->getTableName());
                            $queryBuilder->setMaxResults(1);

                            /** @var Statement $statement */
                            $statement = $queryBuilder->execute();

                            $additionalData = $statement->fetch(PDO::FETCH_ASSOC);
                            $additionalData = /** @scrutinizer ignore-deprecated */ $statement->fetch(PDO::FETCH_ASSOC);

                            if (!is_array($additionalData)) {
                                $additionalData = array();
                            }

                            $this->originalData[$entityObjectHash] = array_merge(
                                $this->originalData[$entityObjectHash],
                                $additionalData
                            );
                        }
                    }
                }
            }

            $className = current(class_parents($className));
        } while (class_exists($className));

        return $this->originalData[$entityObjectHash] ?? [];
    }

    /**
     * @param object $entity
     */
    public function storeDBALDataForEntity($entity, EntityManagerInterface $entityManager): void
    {
        /** @var class-string $className */
        $className = get_class($entity);

        if (class_exists(ClassUtils::class)) {
            $className = ClassUtils::getRealClass($className);
            Assert::classExists($className);
        }

        do {
            /** @var null|EntityMappingInterface $entityMapping */
            $entityMapping = $this->mappingDriver->loadRDMMetadataForClass($className);

            if ($entityMapping instanceof EntityMappingInterface) {
                $context = new HydrationContext($entity, $entityManager);

                /** @var array<scalar> */
                $additionalData = $entityMapping->revertValue($context, $entity);

                if ($this->hasDataChanged($entity, $additionalData)) {
                    /** @var ClassMetadata $classMetaData */
                    $classMetaData = $entityManager->getClassMetadata($className);

                    /** @var array<scalar> $identifier */
                    $identifier = $this->collectIdentifierForEntity($entity, $entityMapping, $classMetaData);

                    /** @var string $tableName */
                    $tableName = $classMetaData->getTableName();

                    /** @var Connection $connection */
                    $connection = $entityManager->getConnection();

                    $connection->update($tableName, $additionalData, $identifier);
                }
            }

            $className = current(class_parents($className));
        } while (class_exists($className));
    }

    /**
     * @param object $entity
     */
    public function removeDBALDataForEntity($entity, EntityManagerInterface $entityManager): void
    {
        # This data-loader does not store data outside the entity-table.
        # No additional data need to be removed.
    }

    public function prepareOnMetadataLoad(EntityManagerInterface $entityManager, ClassMetadata $classMetadata): void
    {
        # This data-loader does not need any preparation
    }

    /**
     * @param object $entity
     */
    private function hasDataChanged($entity, array $additionalData): bool
    {
        /** @var array<scalar> */
        $originalData = array();

        /** @var string $entityObjectHash */
        $entityObjectHash = spl_object_hash($entity);

        if (isset($this->originalData[$entityObjectHash])) {
            $originalData = $this->originalData[$entityObjectHash];
        }

        /** @var bool $hasDataChanged */
        $hasDataChanged = false;

        foreach ($additionalData as $key => $value) {
            if (!array_key_exists($key, $originalData) || $originalData[$key] != $value) {
                $hasDataChanged = true;
                break;
            }
        }

        return $hasDataChanged;
    }

    /**
     * @param object $entity
     */
    private function collectIdentifierForEntity(
        $entity,
        EntityMappingInterface $entityMapping,
        ClassMetadata $classMetaData
    ): array {
        $reflectionClass = new ReflectionClass($entityMapping->getEntityClassName());

        /** @var array<scalar> $identifier */
        $identifier = array();

        foreach ($classMetaData->identifier as $idFieldName) {
            /** @var string $idFieldName */

            /** @var array $idColumn */
            $idColumn = $classMetaData->fieldMappings[$idFieldName];

            /** @var ReflectionProperty $reflectionProperty */
            $reflectionProperty = $reflectionClass->getProperty($idFieldName);

            $reflectionProperty->setAccessible(true);

            $idValue = $reflectionProperty->getValue($entity);

            $identifier[$idColumn['columnName']] = $idValue;
        }

        return $identifier;
    }

}

addiks / symfony_rdm

SimpleSelectDataLoader::prepareOnMetadataLoad() A last analyzed 2024-11-12 10:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SimpleSelectDataLoader::prepareOnMetadataLoad() A
last analyzed 2024-11-12 10:58 UTC
