Query::paginate() - Code Metrics - Inspection of "Implemented property documentation and getters for..." - siriusphp/orm - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — dev_2x ( 1e248d...fedccd )

by Adrian
created 2020-11-29 21:34 UTC
Query::paginate() A

↳ Parent: Query
Complexity

Conditions	2
Paths	2
Size

Total Lines	14
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	7
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	14
rs	10
<?php
declare(strict_types=1);

namespace Sirius\Orm;

use Sirius\Orm\Collection\Collection;
use Sirius\Orm\Collection\PaginatedCollection;
use Sirius\Orm\Contract\EntityInterface;
use Sirius\Orm\Entity\StateEnum;
use Sirius\Orm\Entity\Tracker;
use Sirius\Orm\Helpers\Arr;
use Sirius\Orm\Relation\Aggregate;
use Sirius\Sql\Bindings;
use Sirius\Sql\Select;

class Query extends Select
{
    /**
     * @var Mapper
     */
    protected $mapper;

    /**
     * @var MapperConfig
     */
    protected $mapperConfig;

    /**
     * @var string|array
     */
    protected $primaryKey;

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

    /**
     * @var string
     */
    protected $tableReference;

    /**
     * @var Connection
     */
    protected $connection;

    /**
     * @var array
     */
    protected $load = [];

    /**
     * @var array
     */
    protected $guards = [];

    /**
     * @var array
     */
    protected $scopes = [];

    /**
     * List of relation that were joined to prevent from joining them again
     * Designed for situation where you have conditions on atributes
     * of related entities
     *
     * @example $content->newQuery()->where('tags.name', 'cool')
     * @var array
     */
    protected $joinedWith = [];

    public function __construct(Connection $connection, Mapper $mapper, Bindings $bindings = null, string $indent = '')
    {
        parent::__construct($connection, $bindings, $indent);
        $this->mapper = $mapper;

        $mapperConfig         = $mapper->getConfig();
        $this->primaryKey     = $mapperConfig->getPrimaryKey();
        $this->tableReference = $mapperConfig->getTableReference();
        $this->table          = $mapperConfig->getTableAlias(true);
        $this->guards         = $mapperConfig->getGuards();

        $this->from($this->tableReference);
        $this->resetColumns();
        $this->columns($this->table . '.*');

        $this->init();
    }

    protected function init()
    {

    }

    public function __call(string $method, array $params)
    {
        $scope = $this->scopes[$method] ?? null;
        if ($scope && is_callable($scope)) {
            return $scope($this, ...$params);
        }

        return parent::__call($method, $params);
    }

    public function __clone()
    {
        $vars = get_object_vars($this);
        unset($vars['mapper']);
        foreach ($vars as $name => $prop) {
            if (is_object($prop) && method_exists($prop, '__clone')) {
                $this->$name = clone $prop;
            } else {
                $this->$name = $prop;
            }
        }
    }


    public function load(...$relations): self
    {
        foreach ($relations as $relation) {
            if (is_array($relation)) {
                $name     = key($relation);
                $callback = current($relation);
            } else {
                $name     = $relation;
                $callback = null;
            }
            $this->load[$name] = $callback;
        }

        return $this;
    }

    public function joinWith($name): Query
    {
        if (in_array($name, $this->joinedWith)) {
            return $this;
        }

        if ( ! $this->mapper->hasRelation($name)) {
            throw new \InvalidArgumentException(
                sprintf("Relation %s, not defined for %s", $name, $this->mapper->getConfig()->getTable())
            );
        }

        $relation = $this->mapper->getRelation($name);

        $this->joinedWith[] = $name;

        return $relation->joinSubselect($this, $name);
    }

    public function subSelectForJoinWith(Mapper $mapper): Query
    {
        return new Query($this->connection, $mapper, $this->bindings, $this->indent . '    ');
    }

    public function find($pk, array $load = [])
    {
        return $this->where($this->primaryKey, $pk)
                    ->load(...$load)
                    ->first();
    }

    public function first()
    {
        $row = $this->fetchOne();

        return $this->newEntityFromRow($row, $this->load);
    }

    public function get(): Collection
    {
        return $this->newCollectionFromRows(
            $this->connection->fetchAll($this->getStatement(), $this->getBindValues()),
            $this->load
        );
    }

    public function paginate(int $perPage, int $page = 1): PaginatedCollection
    {
        /** @var Query $countQuery */
        $countQuery = clone $this;
        $total      = $countQuery->count();

        if ($total == 0) {
            $this->newPaginatedCollectionFromRows([], $total, $perPage, $page, $this->load);
        }

        $this->perPage($perPage);
        $this->page($page);

        return $this->newPaginatedCollectionFromRows($this->fetchAll(), $total, $perPage, $page, $this->load);
    }

    protected function newEntityFromRow(array $data = null, array $load = [], Tracker $tracker = null)
    {
        if ($data == null) {
            return null;
        }

        $receivedTracker = ! ! $tracker;
        if ( ! $tracker) {
            $receivedTracker = false;
            $tracker         = new Tracker([$data]);
        }

        $entity = $this->mapper->newEntity($data);
        $this->injectRelations($entity, $tracker, $load);
        $this->injectAggregates($entity, $tracker, $load);
        $entity->setState(StateEnum::SYNCHRONIZED);

        if ( ! $receivedTracker) {
            $tracker->replaceRows([$entity]);
        }

        return $entity;
    }

