Atrapalo\PHPTools\Collection\UniqueEntityCollection

Complexity

Total Complexity

9

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	entityUniqueId()	0	1	?
A	add()	0	10	3
A	exist()	0	8	2
A	uniqueId()	0	9	2
A	customDuplicateEntityException()	0	4	1
A	customInvalidEntityIdException()	0	4	1

<?php

namespace Atrapalo\PHPTools\Collection;

/**
 * Class UniqueEntityCollection
 * @package Collection
 */
abstract class UniqueEntityCollection extends EntityCollection
{
    /**
     * @param $entity
     * @return string
     */
    abstract public function entityUniqueId($entity): string;

    /**
     * @param $entity
     * @throws \Exception
     */
    public function add($entity)
    {
        if (!$this->isValid($entity)) {
            throw self::customInvalidEntityException();
        } elseif ($this->exist($entity)) {
            throw self::customDuplicateEntityException();
        }

        $this->set($this->uniqueId($entity), $entity);
    }

    /**
     * @param $entity
     * @return bool
     */
    public function exist($entity): bool
    {
        if (in_array($this->uniqueId($entity), $this->keys())) {
            return true;
        }

        return false;
    }

    /**
     * @param $entity
     * @return string
     * @throws \Exception
     */
    private function uniqueId($entity): string
    {
        $uniqueId = $this->entityUniqueId($entity);
        if ($uniqueId === '') {
            throw static::customInvalidEntityIdException();
        }

        return $uniqueId;
    }

    /**
     * @return \Exception
     */
    public static function customDuplicateEntityException(): \Exception
    {
        return new \InvalidArgumentException("Entity already exists in collection");
    }


    /**
     * @return \Exception
     */
    public static function customInvalidEntityIdException(): \Exception
    {
        return new \InvalidArgumentException('Entity unique id can not be empty');
    }
}