Minotaur\Db\CursorSubset

Complexity

Total Complexity

10

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

59.09%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	getTotal()	0	4	1
B	toArray()	0	14	5
A	jsonSerialize()	0	5	2

<?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).

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

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

    /**
     * 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) {

The class MongoDB\Driver\Cursor does not exist. Did you forget a USE statement, or did you not list all dependencies?

            return $it->toArray();
        } elseif ($it instanceof Iterable) {

The class Minotaur\Db\iterable does not exist. Did you forget a USE statement, or did you not list all dependencies?

            return $it->toArray();
        } elseif ($it instanceof \ArrayObject) {
            return $it->getArrayCopy();
        } elseif ($it instanceof \ArrayIterator) {
            return $it->getArrayCopy();
        }
        return iterator_to_array($it, false);
    }
}