    protected function newCollectionFromRows(array $rows, array $load = []): Collection
    {
        $entities = [];
        $tracker  = new Tracker($rows);
        foreach ($rows as $row) {
            $entity     = $this->newEntityFromRow($row, $load, $tracker);
            $entities[] = $entity;
        }
        $tracker->replaceRows($entities);

        return new Collection($entities, $this->mapper->getHydrator());
    }

    protected function newPaginatedCollectionFromRows(
        array $rows,
        int $totalCount,
        int $perPage,
        int $currentPage,
        array $load = []
    ): PaginatedCollection {
        $entities = [];
        $tracker  = new Tracker($rows);
        foreach ($rows as $row) {
            $entity     = $this->newEntityFromRow($row, $load, $tracker);
            $entities[] = $entity;
        }
        $tracker->replaceRows($entities);

        return new PaginatedCollection(
            $entities,
            $totalCount,
            $perPage,
            $currentPage,
            $this->mapper->getHydrator()
        );
    }

    protected function injectRelations(EntityInterface $entity, Tracker $tracker, array $eagerLoad = [])
    {
        foreach ($this->mapper->getRelations() as $name) {
            $relation      = $this->mapper->getRelation($name);
            $queryCallback = $eagerLoad[$name] ?? null;
            $nextLoad      = Arr::getChildren($eagerLoad, $name);

            if ( ! $tracker->hasRelation($name)) {
                $tracker->setRelation($name, $relation, $queryCallback, $nextLoad);
            }

            if (array_key_exists($name, $eagerLoad) || in_array($name, $eagerLoad) || $relation->isEagerLoad()) {
                $relation->attachMatchesToEntity($entity, $tracker->getResultsForRelation($name));
            } elseif ($relation->isLazyLoad()) {
                $relation->attachLazyRelationToEntity($entity, $tracker);
            }
        }
    }

    protected function injectAggregates(EntityInterface $entity, Tracker $tracker, array $eagerLoad = [])
    protected function injectAggregates(EntityInterface $entity, Tracker $tracker, /** @scrutinizer ignore-unused */ array $eagerLoad = [])
    {
        foreach ($this->mapper->getRelations() as $name) {
            $relation = $this->mapper->getRelation($name);
            if ( ! method_exists($relation, 'getAggregates')) {
                continue;
            }
            $aggregates = $relation->getAggregates();
            foreach ($aggregates as $aggName => $aggregate) {
                /*
                 * aggregates don't have setters so we can't use the hydrator to inject
                 * the value using the old `attachAggregateToEntity()` method
                 *
                if (array_key_exists($aggName, $eagerLoad) || $aggregate->isEagerLoad()) {
                    $aggregate->attachAggregateToEntity($entity, $tracker->getAggregateResults($aggregate));
                } elseif ($aggregate->isLazyLoad()) {
                    $aggregate->attachLazyAggregateToEntity($entity, $tracker);
                }
                */
                /**
                 * @todo implement a mechanism to inject aggregates via a LazyValue which extends lazy loader
                 */

                /** @var $aggregate Aggregate */
                $aggregate->attachLazyAggregateToEntity($entity, $tracker);
            }
        }
    }

    /**
     * Executes the query with a limit of $size and applies the callback on each entity
     * The callback can change the DB in such a way that you can end up in an infinite loop
     * (depending on the sorting) so we set a limit on the number of chunks that can be processed
     *
     * @param int $size
     * @param callable $callback
     * @param int $limit
     */
    public function chunk(int $size, callable $callback, int $limit = 100000)
    {
        if ( ! $this->orderBy->build()) {
            $this->orderBy(...(array)$this->mapper->getConfig()->getPrimaryKey());
        }

        $query = clone $this;
        $query->applyGuards();
        $query->resetGuards();

        $run = 0;
        while ($run < $limit) {
            $query->limit($size);
            $query->offset($run * $size);
            $results = $query->get();

            if (count($results) === 0) {
                break;
            }

            foreach ($results as $entity) {
                $callback($entity);
            }

            $run++;
        }
    }

    public function count()
    {
        $this->resetOrderBy();
        $this->resetColumns();
        $this->columns('COUNT(*) AS total');

        return (int)$this->fetchValue();
    }

    public function where($column, $value = null, $condition = '=')
    {
        if (is_string($column) && ($dotPosition = strpos($column, '.'))) {
            $relationName = trim(substr($column, 0, $dotPosition), "'`");
            // the relationName could be a table so we need to make sure
            // beforehand that this is actually a relation
            if ($this->mapper->hasRelation($relationName)) {
                $this->joinWith($relationName);
            }
        }

        return parent::where($column, $value, $condition);
    }

    public function setGuards(array $guards)
    {
        foreach ($guards as $column => $value) {
            if (is_int($column)) {
                $this->guards[] = $value;
            } else {
                $this->guards[$column] = $value;
            }
        }

        return $this;
    }

    public function resetGuards()
    {
        $this->guards = [];

        return $this;
    }

    protected function applyGuards()
    {

        if (empty($this->guards)) {
            return;
        }

        $this->groupCurrentWhere();
        foreach ($this->guards as $column => $value) {
            if (is_int($column)) {
                $this->where($value, null, null);
            } else {
                $this->where($column, $value);
            }
        }
    }

    public function getStatement(): string
    {
        $this->applyGuards();

        return parent::getStatement();
    }
}

siriusphp / orm

Push — dev_2x ( 1e248d...fedccd )

Query::paginate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
