v1/vendor/phootwork/collection/Stack.php

60 lines
1.1 KiB
PHP

<?php declare(strict_types=1);
/**
* This file is part of the Phootwork package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
* @copyright Thomas Gossmann
*/
namespace phootwork\collection;
use Iterator;
use phootwork\lang\parts\PopPart;
/**
* Represents a Stack
*
* FILO - first in last out
*
* @author Thomas Gossmann
*/
class Stack extends AbstractList {
use PopPart;
/**
* Creates a new ArrayList
*
* @param array|Iterator $collection
*/
public function __construct(array|Iterator $collection = []) {
$this->push(...$collection);
}
/**
* Pushes an element onto the stack
*
* @param mixed ...$elements
*
* @return $this
*/
public function push(mixed ...$elements): self {
array_push($this->array, ...$elements);
return $this;
}
/**
* Returns the element at the head or null if the stack is empty but doesn't remove that element
*
* @return mixed
*/
public function peek(): mixed {
if ($this->size() > 0) {
return $this->array[$this->size() - 1];
}
return null;
}
}