AbstractCursor::notImplemented() - Code Metrics - Inspection of "Use library GridFS implementation" - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#220)

unknown

created 2018-02-17 05:58 UTC

AbstractCursor::notImplemented() A

↳ Parent: AbstractCursor

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Alcaeus\MongoDbAdapter;

use Alcaeus\MongoDbAdapter\Helper\ReadPreference;
use MongoDB\Collection;
use MongoDB\Driver\Cursor;

/**
 * @internal
 */
abstract class AbstractCursor
{
    use ReadPreference;

    /**
     * @var int|null
     */
    protected $batchSize = null;

    /**
     * @var Collection
     */
    protected $collection;

    /**
     * @var \MongoClient
     */
    protected $connection;

    /**
     * @var Cursor
     */
    protected $cursor;

    /**
     * @var \MongoDB\Database
     */
    protected $db;

    /**
     * @var \Iterator
     */
    protected $iterator;

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

    /**
     * @var bool
     */
    protected $startedIterating = false;

    /**
     * @var bool
     */
    protected $cursorNeedsAdvancing = true;

    /**
     * @var mixed
     */
    private $current = null;

    /**
     * @var mixed
     */
    private $key = null;

    /**
     * @var mixed
     */
    private $valid = false;

    /**
     * @var int
     */
    protected $position = 0;

    /**
     * @var array
     */
    protected $optionNames = [
        'batchSize',
        'readPreference',
    ];

    /**
     * @return Cursor
     */
    abstract protected function ensureCursor();

    /**
     * @return array
     */
    abstract protected function getCursorInfo();

    /**
     * Create a new cursor
     * @link http://www.php.net/manual/en/mongocursor.construct.php
     * @param \MongoClient $connection Database connection.
     * @param string $ns Full name of database and collection.
     */
    public function __construct(\MongoClient $connection, $ns)
    {
        $this->connection = $connection;
        $this->ns = $ns;

        $nsParts = explode('.', $ns);
        $dbName = array_shift($nsParts);
        $collectionName = implode('.', $nsParts);

        $this->db = $connection->selectDB($dbName)->getDb();

        if ($collectionName) {
            $this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
        }
    }

    /**
     * Returns the current element
     * @link http://www.php.net/manual/en/mongocursor.current.php
     * @return array
     */
    public function current()
    {
        return $this->current;
    }

    /**
     * Returns the current result's _id
     * @link http://www.php.net/manual/en/mongocursor.key.php
     * @return string The current result's _id as a string.
     */
    public function key()
    {
        return $this->key;
    }

    /**
     * Advances the cursor to the next result, and returns that result
     * @link http://www.php.net/manual/en/mongocursor.next.php
     * @throws \MongoConnectionException
     * @throws \MongoCursorTimeoutException
     * @return array Returns the next object
     */
    public function next()
    {
        if (! $this->startedIterating) {

            $this->ensureIterator();
            $this->startedIterating = true;
        } else {
            if ($this->cursorNeedsAdvancing) {
                $this->ensureIterator()->next();
            }

            $this->cursorNeedsAdvancing = true;
            $this->position++;
        }

        return $this->storeIteratorState();
    }

    /**
     * Returns the cursor to the beginning of the result set
     * @throws \MongoConnectionException
     * @throws \MongoCursorTimeoutException
     * @return void
     */
    public function rewind()
    {
        // We can recreate the cursor to allow it to be rewound
        $this->reset();
        $this->startedIterating = true;
        $this->position = 0;
        $this->ensureIterator()->rewind();
        $this->storeIteratorState();
    }

    /**
     * Checks if the cursor is reading a valid result.
     * @link http://www.php.net/manual/en/mongocursor.valid.php
     * @return boolean If the current result is not null.
     */
    public function valid()
    {
        return $this->valid;
    }

    /**
     * Limits the number of elements returned in one batch.
     *
     * @link http://docs.php.net/manual/en/mongocursor.batchsize.php
     * @param int|null $batchSize The number of results to return per batch
     * @return $this Returns this cursor.
     */
    public function batchSize($batchSize)
    {
        $this->batchSize = $batchSize;

        return $this;
    }

