Oqq\Minc\Common\Collection\AbstractCollection

Complexity

Total Complexity

22

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	containsKey()	0	4	2
A	get()	0	6	1
A	set()	0	4	1
A	removeKey()	0	4	1
A	contains()	0	4	1
A	remove()	0	6	2
A	add()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	8	2
A	offsetUnset()	0	4	1
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	rewind()	0	4	1
A	assertContainsKey()	0	6	2

<?php

namespace Oqq\Minc\Common\Collection;

use Oqq\Minc\Common\Collection\Exception\KeyIsNotDefinedException;
use Oqq\Minc\Common\Exception\OutOfBoundsException;

/**
 * @author Eric Braun <eb@oqq.be>
 */
abstract class AbstractCollection implements \ArrayAccess, \Iterator, CollectionInterface
{
    /** @var array */
    protected $values;

    /**
     * @param array $values
     */
    public function __construct(array $values = [])
    {
        $this->values = $values;
    }

    /**
     * @inheritdoc
     */
    public function containsKey($key)
    {
        return isset($this->values[$key]) || array_key_exists($key, $this->values);
    }

    /**
     * @inheritdoc
     */
    public function get($key)
    {
        $this->assertContainsKey($key);

        return $this->values[$key];
    }

    /**
     * @inheritdoc
     */
    public function set($key, $value)
    {
        $this->values[$key] = $value;
    }

    /**
     * @inheritdoc
     */
    public function removeKey($key)
    {
        unset($this->values[$key]);
    }

    /**
     * @inheritdoc
     */
    public function contains($value)
    {
        return false !== array_search($value, $this->values, true);
    }

    /**
     * @inheritdoc
     */
    public function remove($value)
    {
        foreach (array_keys($this->values, $value, true) as $key) {
            unset($this->values[$key]);
        }
    }

    /**
     * @inheritdoc
     */
    public function add($value)
    {
        $this->values[] = $value;
    }

    /**
     * @inheritdoc
     */
    public function offsetExists($offset)
    {
        return $this->containsKey($offset);
    }

    /**
     * @inheritdoc
     */
    public function offsetGet($offset)
    {
        return $this->get($offset);
    }

    /**
     * @inheritdoc
     */
    public function offsetSet($offset, $value)
    {
        if (null === $offset) {
            $this->add($value);
        }

        $this->set($offset, $value);
    }

    /**
     * @inheritdoc
     */
    public function offsetUnset($offset)
    {
        $this->removeKey($offset);
    }

    /**
     * @inheritDoc
     */
    public function current()
    {
        return current($this->values);
    }

    /**
     * @inheritDoc
     */
    public function next()
    {
        next($this->values);
    }

    /**
     * @inheritDoc
     */
    public function key()
    {
        return key($this->values);
    }

    /**
     * @inheritDoc
     */
    public function valid()
    {
        return null !== $this->key();
    }

    /**
     * @inheritDoc
     */
    public function rewind()
    {
        reset($this->values);
    }

    /**
     * @param mixed $key
     *
     * @throws OutOfBoundsException
     */
    protected function assertContainsKey($key)
    {
        if (!$this->containsKey($key)) {
            throw new KeyIsNotDefinedException($key);
        }
    }
}