PhpValueObjects\Collection\ObjectCollection

Complexity

Total Complexity

26

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

93.1%

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	3
A	init()	0	4	1
	setClassName()	0	1	?
A	getCollection()	0	4	1
A	first()	0	4	1
A	last()	0	4	1
A	key()	0	4	1
A	next()	0	4	1
A	current()	0	4	1
A	remove()	0	11	3
A	removeElement()	0	12	2
A	contains()	0	4	1
A	get()	0	4	1
A	getKeys()	0	4	1
A	getValues()	0	4	1
A	count()	0	4	1
A	set()	0	4	1
A	add()	0	4	1
A	isEmpty()	0	4	1
A	clear()	0	4	1
A	applyReverse()	0	4	1
A	reverse()	0	4	1

<?php

declare(strict_types=1);

namespace PhpValueObjects\Collection;

use PhpValueObjects\Collection\Exception\InvalidCollectionObjectException;

abstract class ObjectCollection
{
    protected $objects;

    public function __construct(array $objects)
    {
        foreach ($objects as $object) {
            if (false === is_a($object, $this->setClassName())) {
                throw new InvalidCollectionObjectException($object, $this->setClassName());
            }
        }
        $this->objects = $objects;
    }

    public static function init(): self
    {
        return new static([]);
    }

    abstract protected function setClassName(): string;

    public function getCollection(): array
    {
        return $this->objects;
    }

    public function first()
    {
        return reset($this->objects);
    }

    public function last()
    {
        return end($this->objects);
    }

    public function key()
    {
        return key($this->getCollection());
    }

    public function next()
    {
        return next($this->objects);
    }

    public function current()
    {
        return current($this->objects);
    }

    public function remove($key)
    {
        if (!isset($this->objects[$key]) && !array_key_exists($key, $this->objects)) {
            return null;
        }

        $removed = $this->objects[$key];
        unset($this->objects[$key]);

        return $removed;
    }

    public function removeElement($element): bool
    {
        $key = array_search($element, $this->objects, true);

        if ($key === false) {
            return false;
        }

        unset($this->objects[$key]);

        return true;
    }

    public function contains($element): bool
    {
        return in_array($element, $this->objects, true);
    }

    public function get($key)
    {
        return $this->objects[$key] ?? null;
    }

    public function getKeys()
    {
        return array_keys($this->objects);
    }

    public function getValues()
    {
        return array_values($this->objects);
    }

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

    public function set($key, $value): void
    {
        $this->objects[$key] = $value;
    }

    public function add($element): void
    {
        $this->objects[] = $element;
    }

    public function isEmpty(): bool
    {
        return empty($this->objects);
    }

    public function clear(): void
    {
        $this->objects = [];
    }

    public function applyReverse()
    {
        $this->objects = array_reverse($this->getCollection());
    }

    public function reverse(): array
    {
        return array_reverse($this->objects);
    }
}