Collections\ArrayList

Complexity

Total Complexity

35

Size/Duplication

Total Lines	243
Duplicated Lines	10.7 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

65.79%

Importance

Changes	8
Bugs	1	Features	1

21 Methods

Rating	Name	Duplication	Size	Complexity
A	at()	0	7	1
A	set()	0	7	1
A	get()	0	6	1
A	tryGet()	0	8	2
A	add()	0	6	1
A	addAll()	13	13	3
A	setAll()	13	13	3
A	containsKey()	0	6	2
A	removeKey()	0	9	1
A	indexOf()	0	4	1
B	insert()	0	17	5
A	offsetExists()	0	6	2
A	offsetGet()	0	4	1
A	offsetSet()	0	8	2
A	offsetUnset()	0	5	1
A	toMap()	0	4	1
A	reverse()	0	4	1
A	splice()	0	4	1
A	fromArray()	0	13	3
A	getIterator()	0	4	1
A	concat()	0	8	1

<?php

// Copyright (c) Lellys Informática. All rights reserved. See License.txt in the project root for license information.
namespace Collections;

use Collections\Iterator\VectorIterator;
use Collections\Traits\GuardTrait;
use Collections\Traits\StrictIterableTrait;
use InvalidArgumentException;

/**
 * Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort,
 * and manipulate lists.
 */
class ArrayList extends AbstractConstCollectionArray implements VectorInterface, \ArrayAccess
{
    use StrictIterableTrait,
        GuardTrait;

    public function at($key)
    {
        $this->validateKeyType($key);
        $this->validateKeyBounds($key);

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

    public function set($key, $value)
    {
        $this->validateKeyType($key);
        $this->container[$key] = $value;

        return $this;
    }

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

        return $this->container[$index];
    }

    /**
     * {@inheritdoc}
     */
    public function tryGet($index, $default = null)
    {
        if ($this->containsKey($index) === false) {
            return $default;
        }

        return $this->get($index);
    }

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

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function addAll($items)

This method seems to be duplicated in your project.

    {
        $this->validateTraversable($items);

        foreach ($items as $item) {
            if (is_array($item)) {
                $item = new static($item);
            }
            $this->add($item);
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setAll($items)

This method seems to be duplicated in your project.

    {
        $this->validateTraversable($items);

        foreach ($items as $key => $item) {
            if (is_array($item)) {
                $item = new static($item);
            }
            $this->set($key, $item);
        }

        return $this;
    }


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

        return $key >= 0 && $key < $this->count();
    }


    /**
     * {@inheritdoc}
     */
    public function removeKey($key)
    {
        $this->validateKeyType($key);
        $this->validateKeyBounds($key);

        array_splice($this->container, $key, 1);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function indexOf($item)
    {
        return array_search($item, $this->container, true);
    }

    /**
     * {@inheritdoc}
     */
    public function insert($index, $item)
    {
        if (!is_numeric($index)) {
            throw new InvalidArgumentException('The index must be numeric');
        }
        if ($index < 0 || $index >= $this->count()) {
            throw new InvalidArgumentException('The index is out of bounds (must be >=0 and <= size of te array)');
        }

        $current = $this->count() - 1;
        for (; $current >= $index; $current--) {
            $this->container[$current + 1] = $this->container[$current];
        }
        $this->container[$index] = $item;

        return $this;
    }

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

        return $this->containsKey($offset) && $this->at($offset) !== null;
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function offsetUnset($offset)
    {
        throw new \RuntimeException(
            'Cannot unset an element of a ' . get_class($this));
    }

    /**
     * {@inheritdoc}
     */
    public function toMap()
    {
        return new Dictionary($this->getIterator());
    }

    /**
     * {@inheritdoc}
     */
    public function reverse()
    {
        return static::fromArray(array_reverse($this->container));
    }

    /**
     * {@inheritdoc}
     */
    public function splice($offset, $length = null)
    {
        return static::fromArray(array_splice($this->container, $offset, $length));
    }

    /**
     * {@inheritdoc}
     */
    public static function fromArray(array $arr)
    {
        $map = new ArrayList();
        foreach ($arr as $v) {
            if (is_array($v)) {
                $map->add(new ArrayList($v));
            } else {
                $map->add($v);
            }
        }

        return $map;

The return type of return $map; (Collections\ArrayList) is incompatible with the return type declared by the interface Collections\CollectionConvertableInterface::fromArray of type Collections\MapInterface.

    }

    /**
     * Gets the collection's iterator
     * @return VectorIterator
     */
    public function getIterator()
    {
        return new VectorIterator($this->container);
    }

    /**
     * {@inheritDoc}
     * @return $this
     */
    public function concat($iterable)
    {
        $this->validateTraversable($iterable);

        $this->setAll($this->concatRecurse($this, $iterable));

        return $this;
    }
}