Yiisoft\Db\Command\AbstractCommand

Complexity

Total Complexity

72

Size/Duplication

Total Lines	572
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

52 Methods

Rating	Name	Duplication	Size	Complexity
A	queryInternal()	0	15	2
A	execute()	0	12	3
A	resetSequence()	0	4	1
A	requireTableSchemaRefresh()	0	4	1
A	setRawSql()	0	9	2
A	queryColumn()	0	5	2
A	queryAll()	0	5	1
A	renameColumn()	0	4	1
A	queryOne()	0	5	2
A	getSql()	0	3	1
A	insertWithReturningPks()	0	12	2
A	truncateTable()	0	4	1
A	setRetryHandler()	0	4	1
A	reset()	0	7	1
A	renameTable()	0	4	1
A	update()	0	4	1
A	query()	0	4	1
A	is()	0	3	1
A	requireTransaction()	0	4	1
A	queryScalar()	0	10	4
A	setSql()	0	6	1
A	isReadMode()	0	3	1
A	insert()	0	5	1
A	upsert()	0	8	1
A	addDefaultValue()	0	4	1
A	addCommentOnTable()	0	4	1
A	addUnique()	0	4	1
A	createTable()	0	4	1
A	alterColumn()	0	4	1
A	delete()	0	4	1
A	checkIntegrity()	0	4	1
A	dropCommentFromColumn()	0	4	1
A	dropUnique()	0	4	1
A	dropIndex()	0	4	1
A	dropCommentFromTable()	0	4	1
A	batchInsert()	0	18	2
A	dropColumn()	0	4	1
A	dropPrimaryKey()	0	4	1
A	dropDefaultValue()	0	4	1
A	dropForeignKey()	0	4	1
A	dropView()	0	4	1
A	getParams()	0	14	3
A	dropCheck()	0	4	1
A	addForeignKey()	0	19	1
A	addCheck()	0	4	1
A	addColumn()	0	4	1
A	createView()	0	4	1
A	createIndex()	0	9	1
A	dropTable()	0	4	1
A	addCommentOnColumn()	0	4	1
A	addPrimaryKey()	0	4	1
B	getRawSql()	0	46	8

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Command;

use Closure;
use Throwable;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Expression\Expression;
use Yiisoft\Db\Query\Data\DataReaderInterface;
use Yiisoft\Db\Query\QueryInterface;
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
use Yiisoft\Db\Schema\Builder\ColumnInterface;

use function explode;
use function get_resource_type;
use function is_array;
use function is_int;
use function is_resource;
use function is_scalar;
use function is_string;
use function preg_replace_callback;
use function str_starts_with;
use function stream_get_contents;

/**
 * Represents an SQL statement to execute in a database.
 *
 * It's usually created by calling {@see \Yiisoft\Db\Connection\ConnectionInterface::createCommand()}.
 *
 * You can get the SQL statement it represents via the {@see getSql()} method.
 *
 * To execute a non-query SQL (such as `INSERT`, `DELETE`, `UPDATE`), call {@see execute()}.
 *
 * To execute a SQL statement that returns a result (such as `SELECT`), use {@see queryAll()}, {@see queryOne()},
 * {@see queryColumn()}, {@see queryScalar()}, or {@see query()}.
 *
 * For example,
 *
 * ```php
 * $users = $connectionInterface->createCommand('SELECT * FROM user')->queryAll();
 * ```
 *
 * Abstract command supports SQL prepared statements and parameter binding.
 *
 * Call {@see bindValue()} to bind a value to a SQL parameter.
 * Call {@see bindParam()} to bind a PHP variable to a SQL parameter.
 *
 * When binding a parameter, the SQL statement is automatically prepared. You may also call {@see prepare()} explicitly
 * to do it.
 *
 * Abstract command supports building some SQL statements using methods such as {@see insert()}, {@see update()}, {@see delete()},
 * etc.
 *
 * For example, the following code will create and execute an `INSERT` SQL statement:
 *
 * ```php
 * $connectionInterface->createCommand()->insert(
 *     'user',
 *     ['name' => 'Sam', 'age' => 30],
 * )->execute();
 * ```
 *
 * To build `SELECT` SQL statements, please use {@see QueryInterface} and its implementations instead.
 */
