summaryrefslogtreecommitdiffstats
path: root/vendor/ramsey/collection/src/Queue.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ramsey/collection/src/Queue.php')
-rw-r--r--vendor/ramsey/collection/src/Queue.php169
1 files changed, 169 insertions, 0 deletions
diff --git a/vendor/ramsey/collection/src/Queue.php b/vendor/ramsey/collection/src/Queue.php
new file mode 100644
index 0000000..4af2fdf
--- /dev/null
+++ b/vendor/ramsey/collection/src/Queue.php
@@ -0,0 +1,169 @@
+<?php
+
+/**
+ * This file is part of the ramsey/collection library
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+
+declare(strict_types=1);
+
+namespace Ramsey\Collection;
+
+use Ramsey\Collection\Exception\InvalidArgumentException;
+use Ramsey\Collection\Exception\NoSuchElementException;
+use Ramsey\Collection\Tool\TypeTrait;
+use Ramsey\Collection\Tool\ValueToStringTrait;
+
+/**
+ * This class provides a basic implementation of `QueueInterface`, to minimize
+ * the effort required to implement this interface.
+ *
+ * @template T
+ * @template-extends AbstractArray<T>
+ * @template-implements QueueInterface<T>
+ */
+class Queue extends AbstractArray implements QueueInterface
+{
+ use TypeTrait;
+ use ValueToStringTrait;
+
+ /**
+ * The type of elements stored in this queue.
+ *
+ * A queue's type is immutable once it is set. For this reason, this
+ * property is set private.
+ *
+ * @var string
+ */
+ private $queueType;
+
+ /**
+ * The index of the head of the queue.
+ *
+ * @var int
+ */
+ protected $index = 0;
+
+ /**
+ * Constructs a queue object of the specified type, optionally with the
+ * specified data.
+ *
+ * @param string $queueType The type (FQCN) associated with this queue.
+ * @param array<array-key, T> $data The initial items to store in the collection.
+ */
+ public function __construct(string $queueType, array $data = [])
+ {
+ $this->queueType = $queueType;
+ parent::__construct($data);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Since arbitrary offsets may not be manipulated in a queue, this method
+ * serves only to fulfill the `ArrayAccess` interface requirements. It is
+ * invoked by other operations when adding values to the queue.
+ */
+ public function offsetSet($offset, $value): void
+ {
+ if ($this->checkType($this->getType(), $value) === false) {
+ throw new InvalidArgumentException(
+ 'Value must be of type ' . $this->getType() . '; value is '
+ . $this->toolValueToString($value)
+ );
+ }
+
+ $this->data[] = $value;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function add($element): bool
+ {
+ $this[] = $element;
+
+ return true;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function element()
+ {
+ $element = $this->peek();
+
+ if ($element === null) {
+ throw new NoSuchElementException(
+ 'Can\'t return element from Queue. Queue is empty.'
+ );
+ }
+
+ return $element;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function offer($element): bool
+ {
+ try {
+ return $this->add($element);
+ } catch (InvalidArgumentException $e) {
+ return false;
+ }
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function peek()
+ {
+ if ($this->count() === 0) {
+ return null;
+ }
+
+ return $this[$this->index];
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function poll()
+ {
+ if ($this->count() === 0) {
+ return null;
+ }
+
+ $head = $this[$this->index];
+
+ unset($this[$this->index]);
+ $this->index++;
+
+ return $head;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function remove()
+ {
+ $head = $this->poll();
+
+ if ($head === null) {
+ throw new NoSuchElementException('Can\'t return element from Queue. Queue is empty.');
+ }
+
+ return $head;
+ }
+
+ public function getType(): string
+ {
+ return $this->queueType;
+ }
+}