Bdf\Prime\Sharding\Query\ShardingKeyValueQuery

Complexity

Total Complexity

41

Size/Duplication

Total Lines	326
Duplicated Lines	0 %

Test Coverage

Coverage

92.16%

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	getQueryByShard()	0	29	6
A	avg()	0	5	1
A	values()	0	8	1
A	execute()	0	22	5
A	project()	0	5	1
A	aggregate()	0	9	2
A	addSelect()	0	5	1
A	cacheNamespace()	0	3	1
A	where()	0	9	2
A	getShardIds()	0	13	3
A	count()	0	3	1
A	update()	0	13	3
A	selectQueries()	0	4	2
A	__construct()	0	13	2
A	delete()	0	13	3
A	max()	0	3	1
A	sum()	0	3	1
A	from()	0	5	1
A	select()	0	3	1
A	on()	0	6	1
A	min()	0	3	1
A	limit()	0	5	1

<?php

namespace Bdf\Prime\Sharding\Query;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Query\AbstractReadCommand;
use Bdf\Prime\Query\Compiler\Preprocessor\DefaultPreprocessor;
use Bdf\Prime\Query\Compiler\Preprocessor\PreprocessorInterface;
use Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface;
use Bdf\Prime\Query\Extension\CachableTrait;
use Bdf\Prime\Query\Extension\ExecutableTrait;
use Bdf\Prime\Sharding\Extension\ShardPicker;
use Bdf\Prime\Sharding\ShardingConnection;

/**
 * Handle simple key/value query on sharding connection
 * If the distribution key is found on the filters, the corresponding sharding query is used
 * In other case, all shards will be queried on

Doc comment short description must be on a single line, further text should be a separate paragraph

 *
 * @property ShardingConnection $connection

@property tag is not allowed in class comment

 */
class ShardingKeyValueQuery extends AbstractReadCommand implements KeyValueQueryInterface
{
    use CachableTrait;
    use ExecutableTrait;
    use ShardPicker;

    /**
     * @var KeyValueQueryInterface[]
     */
    private $queries = [];


    /**
     * ShardingKeyValueQuery 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($connection, $preprocessor ?: new DefaultPreprocessor());

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

        $this->statements = [
            'where'     => [],
            'table'     => null,
            'columns'   => [],
            'aggregate' => null,
            'limit'     => null,
            'values'    => [
                'data'  => [],
                'types' => []

A comma should follow the last multiline array item. Found: ]

            ]

A comma should follow the last multiline array item. Found: ]

        ];
    }

    /**

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    = [];

        return $this;
    }

    /**

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

     * {@inheritdoc}
     */
    public function project($columns = null)
    {
        $this->statements['columns'] = (array) $columns;

A cast statement should not be followed as per the coding-style.

        return $this;
    }

    /**

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

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

    /**

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

     * {@inheritdoc}
     */
    public function addSelect($columns)
    {
        $this->statements['columns'] = array_merge($this->statements['columns'], $columns);

        return $this;
    }

    /**

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

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

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

The method parameter $alias is never used

    {
        $this->statements['table'] = $from;

        return $this;
    }

    /**

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

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

     * {@inheritdoc}
     */
    public function where($field, $value = null)
    {
        if (is_array($field)) {
            $this->statements['where'] = $field + $this->statements['where'];

Operation must be bracketed

        } else {
            $this->statements['where'][$field] = $value;
        }

        return $this;
    }

    /**

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

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

     * {@inheritdoc}
     */
    public function values(array $values = [], array $types = [])
    {
        $this->statements['values'] = [
            'data'  => $values,
            'types' => $types,
        ];

        return $this;
    }

    /**

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

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

     * {@inheritdoc}
     *
     * @internal Use internally for optimise "first" query. The offset parameter is not used
     */
    public function limit($limit, $offset = null)

The parameter $offset is not used and could be removed.

The method parameter $offset is never used

    {
        $this->statements['limit'] = $limit;

        return $this;
    }

    /**

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

     * {@inheritdoc}
     */
    public function count($column = null)
    {
        return (int) array_sum($this->aggregate(__FUNCTION__, $column));

A cast statement should not be followed as per the coding-style.

    }

    /**

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

     * {@inheritdoc}
     */
    public function avg($column = null)
    {
        $results = $this->aggregate(__FUNCTION__, $column);

        return (float) array_sum($results) / count($results);

A cast statement should not be followed as per the coding-style.

Operation must be bracketed

    }

    /**

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

     * {@inheritdoc}
     */
    public function min($column = null)
    {
        return (float) min($this->aggregate(__FUNCTION__, $column));

A cast statement should not be followed as per the coding-style.

    }

    /**

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

     * {@inheritdoc}
     */
    public function max($column = null)
    {
        return (float) max($this->aggregate(__FUNCTION__, $column));

A cast statement should not be followed as per the coding-style.

    }

    /**

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

     * {@inheritdoc}
     */
    public function sum($column = null)
    {
        return (float) array_sum($this->aggregate(__FUNCTION__, $column));

A cast statement should not be followed as per the coding-style.

    }

