AbstractCursor::info() - Code Metrics - Inspection of "[WIP] Implement command cursors and aggregation" - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Andreas

created 2016-01-01 15:20 UTC

AbstractCursor::info() 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	1
Bugs	0	Features	0

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

<?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 MongoDB\Collection;
use MongoDB\Driver\Cursor;
use MongoDB\Driver\ReadPreference;

/**
 * @internal
 */
abstract class AbstractCursor
{
    /**
     * @var int
     */
    protected $batchSize;

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

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

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

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

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

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

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

    /**
     * @var array
     */
    protected $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()
    {
        $document = $this->ensureIterator()->current();
        if ($document !== null) {
            $document = TypeConverter::convertObjectToLegacyArray($document);
        }

        return $document;
    }

    /**
     * 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->ensureIterator()->key();
    }

    /**
     * Advances the cursor to the next result
     * @link http://www.php.net/manual/en/mongocursor.next.php
     * @throws \MongoConnectionException
     * @throws \MongoCursorTimeoutException
     * @return void
     */
    public function next()
    {
        $this->ensureIterator()->next();
    }

    /**
     * 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->ensureIterator()->rewind();
    }

    /**
     * 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->ensureIterator()->valid();
    }

    /**
     * Limits the number of elements returned in one batch.
     *
     * @link http://docs.php.net/manual/en/mongocursor.batchsize.php
     * @param int $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();
    }

    /**
     * Get the read preference for this query
     * @link http://www.php.net/manual/en/mongocursor.getreadpreference.php
     * @return array
     */
    public function getReadPreference()
    {
        return $this->readPreference;
    }

    /**
     * @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)
    {
        $availableReadPreferences = [
            \MongoClient::RP_PRIMARY,
            \MongoClient::RP_PRIMARY_PREFERRED,
            \MongoClient::RP_SECONDARY,
            \MongoClient::RP_SECONDARY_PREFERRED,
            \MongoClient::RP_NEAREST
        ];
        if (! in_array($readPreference, $availableReadPreferences)) {
            trigger_error("The value '$readPreference' is not valid as read preference type", E_WARNING);
            return $this;
        }

        if ($readPreference == \MongoClient::RP_PRIMARY && count($tags)) {
            trigger_error("You can't use read preference tags with a read preference of PRIMARY", E_WARNING);
            return $this;
        }

        $this->readPreference = [
            'type' => $readPreference,
            'tagsets' => $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)

    {
        $this->notImplemented();
    }

    /**
     * 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 ReadPreference|null
     */
    protected function convertReadPreference()
    {
        $type = array_key_exists('type', $this->readPreference) ? $this->readPreference['type'] : null;
        if ($type === null) {
            return null;
        }

        switch ($type) {
            case \MongoClient::RP_PRIMARY_PREFERRED:
                $mode = ReadPreference::RP_PRIMARY_PREFERRED;
                break;
            case \MongoClient::RP_SECONDARY:
                $mode = ReadPreference::RP_SECONDARY;
                break;
            case \MongoClient::RP_SECONDARY_PREFERRED:
                $mode = ReadPreference::RP_SECONDARY_PREFERRED;
                break;
            case \MongoClient::RP_NEAREST:
                $mode = ReadPreference::RP_NEAREST;
                break;
            default:
                $mode = ReadPreference::RP_PRIMARY;
        }

        $tagSets = array_key_exists('tagsets', $this->readPreference) ? $this->readPreference['tagsets'] : [];

        return new ReadPreference($mode, $tagSets);
    }

    /**
     * @return \IteratorIterator
     */
    protected function ensureIterator()
    {
        if ($this->iterator === null) {
            $this->iterator = new \IteratorIterator($this->ensureCursor());
        }

        return $this->iterator;
    }

