ActiveDataProvider::prepareModels() - Code Metrics - Inspection of "#20055 Fix X-Pagination-Total-Count is always 0" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#20070)

by Loban

created 2023-12-06 06:40 UTC

ActiveDataProvider::prepareModels() A

↳ Parent: ActiveDataProvider

Complexity

Conditions	5
Paths	6

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5.0187

Importance

Changes

Metric	Value
cc	5
eloc	10
c	0
b	0
f	0
nc	6
nop	0
dl	0
loc	17
ccs	10
cts	11
cp	0.9091
crap	5.0187
rs	9.6111

<?php
/**
 * @link https://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license https://www.yiiframework.com/license/
 */

namespace yii\data;

use yii\base\InvalidConfigException;
use yii\base\Model;
use yii\db\ActiveQueryInterface;
use yii\db\Connection;
use yii\db\QueryInterface;
use yii\di\Instance;

/**
 * ActiveDataProvider implements a data provider based on [[\yii\db\Query]] and [[\yii\db\ActiveQuery]].
 *
 * ActiveDataProvider provides data by performing DB queries using [[query]].
 *
 * The following is an example of using ActiveDataProvider to provide ActiveRecord instances:
 *
 * ```php
 * $provider = new ActiveDataProvider([
 *     'query' => Post::find(),
 *     'pagination' => [
 *         'pageSize' => 20,
 *     ],
 * ]);
 *
 * // get the posts in the current page
 * $posts = $provider->getModels();
 * ```
 *
 * And the following example shows how to use ActiveDataProvider without ActiveRecord:
 *
 * ```php
 * $query = new Query();
 * $provider = new ActiveDataProvider([
 *     'query' => $query->from('post'),
 *     'pagination' => [
 *         'pageSize' => 20,
 *     ],
 * ]);
 *
 * // get the posts in the current page
 * $posts = $provider->getModels();
 * ```
 *
 * For more details and usage information on ActiveDataProvider, see the [guide article on data providers](guide:output-data-providers).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class ActiveDataProvider extends BaseDataProvider
{
    /**
     * @var QueryInterface|null the query that is used to fetch data models and [[totalCount]] if it is not explicitly set.
     */
    public $query;
    /**
     * @var string|callable|null 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 [[query]] is an [[\yii\db\ActiveQuery]] instance, the primary keys of [[\yii\db\ActiveQuery::modelClass]] will be used.
     * - Otherwise, the keys of the [[models]] array will be used.
     *
     * @see getKeys()
     */
    public $key;
    /**
     * @var Connection|array|string|null the DB connection object or the application component ID of the DB connection.
     * If set it overrides [[query]] default DB connection.
     * Starting from version 2.0.2, this can also be a configuration array for creating the object.
     */
    public $db;


    /**
     * Initializes the DB connection component.
     * This method will initialize the [[db]] property (when set) to make sure it refers to a valid DB connection.
     * @throws InvalidConfigException if [[db]] is invalid.
     */
    public function init()
    {
        parent::init();
        if ($this->db !== null) {
            $this->db = Instance::ensure($this->db);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function prepareModels()
    {
        if (!$this->query instanceof QueryInterface) {
            throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
        }
        $query = clone $this->query;
        if (($pagination = $this->getPagination()) !== false) {
            if ($pagination->totalCount === 0) {
                return [];
            }
            $query->limit($pagination->getLimit())->offset($pagination->getOffset());
        }
        if (($sort = $this->getSort()) !== false) {
            $query->addOrderBy($sort->getOrders());
        }

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

    /**
     * {@inheritdoc}
     */
    protected function prepareKeys($models)
    {
        $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 \yii\db\ActiveRecordInterface */
            $class = $this->query->modelClass;

            $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()
    {
        if (!$this->query instanceof QueryInterface) {
            throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
        }
        $query = clone $this->query;
        return (int) $query->limit(-1)->offset(-1)->orderBy([])->count('*', $this->db);
    }

    /**
     * {@inheritdoc}
     */
    public function setSort($value)
    {
        parent::setSort($value);
        if ($this->query instanceof ActiveQueryInterface && ($sort = $this->getSort()) !== false) {
            /* @var $modelClass Model */
            $modelClass = $this->query->modelClass;
            $model = $modelClass::instance();
            if (empty($sort->attributes)) {
                foreach ($model->attributes() as $attribute) {
                    $sort->attributes[$attribute] = [
                        'asc' => [$attribute => SORT_ASC],
                        'desc' => [$attribute => SORT_DESC],
                    ];
                }
            }
            if ($sort->modelClass === null) {
                $sort->modelClass = $modelClass;

            }
        }
    }

    public function __clone()
    {
        if (is_object($this->query)) {
            $this->query = clone $this->query;
        }

        parent::__clone();
    }
}


1		<?php
2		/**
3		* @link https://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license https://www.yiiframework.com/license/
6		*/
7
8		namespace yii\data;
9
10		use yii\base\InvalidConfigException;
11		use yii\base\Model;
12		use yii\db\ActiveQueryInterface;
13		use yii\db\Connection;
14		use yii\db\QueryInterface;
15		use yii\di\Instance;
16
17		/**
18		* ActiveDataProvider implements a data provider based on [[\yii\db\Query]] and [[\yii\db\ActiveQuery]].
19		*
20		* ActiveDataProvider provides data by performing DB queries using [[query]].
21		*
22		* The following is an example of using ActiveDataProvider to provide ActiveRecord instances:
23		*
24		* ```php
25		* $provider = new ActiveDataProvider([
26		* 'query' => Post::find(),
27		* 'pagination' => [
28		* 'pageSize' => 20,
29		* ],
30		* ]);
31		*
32		* // get the posts in the current page
33		* $posts = $provider->getModels();
34		* ```
35		*
36		* And the following example shows how to use ActiveDataProvider without ActiveRecord:
37		*
38		* ```php
39		* $query = new Query();
40		* $provider = new ActiveDataProvider([
41		* 'query' => $query->from('post'),
42		* 'pagination' => [
43		* 'pageSize' => 20,
44		* ],
45		* ]);
46		*
47		* // get the posts in the current page
48		* $posts = $provider->getModels();
49		* ```
50		*
51		* For more details and usage information on ActiveDataProvider, see the [guide article on data providers](guide:output-data-providers).
52		*
53		* @author Qiang Xue <[email protected]>
54		* @since 2.0
55		*/
56		class ActiveDataProvider extends BaseDataProvider
57		{
58		/**
59		* @var QueryInterface\|null the query that is used to fetch data models and [[totalCount]] if it is not explicitly set.
60		*/
61		public $query;
62		/**
63		* @var string\|callable\|null the column that is used as the key of the data models.
64		* This can be either a column name, or a callable that returns the key value of a given data model.
65		*
66		* If this is not set, the following rules will be used to determine the keys of the data models:
67		*
68		* - If [[query]] is an [[\yii\db\ActiveQuery]] instance, the primary keys of [[\yii\db\ActiveQuery::modelClass]] will be used.
69		* - Otherwise, the keys of the [[models]] array will be used.
70		*
71		* @see getKeys()
72		*/
73		public $key;
74		/**
75		* @var Connection\|array\|string\|null the DB connection object or the application component ID of the DB connection.
76		* If set it overrides [[query]] default DB connection.
77		* Starting from version 2.0.2, this can also be a configuration array for creating the object.
78		*/
79		public $db;
80
81
82		/**
83		* Initializes the DB connection component.
84		* This method will initialize the [[db]] property (when set) to make sure it refers to a valid DB connection.
85		* @throws InvalidConfigException if [[db]] is invalid.
86		*/
87	35	public function init()
88		{
89	35	parent::init();
90	35	if ($this->db !== null) {
91	12	$this->db = Instance::ensure($this->db);
92		}
93	35	}
94
95		/**
96		* {@inheritdoc}
97		*/
98	25	protected function prepareModels()
99		{
100	25	if (!$this->query instanceof QueryInterface) {
101		throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
102		}
103	25	$query = clone $this->query;
104	25	if (($pagination = $this->getPagination()) !== false) {
105	25	if ($pagination->totalCount === 0) {
106	4	return [];
107		}
108	21	$query->limit($pagination->getLimit())->offset($pagination->getOffset());
109		}
110	21	if (($sort = $this->getSort()) !== false) {
111	21	$query->addOrderBy($sort->getOrders());
112		}
113
114	21	return $query->all($this->db);
115		}
116
117		/**
118		* {@inheritdoc}
119		*/
120	27	protected function prepareKeys($models)
121		{
122	27	$keys = [];
123	27	if ($this->key !== null) {
124		foreach ($models as $model) {
125		if (is_string($this->key)) {
126		$keys[] = $model[$this->key];
127		} else {
128		$keys[] = call_user_func($this->key, $model);
129		}
130		}
131
132		return $keys;
133	27	} elseif ($this->query instanceof ActiveQueryInterface) {
134		/* @var $class \yii\db\ActiveRecordInterface */
135	15	$class = $this->query->modelClass;
		0 ignored issues – show Bug introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report Accessing `modelClass` on the interface `yii\db\ActiveQueryInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
136	15	$pks = $class::primaryKey();
137	15	if (count($pks) === 1) {
138	15	$pk = $pks[0];
139	15	foreach ($models as $model) {
140	14	$keys[] = $model[$pk];
141		}
142		} else {
143		foreach ($models as $model) {
144		$kk = [];
145		foreach ($pks as $pk) {
146		$kk[$pk] = $model[$pk];
147		}
148		$keys[] = $kk;
149		}
150		}
151
152	15	return $keys;
153		}
154
155	12	return array_keys($models);
156		}
157
158		/**
159		* {@inheritdoc}
160		*/
161	29	protected function prepareTotalCount()
162		{
163	29	if (!$this->query instanceof QueryInterface) {
164		throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
165		}
166	29	$query = clone $this->query;
167	29	return (int) $query->limit(-1)->offset(-1)->orderBy([])->count('*', $this->db);
168		}
169
170		/**
171		* {@inheritdoc}
172		*/
173	30	public function setSort($value)
174		{
175	30	parent::setSort($value);
176	30	if ($this->query instanceof ActiveQueryInterface && ($sort = $this->getSort()) !== false) {
177		/* @var $modelClass Model */
178	20	$modelClass = $this->query->modelClass;
179	20	$model = $modelClass::instance();
180	20	if (empty($sort->attributes)) {
181	16	foreach ($model->attributes() as $attribute) {
182	16	$sort->attributes[$attribute] = [
183	16	'asc' => [$attribute => SORT_ASC],
184	16	'desc' => [$attribute => SORT_DESC],
185		];
186		}
187		}
188	20	if ($sort->modelClass === null) {
189	20	$sort->modelClass = $modelClass;
		0 ignored issues – show Documentation Bug introduced 2023-07-19 18:28 UTC by Report Bug Copy Issue Report It seems like `$modelClass` of type `yii\base\Model` is incompatible with the declared type `null\|string` of property `$modelClass`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
190		}
191		}
192	30	}
193
194	1	public function __clone()
195		{
196	1	if (is_object($this->query)) {
197	1	$this->query = clone $this->query;
198		}
199
200	1	parent::__clone();
201	1	}
202		}
203

yiisoft / yii2

Pull Request — master (#20070)

ActiveDataProvider::prepareModels() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like