RobotE13\DDD\Entities\Collection\CollectionTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Test Coverage

Coverage

50%

Importance

Changes	1
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	count()	0	3	1
A	exist()	0	3	1
A	get()	0	4	1
A	remove()	0	4	1
A	getItemName()	0	3	1
A	toArray()	0	3	1
A	getIterator()	0	3	1

<?php

/*
 * This file is part of the ddd-common.
 *
 * Copyright 2021 Evgenii Dudal <wolfstrace@gmail.com>.
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 * @package ddd-common
 */

namespace RobotE13\DDD\Entities\Collection;

use Webmozart\Assert\Assert;

/**
 *
 * @author Evgenii Dudal <wolfstrace@gmail.com>
 */
trait CollectionTrait
{

    protected static $collectionItemName = 'Item';
    private $items = [];

    public function exist($index): bool
    {
        return key_exists($index, $this->items);
    }

    /**
     *
     * @param mixed $key
     * @return mixed
     * @throws \InvalidArgumentException
     */
    public function get($key)
    {
        Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection");
        return clone $this->items[$key];
    }

    public function remove($key): void
    {
        Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection.");
        unset($this->items[$key]);
    }

    public function toArray()
    {
        return $this->items;
    }

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

    public function getIterator(): \Traversable
    {
        yield from $this->items;
    }

    public static function getItemName(): string
    {
        return 'Item';
    }

}