    /**
     * @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_ARBITER:
                    $typeString = 'ARBITER';
                    break;
                case \MongoDB\Driver\Server::TYPE_MONGOS:
                    $typeString = 'MONGOS';
                    break;
                case \MongoDB\Driver\Server::TYPE_PRIMARY:
                    $typeString = 'PRIMARY';
                    break;
                case \MongoDB\Driver\Server::TYPE_SECONDARY:
                    $typeString = 'SECONDARY';
                    break;
                default:
                    $typeString = 'STANDALONE';
            }

            $iterationInfo += [
                'id' => (string)$this->cursor->getId(),
                'at' => null, // @todo Complete info for cursor that is iterating
                'numReturned' => null, // @todo Complete info for cursor that is iterating
                'server' => null, // @todo Complete info for cursor that is iterating
                '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->cursor = null;
        $this->iterator = null;
    }
}


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		use MongoDB\Collection;
18		use MongoDB\Driver\Cursor;
19		use MongoDB\Driver\ReadPreference;
20
21		/**
22		* @internal
23		*/
24		abstract class AbstractCursor
25		{
26		/**
27		* @var int
28		*/
29		protected $batchSize;
30
31		/**
32		* @var Collection
33		*/
34		protected $collection;
35
36		/**
37		* @var \MongoClient
38		*/
39		protected $connection;
40
41		/**
42		* @var Cursor
43		*/
44		protected $cursor;
45
46		/**
47		* @var \MongoDB\Database
48		*/
49		protected $db;
50
51		/**
52		* @var \IteratorIterator
53		*/
54		protected $iterator;
55
56		/**
57		* @var string
58		*/
59		protected $ns;
60
61		/**
62		* @var array
63		*/
64		protected $optionNames = [
65		'batchSize',
66		'readPreference',
67		];
68
69		/**
70		* @var array
71		*/
72		protected $readPreference = [];
73
74		/**
75		* @return Cursor
76		*/
77		abstract protected function ensureCursor();
78
79		/**
80		* @return array
81		*/
82		abstract protected function getCursorInfo();
83
84		/**
85		* Create a new cursor
86		* @link http://www.php.net/manual/en/mongocursor.construct.php
87		* @param \MongoClient $connection Database connection.
88		* @param string $ns Full name of database and collection.
89		*/
90	23	public function __construct(\MongoClient $connection, $ns)
91		{
92	23	$this->connection = $connection;
93	23	$this->ns = $ns;
94
95	23	$nsParts = explode('.', $ns);
96	23	$dbName = array_shift($nsParts);
97	23	$collectionName = implode('.', $nsParts);
98
99	23	$this->db = $connection->selectDB($dbName)->getDb();
100
101	23	if ($collectionName) {
102	20	$this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
103	20	}
104	23	}
105
106		/**
107		* Returns the current element
108		* @link http://www.php.net/manual/en/mongocursor.current.php
109		* @return array
110		*/
111	4	public function current()
112		{
113	4	$document = $this->ensureIterator()->current();
114	4	if ($document !== null) {
115	4	$document = TypeConverter::convertObjectToLegacyArray($document);
116	4	}
117
118	4	return $document;
119		}
120
121		/**
122		* Returns the current result's _id
123		* @link http://www.php.net/manual/en/mongocursor.key.php
124		* @return string The current result's _id as a string.
125		*/
126	4	public function key()
127		{
128	4	return $this->ensureIterator()->key();
129		}
130
131		/**
132		* Advances the cursor to the next result
133		* @link http://www.php.net/manual/en/mongocursor.next.php
134		* @throws \MongoConnectionException
135		* @throws \MongoCursorTimeoutException
136		* @return void
137		*/
138	4	public function next()
139		{
140	4	$this->ensureIterator()->next();
141	4	}
142
143		/**
144		* Returns the cursor to the beginning of the result set
145		* @throws \MongoConnectionException
146		* @throws \MongoCursorTimeoutException
147		* @return void
148		*/
149	21	public function rewind()
150		{
151		// We can recreate the cursor to allow it to be rewound
152	21	$this->reset();
153	21	$this->ensureIterator()->rewind();
154	20	}
155
156		/**
157		* Checks if the cursor is reading a valid result.
158		* @link http://www.php.net/manual/en/mongocursor.valid.php
159		* @return boolean If the current result is not null.
160		*/
161	20	public function valid()
162		{
163	20	return $this->ensureIterator()->valid();
164		}
165
166		/**
167		* Limits the number of elements returned in one batch.
168		*
169		* @link http://docs.php.net/manual/en/mongocursor.batchsize.php
170		* @param int $batchSize The number of results to return per batch
171		* @return $this Returns this cursor.
172		*/
173	1	public function batchSize($batchSize)
174		{
175	1	$this->batchSize = $batchSize;
176
177	1	return $this;
178		}
179
180		/**
181		* Checks if there are documents that have not been sent yet from the database for this cursor
182		* @link http://www.php.net/manual/en/mongocursor.dead.php
183		* @return boolean Returns if there are more results that have not been sent to the client, yet.
184		*/
185		public function dead()
186		{
187		return $this->ensureCursor()->isDead();
188		}
189
190		/**
191		* Get the read preference for this query
192		* @link http://www.php.net/manual/en/mongocursor.getreadpreference.php
193		* @return array
194		*/
195		public function getReadPreference()
196		{
197		return $this->readPreference;
198		}
199
200		/**
201		* @return array
202		*/
203		public function info()
204		{
205		return $this->getCursorInfo() + $this->getIterationInfo();
206		}
207
208		/**
209		* @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
210		* @param string $readPreference
211		* @param array $tags
212		* @return $this Returns this cursor.
213		*/
214	2	public function setReadPreference($readPreference, $tags = null)
215		{
216		$availableReadPreferences = [
217	2	\MongoClient::RP_PRIMARY,
218	2	\MongoClient::RP_PRIMARY_PREFERRED,
219	2	\MongoClient::RP_SECONDARY,
220	2	\MongoClient::RP_SECONDARY_PREFERRED,
221		\MongoClient::RP_NEAREST
222	2	];
223	2	if (! in_array($readPreference, $availableReadPreferences)) {
224		trigger_error("The value '$readPreference' is not valid as read preference type", E_WARNING);
225		return $this;
226		}
227
228	2	if ($readPreference == \MongoClient::RP_PRIMARY && count($tags)) {
229		trigger_error("You can't use read preference tags with a read preference of PRIMARY", E_WARNING);
230		return $this;
231		}
232
233	2	$this->readPreference = [
234	2	'type' => $readPreference,
235		'tagsets' => $tags
236	2	];
237
238	2	return $this;
239		}
240
241		/**
242		* Sets a client-side timeout for this query
243		* @link http://www.php.net/manual/en/mongocursor.timeout.php
244		* @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
245		* @return $this Returns this cursor
246		*/
247		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...
248		{
249		$this->notImplemented();
250		}
251
252		/**
253		* Applies all options set on the cursor, overwriting any options that have already been set
254		*
255		* @param array $optionNames Array of option names to be applied (will be read from properties)
256		* @return array
257		*/
258	22	protected function getOptions($optionNames = null)
259		{
260	22	$options = [];
261
262	22	if ($optionNames === null) {
263	21	$optionNames = $this->optionNames;
264	21	}
265
266	22	foreach ($optionNames as $option) {
267	22	$converter = 'convert' . ucfirst($option);
268	22	$value = method_exists($this, $converter) ? $this->$converter() : $this->$option;
269
270	22	if ($value === null) {
271	22	continue;
272		}
273
274	18	$options[$option] = $value;
275	22	}
276
277	22	return $options;
278		}
279
280		/**
281		* @return ReadPreference\|null
282		*/
283	21	protected function convertReadPreference()
284		{
285	21	$type = array_key_exists('type', $this->readPreference) ? $this->readPreference['type'] : null;
286	21	if ($type === null) {
287	19	return null;
288		}
289
290		switch ($type) {
291	2	case \MongoClient::RP_PRIMARY_PREFERRED:
292		$mode = ReadPreference::RP_PRIMARY_PREFERRED;
293		break;
294	2	case \MongoClient::RP_SECONDARY:
295	1	$mode = ReadPreference::RP_SECONDARY;
296	1	break;
297	1	case \MongoClient::RP_SECONDARY_PREFERRED:
298		$mode = ReadPreference::RP_SECONDARY_PREFERRED;
299		break;
300	1	case \MongoClient::RP_NEAREST:
301		$mode = ReadPreference::RP_NEAREST;
302		break;
303	1	default:
304	1	$mode = ReadPreference::RP_PRIMARY;
305	1	}
306
307	2	$tagSets = array_key_exists('tagsets', $this->readPreference) ? $this->readPreference['tagsets'] : [];
308
309	2	return new ReadPreference($mode, $tagSets);
310		}
311
312		/**
313		* @return \IteratorIterator
314		*/
315	21	protected function ensureIterator()
316		{
317	21	if ($this->iterator === null) {
318	21	$this->iterator = new \IteratorIterator($this->ensureCursor());
319	20	}
320
321	20	return $this->iterator;
322		}
323
324		/**
325		* @throws \MongoCursorException
326		*/
327	13	protected function errorIfOpened()
328		{
329	13	if ($this->cursor === null) {
330	13	return;
331		}
332
333		throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
334		}
335
336		/**
337		* @return array
338		*/
339		protected function getIterationInfo()
340		{
341		$iterationInfo = [
342		'started_iterating' => $this->cursor !== null,
343		];
344
345		if ($this->cursor !== null) {
346		switch ($this->cursor->getServer()->getType()) {
347		case \MongoDB\Driver\Server::TYPE_ARBITER:
348		$typeString = 'ARBITER';
349		break;
350		case \MongoDB\Driver\Server::TYPE_MONGOS:
351		$typeString = 'MONGOS';
352		break;
353		case \MongoDB\Driver\Server::TYPE_PRIMARY:
354		$typeString = 'PRIMARY';
355		break;
356		case \MongoDB\Driver\Server::TYPE_SECONDARY:
357		$typeString = 'SECONDARY';
358		break;
359		default:
360		$typeString = 'STANDALONE';
361		}
362
363		$iterationInfo += [
364		'id' => (string)$this->cursor->getId(),
365		'at' => null, // @todo Complete info for cursor that is iterating
366		'numReturned' => null, // @todo Complete info for cursor that is iterating
367		'server' => null, // @todo Complete info for cursor that is iterating
368		'host' => $this->cursor->getServer()->getHost(),
369		'port' => $this->cursor->getServer()->getPort(),
370		'connection_type_desc' => $typeString,
371		];
372		}
373
374		return $iterationInfo;
375		}
376
377		/**
378		* @throws \Exception
379		*/
380		protected function notImplemented()
381		{
382		throw new \Exception('Not implemented');
383		}
384
385		/**
386		* Clears the cursor
387		*
388		* This is generic but implemented as protected since it's only exposed in MongoCursor
389		*/
390	21	protected function reset()
391		{
392	21	$this->cursor = null;
393	21	$this->iterator = null;
394	21	}
395		}
396

alcaeus / mongo-php-adapter

Pull Request — master (#10)

AbstractCursor::info() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like