Doctrine\Annotations\Metadata\MetadataCollection

Complexity

Total Complexity

10

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

89.29%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetSet()	0	5	1
A	add()	0	6	2
A	__construct()	0	3	1
A	offsetUnset()	0	5	1
A	getIterator()	0	3	1
A	offsetExists()	0	3	1
A	offsetGet()	0	5	1
A	include()	0	3	1
A	count()	0	3	1

<?php

declare(strict_types=1);

namespace Doctrine\Annotations\Metadata;

use ArrayAccess;
use Countable;
use IteratorAggregate;
use Traversable;
use function array_key_exists;
use function array_values;
use function assert;
use function count;
use function sprintf;

/**
 * @internal
 */
final class MetadataCollection implements ArrayAccess, Countable, IteratorAggregate
{
    /** @var array<string, AnnotationMetadata> */
    private $metadata = [];

    public function __construct(AnnotationMetadata ...$metadatas)
    {
        $this->add(...$metadatas);
    }

    public function add(AnnotationMetadata ...$metadatas) : void
    {
        foreach ($metadatas as $metadata) {
            assert(! isset($this[$metadata->getName()]), sprintf('Metadata with name %s already exists.', $metadata->getName()));

            $this->metadata[$metadata->getName()] = $metadata;
        }
    }

    public function include(self $other) : void
    {
        $this->add(...$other);
    }

    /**
     * @param string $name
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
     */
    public function offsetGet($name) : AnnotationMetadata
    {
        assert(isset($this[$name]), sprintf('Metadata for name %s does not exist', $name));

        return $this->metadata[$name];
    }

    /**
     * @param null               $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param AnnotationMetadata $metadata
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
     */
    public function offsetSet($name, $metadata) : void
    {
        assert($name === null, 'Setting named metadata is not supported.');

        $this->add($metadata);
    }

    /**
     * @param string $name
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
     */
    public function offsetExists($name) : bool
    {
        return array_key_exists($name, $this->metadata);
    }

    /**
     * @param string $name
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
     */
    public function offsetUnset($name) : void
    {
        assert(isset($this[$name]));

        unset($this->metadata[$name]);
    }

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

    /**
     * @return Traversable<AnnotationMetadata>
     */
    public function getIterator() : Traversable
    {
        yield from array_values($this->metadata);
    }
}