Bdf\Prime\Sharding\Query\ShardingInsertQuery

Complexity

Total Complexity

28

Size/Duplication

Total Lines	251
Duplicated Lines	0 %

Test Coverage

Coverage

81.16%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	connection()	0	3	1
A	mode()	0	9	2
A	columns()	0	9	2
A	values()	0	8	1
A	on()	0	7	1
A	into()	0	9	2
A	ignore()	0	3	2
A	currentQuery()	0	23	3
A	setCompiler()	0	3	1
A	cacheNamespace()	0	3	1
A	compiler()	0	3	1
A	__construct()	0	5	2
A	bulk()	0	3	1
A	execute()	0	9	2
A	replace()	0	3	2
A	from()	0	3	1
A	getShardId()	0	13	3

<?php

namespace Bdf\Prime\Sharding\Query;

use BadMethodCallException;
use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Query\CommandInterface;
use Bdf\Prime\Query\CompilableClause;
use Bdf\Prime\Query\Compiler\CompilerInterface;
use Bdf\Prime\Query\Compiler\Preprocessor\DefaultPreprocessor;
use Bdf\Prime\Query\Compiler\Preprocessor\PreprocessorInterface;
use Bdf\Prime\Query\Contract\Cachable;
use Bdf\Prime\Query\Contract\Query\InsertQueryInterface;
use Bdf\Prime\Query\Custom\BulkInsert\BulkInsertQuery;
use Bdf\Prime\Query\Extension\CachableTrait;
use Bdf\Prime\Sharding\Extension\ShardPicker;
use Bdf\Prime\Sharding\ShardingConnection;

/**
 * Handle INSERT operations on Sharding connection set
 * The shard will be choosed using inserted data value, and the operation will be delegated to the shard connection
 *
 * @implements CommandInterface<ShardingConnection>
 */
class ShardingInsertQuery extends CompilableClause implements InsertQueryInterface, CommandInterface, Cachable
{
    use CachableTrait;
    use ShardPicker;

    /**
     * The DBAL Connection.
     *
     * @var ShardingConnection
     */
    private $connection;

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

    /**
     * @var string[]
     */
    private $columns = [];

    /**
     * @var string
     */
    private $mode = self::MODE_INSERT;

    /**
     * @var array
     */
    private $values = [];

    /**
     * Queries indexed by shard id
     *
     * @var BulkInsertQuery[]
     */
    private $queries = [];

    /**
     * @var BulkInsertQuery
     */
    private $currentQuery;


    /**
     * ShardingInsertQuery constructor.
     *
     * @param ShardingConnection $connection
     * @param PreprocessorInterface $preprocessor
     */
    public function __construct(ShardingConnection $connection, PreprocessorInterface $preprocessor = null)

Expected 1 blank line before function; 2 found

    {
        parent::__construct($preprocessor ?: new DefaultPreprocessor());

Inline shorthand IF statement requires brackets around comparison

        $this->connection = $connection;
    }

    /**
     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function compiler(): CompilerInterface
    {
        throw new BadMethodCallException('Cannot directly compile a sharding query');
    }

    /**

Parameter $compiler should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function setCompiler(CompilerInterface $compiler)
    {
        throw new BadMethodCallException('Cannot directly compile a sharding query');
    }

    /**
     * {@inheritdoc}
     */
    public function connection(): ConnectionInterface
    {
        return $this->connection;
    }

    /**

Parameter $connection should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function on(ConnectionInterface $connection)
    {
        $this->connection = $connection;

$connection is of type Bdf\Prime\Connection\ConnectionInterface, but the property $connection was declared to be of type Bdf\Prime\Sharding\ShardingConnection. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        $this->queries = [];
        $this->currentQuery = null;

        return $this;
    }

    /**

Parameter $alias should have a doc-comment as per coding-style.

Parameter $from should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function from($from, $alias = null)

The method parameter $alias is never used

    {
        return $this->into($from);
    }

    /**

Parameter $flag should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function bulk(bool $flag = true)
    {
        throw new BadMethodCallException('Bulk insert is not (yet ?) supported by sharding connection');
    }

    /**

Parameter $table should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function into(string $table)
    {
        $this->table = $table;

        foreach ($this->queries as $query) {
            $query->into($table);
        }

        return $this;
    }

    /**

Parameter $columns should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function columns(array $columns)
    {
        $this->columns = $columns;

        foreach ($this->queries as $query) {
            $query->columns($columns);
        }

        return $this;
    }

    /**

Parameter $replace should have a doc-comment as per coding-style.

Parameter $data should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function values(array $data, bool $replace = false)

The method parameter $replace is never used

    {
        $this->values = $data;
        $this->currentQuery = null;

        $this->currentQuery()->values($data);

        return $this;
    }

    /**

Parameter $mode should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function mode(string $mode)
    {
        $this->mode = $mode;

        foreach ($this->queries as $query) {
            $query->mode($mode);
        }

        return $this;
    }

    /**

Parameter $flag should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function ignore(bool $flag = true)
    {
        return $this->mode($flag ? self::MODE_IGNORE : self::MODE_INSERT);

Inline shorthand IF statement requires brackets around comparison

    }

    /**

Parameter $flag should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function replace(bool $flag = true)
    {
        return $this->mode($flag ? self::MODE_REPLACE : self::MODE_INSERT);

Inline shorthand IF statement requires brackets around comparison

    }

    /**

Parameter $columns should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function execute($columns = null)
    {
        $count = $this->currentQuery()->execute($columns);

        if ($count > 0) {
            $this->clearCacheOnWrite();
        }

        return $count;
    }

    /**
     * Get the query associated to the matching sharding
     *
     * @return BulkInsertQuery
     */
    private function currentQuery()

Private method name "ShardingInsertQuery::currentQuery" must be prefixed with an underscore

    {
        if ($this->currentQuery !== null) {
            return $this->currentQuery;
        }

        $shardId = $this->getShardId();

        if (isset($this->queries[$shardId])) {
            return $this->queries[$shardId];
        }

        /** @var BulkInsertQuery $query */

Block comments must be started with /*

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

        $query = $this->connection->getConnection($shardId)->make(BulkInsertQuery::class, $this->preprocessor());

        $query
            ->setCache($this->cache)

Object operator not indented correctly; expected 10 spaces but found 12

Space found before object operator

            ->into($this->table)

Space found before object operator

            ->columns($this->columns)

Space found before object operator

            ->mode($this->mode)

Space found before object operator

Space after closing parenthesis of function call prohibited

        ;

Space found before semicolon; expected ");" but found ")
;"

        return $this->currentQuery = $this->queries[$shardId] = $query;

Assignments must be the first block of code on a line

    }

    /**
     * Get the targeted shard ID
     *
     * @return string|null
     */

Missing @throws tag in function comment

    private function getShardId()

Private method name "ShardingInsertQuery::getShardId" must be prefixed with an underscore

    {
        if ($this->shardId !== null) {
            return $this->shardId;
        }

        $distributionKey = $this->connection->getDistributionKey();

        if (!isset($this->values[$distributionKey])) {
            throw new \LogicException('The value "'.$distributionKey.'" must be provided for selecting the sharding');
        }

        return $this->connection->getShardChoser()->pick($this->values[$distributionKey], $this->connection);
    }

    /**
     * {@inheritdoc}
     */
    protected function cacheNamespace()
    {
        return $this->connection->getName().':'.$this->table;
    }
}