Jnjxp\Purple\Queue

Complexity

Total Complexity

6

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	count()	0	4	1
A	insert()	0	4	1
A	getIterator()	0	4	1
A	clear()	0	6	2

<?php
/**
 * Purple - Run tasks on collections
 *
 * PHP version 5
 *
 * Copyright (C) 2016 Jake Johns
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 *
 * @category  Queue
 * @package   Jnjxp\Purple
 * @author    Jake Johns <jake@jakejohns.net>
 * @copyright 2016 Jake Johns
 * @license   http://jnj.mit-license.org/2016 MIT License
 * @link      https://github.com/jnjxp/jnjxp.purple
 */

namespace Jnjxp\Purple;

use IteratorAggregate;

/**
 * Queue
 *
 * @category Queue
 * @package  Jnjxp\Purple
 * @author   Jake Johns <jake@jakejohns.net>
 * @license  http://jnj.mit-license.org/ MIT License
 * @link     https://github.com/jnjxp/jnjxp.purple
 */
class Queue implements IteratorAggregate, QueueInterface
{
    /**
     * Queue
     *
     * @var SplPriorityQueue
     *
     * @access protected
     */
    protected $queue;

    /**
     * __construct
     *
     * @access public
     */
    public function __construct()
    {
        $this->queue = new SplPriorityQueue;
    }

    /**
     * Count
     *
     * @return int
     *
     * @access public
     */
    public function count()
    {
        return count($this->queue);
    }

    /**
     * Insert
     *
     * @param mixed $value    value
     * @param mixed $priority order priority
     *
     * @return void
     *
     * @access public
     */
    public function insert($value, $priority)
    {
        $this->queue->insert($value, $priority);
    }

    /**
     * Get Iterator
     *
     * @return SplPriorityQueue
     *
     * @access public
     */
    public function getIterator()
    {
        return clone $this->queue;
    }

    /**
     * Clear
     *
     * @return void
     *
     * @access public
     */
    public function clear()
    {
        while (!$this->queue->isEmpty()) {
            $this->queue->next();
        }
    }
}