mav3rick177\RapidPagination\Paginator

Complexity

Total Complexity

24

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	5	1
A	transform()	0	4	1
A	build()	0	4	1
A	paginate()	0	5	1
A	compileSelectOrUnionAll()	0	14	3
A	compileSelect()	0	9	1
A	compileWhere()	0	15	5
A	compileOrderBy()	0	7	2
A	compileLimit()	0	5	1
A	addSelectForUnionAll()	0	12	4
A	transformPivotColumn()	0	6	3

<?php

namespace mav3rick177\RapidPagination;

use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Support\Traits\Macroable;
use mav3rick177\RapidPagination\Base\Concerns\HasProcessor;
use mav3rick177\RapidPagination\Base\Contracts\Cursor;
use mav3rick177\RapidPagination\Base\Paginator as BasePaginator;
use mav3rick177\RapidPagination\Base\Query;
use mav3rick177\RapidPagination\Base\Query\Select;
use mav3rick177\RapidPagination\Base\Query\SelectOrUnionAll;
use mav3rick177\RapidPagination\Base\Query\UnionAll;

/**
 * Class Paginator
 *
 * @see BasePaginator, HasProcessor
 */
class Paginator extends BasePaginator
{
    use Macroable, HasProcessor;

    /**
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder $builder
     * @return static
     */
    public static function create($builder)
    {
        return new static($builder);
    }

    /**
     * Paginator constructor.
     *
     * @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder $builder
     */
    public function __construct($builder)
    {
        $this->builder = $builder;
        $this->processor = new Processor();
    }

    /**
     * Build Illuminate Builder instance from Query config.
     *
     * @param  Query                                                                                                                     $query
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     */
    public function transform(Query $query)
    {
        return $this->compileSelectOrUnionAll($query->selectOrUnionAll());
    }

    /**
     * Configure -> Transform.
     *
     * @param  Cursor|int[]|string[]                                                                                                     $cursor
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     */
    public function build($cursor = [])
    {
        return $this->transform($this->configure($cursor));
    }

    /**
     * Execute query and paginate them.
     *
     * @param  Cursor|int[]|string[]  $cursor
     * @return mixed|PaginationResult
     */
    public function paginate($cursor = [])
    {
        $query = $this->configure($cursor);
        return $this->process($query, $this->transform($query)->get());
    }

    /**
     * @param  SelectOrUnionAll                                                                                                          $selectOrUnionAll
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     */
    protected function compileSelectOrUnionAll(SelectOrUnionAll $selectOrUnionAll)
    {
        if ($selectOrUnionAll instanceof Select) {
            return $this->compileSelect($selectOrUnionAll);
        }
        if ($selectOrUnionAll instanceof UnionAll) {
            $supportQuery = $this->compileSelect($selectOrUnionAll->supportQuery());
            $mainQuery = $this->compileSelect($selectOrUnionAll->mainQuery());
            return $supportQuery->unionAll($this->addSelectForUnionAll($mainQuery));

It seems like $this->addSelectForUnionAll($mainQuery) targeting mav3rick177\RapidPagination\Paginator::addSelectForUnionAll() can also be of type object<Illuminate\Database\Eloquent\Builder> or object<Illuminate\Database\Eloquent\Relations\Relation>; however, Illuminate\Database\Query\Builder::unionAll() does only seem to accept object<Illuminate\Database\Query\Builder>|object<Closure>, maybe add an additional type check?

The method unionAll does only exist in Illuminate\Database\Query\Builder, but not in Illuminate\Database\Eloquent\Builder and Illuminate\Database\Eloquent\Relations\Relation.

        }
        // @codeCoverageIgnoreStart
        throw new \LogicException('Unreachable here');
        // @codeCoverageIgnoreEnd
    }

    /**
     * @param  Select                                                                                                                    $select
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     */
    protected function compileSelect(Select $select)
    {
        $builder = clone $this->builder;
        $this
            ->compileWhere($builder, $select)
            ->compileOrderBy($builder, $select)
            ->compileLimit($builder, $select);
        return $builder;
    }

    /**
     * @param $builder \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     * @param  Select $select
     * @return $this
     */
    protected function compileWhere($builder, Select $select)
    {
        $builder->where(function ($builder) use ($select) {
            foreach ($select->where() as $i => $group) {
                foreach ($group as $j => $condition) {
                    $builder->{$i !== 0 && $j === 0 ? 'orWhere' : 'where'}(
                        $this->transformPivotColumn($condition->left()),
                        $condition->comparator(),
                        $condition->right()
                    );
                }
            }
        });
        return $this;
    }

    /**
     * @param $builder \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     * @param  Select $select
     * @return $this
     */
    protected function compileOrderBy($builder, Select $select)
    {
        foreach ($select->orders() as $order) {
            $builder->orderBy(...$order->toArray());
        }
        return $this;
    }

    /**
     * @param $builder \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     * @param  Select $select
     * @return $this
     */
    protected function compileLimit($builder, Select $select)
    {
        $builder->limit($select->limit()->toInteger());
        return $this;
    }

    /**
     * We need to add columns explicitly for UNION ALL subjects
     * because BelongsToMany cannot handle them correctly.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation|\Illuminate\Database\Query\Builder
     */
    protected function addSelectForUnionAll($query)
    {
        static $invoker;
        if (!$invoker) {
            $invoker = function () {
                return $this->shouldSelect($this->getBaseQuery()->columns ? [] : ['*']);

The method getBaseQuery does not exist on object<mav3rick177\RapidPagination\Paginator>? Since you implemented __call, maybe consider adding a @method annotation.

The method shouldSelect does not exist on object<mav3rick177\RapidPagination\Paginator>? Since you implemented __call, maybe consider adding a @method annotation.

            };
        }
        return $query instanceof BelongsToMany
            ? $query->addSelect($invoker->bindTo($query, $query)->__invoke())
            : $query;
    }

    /**
     * We need to transform aliased columns into non-aliased form
     * because SQL standard does not allow column aliases in WHERE conditions.
     *
     * @param  string $column
     * @return string
     */
    protected function transformPivotColumn($column)
    {
        return $this->builder instanceof BelongsToMany && strpos($column, 'pivot_') === 0
            ? ($this->builder->getTable() . '.' . substr($column, 6))
            : $column;
    }
}