Cubiche\Core\Collections\ArrayCollection

Complexity

Total Complexity

37

Size/Duplication

Total Lines	256
Duplicated Lines	7.81 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	4
Bugs	1	Features	1

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	add()	0	4	1
A	addAll()	0	6	2
A	remove()	0	9	3
A	removeAt()	0	6	2
A	clear()	0	4	1
A	contains()	0	4	1
A	containsKey()	0	6	2
A	get()	0	6	2
A	set()	0	6	1
A	count()	0	4	1
A	getIterator()	0	4	1
A	slice()	0	4	1
A	find()	0	4	1
A	findOne()	0	4	1
A	toArray()	0	4	1
A	sort()	10	10	2
A	sortByKey()	10	10	2
A	sorted()	0	4	1
A	keys()	0	4	1
A	values()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	8	2
A	offsetUnset()	0	4	1
A	validateKey()	0	8	3

<?php

/**
 * This file is part of the Cubiche package.
 *
 * Copyright (c) Cubiche
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Cubiche\Core\Collections;

use Cubiche\Core\Comparable\Comparator;
use Cubiche\Core\Comparable\ComparatorInterface;
use Cubiche\Core\Specification\Criteria;
use Cubiche\Core\Specification\SpecificationInterface;
use Cubiche\Core\Collections\DataSource\ArrayDataSource;
use Cubiche\Core\Collections\Exception\InvalidKeyException;

/**
 * Array Collection Class.
 *
 * @author Karel Osorio Ramírez <osorioramirez@gmail.com>
 * @author Ivannis Suárez Jerez <ivannis.suarez@gmail.com>
 */
class ArrayCollection implements ArrayCollectionInterface
{
    /**
     * @var array
     */
    protected $items;

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

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

    /**
     * {@inheritdoc}
     */
    public function addAll($items)
    {
        foreach ($items as $item) {
            $this->add($item);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function remove($item)
    {
        $criteria = Criteria::eq($item);
        foreach ($this->items as $key => $value) {
            if ($criteria->evaluate($value)) {
                unset($this->items[$key]);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeAt($key)
    {
        if ($this->containsKey($key)) {
            unset($this->items[$key]);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        $this->items = array();
    }

    /**
     * {@inheritdoc}
     */
    public function contains($item)
    {
        return \in_array($item, $this->items, true);
    }

    /**
     * {@inheritdoc}
     */
    public function containsKey($key)
    {
        $this->validateKey($key);

        return isset($this->items[$key]) || \array_key_exists($key, $this->items);
    }

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

        return isset($this->items[$key]) ? $this->items[$key] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value)
    {
        $this->validateKey($key);

        $this->items[$key] = $value;
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return \count($this->items);
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->items);
    }

    /**
     * {@inheritdoc}
     */
    public function slice($offset, $length = null)
    {
        return new self(\array_slice($this->items, $offset, $length, true));
    }

    /**
     * {@inheritdoc}
     */
    public function find(SpecificationInterface $criteria)
    {
        return new DataSourceCollection(new ArrayDataSource($this->items, $criteria));
    }

    /**
     * {@inheritdoc}
     */
    public function findOne(SpecificationInterface $criteria)
    {
        return (new ArrayDataSource($this->items, $criteria))->findOne();
    }

    /**
     * {@inheritdoc}
     */
    public function toArray()
    {
        return $this->items;
    }

    /**
     * {@inheritdoc}
     */
    public function sort(ComparatorInterface $criteria = null)

This method seems to be duplicated in your project.

    {
        if ($criteria === null) {
            $criteria = new Comparator();
        }

        uasort($this->items, function ($a, $b) use ($criteria) {
            return $criteria->compare($a, $b);
        });
    }

    /**
     * {@inheritdoc}
     */
    public function sortByKey(ComparatorInterface $criteria = null)

This method seems to be duplicated in your project.

    {
        if ($criteria === null) {
            $criteria = new Comparator();
        }

        uksort($this->items, function ($a, $b) use ($criteria) {
            return $criteria->compare($a, $b);
        });
    }

    /**
     * {@inheritdoc}
     */
    public function sorted(ComparatorInterface $criteria)
    {
        return new DataSourceCollection(new ArrayDataSource($this->items, null, $criteria));
    }

    /**
     * {@inheritdoc}
     */
    public function keys()
    {
        return new self(\array_keys($this->items));
    }

    /**
     * {@inheritdoc}
     */
    public function values()
    {
        return new self(\array_values($this->items));
    }

    /**
     * {@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 (!isset($offset)) {
            return $this->add($value);
        }

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

    /**
     * {@inheritdoc}
     */
    public function offsetUnset($offset)
    {
        unset($this->items[$offset]);
    }

    /**
     * Validates that a key is valid.
     *
     * @param int|string $key
     *
     * @return bool
     *
     * @throws InvalidKeyException If the key is invalid.
     */
    protected function validateKey($key)
    {
        if (!is_string($key) && !is_int($key)) {
            throw InvalidKeyException::forKey($key);
        }

        return true;
    }
}