Zicht\Bundle\FrameworkExtraBundle\Util\SortedSet

Complexity

Total Complexity

13

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	4	1
A	setValues()	0	4	1
A	remove()	0	9	3
A	stateChanged()	0	5	2
A	addValues()	0	4	2
A	count()	0	3	1
A	__construct()	0	3	1
A	toArray()	0	3	1
A	contains()	0	3	1

<?php
/**
 * @author Gerard van Helden <gerard@zicht.nl>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Bundle\FrameworkExtraBundle\Util;

/**
 * A sorted set implementation:
 *
 * All values are ensured unique.
 * All values are ensured sorted.
 *
 * @deprecated Use sorting and unique functionality from `zicht/itertools` instead
 */
class SortedSet implements \Countable
{
    /**
     * The set values
     *
     * @var array
     */
    private $values;


    /**
     * Construct the set with initial values
     *
     * @param array $values
     */
    public function __construct(array $values = array())
    {
        $this->setValues($values);
    }


    /**
     * Remove all current values and replace them with the values.
     *
     * @param array $values
     * @return void
     */
    public function setValues($values)
    {
        $this->values = array();
        $this->addValues($values);
    }


    /**
     * Returns the values as an array
     *
     * @return array
     */
    public function toArray()
    {
        return $this->values;
    }


    /**
     * Add all values in the given array.
     * Values already in the set are ignored, and the set is sorted after adding.
     *
     * @param array $values
     * @return void
     */
    public function addValues($values)
    {
        foreach ($values as $value) {
            $this->add($value);
        }
    }


    /**
     * Checks if the set contains the value
     *
     * @param int|float|string|bool $value
     * @return array
     */
    public function contains($value)
    {
        return in_array($value, $this->values);

The expression return in_array($value, $this->values) returns the type boolean which is incompatible with the documented return type array.

    }


    /**
     * Adds a value to the set.
     * If the value is already present, it is ignored
     *
     * @param int|float|string|bool $value
     * @return void
     */
    public function add($value)
    {
        $this->values[] = $value;
        $this->stateChanged();
    }


    /**
     * Removes a value from the set, if present
     *
     * @param int|float|string|bool $value
     * @return void
     */
    public function remove($value)
    {
        foreach ($this->values as $i => $v) {
            if ($value == $v) {
                unset($this->values[$i]);
                break;
            }
        }
        $this->stateChanged();
    }


    /**
     * Returns the number of items in the set
     *
     * @return int
     */
    public function count()
    {
        return count($this->values);
    }


    /**
     * Ensured uniqueness and sorted values
     *
     * @return void
     */
    private function stateChanged()
    {
        if (count($this->values)) {
            $this->values = array_unique(array_values($this->values));
            sort($this->values);
        }
    }
}