DatabaseUpdaterTask.php

<?php

declare(strict_types=1);

/*
 * This file is part of the CleverAge/DoctrineProcessBundle package.
 *
 * Copyright (c) Clever-Age
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CleverAge\DoctrineProcessBundle\Task\Database;

use CleverAge\ProcessBundle\Model\AbstractConfigurableTask;
use CleverAge\ProcessBundle\Model\ProcessState;
use Doctrine\DBAL\ArrayParameterType;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Exception;
use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Types\Type;
use Doctrine\Persistence\ManagerRegistry;
use Psr\Log\LoggerInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Execute an update/delete in the database from a SQL statement.
 *
 * @see https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/reference/data-retrieval-and-manipulation.html#list-of-parameters-conversion
 *
 * @phpstan-type Options array{
 *     'sql': string,
 *     'input_as_params': bool,
 *     'params': array<string, mixed>,
 *     'types': array<int<0, max>|string, ArrayParameterType|ParameterType|Type|string>
 * }
 */
class DatabaseUpdaterTask extends AbstractConfigurableTask
{
    public function __construct(
        protected ManagerRegistry $doctrine,
        protected LoggerInterface $logger,
    ) {
    }

    public function execute(ProcessState $state): void
    {
        $numberRows = $this->initializeStatement($state);

        $state->setOutput($numberRows);
    }

    /**
     * @return int the number of affected rows
     *
     * @throws Exception
     */
    protected function initializeStatement(ProcessState $state): int
    {
        /** @var Options $options */
        $options = $this->getOptions($state);
        $connection = $this->getConnection($state);

        $inputAsParams = $state->getInput();
        $params = $options['input_as_params'] ? $inputAsParams : $options['params'];
        if (!\is_array($params)) {
            throw new \UnexpectedValueException('Expecting an array of params');
        }

        /** @var array<string, mixed> $params */
        return (int) $connection->executeStatement($options['sql'], $params, $options['types']);
    }

    protected function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setRequired(['sql']);
        $resolver->setAllowedTypes('sql', ['string']);
        $resolver->setDefaults([
            'connection' => null,
            'input_as_params' => true,
            'params' => [],
            'types' => [],
        ]);
        $resolver->setAllowedTypes('connection', ['null', 'string']);
        $resolver->setAllowedTypes('input_as_params', ['bool']);
        $resolver->setAllowedTypes('params', ['array']);
        $resolver->setAllowedTypes('types', ['array']);
    }

    protected function getConnection(ProcessState $state): Connection
    {
        /** @var ?string $connectionOptions */
        $connectionOptions = $this->getOption($state, 'connection');
        /** @var Connection $connection */
        $connection = $this->doctrine->getConnection($connectionOptions);

        return $connection;
    }
}