Yiisoft\ActiveRecord\ActiveDataProvider

Complexity

Total Complexity

26

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	prepareQuery()	0	18	5
A	prepareTotalCount()	0	10	2
B	prepareKeys()	0	36	9
A	prepareModels()	0	7	2
B	setSort()	0	18	7

<?php

declare(strict_types=1);

namespace Yiisoft\ActiveRecord;

use Yiisoft\Db\Connection\Connection;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Query\QueryInterface;

/**
 * ActiveDataProvider implements a data provider based on {@see \Yiisoft\Db\Querys\Query} and
 * {@see \Yiisoft\ActiveRecord\ActiveQuery}.
 *
 * ActiveDataProvider provides data by performing DB queries using {@see query}.
 *
 * The following is an example of using ActiveDataProvider to provide ActiveRecord instances:
 *
 * ```php
 * $provider = new ActiveDataProvider(
 *      Post::find()
 * );
 *
 * $provider->pagination' => [
 *     'pageSize' => 20,
 * ];
 *
 *
 * // get the posts in the current page
 * $posts = $provider->getModels(); // or $provider->models
 * ```
 *
 * And the following example shows how to use ActiveDataProvider without ActiveRecord:
 *
 * ```php
 * $query = new Query();
 * $provider = new ActiveDataProvider(
 *     Yii::get('db'),
 *     $query->from('post')
 * );
 * $provider->pagination' => [
 *     'pageSize' => 20,
 * ];
 *
 *
 * // get the posts in the current page
 * $posts = $provider->getModels();  // or $provider->models
 * ```
 *
 * For more details and usage information on ActiveDataProvider, see the
 * [guide article on data providers](guide:output-data-providers).
 */
class ActiveDataProvider
{
    /**
     * @var QueryInterface|null the query that is used to fetch data models and {@see totalCount}
     *
     * if it is not explicitly set.
     */
    public ?QueryInterface $query = null;

    /**
     * @var string|callable the column that is used as the key of the data models.
     *
     * This can be either a column name, or a callable that returns the key value of a given data model.
     *
     * If this is not set, the following rules will be used to determine the keys of the data models:
     *
     * - If {@see query} is an {@see \Yiisoft\ActiveRecord\ActiveQuery} instance, the primary keys of
     * {@see \Yiisoft\ActiveRecord\ActiveQuery::modelClass} will be used.
     *
     * - Otherwise, the keys of the {@see models} array will be used.
     *
     * @see getKeys()
     */
    public $key;

    /**
     * @var Connection|null the DB connection object or the application component ID of the DB connection.
     */
    public ?Connection $db = null;


    /**
     * Create the ActiveDataProvider object.
     *
     * @param Connection $db database connection.
     * @param QueryInterface $query query to be executed
     */
    public function __construct(Connection $db, QueryInterface $query)
    {
        $this->db = $db;
        $this->query = $query;
    }

    /**
     * {@inheritdoc}
     */
    protected function prepareModels(): array
    {
        $query = $this->prepareQuery();
        if ($query->emulateExecution) {

Accessing emulateExecution on the interface Yiisoft\Db\Query\QueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            return [];
        }
        return $query->all($this->db);

The call to Yiisoft\Db\Query\QueryInterface::all() has too many arguments starting with $this->db.

    }

    /**
     * Prepares the sql-query that will get the data for current page.
     *
     * @throws InvalidConfigException
     *
     * @return QueryInterface
     */
    public function prepareQuery(): QueryInterface
    {
        if (!$this->query instanceof QueryInterface) {
            throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. Yiisoft\Db\Query or its subclasses.');
        }
        $query = clone $this->query;
        if (($pagination = $this->getPagination()) !== false) {

The method getPagination() does not exist on Yiisoft\ActiveRecord\ActiveDataProvider.

            $pagination->totalCount = $this->getTotalCount();

The method getTotalCount() does not exist on Yiisoft\ActiveRecord\ActiveDataProvider.

            if ($pagination->totalCount === 0) {
                $query->emulateExecution();
            }
            $query->limit($pagination->getLimit())->offset($pagination->getOffset());
        }
        if (($sort = $this->getSort()) !== false) {

The method getSort() does not exist on Yiisoft\ActiveRecord\ActiveDataProvider.

            $query->addOrderBy($sort->getOrders());
        }

        return $query;
    }

    /**
     * {@inheritdoc}
     */
    protected function prepareKeys($models): array
    {
        $keys = [];
        if ($this->key !== null) {
            foreach ($models as $model) {
                if (\is_string($this->key)) {
                    $keys[] = $model[$this->key];
                } else {
                    $keys[] = \call_user_func($this->key, $model);
                }
            }

            return $keys;
        } elseif ($this->query instanceof ActiveQueryInterface) {
            /* @var $class ActiveRecordInterface */
            $class = $this->query->modelClass;

Accessing modelClass on the interface Yiisoft\Db\Query\QueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            $pks = $class::primaryKey();
            if (\count($pks) === 1) {
                $pk = $pks[0];
                foreach ($models as $model) {
                    $keys[] = $model[$pk];
                }
            } else {
                foreach ($models as $model) {
                    $kk = [];
                    foreach ($pks as $pk) {
                        $kk[$pk] = $model[$pk];
                    }
                    $keys[] = $kk;
                }
            }

            return $keys;
        }

        return \array_keys($models);
    }

    /**
     * {@inheritdoc}
     */
    protected function prepareTotalCount(): int
    {
        if (!$this->query instanceof QueryInterface) {
            throw new InvalidConfigException(
                'The "query" property must be an instance of a class that implements the QueryInterface e.g. '
                . 'Yiisoft\Db\Query or its subclasses.'
            );
        }
        $query = clone $this->query;
        return (int) $query->limit(-1)->offset(-1)->orderBy([])->count('*', $this->db);

The call to Yiisoft\Db\Query\Query::count() has too many arguments starting with $this->db.

    }

    /**
     * {@inheritdoc}
     */
    public function setSort($value): void

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

    {
        if (($sort = $this->getSort()) !== false && $this->query instanceof ActiveQueryInterface) {
            /* @var $modelClass Model */
            $modelClass = $this->query->modelClass;

Accessing modelClass on the interface Yiisoft\Db\Query\QueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            $model = $modelClass::instance();
            if (empty($sort->attributes)) {
                foreach ($model->attributes() as $attribute) {
                    $sort->attributes[$attribute] = [
                        'asc' => [$attribute => SORT_ASC],
                        'desc' => [$attribute => SORT_DESC],
                        'label' => $model->getAttributeLabel($attribute),
                    ];
                }
            } else {
                foreach ($sort->attributes as $attribute => $config) {
                    if (!isset($config['label'])) {
                        $sort->attributes[$attribute]['label'] = $model->getAttributeLabel($attribute);
                    }
                }
            }
        }
    }
}