Bdf\Prime\Query\Pagination\WalkStrategy\PaginationWalkStrategy

Complexity

Total Complexity

4

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

87.5%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	next()	0	16	2
A	initialize()	0	12	2

<?php

namespace Bdf\Prime\Query\Pagination\WalkStrategy;

use Bdf\Prime\Collection\CollectionInterface;
use Bdf\Prime\Query\Contract\Limitable;
use Bdf\Prime\Query\Contract\ReadOperation;
use Bdf\Prime\Query\ReadCommandInterface;
use InvalidArgumentException;

/**
 * Simple walk strategy using pagination
 * This strategy do not handle write on entities during the walk (like delete entities)

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

 */
final class PaginationWalkStrategy implements WalkStrategyInterface
{
    /**

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

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

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

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function initialize(ReadCommandInterface $query, int $chunkSize, int $startPage): WalkCursor

Expected 1 blank line before function; 0 found

    {
        if (!$query instanceof Limitable) {
            throw new InvalidArgumentException('The query must be an instance of '.Limitable::class);
        }

        $cursor = new WalkCursor(clone $query);

        $cursor->cursor = ($startPage - 1) * $chunkSize;

Operation must be bracketed

        $cursor->query->limit($chunkSize);

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

        return $cursor;
    }

    /**
     * {@inheritdoc}
     */
    #[ReadOperation]

67% of this comment could be valid code. Did you maybe forget this after debugging?

Perl-style comments are not allowed; use "// Comment" instead

Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead.

    public function next(WalkCursor $cursor): WalkCursor

You must use "/**" style comments for a function comment

    {
        $cursor = clone $cursor;
        /** @var Limitable&ReadCommandInterface $query */

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

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

Block comments must be started with /*

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

        $query = $cursor->query;

        $query->offset($cursor->cursor);

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

        $cursor->cursor += $query->getLimit();

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

        $cursor->entities = $query->all();

        if ($cursor->entities instanceof CollectionInterface) {

$cursor->entities is never a sub-type of Bdf\Prime\Collection\CollectionInterface.

            $cursor->entities = $cursor->entities->all();
        }

        return $cursor;
    }
}