Sunrise\Hydrator\ObjectCollection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getItemClassName()	0	10	2
A	all()	0	3	1
A	add()	0	13	2
A	get()	0	3	1
A	isEmpty()	0	3	1

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <anatoly@fenric.ru>
 * @copyright Copyright (c) 2021, Anatoly Fenric
 * @license https://github.com/sunrise-php/hydrator/blob/master/LICENSE
 * @link https://github.com/sunrise-php/hydrator
 */

namespace Sunrise\Hydrator;

/**
 * Import classes
 */
use InvalidArgumentException;
use RuntimeException;

/**
 * Import functions
 */
use function sprintf;

/**
 * ObjectCollection
 */
abstract class ObjectCollection implements ObjectCollectionInterface
{

    /**
     * The type of objects in the collection
     *
     * @var class-string
     */
    public const T = null;

    /**
     * The collection objects
     *
     * @var array<array-key, object>

The doc comment array<array-key, object> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, object>.

     */
    private $objects = [];

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     *         If the called class doesn't contain the T constant.
     */
    final public function getItemClassName() : string
    {
        if (null === static::T) {

The condition null === static::T is always true.

            throw new RuntimeException(sprintf(
                'The %s collection must contain the T constant.',
                static::class
            ));
        }

        return static::T;
    }

    /**
     * {@inheritdoc}
     */
    final public function add($key, object $object) : void
    {
        $type = $this->getItemClassName();

        if (!($object instanceof $type)) {
            throw new InvalidArgumentException(sprintf(
                'The %s collection can contain the %s objects only.',
                static::class,
                $type
            ));
        }

        $this->objects[$key] = $object;
    }

    /**
     * {@inheritdoc}
     */
    final public function get($key) : ?object
    {
        return $this->objects[$key] ?? null;
    }

    /**
     * {@inheritdoc}
     */
    final public function all() : array
    {
        return $this->objects;
    }

    /**
     * {@inheritdoc}
     */
    final public function isEmpty() : bool
    {
        return [] === $this->objects;
    }
}