BatchQueryResult::rewind() - Code Metrics - Inspection of "Adjust password" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — fix-tests ( 6dd538...727178 )

by Alexander

created 2020-03-20 19:05 UTC

BatchQueryResult::rewind() A

↳ Parent: BatchQueryResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?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\BaseObject;

/**
 * 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 BaseObject implements \Iterator
{
    /**
     * @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;
    }

    /**
     * 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 && ($row = $this->_dataReader->read())) {
                $rows[] = $row;
            }
        } 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;
    }
}


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\BaseObject;
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 BaseObject implements \Iterator
32		{
33		/**
34		* @var Connection the DB connection to be used when performing batch query.
35		* If null, the "db" application component will be used.
36		*/
37		public $db;
38		/**
39		* @var Query the query object associated with this batch query.
40		* Do not modify this property directly unless after [[reset()]] is called explicitly.
41		*/
42		public $query;
43		/**
44		* @var int the number of rows to be returned in each batch.
45		*/
46		public $batchSize = 100;
47		/**
48		* @var bool whether to return a single row during each iteration.
49		* If false, a whole batch of rows will be returned in each iteration.
50		*/
51		public $each = false;
52
53		/**
54		* @var DataReader the data reader associated with this batch query.
55		*/
56		private $_dataReader;
57		/**
58		* @var array the data retrieved in the current batch
59		*/
60		private $_batch;
61		/**
62		* @var mixed the value for the current iteration
63		*/
64		private $_value;
65		/**
66		* @var string\|int the key for the current iteration
67		*/
68		private $_key;
69		/**
70		* @var int MSSQL error code for exception that is thrown when last batch is size less than specified batch size
71		* @see https://github.com/yiisoft/yii2/issues/10023
72		*/
73		private $mssqlNoMoreRowsErrorCode = -13;
74
75
76		/**
77		* Destructor.
78		*/
79	12	public function __destruct()
80		{
81		// make sure cursor is closed
82	12	$this->reset();
83	12	}
84
85		/**
86		* Resets the batch query.
87		* This method will clean up the existing batch query so that a new batch query can be performed.
88		*/
89	12	public function reset()
90		{
91	12	if ($this->_dataReader !== null) {
92	12	$this->_dataReader->close();
93		}
94	12	$this->_dataReader = null;
95	12	$this->_batch = null;
96	12	$this->_value = null;
97	12	$this->_key = null;
98	12	}
99
100		/**
101		* Resets the iterator to the initial state.
102		* This method is required by the interface [[\Iterator]].
103		*/
104	12	public function rewind()
105		{
106	12	$this->reset();
107	12	$this->next();
108	12	}
109
110		/**
111		* Moves the internal pointer to the next dataset.
112		* This method is required by the interface [[\Iterator]].
113		*/
114	12	public function next()
115		{
116	12	if ($this->_batch === null \|\| !$this->each \|\| $this->each && next($this->_batch) === false) {
117	12	$this->_batch = $this->fetchData();
118	12	reset($this->_batch);
119		}
120
121	12	if ($this->each) {
122	3	$this->_value = current($this->_batch);
123	3	if ($this->query->indexBy !== null) {
124	3	$this->_key = key($this->_batch);
125	3	} elseif (key($this->_batch) !== null) {
126	3	$this->_key = $this->_key === null ? 0 : $this->_key + 1;
127		} else {
128	3	$this->_key = null;
129		}
130		} else {
131	12	$this->_value = $this->_batch;
132	12	$this->_key = $this->_key === null ? 0 : $this->_key + 1;
133		}
134	12	}
135
136		/**
137		* Fetches the next batch of data.
138		* @return array the data fetched
139		* @throws Exception
140		*/
141	12	protected function fetchData()
142		{
143	12	if ($this->_dataReader === null) {
144	12	$this->_dataReader = $this->query->createCommand($this->db)->query();
145		}
146
147	12	$rows = $this->getRows();
148
149	12	return $this->query->populate($rows);
150		}
151
152		/**
153		* Reads and collects rows for batch
154		* @return array
155		* @since 2.0.23
156		*/
157	12	protected function getRows()
158		{
159	12	$rows = [];
160	12	$count = 0;
161
162		try {
163	12	while ($count++ < $this->batchSize && ($row = $this->_dataReader->read())) {
164	12	$rows[] = $row;
165		}
166		} catch (\PDOException $e) {
167		$errorCode = isset($e->errorInfo[1]) ? $e->errorInfo[1] : null;
168		if ($this->getDbDriverName() !== 'sqlsrv' \|\| $errorCode !== $this->mssqlNoMoreRowsErrorCode) {
169		throw $e;
170		}
171		}
172
173	12	return $rows;
174		}
175
176		/**
177		* Returns the index of the current dataset.
178		* This method is required by the interface [[\Iterator]].
179		* @return int the index of the current row.
180		*/
181	3	public function key()
182		{
183	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...
184		}
185
186		/**
187		* Returns the current dataset.
188		* This method is required by the interface [[\Iterator]].
189		* @return mixed the current dataset.
190		*/
191	12	public function current()
192		{
193	12	return $this->_value;
194		}
195
196		/**
197		* Returns whether there is a valid dataset at the current position.
198		* This method is required by the interface [[\Iterator]].
199		* @return bool whether there is a valid dataset at the current position.
200		*/
201	12	public function valid()
202		{
203	12	return !empty($this->_batch);
204		}
205
206		/**
207		* Gets db driver name from the db connection that is passed to the `batch()`, if it is not passed it uses
208		* connection from the active record model
209		* @return string\|null
210		*/
211		private function getDbDriverName()
212		{
213		if (isset($this->db->driverName)) {
214		return $this->db->driverName;
215		}
216
217		if (!empty($this->_batch)) {
218		$key = array_keys($this->_batch)[0];
219		if (isset($this->_batch[$key]->db->driverName)) {
220		return $this->_batch[$key]->db->driverName;
221		}
222		}
223
224		return null;
225		}
226		}
227

yiisoft / yii2

Push — fix-tests ( 6dd538...727178 )

BatchQueryResult::rewind() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like