kartavik\Collections\Collection

Complexity

Total Complexity

41

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetExists()	0	3	1
A	__construct()	0	9	3
A	jsonSerialize()	0	3	1
A	getIterator()	0	3	1
A	append()	0	6	2
A	offsetGet()	0	3	1
A	type()	0	3	1
A	offsetSet()	0	3	1
A	offsetUnset()	0	4	2
A	last()	0	5	1
A	validate()	0	6	2
A	chunk()	0	16	3
A	validateType()	0	4	2
B	isCompatible()	0	27	7
A	count()	0	3	1
A	__callStatic()	0	14	4
A	pop()	0	3	1
A	add()	0	4	1
A	sum()	0	9	2
A	first()	0	5	1
A	column()	0	19	3

<?php

namespace kartavik\Collections;

use kartavik\Collections\Exception;

/**
 * Class Collection
 * @package kartavik\Collections
 */
class Collection implements \ArrayAccess, \Countable, \IteratorAggregate, \JsonSerializable
{
    /** @var string */
    private $type = null;

    /** @var array */
    protected $container = [];

    public function __construct(string $type, iterable ...$iterables)
    {
        static::validateType($type);

        $this->type = $type;

        foreach ($iterables as $iterable) {
            foreach ($iterable as $index => $item) {
                $this->add($item, $index);
            }
        }
    }

    final public function type(): string
    {
        return $this->type;
    }

    public function offsetExists($offset): bool
    {
        return array_key_exists($offset, $this->container);
    }

    public function offsetGet($offset): object
    {
        return $this->container[$offset];
    }

    public function offsetUnset($offset): void
    {
        if ($this->offsetExists($offset)) {
            unset($this->container[$offset]);
        }
    }

    public function getIterator(): \ArrayIterator
    {
        return new \ArrayIterator($this->container);
    }

    public function append(): void
    {
        $items = func_get_args();

        foreach ($items as $item) {
            $this->add($item);
        }
    }

    /**
     * @param mixed $index
     * @param object $value
     *
     * @throws Exception\InvalidElement
     */
    public function offsetSet($index, $value): void
    {
        $this->add($value, $index);
    }

    public function jsonSerialize(): array
    {
        return $this->container;
    }

    public function isCompatible($var): bool
    {
        try {
            if ($var instanceof self) {
                return true;
            } elseif (is_array($var)) {
                foreach ($var as $item) {
                    try {
                        $this->validate($item);
                    } catch (Exception\InvalidElement $ex) {
                        return false;
                    }
                }

                return true;
            } else {
                try {
                    $this->validate($var);
                } catch (Exception\InvalidElement $ex) {
                    return false;
                }

                return true;
            }
        } catch (\InvalidArgumentException $exception) {

Consider adding a comment why this CATCH block is empty.

        } finally {
            return false;
        }
    }

    public function first(): object
    {
        reset($this->container);

        return current($this->container);
    }

    public function last(): object
    {
        end($this->container);

        return current($this->container);
    }

    public function validate(object $item): void
    {
        $type = $this->type();

        if (!$item instanceof $type) {
            throw new Exception\UnprocessedType($item, $type);

$type of type string is incompatible with the type integer expected by parameter $code of kartavik\Collections\Exception\UnprocessedType::__construct().

$item of type object is incompatible with the type null|string expected by parameter $type of kartavik\Collections\Exception\UnprocessedType::__construct().

        }
    }

    public function chunk(int $size): Collection
    {
        $mappedType = get_class($this->offsetGet(0));
        /** @var Collection $collection */
        $collection = Collection::{Collection::class}();
        $chunked = array_chunk($this->jsonSerialize(), $size);

        foreach ($chunked as $index => $chunk) {
            $collection->append(Collection::{$mappedType}());

            foreach ($chunk as $item) {
                $collection[$index]->append($item);
            }
        }

        return $collection;
    }

    public function column(string $property, \Closure $callback = null): Collection
    {
        $getterType = get_class($this->offsetGet(0)->$property);

        if (!is_null($callback)) {
            /** @var Collection $collection */
            $collection = Collection::{$getterType}();

            foreach ($this->jsonSerialize() as $item) {
                $collection->append(call_user_func($callback, $item->$property));
            }

            return $collection;
        } else {
            return Collection::{$getterType}(array_map(
                function ($item) use ($property) {
                    return $item->$property;
                },
                $this->jsonSerialize()
            ));
        }
    }

    /**
     * @return object
     */
    public function pop()
    {
        return array_pop($this->container);
    }

    public function sum(callable $callback)
    {
        $sum = 0;

        foreach ($this as $element) {
            $sum += call_user_func($callback, $element);
        }

        return $sum;
    }

    /**
     * @param string $name
     * @param array  $arguments
     *
     * @return Collection
     */
    public static function __callStatic(string $name, array $arguments = [])
    {
        if (!empty($arguments) && is_array($arguments[0])) {
            $arguments = $arguments[0];
        }

        static::validateType($name);

        reset($arguments);

        if (current($arguments) instanceof Collection) {
            return new static($name, ...$arguments);
        } else {
            return new static($name, $arguments);
        }
    }

    public function count(): int
    {
        return count($this->container);
    }

    public function add(object $item, $index = null): void
    {
        $this->validate($item);
        $this->container[$index ?? $this->count()] = $item;
    }

    protected static function validateType(string $type): void
    {
        if (!class_exists($type)) {
            throw new Exception\UnprocessedType($type);
        }
    }
}