Knp\DictionaryBundle\Dictionary\Collection

Complexity

Total Complexity

10

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes	2
Bugs	0	Features	0

8 Methods

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

<?php

declare(strict_types=1);

namespace Knp\DictionaryBundle\Dictionary;

use ArrayAccess;
use IteratorAggregate;
use Knp\DictionaryBundle\Dictionary;
use Knp\DictionaryBundle\Exception\DictionaryNotFoundException;

/**
 * @implements ArrayAccess<string, Dictionary<mixed>>
 * @implements IteratorAggregate<string, Dictionary<mixed>>
 */
final class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
{
    /**
     * @var array<string, Dictionary<mixed>>

The doc comment array<string, Dictionary<mixed>> at position 4 could not be parsed: Expected '>' at position 4, but found 'Dictionary'.

     */
    private array $dictionaries = [];

    /**
     * @param Dictionary<mixed> ...$dictionaries
     */
    public function __construct(Dictionary ...$dictionaries)
    {
        foreach ($dictionaries as $dictionary) {
            $this->add($dictionary);
        }
    }

    /**
     * @param Dictionary<mixed> $dictionary
     */
    public function add(Dictionary $dictionary): void
    {
        $this->dictionaries[$dictionary->getName()] = $dictionary;
    }

    public function offsetExists($offset): bool
    {
        return \array_key_exists($offset, $this->dictionaries);
    }

    /**
     * @return Dictionary<mixed>
     *                           {@inheritdoc}
     *
     * @throws DictionaryNotFoundException
     */
    public function offsetGet($offset): Dictionary
    {
        if (!$this->offsetExists($offset)) {
            throw new DictionaryNotFoundException($offset, array_keys($this->dictionaries));
        }

        return $this->dictionaries[$offset];
    }

    public function offsetSet($offset, $value): void
    {
        throw new \RuntimeException(
            'To add a Dictionary to the Collection, use '.self::class.'::add(Dictionary $dictionary).'
        );
    }

    public function offsetUnset($offset): void
    {
        throw new \RuntimeException('It is not possible to remove a dictionary from the collection.');
    }

    public function getIterator(): \Traversable
    {
        return new \ArrayIterator($this->dictionaries);
    }

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