BatchQueryResult::getRows() - Code Metrics - Inspection of "Merge branch 'master' into fix-array-access" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — fix-array-access ( 050ccc...ecf3a7 )

by Alexander

created 2021-02-04 09:46 UTC

BatchQueryResult::getRows() B

↳ Parent: BatchQueryResult

Complexity

Conditions	7
Paths	12

Size

Total Lines	23
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	8.4275

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	7
eloc	14
c	3
b	0
f	0
nc	12
nop	0
dl	0
loc	23
ccs	9
cts	13
cp	0.6923
crap	8.4275
rs	8.8333

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

namespace yii\db;

use yii\base\Component;

/**
 * BatchQueryResult represents a batch query from which you can retrieve data in batches.
 *
 * You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by
 * calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the [[\Iterator]] interface,
 * you can iterate it to obtain a batch of data in each iteration. For example,
 *
 * ```php
 * $query = (new Query)->from('user');
 * foreach ($query->batch() as $i => $users) {
 *     // $users represents the rows in the $i-th batch
 * }
 * foreach ($query->each() as $user) {
 * }
 * ```
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class BatchQueryResult extends Component implements \Iterator
{
    /**
     * @event Event an event that is triggered when the batch query is reset.
     * @see reset()
     * @since 2.0.41
     */
    const EVENT_RESET = 'reset';
    /**
     * @event Event an event that is triggered when the last batch has been fetched.
     * @since 2.0.41
     */
    const EVENT_FINISH = 'finish';

    /**
     * @var Connection the DB connection to be used when performing batch query.
     * If null, the "db" application component will be used.
     */
    public $db;
    /**
     * @var Query the query object associated with this batch query.
     * Do not modify this property directly unless after [[reset()]] is called explicitly.
     */
    public $query;
    /**
     * @var int the number of rows to be returned in each batch.
     */
    public $batchSize = 100;
    /**
     * @var bool whether to return a single row during each iteration.
     * If false, a whole batch of rows will be returned in each iteration.
     */
    public $each = false;

    /**
     * @var DataReader the data reader associated with this batch query.
     */
    private $_dataReader;
    /**
     * @var array the data retrieved in the current batch
     */
    private $_batch;
    /**
     * @var mixed the value for the current iteration
     */
    private $_value;
    /**
     * @var string|int the key for the current iteration
     */
    private $_key;
    /**
     * @var int MSSQL error code for exception that is thrown when last batch is size less than specified batch size
     * @see https://github.com/yiisoft/yii2/issues/10023
     */
    private $mssqlNoMoreRowsErrorCode = -13;


    /**
     * Destructor.
     */
    public function __destruct()
    {
        // make sure cursor is closed
        $this->reset();
    }

    /**
     * Resets the batch query.
     * This method will clean up the existing batch query so that a new batch query can be performed.
     */
    public function reset()
    {
        if ($this->_dataReader !== null) {
            $this->_dataReader->close();
        }
        $this->_dataReader = null;
        $this->_batch = null;
        $this->_value = null;
        $this->_key = null;
        $this->trigger(self::EVENT_RESET);
    }

    /**
     * Resets the iterator to the initial state.
     * This method is required by the interface [[\Iterator]].
     */
    public function rewind()
    {
        $this->reset();
        $this->next();
    }

    /**
     * Moves the internal pointer to the next dataset.
     * This method is required by the interface [[\Iterator]].
     */
    public function next()
    {
        if ($this->_batch === null || !$this->each || $this->each && next($this->_batch) === false) {
            $this->_batch = $this->fetchData();
            reset($this->_batch);
        }

        if ($this->each) {
            $this->_value = current($this->_batch);
            if ($this->query->indexBy !== null) {
                $this->_key = key($this->_batch);
            } elseif (key($this->_batch) !== null) {
                $this->_key = $this->_key === null ? 0 : $this->_key + 1;
            } else {
                $this->_key = null;
            }
        } else {
            $this->_value = $this->_batch;
            $this->_key = $this->_key === null ? 0 : $this->_key + 1;
        }
    }

    /**
     * Fetches the next batch of data.
     * @return array the data fetched
     * @throws Exception
     */
    protected function fetchData()
    {
        if ($this->_dataReader === null) {
            $this->_dataReader = $this->query->createCommand($this->db)->query();
        }

        $rows = $this->getRows();

        return $this->query->populate($rows);
    }

    /**
     * Reads and collects rows for batch
     * @return array
     * @since 2.0.23
     */
    protected function getRows()
    {
        $rows = [];
        $count = 0;

        try {
            while ($count++ < $this->batchSize) {
                if ($row = $this->_dataReader->read()) {
                    $rows[] = $row;
                } else {
                    // we've reached the end
                    $this->trigger(self::EVENT_FINISH);
                    break;
                }
            }
        } catch (\PDOException $e) {
            $errorCode = isset($e->errorInfo[1]) ? $e->errorInfo[1] : null;
            if ($this->getDbDriverName() !== 'sqlsrv' || $errorCode !== $this->mssqlNoMoreRowsErrorCode) {
                throw $e;
            }
        }

        return $rows;
    }

    /**
     * Returns the index of the current dataset.
     * This method is required by the interface [[\Iterator]].
     * @return int the index of the current row.
     */
    public function key()
    {
        return $this->_key;

    }

    /**
     * Returns the current dataset.
     * This method is required by the interface [[\Iterator]].
     * @return mixed the current dataset.
     */
    public function current()
    {
        return $this->_value;
    }

    /**
     * Returns whether there is a valid dataset at the current position.
     * This method is required by the interface [[\Iterator]].
     * @return bool whether there is a valid dataset at the current position.
     */
    public function valid()
    {
        return !empty($this->_batch);
    }

    /**
     * Gets db driver name from the db connection that is passed to the `batch()`, if it is not passed it uses
     * connection from the active record model
     * @return string|null
     */
    private function getDbDriverName()
    {
        if (isset($this->db->driverName)) {
            return $this->db->driverName;
        }

        if (!empty($this->_batch)) {
            $key = array_keys($this->_batch)[0];
            if (isset($this->_batch[$key]->db->driverName)) {
                return $this->_batch[$key]->db->driverName;
            }
        }

        return null;
    }

    /**
     * Unserialization is disabled to prevent remote code execution in case application
     * calls unserialize() on user input containing specially crafted string.
     * @see CVE-2020-15148
     * @since 2.0.38
     */
    public function __wakeup()
    {
        throw new \BadMethodCallException('Cannot unserialize ' . __CLASS__);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\db;
9
10		use yii\base\Component;
11
12		/**
13		* BatchQueryResult represents a batch query from which you can retrieve data in batches.
14		*
15		* You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by
16		* calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the [[\Iterator]] interface,
17		* you can iterate it to obtain a batch of data in each iteration. For example,
18		*
19		* ```php
20		* $query = (new Query)->from('user');
21		* foreach ($query->batch() as $i => $users) {
22		* // $users represents the rows in the $i-th batch
23		* }
24		* foreach ($query->each() as $user) {
25		* }
26		* ```
27		*
28		* @author Qiang Xue <[email protected]>
29		* @since 2.0
30		*/
31		class BatchQueryResult extends Component implements \Iterator
32		{
33		/**
34		* @event Event an event that is triggered when the batch query is reset.
35		* @see reset()
36		* @since 2.0.41
37		*/
38		const EVENT_RESET = 'reset';
39		/**
40		* @event Event an event that is triggered when the last batch has been fetched.
41		* @since 2.0.41
42		*/
43		const EVENT_FINISH = 'finish';
44
45		/**
46		* @var Connection the DB connection to be used when performing batch query.
47		* If null, the "db" application component will be used.
48		*/
49		public $db;
50		/**
51		* @var Query the query object associated with this batch query.
52		* Do not modify this property directly unless after [[reset()]] is called explicitly.
53		*/
54		public $query;
55		/**
56		* @var int the number of rows to be returned in each batch.
57		*/
58		public $batchSize = 100;
59		/**
60		* @var bool whether to return a single row during each iteration.
61		* If false, a whole batch of rows will be returned in each iteration.
62		*/
63		public $each = false;
64
65		/**
66		* @var DataReader the data reader associated with this batch query.
67		*/
68		private $_dataReader;
69		/**
70		* @var array the data retrieved in the current batch
71		*/
72		private $_batch;
73		/**
74		* @var mixed the value for the current iteration
75		*/
76		private $_value;
77		/**
78		* @var string\|int the key for the current iteration
79		*/
80		private $_key;
81		/**
82		* @var int MSSQL error code for exception that is thrown when last batch is size less than specified batch size
83		* @see https://github.com/yiisoft/yii2/issues/10023
84		*/
85		private $mssqlNoMoreRowsErrorCode = -13;
86
87
88		/**
89		* Destructor.
90		*/
91	12	public function __destruct()
92		{
93		// make sure cursor is closed
94	12	$this->reset();
95	12	}
96
97		/**
98		* Resets the batch query.
99		* This method will clean up the existing batch query so that a new batch query can be performed.
100		*/
101	12	public function reset()
102		{
103	12	if ($this->_dataReader !== null) {
104	12	$this->_dataReader->close();
105		}
106	12	$this->_dataReader = null;
107	12	$this->_batch = null;
108	12	$this->_value = null;
109	12	$this->_key = null;
110	12	$this->trigger(self::EVENT_RESET);
111	12	}
112
113		/**
114		* Resets the iterator to the initial state.
115		* This method is required by the interface [[\Iterator]].
116		*/
117	12	public function rewind()
118		{
119	12	$this->reset();
120	12	$this->next();
121	12	}
122
123		/**
124		* Moves the internal pointer to the next dataset.
125		* This method is required by the interface [[\Iterator]].
126		*/
127	12	public function next()
128		{
129	12	if ($this->_batch === null \|\| !$this->each \|\| $this->each && next($this->_batch) === false) {
130	12	$this->_batch = $this->fetchData();
131	12	reset($this->_batch);
132		}
133
134	12	if ($this->each) {
135	3	$this->_value = current($this->_batch);
136	3	if ($this->query->indexBy !== null) {
137	3	$this->_key = key($this->_batch);
138	3	} elseif (key($this->_batch) !== null) {
139	3	$this->_key = $this->_key === null ? 0 : $this->_key + 1;
140		} else {
141	3	$this->_key = null;
142		}
143		} else {
144	12	$this->_value = $this->_batch;
145	12	$this->_key = $this->_key === null ? 0 : $this->_key + 1;
146		}
147	12	}
148
149		/**
150		* Fetches the next batch of data.
151		* @return array the data fetched
152		* @throws Exception
153		*/
154	12	protected function fetchData()
155		{
156	12	if ($this->_dataReader === null) {
157	12	$this->_dataReader = $this->query->createCommand($this->db)->query();
158		}
159
160	12	$rows = $this->getRows();
161
162	12	return $this->query->populate($rows);
163		}
164
165		/**
166		* Reads and collects rows for batch
167		* @return array
168		* @since 2.0.23
169		*/
170	12	protected function getRows()
171		{
172	12	$rows = [];
173	12	$count = 0;
174
175		try {
176	12	while ($count++ < $this->batchSize) {
177	12	if ($row = $this->_dataReader->read()) {
178	12	$rows[] = $row;
179		} else {
180		// we've reached the end
181	12	$this->trigger(self::EVENT_FINISH);
182	12	break;
183		}
184		}
185		} catch (\PDOException $e) {
186		$errorCode = isset($e->errorInfo[1]) ? $e->errorInfo[1] : null;
187		if ($this->getDbDriverName() !== 'sqlsrv' \|\| $errorCode !== $this->mssqlNoMoreRowsErrorCode) {
188		throw $e;
189		}
190		}
191
192	12	return $rows;
193		}
194
195		/**
196		* Returns the index of the current dataset.
197		* This method is required by the interface [[\Iterator]].
198		* @return int the index of the current row.
199		*/
200	3	public function key()
201		{
202	3	return $this->_key;
		0 ignored issues – show Bug Best Practice introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report The expression `return $this->_key` also could return the type `string` which is incompatible with the documented return type `integer`. Loading history...
203		}
204
205		/**
206		* Returns the current dataset.
207		* This method is required by the interface [[\Iterator]].
208		* @return mixed the current dataset.
209		*/
210	12	public function current()
211		{
212	12	return $this->_value;
213		}
214
215		/**
216		* Returns whether there is a valid dataset at the current position.
217		* This method is required by the interface [[\Iterator]].
218		* @return bool whether there is a valid dataset at the current position.
219		*/
220	12	public function valid()
221		{
222	12	return !empty($this->_batch);
223		}
224
225		/**
226		* Gets db driver name from the db connection that is passed to the `batch()`, if it is not passed it uses
227		* connection from the active record model
228		* @return string\|null
229		*/
230		private function getDbDriverName()
231		{
232		if (isset($this->db->driverName)) {
233		return $this->db->driverName;
234		}
235
236		if (!empty($this->_batch)) {
237		$key = array_keys($this->_batch)[0];
238		if (isset($this->_batch[$key]->db->driverName)) {
239		return $this->_batch[$key]->db->driverName;
240		}
241		}
242
243		return null;
244		}
245
246		/**
247		* Unserialization is disabled to prevent remote code execution in case application
248		* calls unserialize() on user input containing specially crafted string.
249		* @see CVE-2020-15148
250		* @since 2.0.38
251		*/
252		public function __wakeup()
253		{
254		throw new \BadMethodCallException('Cannot unserialize ' . __CLASS__);
255		}
256		}
257

yiisoft / yii2

Push — fix-array-access ( 050ccc...ecf3a7 )

BatchQueryResult::getRows() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like