abstract class AbstractCommand implements CommandInterface
{
    /**
     * Command in this query mode returns count of affected rows.
     *
     * @see execute()
     */
    protected const QUERY_MODE_EXECUTE = 1;
    /**
     * Command in this query mode returns the first row of selected data.
     *
     * @see queryOne()
     */
    protected const QUERY_MODE_ROW = 2;
    /**
     * Command in this query mode returns all rows of selected data.
     *
     * @see queryAll()
     */
    protected const QUERY_MODE_ALL = 4;
    /**
     * Command in this query mode returns all rows with the first column of selected data.
     *
     * @see queryColumn()
     */
    protected const QUERY_MODE_COLUMN = 8;
    /**
     * Command in this query mode returns {@see DataReaderInterface}, an abstraction for database cursor for
     * selected data.
     *
     * @see query()
     */
    protected const QUERY_MODE_CURSOR = 16;
    /**
     * Command in this query mode returns the first column in the first row of the query result
     *
     * @see queryScalar()
     */
    protected const QUERY_MODE_SCALAR = 32;

    /**
     * @var string|null Transaction isolation level.
     */
    protected string|null $isolationLevel = null;

    /**
     * @var ParamInterface[] Parameters to use.
     */
    protected array $params = [];

    /**
     * @var string|null Name of the table to refresh schema for. Null means not to refresh the schema.
     */
    protected string|null $refreshTableName = null;
    protected Closure|null $retryHandler = null;
    /**
     * @var string The SQL statement to execute.
     */
    private string $sql = '';