    /**
     * Checks if there are documents that have not been sent yet from the database for this cursor
     * @link http://www.php.net/manual/en/mongocursor.dead.php
     * @return boolean Returns if there are more results that have not been sent to the client, yet.
     */
    public function dead()
    {
        return $this->ensureCursor()->isDead();
    }

    /**
     * @return array
     */
    public function info()
    {
        return $this->getCursorInfo() + $this->getIterationInfo();
    }

    /**
     * @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
     * @param string $readPreference
     * @param array $tags
     * @return $this Returns this cursor.
     */
    public function setReadPreference($readPreference, $tags = null)
    {
        $this->setReadPreferenceFromParameters($readPreference, $tags);

        return $this;
    }

    /**
     * Sets a client-side timeout for this query
     * @link http://www.php.net/manual/en/mongocursor.timeout.php
     * @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
     * @return $this Returns this cursor
     */
    public function timeout($ms)

    {
        trigger_error('The ' . __METHOD__ . ' method is not implemented in mongo-php-adapter', E_USER_WARNING);
        return $this;
    }

    /**
     * Applies all options set on the cursor, overwriting any options that have already been set
     *
     * @param array $optionNames Array of option names to be applied (will be read from properties)
     * @return array
     */
    protected function getOptions($optionNames = null)
    {
        $options = [];

        if ($optionNames === null) {
            $optionNames = $this->optionNames;
        }

        foreach ($optionNames as $option) {
            $converter = 'convert' . ucfirst($option);
            $value = method_exists($this, $converter) ? $this->$converter() : $this->$option;

            if ($value === null) {
                continue;
            }

            $options[$option] = $value;
        }

        return $options;
    }

    /**
     * @return \Iterator
     */
    protected function ensureIterator()
    {
        if ($this->iterator === null) {
            // MongoDB\Driver\Cursor needs to be wrapped into a \Generator so that a valid \Iterator with working implementations of
            // next, current, valid, key and rewind is returned. These methods don't work if we wrap the Cursor inside an \IteratorIterator
            $this->iterator = $this->wrapTraversable($this->ensureCursor());
        }

        return $this->iterator;
    }

    /**
     * @param \Traversable $traversable
     * @return \Generator
     */
    protected function wrapTraversable(\Traversable $traversable)
    {
        foreach ($traversable as $key => $value) {
            yield $key => $value;
        }
    }

    /**
     * @throws \MongoCursorException
     */
    protected function errorIfOpened()
    {
        if ($this->cursor === null) {
            return;
        }

        throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
    }

    /**
     * @return array
     */
    protected function getIterationInfo()
    {
        $iterationInfo = [
            'started_iterating' => $this->cursor !== null,
        ];

        if ($this->cursor !== null) {
            switch ($this->cursor->getServer()->getType()) {
                case \MongoDB\Driver\Server::TYPE_RS_ARBITER:
                    $typeString = 'ARBITER';
                    break;
                case \MongoDB\Driver\Server::TYPE_MONGOS:
                    $typeString = 'MONGOS';
                    break;
                case \MongoDB\Driver\Server::TYPE_RS_PRIMARY:
                    $typeString = 'PRIMARY';
                    break;
                case \MongoDB\Driver\Server::TYPE_RS_SECONDARY:
                    $typeString = 'SECONDARY';
                    break;
                default:
                    $typeString = 'STANDALONE';
            }

            $cursorId = (string) $this->cursor->getId();
            $iterationInfo += [
                'id' => (int) $cursorId,
                'at' => $this->position,
                'numReturned' => $this->position, // This can't be obtained from the new cursor
                'server' => sprintf('%s:%d;-;.;%d', $this->cursor->getServer()->getHost(), $this->cursor->getServer()->getPort(), getmypid()),
                'host' => $this->cursor->getServer()->getHost(),
                'port' => $this->cursor->getServer()->getPort(),
                'connection_type_desc' => $typeString,
            ];
        }

        return $iterationInfo;
    }

    /**
     * @throws \Exception
     */
    protected function notImplemented()
    {
        throw new \Exception('Not implemented');
    }

