Queue::getIterator() - Code Metrics - Inspection of "Add Set::sorted,reversed,sum and Map::sorted,ksort..." - php-ds/polyfill - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7aefdd...988c00 )

by Rudi

created 2016-07-25 03:13 UTC

Queue::getIterator() A

↳ Parent: Queue

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	0

<?php
namespace Ds;

use \Error;

/**
 * Queue
 * @package Ds
 */
final class Queue implements \IteratorAggregate, \ArrayAccess, Collection
{
    use Traits\Collection;

    const MIN_CAPACITY = 8;

    /**
     * @var Deque
     */
    private $internal;

    /**
     * Creates an instance using the values of an array or Traversable object.
     *
     * @param array|\Traversable $values

     */
    public function __construct($values = null)
    {
        $this->internal = new Deque($values ?: []);
    }

    /**
     * Ensures that enough memory is allocated for a specified capacity. This
     * potentially reduces the number of reallocations as the size increases.
     *
     * @param int $capacity The number of values for which capacity should be
     *                      allocated. Capacity will stay the same if this value
     *                      is less than or equal to the current capacity.
     */
    public function allocate(int $capacity)
    {
        $this->internal->allocate($capacity);
    }

    /**
     * Returns the current capacity of the queue.
     *
     * @return int
     */
    public function capacity(): int
    {
        return $this->internal->capacity();
    }

    /**
     * @inheritDoc
     */
    public function clear()
    {
        $this->internal->clear();
    }

    /**
     * @inheritDoc
     */
    public function copy(): \Ds\Collection
    {
        return new self($this->internal);
    }

    /**
     * @inheritDoc
     */
    public function count(): int
    {
        return count($this->internal);
    }

    /**
     * Returns the value at the front of the queue without removing it.
     *
     * @return
     */
    public function peek()
    {
        return $this->internal->first();
    }

    /**
     * Returns and removes the value at the front of the Queue.
     *
     * @return mixed
     */
    public function pop()
    {
        return $this->internal->shift();
    }

    /**
     * Pushes zero or more values into the front of the queue.
     *
     * @param mixed ...$values
     */

    public function push(...$values)
    {
        $this->internal->push(...$values);
    }

    /**
     * @inheritDoc
     */
    public function toArray(): array
    {
        return $this->internal->toArray();
    }

    /**
     * Get iterator
     */
    public function getIterator()
    {
        while ( ! $this->isEmpty()) {
            yield $this->pop();
        }
    }


    /**
     * @inheritdoc
     *
     * @throws Error
     */
    public function offsetSet($offset, $value)
    {
        if ($offset === null) {
            $this->push($value);
        } else {
            throw new Error();
        }
    }

    /**
     * @inheritdoc
     *
     * @throws Error
     */
    public function offsetGet($offset)
    {
        throw new Error();
    }

    /**
     * @inheritdoc
     *
     * @throws Error
     */
    public function offsetUnset($offset)
    {
        throw new Error();
    }

    /**
     * @inheritdoc
     *
     * @throws Error
     */
    public function offsetExists($offset)
    {
        throw new Error();
    }
}


1			<?php
2			namespace Ds;
3
4			use \Error;
5
6			/**
7			* Queue
8			* @package Ds
9			*/
10			final class Queue implements \IteratorAggregate, \ArrayAccess, Collection
11			{
12			use Traits\Collection;
13
14			const MIN_CAPACITY = 8;
15
16			/**
17			* @var Deque
18			*/
19			private $internal;
20
21			/**
22			* Creates an instance using the values of an array or Traversable object.
23			*
24			* @param array\|\Traversable $values
			0 ignored issues – show Documentation introduced 2016-03-01 03:50 UTC by Report Bug Copy Issue Report Should the type for parameter `$values` not be `array\|\Traversable\|null`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. In addition it looks for parameters that have the generic type `array` and suggests a stricter type like `array<String>`. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
25			*/
26			public function __construct($values = null)
27			{
28			$this->internal = new Deque($values ?: []);
29			}
30
31			/**
32			* Ensures that enough memory is allocated for a specified capacity. This
33			* potentially reduces the number of reallocations as the size increases.
34			*
35			* @param int $capacity The number of values for which capacity should be
36			* allocated. Capacity will stay the same if this value
37			* is less than or equal to the current capacity.
38			*/
39			public function allocate(int $capacity)
40			{
41			$this->internal->allocate($capacity);
42			}
43
44			/**
45			* Returns the current capacity of the queue.
46			*
47			* @return int
48			*/
49			public function capacity(): int
50			{
51			return $this->internal->capacity();
52			}
53
54			/**
55			* @inheritDoc
56			*/
57			public function clear()
58			{
59			$this->internal->clear();
60			}
61
62			/**
63			* @inheritDoc
64			*/
65			public function copy(): \Ds\Collection
66			{
67			return new self($this->internal);
68			}
69
70			/**
71			* @inheritDoc
72			*/
73			public function count(): int
74			{
75			return count($this->internal);
76			}
77
78			/**
79			* Returns the value at the front of the queue without removing it.
80			*
81			* @return
82			*/
83			public function peek()
84			{
85			return $this->internal->first();
86			}
87
88			/**
89			* Returns and removes the value at the front of the Queue.
90			*
91			* @return mixed
92			*/
93			public function pop()
94			{
95			return $this->internal->shift();
96			}
97
98			/**
99			* Pushes zero or more values into the front of the queue.
100			*
101			* @param mixed ...$values
102			*/
			0 ignored issues – show Documentation introduced 2016-07-09 12:15 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$values` a bit more specific; maybe use `array`. Loading history...
103			public function push(...$values)
104			{
105			$this->internal->push(...$values);
106			}
107
108			/**
109			* @inheritDoc
110			*/
111			public function toArray(): array
112			{
113			return $this->internal->toArray();
114			}
115
116			/**
117			* Get iterator
118			*/
119			public function getIterator()
120			{
121			while ( ! $this->isEmpty()) {
122			yield $this->pop();
123			}
124			}
125
126
127			/**
128			* @inheritdoc
129			*
130			* @throws Error
131			*/
132			public function offsetSet($offset, $value)
133			{
134			if ($offset === null) {
135			$this->push($value);
136			} else {
137			throw new Error();
138			}
139			}
140
141			/**
142			* @inheritdoc
143			*
144			* @throws Error
145			*/
146			public function offsetGet($offset)
147			{
148			throw new Error();
149			}
150
151			/**
152			* @inheritdoc
153			*
154			* @throws Error
155			*/
156			public function offsetUnset($offset)
157			{
158			throw new Error();
159			}
160
161			/**
162			* @inheritdoc
163			*
164			* @throws Error
165			*/
166			public function offsetExists($offset)
167			{
168			throw new Error();
169			}
170			}
171

php-ds / polyfill

Push — master ( 7aefdd...988c00 )

Queue::getIterator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like