    public function addCheck(string $table, string $name, string $expression): static
    {
        $sql = $this->getQueryBuilder()->addCheck($table, $name, $expression);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addColumn(string $table, string $column, ColumnInterface|string $type): static
    {
        $sql = $this->getQueryBuilder()->addColumn($table, $column, $type);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addCommentOnColumn(string $table, string $column, string $comment): static
    {
        $sql = $this->getQueryBuilder()->addCommentOnColumn($table, $column, $comment);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addCommentOnTable(string $table, string $comment): static
    {
        $sql = $this->getQueryBuilder()->addCommentOnTable($table, $comment);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addDefaultValue(string $table, string $name, string $column, mixed $value): static
    {
        $sql = $this->getQueryBuilder()->addDefaultValue($table, $name, $column, $value);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addForeignKey(
        string $table,
        string $name,
        array|string $columns,
        string $referenceTable,
        array|string $referenceColumns,
        string $delete = null,
        string $update = null
    ): static {
        $sql = $this->getQueryBuilder()->addForeignKey(
            $table,
            $name,
            $columns,
            $referenceTable,
            $referenceColumns,
            $delete,
            $update
        );
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addPrimaryKey(string $table, string $name, array|string $columns): static
    {
        $sql = $this->getQueryBuilder()->addPrimaryKey($table, $name, $columns);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function addUnique(string $table, string $name, array|string $columns): static
    {
        $sql = $this->getQueryBuilder()->addUnique($table, $name, $columns);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function alterColumn(string $table, string $column, ColumnInterface|string $type): static
    {
        $sql = $this->getQueryBuilder()->alterColumn($table, $column, $type);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function batchInsert(string $table, array $columns, iterable $rows): static
    {
        $table = $this->getQueryBuilder()->quoter()->quoteSql($table);

        /** @psalm-var string[] $columns */
        foreach ($columns as &$column) {
            $column = $this->getQueryBuilder()->quoter()->quoteSql($column);
        }

        unset($column);

        $params = [];
        $sql = $this->getQueryBuilder()->batchInsert($table, $columns, $rows, $params);

        $this->setRawSql($sql);
        $this->bindValues($params);

        return $this;
    }

    abstract public function bindValue(int|string $name, mixed $value, int $dataType = null): static;

    abstract public function bindValues(array $values): static;

    public function checkIntegrity(string $schema, string $table, bool $check = true): static
    {
        $sql = $this->getQueryBuilder()->checkIntegrity($schema, $table, $check);
        return $this->setSql($sql);
    }

    public function createIndex(
        string $table,
        string $name,
        array|string $columns,
        string $indexType = null,
        string $indexMethod = null
    ): static {
        $sql = $this->getQueryBuilder()->createIndex($table, $name, $columns, $indexType, $indexMethod);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function createTable(string $table, array $columns, string $options = null): static
    {
        $sql = $this->getQueryBuilder()->createTable($table, $columns, $options);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function createView(string $viewName, QueryInterface|string $subQuery): static
    {
        $sql = $this->getQueryBuilder()->createView($viewName, $subQuery);
        return $this->setSql($sql)->requireTableSchemaRefresh($viewName);
    }

    public function delete(string $table, array|string $condition = '', array $params = []): static
    {
        $sql = $this->getQueryBuilder()->delete($table, $condition, $params);
        return $this->setSql($sql)->bindValues($params);
    }

    public function dropCheck(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropCheck($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropColumn(string $table, string $column): static
    {
        $sql = $this->getQueryBuilder()->dropColumn($table, $column);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropCommentFromColumn(string $table, string $column): static
    {
        $sql = $this->getQueryBuilder()->dropCommentFromColumn($table, $column);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropCommentFromTable(string $table): static
    {
        $sql = $this->getQueryBuilder()->dropCommentFromTable($table);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropDefaultValue(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropDefaultValue($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropForeignKey(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropForeignKey($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropIndex(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropIndex($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropPrimaryKey(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropPrimaryKey($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropTable(string $table): static
    {
        $sql = $this->getQueryBuilder()->dropTable($table);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropUnique(string $table, string $name): static
    {
        $sql = $this->getQueryBuilder()->dropUnique($table, $name);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function dropView(string $viewName): static
    {
        $sql = $this->getQueryBuilder()->dropView($viewName);
        return $this->setSql($sql)->requireTableSchemaRefresh($viewName);
    }

    public function getParams(bool $asValues = true): array
    {
        if (!$asValues) {
            return $this->params;
        }

        $buildParams = [];

        foreach ($this->params as $name => $value) {
            /** @psalm-var mixed */
            $buildParams[$name] = $value->getValue();
        }

        return $buildParams;
    }

    public function getRawSql(): string
    {
        if (empty($this->params)) {
            return $this->sql;
        }

        $params = [];
        $quoter = $this->getQueryBuilder()->quoter();

        foreach ($this->params as $name => $param) {
            if (is_string($name) && !str_starts_with($name, ':')) {
                $name = ':' . $name;
            }

            $value = $param->getValue();

            $params[$name] = match ($param->getType()) {
                DataType::INTEGER => (string)(int)$value,
                DataType::STRING, DataType::LOB => match (true) {
                    $value instanceof Expression => (string)$value,
                    is_resource($value) => $name,
                    default => $quoter->quoteValue((string)$value),
                },
                DataType::BOOLEAN => $value ? 'TRUE' : 'FALSE',
                DataType::NULL => 'NULL',
                default => $name,
            };
        }

        /** @var string[] $params */
        if (!isset($params[0])) {
            return preg_replace_callback(
                '#(:\w+)#',
                static fn (array $matches): string => $params[$matches[1]] ?? $matches[1],
                $this->sql
            );
        }

        // Support unnamed placeholders should be dropped
        $sql = '';

        foreach (explode('?', $this->sql) as $i => $part) {
            $sql .= $part . ($params[$i] ?? '');
        }

        return $sql;
    }

    public function getSql(): string
    {
        return $this->sql;
    }

    public function insert(string $table, QueryInterface|array $columns): static
    {
        $params = [];
        $sql = $this->getQueryBuilder()->insert($table, $columns, $params);
        return $this->setSql($sql)->bindValues($params);
    }

    public function insertWithReturningPks(string $table, array $columns): bool|array
    {
        $params = [];

        $sql = $this->getQueryBuilder()->insertWithReturningPks($table, $columns, $params);

        $this->setSql($sql)->bindValues($params);

        /** @psalm-var array|bool $result */
        $result = $this->queryInternal(self::QUERY_MODE_ROW | self::QUERY_MODE_EXECUTE);

        return is_array($result) ? $result : false;
    }

    public function execute(): int
    {
        $sql = $this->getSql();

        if ($sql === '') {
            return 0;
        }

        /** @psalm-var int|bool $execute */
        $execute = $this->queryInternal(self::QUERY_MODE_EXECUTE);

        return is_int($execute) ? $execute : 0;
    }

    public function query(): DataReaderInterface
    {
        /** @psalm-var DataReaderInterface */
        return $this->queryInternal(self::QUERY_MODE_CURSOR);
    }

    public function queryAll(): array
    {
        /** @psalm-var array<array-key, array>|null $results */
        $results = $this->queryInternal(self::QUERY_MODE_ALL);
        return $results ?? [];
    }

    public function queryColumn(): array
    {
        /** @psalm-var mixed $results */
        $results = $this->queryInternal(self::QUERY_MODE_COLUMN);
        return is_array($results) ? $results : [];
    }

    public function queryOne(): array|null
    {
        /** @psalm-var mixed $results */
        $results = $this->queryInternal(self::QUERY_MODE_ROW);
        return is_array($results) ? $results : null;
    }

    public function queryScalar(): bool|string|null|int|float
    {
        /** @psalm-var mixed $result */
        $result = $this->queryInternal(self::QUERY_MODE_SCALAR);

        if (is_resource($result) && get_resource_type($result) === 'stream') {
            return stream_get_contents($result);
        }

        return is_scalar($result) ? $result : null;
    }

    public function renameColumn(string $table, string $oldName, string $newName): static
    {
        $sql = $this->getQueryBuilder()->renameColumn($table, $oldName, $newName);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function renameTable(string $table, string $newName): static
    {
        $sql = $this->getQueryBuilder()->renameTable($table, $newName);
        return $this->setSql($sql)->requireTableSchemaRefresh($table);
    }

    public function resetSequence(string $table, int|string $value = null): static
    {
        $sql = $this->getQueryBuilder()->resetSequence($table, $value);
        return $this->setSql($sql);
    }

    public function setRawSql(string $sql): static
    {
        if ($sql !== $this->sql) {
            $this->cancel();
            $this->reset();
            $this->sql = $sql;
        }

        return $this;
    }

    public function setSql(string $sql): static
    {
        $this->cancel();
        $this->reset();
        $this->sql = $this->getQueryBuilder()->quoter()->quoteSql($sql);
        return $this;
    }

    public function setRetryHandler(Closure|null $handler): static
    {
        $this->retryHandler = $handler;
        return $this;
    }

    public function truncateTable(string $table): static
    {
        $sql = $this->getQueryBuilder()->truncateTable($table);
        return $this->setSql($sql);
    }

    public function update(string $table, array $columns, array|string $condition = '', array $params = []): static
    {
        $sql = $this->getQueryBuilder()->update($table, $columns, $condition, $params);
        return $this->setSql($sql)->bindValues($params);
    }

    public function upsert(
        string $table,
        QueryInterface|array $insertColumns,
        bool|array $updateColumns = true,
        array $params = []
    ): static {
        $sql = $this->getQueryBuilder()->upsert($table, $insertColumns, $updateColumns, $params);
        return $this->setSql($sql)->bindValues($params);
    }

    /**
     * @return QueryBuilderInterface The query builder instance.
     */
    abstract protected function getQueryBuilder(): QueryBuilderInterface;

    /**
     * Returns the query result.
     *
     * @param int $queryMode Query mode, `QUERY_MODE_*`.
     *
     * @throws Exception
     * @throws Throwable
     */
    abstract protected function internalGetQueryResult(int $queryMode): mixed;

    /**
     * Executes a prepared statement.
     *
     * @param string|null $rawSql Deprecated. Use `null` value. Will be removed in version 2.0.0.
     *
     * @throws Exception
     * @throws Throwable
     */
    abstract protected function internalExecute(string|null $rawSql): void;

    /**
     * Check if the value has a given flag.
     *
     * @param int $value Flags value to check.
     * @param int $flag Flag to look for in the value.
     *
     * @return bool Whether the value has a given flag.
     */
    protected function is(int $value, int $flag): bool
    {
        return ($value & $flag) === $flag;
    }

    /**
     * The method is called after the query is executed.
     *
     * @param int $queryMode Query mode, `QUERY_MODE_*`.
     *
     * @throws Exception
     * @throws Throwable
     */
    protected function queryInternal(int $queryMode): mixed
    {
        $isReadMode = $this->isReadMode($queryMode);
        $this->prepare($isReadMode);

        $this->internalExecute(null);

        /** @psalm-var mixed $result */
        $result = $this->internalGetQueryResult($queryMode);

        if (!$isReadMode) {
            $this->refreshTableSchema();
        }

        return $result;
    }

    /**
     * Refreshes table schema, which was marked by {@see requireTableSchemaRefresh()}.
     */
    abstract protected function refreshTableSchema(): void;

    /**
     * Marks a specified table schema to be refreshed after command execution.
     *
     * @param string $name Name of the table, which schema should be refreshed.
     */
    protected function requireTableSchemaRefresh(string $name): static
    {
        $this->refreshTableName = $name;
        return $this;
    }

    /**
     * Marks the command to execute in transaction.
     *
     * @param string|null $isolationLevel The isolation level to use for this transaction.
     *
     * {@see \Yiisoft\Db\Transaction\TransactionInterface::begin()} for details.
     */
    protected function requireTransaction(string $isolationLevel = null): static
    {
        $this->isolationLevel = $isolationLevel;
        return $this;
    }

    /**
     * Resets the command object, so it can be reused to build another SQL statement.
     */
    protected function reset(): void
    {
        $this->sql = '';
        $this->params = [];
        $this->refreshTableName = null;
        $this->isolationLevel = null;
        $this->retryHandler = null;
    }

    /**
     * Checks if the query mode is a read mode.
     */
    private function isReadMode(int $queryMode): bool
    {
        return !$this->is($queryMode, self::QUERY_MODE_EXECUTE);
    }
}