    /**
     * Clears the cursor
     *
     * This is generic but implemented as protected since it's only exposed in MongoCursor
     */
    protected function reset()
    {
        $this->startedIterating = false;
        $this->cursorNeedsAdvancing = true;
        $this->cursor = null;
        $this->iterator = null;
        $this->storeIteratorState();
    }

    /**
     * @return array
     */
    public function __sleep()
    {
        return ['batchSize', 'connection', 'iterator', 'ns', 'optionNames', 'position', 'startedIterating'];
    }

    /**
     * Stores the current cursor element.
     *
     * This is necessary because hasNext() might advance the iterator but we still
     * need to be able to return the current object.
     */
    protected function storeIteratorState()
    {
        if (! $this->startedIterating) {
            $this->current = null;
            $this->key = null;
            $this->valid = false;
            return null;
        }

        $this->current = $this->ensureIterator()->current();
        $this->key = $this->ensureIterator()->key();
        $this->valid = $this->ensureIterator()->valid();

        if ($this->current !== null) {
            $this->current = TypeConverter::toLegacy($this->current);
        }

        return $this->current;
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*/
15
16			namespace Alcaeus\MongoDbAdapter;
17
18			use Alcaeus\MongoDbAdapter\Helper\ReadPreference;
19			use MongoDB\Collection;
20			use MongoDB\Driver\Cursor;
21
22			/**
23			* @internal
24			*/
25			abstract class AbstractCursor
26			{
27			use ReadPreference;
28
29			/**
30			* @var int\|null
31			*/
32			protected $batchSize = null;
33
34			/**
35			* @var Collection
36			*/
37			protected $collection;
38
39			/**
40			* @var \MongoClient
41			*/
42			protected $connection;
43
44			/**
45			* @var Cursor
46			*/
47			protected $cursor;
48
49			/**
50			* @var \MongoDB\Database
51			*/
52			protected $db;
53
54			/**
55			* @var \Iterator
56			*/
57			protected $iterator;
58
59			/**
60			* @var string
61			*/
62			protected $ns;
63
64			/**
65			* @var bool
66			*/
67			protected $startedIterating = false;
68
69			/**
70			* @var bool
71			*/
72			protected $cursorNeedsAdvancing = true;
73
74			/**
75			* @var mixed
76			*/
77			private $current = null;
78
79			/**
80			* @var mixed
81			*/
82			private $key = null;
83
84			/**
85			* @var mixed
86			*/
87			private $valid = false;
88
89			/**
90			* @var int
91			*/
92			protected $position = 0;
93
94			/**
95			* @var array
96			*/
97			protected $optionNames = [
98			'batchSize',
99			'readPreference',
100			];
101
102			/**
103			* @return Cursor
104			*/
105			abstract protected function ensureCursor();
106
107			/**
108			* @return array
109			*/
110			abstract protected function getCursorInfo();
111
112			/**
113			* Create a new cursor
114			* @link http://www.php.net/manual/en/mongocursor.construct.php
115			* @param \MongoClient $connection Database connection.
116			* @param string $ns Full name of database and collection.
117			*/
118	91		public function __construct(\MongoClient $connection, $ns)
119			{
120	91		$this->connection = $connection;
121	91		$this->ns = $ns;
122
123	91		$nsParts = explode('.', $ns);
124	91		$dbName = array_shift($nsParts);
125	91		$collectionName = implode('.', $nsParts);
126
127	91		$this->db = $connection->selectDB($dbName)->getDb();
128
129	91		if ($collectionName) {
130	55		$this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
131			}
132	91		}
133
134			/**
135			* Returns the current element
136			* @link http://www.php.net/manual/en/mongocursor.current.php
137			* @return array
138			*/
139	43		public function current()
140			{
141	43		return $this->current;
142			}
143
144			/**
145			* Returns the current result's _id
146			* @link http://www.php.net/manual/en/mongocursor.key.php
147			* @return string The current result's _id as a string.
148			*/
149	28		public function key()
150			{
151	28		return $this->key;
152			}
153
154			/**
155			* Advances the cursor to the next result, and returns that result
156			* @link http://www.php.net/manual/en/mongocursor.next.php
157			* @throws \MongoConnectionException
158			* @throws \MongoCursorTimeoutException
159			* @return array Returns the next object
160			*/
161	45		public function next()
162			{
163	45	View Code Duplication	if (! $this->startedIterating) {
			0 ignored issues – show Duplication introduced 2016-04-08 14:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
164	1		$this->ensureIterator();
165	1		$this->startedIterating = true;
166			} else {
167	45		if ($this->cursorNeedsAdvancing) {
168	44		$this->ensureIterator()->next();
169			}
170
171	45		$this->cursorNeedsAdvancing = true;
172	45		$this->position++;
173			}
174
175	45		return $this->storeIteratorState();
176			}
177
178			/**
179			* Returns the cursor to the beginning of the result set
180			* @throws \MongoConnectionException
181			* @throws \MongoCursorTimeoutException
182			* @return void
183			*/
184	76		public function rewind()
185			{
186			// We can recreate the cursor to allow it to be rewound
187	76		$this->reset();
188	76		$this->startedIterating = true;
189	76		$this->position = 0;
190	76		$this->ensureIterator()->rewind();
191	74		$this->storeIteratorState();
192	74		}
193
194			/**
195			* Checks if the cursor is reading a valid result.
196			* @link http://www.php.net/manual/en/mongocursor.valid.php
197			* @return boolean If the current result is not null.
198			*/
199	74		public function valid()
200			{
201	74		return $this->valid;
202			}
203
204			/**
205			* Limits the number of elements returned in one batch.
206			*
207			* @link http://docs.php.net/manual/en/mongocursor.batchsize.php
208			* @param int\|null $batchSize The number of results to return per batch
209			* @return $this Returns this cursor.
210			*/
211	2		public function batchSize($batchSize)
212			{
213	2		$this->batchSize = $batchSize;
214
215	2		return $this;
216			}
217
218			/**
219			* Checks if there are documents that have not been sent yet from the database for this cursor
220			* @link http://www.php.net/manual/en/mongocursor.dead.php
221			* @return boolean Returns if there are more results that have not been sent to the client, yet.
222			*/
223			public function dead()
224			{
225			return $this->ensureCursor()->isDead();
226			}
227
228			/**
229			* @return array
230			*/
231	5		public function info()
232			{
233	5		return $this->getCursorInfo() + $this->getIterationInfo();
234			}
235
236			/**
237			* @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
238			* @param string $readPreference
239			* @param array $tags
240			* @return $this Returns this cursor.
241			*/
242	91		public function setReadPreference($readPreference, $tags = null)
243			{
244	91		$this->setReadPreferenceFromParameters($readPreference, $tags);
245
246	91		return $this;
247			}
248
249			/**
250			* Sets a client-side timeout for this query
251			* @link http://www.php.net/manual/en/mongocursor.timeout.php
252			* @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
253			* @return $this Returns this cursor
254			*/
255			public function timeout($ms)
			0 ignored issues – show Unused Code introduced 2016-01-01 11:06 UTC by Report Bug Copy Issue Report The parameter `$ms` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
256			{
257			trigger_error('The ' . __METHOD__ . ' method is not implemented in mongo-php-adapter', E_USER_WARNING);
258			return $this;
259			}
260
261			/**
262			* Applies all options set on the cursor, overwriting any options that have already been set
263			*
264			* @param array $optionNames Array of option names to be applied (will be read from properties)
265			* @return array
266			*/
267	85		protected function getOptions($optionNames = null)
268			{
269	85		$options = [];
270
271	85		if ($optionNames === null) {
272	78		$optionNames = $this->optionNames;
273			}
274
275	85		foreach ($optionNames as $option) {
276	85		$converter = 'convert' . ucfirst($option);
277	85		$value = method_exists($this, $converter) ? $this->$converter() : $this->$option;
278
279	85		if ($value === null) {
280	85		continue;
281			}
282
283	80		$options[$option] = $value;
284			}
285
286	85		return $options;
287			}
288
289			/**
290			* @return \Iterator
291			*/
292	78		protected function ensureIterator()
293			{
294	78		if ($this->iterator === null) {
295			// MongoDB\Driver\Cursor needs to be wrapped into a \Generator so that a valid \Iterator with working implementations of
296			// next, current, valid, key and rewind is returned. These methods don't work if we wrap the Cursor inside an \IteratorIterator
297	78		$this->iterator = $this->wrapTraversable($this->ensureCursor());
298			}
299
300	76		return $this->iterator;
301			}
302
303			/**
304			* @param \Traversable $traversable
305			* @return \Generator
306			*/
307	36		protected function wrapTraversable(\Traversable $traversable)
308			{
309	36		foreach ($traversable as $key => $value) {
310	22		yield $key => $value;
311			}
312	36		}
313
314			/**
315			* @throws \MongoCursorException
316			*/
317	25		protected function errorIfOpened()
318			{
319	25		if ($this->cursor === null) {
320	25		return;
321			}
322
323			throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
324			}
325
326			/**
327			* @return array
328			*/
329	5		protected function getIterationInfo()
330			{
331			$iterationInfo = [
332	5		'started_iterating' => $this->cursor !== null,
333			];
334
335	5		if ($this->cursor !== null) {
336	5		switch ($this->cursor->getServer()->getType()) {
337			case \MongoDB\Driver\Server::TYPE_RS_ARBITER:
338			$typeString = 'ARBITER';
339			break;
340			case \MongoDB\Driver\Server::TYPE_MONGOS:
341			$typeString = 'MONGOS';
342			break;
343			case \MongoDB\Driver\Server::TYPE_RS_PRIMARY:
344			$typeString = 'PRIMARY';
345			break;
346			case \MongoDB\Driver\Server::TYPE_RS_SECONDARY:
347			$typeString = 'SECONDARY';
348			break;
349			default:
350	5		$typeString = 'STANDALONE';
351			}
352
353	5		$cursorId = (string) $this->cursor->getId();
354			$iterationInfo += [
355	5		'id' => (int) $cursorId,
356	5		'at' => $this->position,
357	5		'numReturned' => $this->position, // This can't be obtained from the new cursor
358	5		'server' => sprintf('%s:%d;-;.;%d', $this->cursor->getServer()->getHost(), $this->cursor->getServer()->getPort(), getmypid()),
359	5		'host' => $this->cursor->getServer()->getHost(),
360	5		'port' => $this->cursor->getServer()->getPort(),
361	5		'connection_type_desc' => $typeString,
362			];
363			}
364
365	5		return $iterationInfo;
366			}
367
368			/**
369			* @throws \Exception
370			*/
371			protected function notImplemented()
372			{
373			throw new \Exception('Not implemented');
374			}
375
376			/**
377			* Clears the cursor
378			*
379			* This is generic but implemented as protected since it's only exposed in MongoCursor
380			*/
381	77		protected function reset()
382			{
383	77		$this->startedIterating = false;
384	77		$this->cursorNeedsAdvancing = true;
385	77		$this->cursor = null;
386	77		$this->iterator = null;
387	77		$this->storeIteratorState();
388	77		}
389
390			/**
391			* @return array
392			*/
393	3		public function __sleep()
394			{
395	3		return ['batchSize', 'connection', 'iterator', 'ns', 'optionNames', 'position', 'startedIterating'];
396			}
397
398			/**
399			* Stores the current cursor element.
400			*
401			* This is necessary because hasNext() might advance the iterator but we still
402			* need to be able to return the current object.
403			*/
404	78		protected function storeIteratorState()
405			{
406	78		if (! $this->startedIterating) {
407	77		$this->current = null;
408	77		$this->key = null;
409	77		$this->valid = false;
410	77		return null;
411			}
412
413	76		$this->current = $this->ensureIterator()->current();
414	76		$this->key = $this->ensureIterator()->key();
415	76		$this->valid = $this->ensureIterator()->valid();
416
417	76		if ($this->current !== null) {
418	45		$this->current = TypeConverter::toLegacy($this->current);
419			}
420
421	76		return $this->current;
422			}
423			}
424

alcaeus / mongo-php-adapter

Pull Request — master (#220)

AbstractCursor::notImplemented() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like