    /**

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

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

     * {@inheritdoc}
     *
     * @return array
     */
    public function aggregate($function, $column = null)
    {
        $results = [];

        foreach ($this->selectQueries() as $query) {
            $results[] = $query->aggregate($function, $column);
        }

        return $results;

The expression return $results returns the type array|string[] which is incompatible with the return type mandated by Bdf\Prime\Query\Contract\Aggregatable::aggregate() of string.

    }

    /**

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

     * {@inheritdoc}
     *
     * @todo execute cached with closure

Comment refers to a TODO task

     */
    public function execute($columns = null)
    {
        $results = [];
        $limit = $this->statements['limit'];

        foreach ($this->selectQueries() as $query) {
            $results = array_merge($results, $query->execute($columns));

            if ($limit) {
                $count = count($results);

                if ($count == $limit) {
                    return $results;
                }

                if ($count > $limit) {
                    return array_slice($results, 0, $limit);
                }
            }
        }

        return $results;
    }

    /**

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

     * {@inheritdoc}
     */
    public function update($values = null)
    {
        $count = 0;

        foreach ($this->selectQueries() as $query) {
            $count += $query->update($values);
        }

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

        return $count;
    }

    /**
     * {@inheritdoc}
     */
    public function delete()
    {
        $count = 0;

        foreach ($this->selectQueries() as $query) {
            $count += $query->delete();
        }

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

        return $count;
    }

    /**
     * Select the queriesvto use
     *
     * @return KeyValueQueryInterface[]
     *
     * @throws \Doctrine\DBAL\Sharding\ShardingException

Comment missing for @throws tag in function comment

     */
    private function selectQueries(): iterable

Private method name "ShardingKeyValueQuery::selectQueries" must be prefixed with an underscore

    {
        foreach ($this->getShardIds() as $shardId) {
            yield $this->getQueryByShard($shardId);

The expression yield $this->getQueryByShard($shardId) returns the type Generator which is incompatible with the documented return type Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface[].

        }
    }

    /**
     * Get the targeted shard IDs
     *
     * @return string[]
     */
    private function getShardIds(): array

Private method name "ShardingKeyValueQuery::getShardIds" must be prefixed with an underscore

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

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

        if (isset($this->statements['where'][$distributionKey])) {
            return [$this->connection->getShardChoser()->pick($this->statements['where'][$distributionKey], $this->connection)];
        }

        return $this->connection->getShardIds();
    }

    /**
     * Get and configure a query for the given shard
     *
     * @param string $shardId The shard id
     *
     * @return KeyValueQueryInterface
     *
     * @throws \Doctrine\DBAL\Sharding\ShardingException

Comment missing for @throws tag in function comment

     */
    private function getQueryByShard($shardId)

Private method name "ShardingKeyValueQuery::getQueryByShard" must be prefixed with an underscore

    {
        /** @var KeyValueQueryInterface $query */

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

Block comments must be started with /*

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

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

        if (isset($this->queries[$shardId])) {
            $query = $this->queries[$shardId];
        } else {
            $this->queries[$shardId] = $query = $this->connection->getShardConnection($shardId)->make(KeyValueQueryInterface::class, $this->preprocessor());

Assignments must be the first block of code on a line

            $query->setExtension($this->extension);

The method setExtension() does not exist on Bdf\Prime\Query\CommandInterface. It seems like you code against a sub-type of Bdf\Prime\Query\CommandInterface such as Bdf\Prime\Query\ReadCommandInterface.

        }

        $query->from($this->statements['table']);

        if (!empty($this->statements['limit'])) {
            $query->limit($this->statements['limit']);

The method limit() does not exist on Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface.

The method limit() does not exist on Bdf\Prime\Query\CommandInterface. It seems like you code against a sub-type of Bdf\Prime\Query\CommandInterface such as Bdf\Prime\Query\AbstractReadCommand or Bdf\Prime\Sharding\Query\ShardingKeyValueQuery or Bdf\Prime\Query\Custom\KeyValue\KeyValueQuery or Bdf\Prime\Query\AbstractQuery or Bdf\Prime\Query\SqlQueryInterface.

        }

        if (!empty($this->statements['columns'])) {
            $query->project($this->statements['columns']);

The method project() does not exist on Bdf\Prime\Query\CommandInterface. It seems like you code against a sub-type of Bdf\Prime\Query\CommandInterface such as Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface or Bdf\Prime\Query\QueryInterface or Bdf\Prime\Query\AbstractReadCommand.

        }

        if (!empty($this->statements['where'])) {
            $query->where($this->statements['where']);

The method where() does not exist on Bdf\Prime\Query\CommandInterface. It seems like you code against a sub-type of Bdf\Prime\Query\CommandInterface such as Bdf\Prime\Query\Contract\Query\KeyValueQueryInterface or Bdf\Prime\Query\QueryInterface or Bdf\Prime\Query\AbstractReadCommand.

        }

        if (!empty($this->statements['values']['data'])) {
            $query->values($this->statements['values']['data'], $this->statements['values']['types']);

The method values() does not exist on Bdf\Prime\Query\CommandInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Bdf\Prime\Query\ReadCommandInterface or Bdf\Prime\Query\QueryInterface or Bdf\Prime\Query\SqlQueryInterface. Are you sure you never get one of those?

        }

        return $query;
    }

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