phootwork\collection\Queue

Complexity

Total Complexity

8

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	enqueue()	0	5	1
A	enqueueAll()	0	7	2
A	peek()	0	7	2
A	poll()	0	3	1

<?php
namespace phootwork\collection;

use \Iterator;

/**
 * Represents a Queue
 * 
 * FIFO - first in first out
 * 
 * @author Thomas Gossmann
 */
class Queue extends AbstractList {
	
	/**
	 * Creates a new Queue
	 * 
	 * @param array|Iterator $collection
	 */
	public function __construct($collection = []) {
		foreach ($collection as $element) {
			$this->collection[] = $element;
		}
	}
	
	/**
	 * Enqueues an element
	 * 
	 * @param mixed $element
	 * @return $this
	 */
	public function enqueue($element) {
		array_unshift($this->collection, $element);
		
		return $this;
	}
	
	/**
	 * Enqueues many elements
	 *
	 * @param array|Iterator $collection
	 * @return $this
	 */
	public function enqueueAll($collection) {
		foreach ($collection as $element) {
			$this->enqueue($element);
		}
	
		return $this;
	}
	
	/**
	 * Returns the element at the head or null if the queue is empty but doesn't remove that element  
	 * 
	 * @return mixed
	 */
	public function peek() {
		if ($this->size() > 0) {
			return $this->collection[0];
		}
		
		return null;
	}
	
	/**
	 * Removes and returns the element at the head or null if the is empty
	 * 
	 * @return mixed
	 */
	public function poll() {
		return array_shift($this->collection);
	}
	
}