PHPCollections\Collections\Stack

Complexity

Total Complexity

7

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	count()	0	3	1
A	peek()	0	3	1
A	pop()	0	3	1
A	push()	0	12	1
A	__construct()	0	4	1
A	isEmpty()	0	3	1
A	clear()	0	3	1

<?php

declare(strict_types=1);

namespace PHPCollections\Collections;

use Countable;
use PHPCollections\Checker;

/**
 * A generic LIFO Stack.
 */
class Stack implements Countable
{
    /**
     * The data container.
     *
     * @var array
     */
    private $data;

    /**
     * The type of the values
     * for this Stack.
     *
     * @var mixed
     */
    private $type;

    /**
     * Creates a new Stack.
     *
     * @param string $type
     */
    public function __construct(string $type)
    {
        $this->data = [];
        $this->type = $type;
    }

    /**
     * Clears the data values.
     *
     * @return void
     */
    public function clear(): void
    {
        $this->data = [];
    }

    /**
     * Returns the length of the Stack.
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->data);
    }

    /**
     * Checks if the stack is empty.
     *
     * @return bool
     */
    public function isEmpty(): bool
    {
        return $this->count() === 0;
    }

    /**
     * Gets the element at
     * the end of the Stack.
     *
     * @return mixed
     */
    public function peek()
    {
        return $this->data[$this->count() - 1];
    }

    /**
     * Pops the element at
     * the end of the stack.
     *
     * @return mixed
     */
    public function pop()
    {
        return array_pop($this->data);
    }

    /**
     * Adds a new element at
     * the end of the Stack.
     *
     * @param mixed $value
     *
     * @throws \InvalidArgumentException
     *
     * @return mixed
     */
    public function push($value)
    {
        $message = sprintf(
            'The type specified for this collection is %s, you cannot pass a value of type %s',
            $this->type, gettype($value)
        );

        Checker::valueIsOfType($value, $this->type, $message);

        $this->data[] = $value;

        return $value;
    }
}