CursorSubset::toArray() - Code Metrics - appertly/minotaur - Measure and Improve Code Quality continuously with Scrutinizer

CursorSubset::toArray() B
last analyzed 2018-02-14 18:59 UTC

↳ Parent: CursorSubset

Complexity

Conditions	5
Paths	5

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5.5069

Importance

Changes

Metric	Value
cc	5
eloc	11
nc	5
nop	0
dl	0
loc	14
ccs	8
cts	11
cp	0.7272
crap	5.5069
rs	8.8571
c	0
b	0
f	0

<?php
declare(strict_types=1);
/**
 * Minotaur
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2017 Appertly
 * @license   Apache-2.0
 */
namespace Minotaur\Db;

/**
 * A wrapper around a `Traversable` that includes the total count of the superset.
 */
class CursorSubset extends \IteratorIterator implements \JsonSerializable
{
    /**
     * @var int
     */
    private $total;

    /**
     * Create a new CursorSubset.
     *
     * @param \Traversable $iterable The traversable to wrap
     * @param int $total The total number of items in the superset
     * @throws \RangeException if the total is negative
     */
    public function __construct(\Traversable $iterable, int $total)
    {
        parent::__construct($iterable);
        if ($total < 0) {
            throw new \RangeException("Total cannot be a negative number");
        }
        $this->total = $total;
    }

    /**
     * Gets the superset total.
     *
     * @return - The total number of items in the superset (never negative).

     */
    public function getTotal(): int
    {
        return $this->total;
    }

    /**
     * Return data which can be serialized with json_encode.
     */
    public function jsonSerialize()
    {
        $it = $this->getInnerIterator();
        return $it instanceof \JsonSerializable ? $it : $this->toArray();
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Converts this thing into an array.
     *
     * @return array<mixed> The array version of this thing
     */
    public function toArray(): array
    {
        $it = $this->getInnerIterator();
        if ($it instanceof \MongoDB\Driver\Cursor) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $it->toArray();
        } elseif ($it instanceof Iterable) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $it->toArray();
        } elseif ($it instanceof \ArrayObject) {
            return $it->getArrayCopy();
        } elseif ($it instanceof \ArrayIterator) {
            return $it->getArrayCopy();
        }
        return iterator_to_array($it, false);
    }
}


CursorSubset::toArray() B
last analyzed 2018-02-14 18:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php
2		declare(strict_types=1);
3		/**
4		* Minotaur
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License"); you may not
7		* use this file except in compliance with the License. You may obtain a copy of
8		* the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14		* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15		* License for the specific language governing permissions and limitations under
16		* the License.
17		*
18		* @copyright 2015-2017 Appertly
19		* @license Apache-2.0
20		*/
21		namespace Minotaur\Db;
22
23		/**
24		* A wrapper around a `Traversable` that includes the total count of the superset.
25		*/
26		class CursorSubset extends \IteratorIterator implements \JsonSerializable
27		{
28		/**
29		* @var int
30		*/
31		private $total;
32
33		/**
34		* Create a new CursorSubset.
35		*
36		* @param \Traversable $iterable The traversable to wrap
37		* @param int $total The total number of items in the superset
38		* @throws \RangeException if the total is negative
39		*/
40	5	public function __construct(\Traversable $iterable, int $total)
41		{
42	5	parent::__construct($iterable);
43	5	if ($total < 0) {
44	1	throw new \RangeException("Total cannot be a negative number");
45		}
46	4	$this->total = $total;
47	4	}
48
49		/**
50		* Gets the superset total.
51		*
52		* @return - The total number of items in the superset (never negative).
		0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `-` could not be parsed: Unknown type name "-" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
53		*/
54	4	public function getTotal(): int
55		{
56	4	return $this->total;
57		}
58
59		/**
60		* Return data which can be serialized with json_encode.
61		*/
62	1	public function jsonSerialize()
63		{
64	1	$it = $this->getInnerIterator();
65	1	return $it instanceof \JsonSerializable ? $it : $this->toArray();
		0 ignored issues – show Bug introduced 2017-05-04 15:22 UTC by Report Bug Copy Issue Report The class `JsonSerializable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
66		}
67
68		/**
69		* Converts this thing into an array.
70		*
71		* @return array<mixed> The array version of this thing
72		*/
73	4	public function toArray(): array
74		{
75	4	$it = $this->getInnerIterator();
76	4	if ($it instanceof \MongoDB\Driver\Cursor) {
		0 ignored issues – show Bug introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The class `MongoDB\Driver\Cursor` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
77		return $it->toArray();
78	4	} elseif ($it instanceof Iterable) {
		0 ignored issues – show Bug introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The class `Minotaur\Db\iterable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
79		return $it->toArray();
80	4	} elseif ($it instanceof \ArrayObject) {
81		return $it->getArrayCopy();
82	4	} elseif ($it instanceof \ArrayIterator) {
83	3	return $it->getArrayCopy();
84		}
85	1	return iterator_to_array($it, false);
86		}
87		}
88

appertly / minotaur

CursorSubset::toArray() B last analyzed 2018-02-14 18:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

CursorSubset::toArray() B
last analyzed 2018-02-14 18:59 UTC