Doctrine\ORM\Query\Exec\MultiTableUpdateExecutor

Complexity

Total Complexity

14

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Test Coverage

Coverage

96.1%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	39	5
D	__construct()	0	98	9

<?php

declare(strict_types=1);

namespace Doctrine\ORM\Query\Exec;

use Doctrine\DBAL\Connection;
use Doctrine\ORM\Query\AST;
use Doctrine\ORM\Query\AST\Node;
use Doctrine\ORM\Query\ParameterTypeInferer;
use Doctrine\ORM\Query\SqlWalker;
use Throwable;
use function array_keys;
use function array_map;
use function array_merge;
use function array_reverse;
use function array_slice;
use function implode;
use function sprintf;

/**
 * Executes the SQL statements for bulk DQL UPDATE statements on classes in
 * Class Table Inheritance (JOINED).
 */
class MultiTableUpdateExecutor extends AbstractSqlExecutor
{
    /** @var string */
    private $createTempTableSql;

    /** @var string */
    private $dropTempTableSql;

    /** @var string */
    private $insertSql;

    /** @var mixed[] */
    private $sqlParameters = [];

    /** @var int */
    private $numParametersInUpdateClause = 0;

    /**
     * Initializes a new <tt>MultiTableUpdateExecutor</tt>.
     *
     * {@internal Any SQL construction and preparation takes place in the constructor for
     *            best performance. With a query cache the executor will be cached. }}
     *
     * @param Node      $AST       The root AST node of the DQL query.
     * @param SqlWalker $sqlWalker The walker used for SQL generation from the AST.
     */
    public function __construct(AST\Node $AST, $sqlWalker)
    {
        $em       = $sqlWalker->getEntityManager();
        $conn     = $em->getConnection();
        $platform = $conn->getDatabasePlatform();

        $updateClause = $AST->updateClause;
        $primaryClass = $sqlWalker->getEntityManager()->getClassMetadata($updateClause->abstractSchemaName);
        $rootClass    = $em->getClassMetadata($primaryClass->getRootClassName());

The method getRootClassName() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

        $updateItems = $updateClause->updateItems;

        $tempTable        = $platform->getTemporaryTableName($rootClass->getTemporaryIdTableName());

The method getTemporaryIdTableName() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

        $idColumns        = $rootClass->getIdentifierColumns($em);

The method getIdentifierColumns() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata. Did you maybe mean getIdentifier()?

        $idColumnNameList = implode(', ', array_keys($idColumns));

        // 1. Create an INSERT INTO temptable ... SELECT identifiers WHERE $AST->getWhereClause()
        $sqlWalker->setSQLTableAlias($primaryClass->getTableName(), 'i0', $updateClause->aliasIdentificationVariable);

The method getTableName() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

        $this->insertSql = 'INSERT INTO ' . $tempTable . ' (' . $idColumnNameList . ')'
                . ' SELECT i0.' . implode(', i0.', array_keys($idColumns));

        $rangeDecl  = new AST\RangeVariableDeclaration($primaryClass->getClassName(), $updateClause->aliasIdentificationVariable);

The method getClassName() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

        $fromClause = new AST\FromClause([new AST\IdentificationVariableDeclaration($rangeDecl, null, [])]);

        $this->insertSql .= $sqlWalker->walkFromClause($fromClause);

        // 2. Create statement used in UPDATE ... WHERE ... IN (subselect)
        $updateSQLTemplate = sprintf(
            'UPDATE %%s SET %%s WHERE (%s) IN (SELECT %s FROM %s)',
            $idColumnNameList,
            $idColumnNameList,
            $tempTable
        );

        // 3. Create and store UPDATE statements
        $hierarchyClasses = array_merge(
            array_map(
                function ($className) use ($em) {
                    return $em->getClassMetadata($className);
                },
                array_reverse($primaryClass->getSubClasses())

The method getSubClasses() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

            ),
            [$primaryClass],
            $primaryClass->getAncestorsIterator()->getArrayCopy()

The method getAncestorsIterator() does not exist on Doctrine\Common\Persistence\Mapping\ClassMetadata.

        );

        $i = 0;

        foreach ($hierarchyClasses as $class) {
            $updateSQLParts = [];

            foreach ($updateItems as $updateItem) {
                $field    = $updateItem->pathExpression->field;
                $property = $class->getProperty($field);

                if ($property && ! $class->isInheritedProperty($field)) {
                    $updateSQLParts[] = $sqlWalker->walkUpdateItem($updateItem);
                    $newValue         = $updateItem->newValue;

                    if ($newValue instanceof AST\InputParameter) {
                        $this->sqlParameters[$i][] = $newValue->name;

                        ++$this->numParametersInUpdateClause;
                    }
                }
            }

            if ($updateSQLParts) {
                $this->sqlStatements[$i] = sprintf(
                    $updateSQLTemplate,
                    $class->table->getQuotedQualifiedName($platform),
                    implode(', ', $updateSQLParts)
                );

                $i++;
            }
        }

        // Append WHERE clause to insertSql, if there is one.
        if ($AST->whereClause) {
            $this->insertSql .= $sqlWalker->walkWhereClause($AST->whereClause);
        }

        // 4. Store DDL for temporary identifier table.
        $columnDefinitions = [];

        foreach ($idColumns as $columnName => $column) {
            $columnDefinitions[$columnName] = [
                'notnull' => true,
                'type'    => $column->getType(),
            ];
        }

        $this->createTempTableSql = $platform->getCreateTemporaryTableSnippetSQL() . ' ' . $tempTable . ' ('
                . $platform->getColumnDeclarationListSQL($columnDefinitions) . ')';

        $this->dropTempTableSql = $platform->getDropTemporaryTableSQL($tempTable);
    }

    /**
     * {@inheritDoc}
     */
    public function execute(Connection $conn, array $params, array $types)
    {
        // Create temporary id table
        $conn->executeUpdate($this->createTempTableSql);

        try {
            // Insert identifiers. Parameters from the update clause are cut off.
            $numUpdated = $conn->executeUpdate(
                $this->insertSql,
                array_slice($params, $this->numParametersInUpdateClause),
                array_slice($types, $this->numParametersInUpdateClause)
            );

            // Execute UPDATE statements
            foreach ($this->sqlStatements as $key => $statement) {
                $paramValues = [];
                $paramTypes  = [];

                if (isset($this->sqlParameters[$key])) {
                    foreach ($this->sqlParameters[$key] as $parameterKey => $parameterName) {
                        $paramValues[] = $params[$parameterKey];
                        $paramTypes[]  = $types[$parameterKey] ?? ParameterTypeInferer::inferType($params[$parameterKey]);
                    }
                }

                $conn->executeUpdate($statement, $paramValues, $paramTypes);
            }
        } catch (Throwable $exception) {
            // FAILURE! Drop temporary table to avoid possible collisions
            $conn->executeUpdate($this->dropTempTableSql);

            // Re-throw exception
            throw $exception;
        }

        // Drop temporary table
        $conn->executeUpdate($this->dropTempTableSql);

        return $numUpdated;

The expression return $numUpdated returns the type integer which is incompatible with the return type mandated by Doctrine\ORM\Query\Exec\AbstractSqlExecutor::execute() of Doctrine\DBAL\Driver\Statement.

    }
}