WS\Utils\Collections\ArrayStack

Complexity

Total Complexity

8

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	push()	0	3	1
A	pop()	0	7	2
A	peek()	0	7	2
A	stream()	0	3	1
A	toArray()	0	3	1
A	getIndexIterator()	0	3	1

<?php
/**
 * @author  Igor Pomiluyko pomiluyko@worksolutions.ru
 * @license MIT
 */

namespace WS\Utils\Collections;

use RuntimeException;
use WS\Utils\Collections\Iterator\Iterator;
use WS\Utils\Collections\Iterator\IteratorFactory;

class ArrayStack extends AbstractCollection implements Stack, IndexIterable
{

    use RemoveTraverseTrait;

    /**
     * Adds element to the top of stack
     *
     * @param $element
     *
     * @return bool
     */
    public function push($element): bool
    {
        return $this->add($element);
    }

    /**
     * Gets element from the top of stack
     *
     * @return mixed
     */
    public function pop()
    {
        if ($this->isEmpty()) {
            throw new RuntimeException('Stack is empty');
        }

        return array_pop($this->elements);
    }

    /**
     * Retrieves, but does not remove
     *
     * @return mixed
     */
    public function peek()
    {
        if ($this->isEmpty()) {
            throw new RuntimeException('Stack is empty');
        }

        return $this->elements[count($this->elements) - 1];
    }

    public function stream(): Stream
    {
        return new SerialStream($this);
    }

    public function toArray(): array
    {
        return array_reverse($this->elements);
    }

    public function getIndexIterator(): Iterator
    {
        return IteratorFactory::reverseSequence($this->size());
    }
}