Stack::peek() - 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

Stack::peek() A

↳ Parent: Stack

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Ds;

use Error;
use UnderflowException;

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

    /**
     * @var Vector
     */
    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 Vector($values ?: []);
    }

    /**
     * Clear all elements in the Stack
     */
    public function clear()
    {
        $this->internal->clear();
    }

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

    /**
     * Returns the number of elements in the Stack
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->internal);
    }

    /**
     * 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 stack.
     *
     * @return int
     */
    public function capacity(): int
    {
        return $this->internal->capacity();
    }

    /**
     * Returns the value at the top of the stack without removing it.
     *
     * @return mixed
     *
     * @throws UnderflowException if the stack is empty.
     */
    public function peek()
    {
        return $this->internal->last();
    }

    /**
     * Returns and removes the value at the top of the stack
     *
     * @return mixed
     *
     * @throws UnderflowException if the stack is empty.
     */
    public function pop()
    {
        return $this->internal->pop();
    }

    /**
     * Pushes zero or more values onto the top of the stack.
     *
     * @param mixed ...$values
     */

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

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

    /**
     * Get iterator
     */
    public function getIterator()
    {
        while ($this->isEmpty() === false) {
            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			use UnderflowException;
6
7			/**
8			* Stack
9			*
10			* @package Ds
11			*/
12			final class Stack implements \IteratorAggregate, \ArrayAccess, Collection
13			{
14			use Traits\Collection;
15
16			/**
17			* @var Vector
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 Vector($values ?: []);
29			}
30
31			/**
32			* Clear all elements in the Stack
33			*/
34			public function clear()
35			{
36			$this->internal->clear();
37			}
38
39			/**
40			* @inheritdoc
41			*/
42			public function copy(): Collection
43			{
44			return new self($this->internal);
45			}
46
47			/**
48			* Returns the number of elements in the Stack
49			*
50			* @return int
51			*/
52			public function count(): int
53			{
54			return count($this->internal);
55			}
56
57			/**
58			* Ensures that enough memory is allocated for a specified capacity. This
59			* potentially reduces the number of reallocations as the size increases.
60			*
61			* @param int $capacity The number of values for which capacity should be
62			* allocated. Capacity will stay the same if this value
63			* is less than or equal to the current capacity.
64			*/
65			public function allocate(int $capacity)
66			{
67			$this->internal->allocate($capacity);
68			}
69
70			/**
71			* Returns the current capacity of the stack.
72			*
73			* @return int
74			*/
75			public function capacity(): int
76			{
77			return $this->internal->capacity();
78			}
79
80			/**
81			* Returns the value at the top of the stack without removing it.
82			*
83			* @return mixed
84			*
85			* @throws UnderflowException if the stack is empty.
86			*/
87			public function peek()
88			{
89			return $this->internal->last();
90			}
91
92			/**
93			* Returns and removes the value at the top of the stack
94			*
95			* @return mixed
96			*
97			* @throws UnderflowException if the stack is empty.
98			*/
99			public function pop()
100			{
101			return $this->internal->pop();
102			}
103
104			/**
105			* Pushes zero or more values onto the top of the stack.
106			*
107			* @param mixed ...$values
108			*/
			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...
109			public function push(...$values)
110			{
111			$this->internal->push(...$values);
112			}
113
114			/**
115			* @inheritDoc
116			*/
117			public function toArray(): array
118			{
119			return array_reverse($this->internal->toArray());
120			}
121
122			/**
123			* Get iterator
124			*/
125			public function getIterator()
126			{
127			while ($this->isEmpty() === false) {
128			yield $this->pop();
129			}
130			}
131
132			/**
133			* @inheritdoc
134			*
135			* @throws Error
136			*/
137			public function offsetSet($offset, $value)
138			{
139			if ($offset === null) {
140			$this->push($value);
141			} else {
142			throw new Error();
143			}
144			}
145
146			/**
147			* @inheritdoc
148			*
149			* @throws Error
150			*/
151			public function offsetGet($offset)
152			{
153			throw new Error();
154			}
155
156			/**
157			* @inheritdoc
158			*
159			* @throws Error
160			*/
161			public function offsetUnset($offset)
162			{
163			throw new Error();
164			}
165
166			/**
167			* @inheritdoc
168			*
169			* @throws Error
170			*/
171			public function offsetExists($offset)
172			{
173			throw new Error();
174			}
175			}
176

php-ds / polyfill

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

Stack::peek() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like