Polidog\Chatwork\Entity\Collection\AbstractCollection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	5	1
A	get()	0	7	2
A	getIterator()	0	4	2
A	__construct()	0	3	1
A	count()	0	3	1

<?php

declare(strict_types=1);

namespace Polidog\Chatwork\Entity\Collection;

use Polidog\Chatwork\Entity\EntityInterface;
use Polidog\Chatwork\Exception\OutOfBoundsException;

abstract class AbstractCollection implements \IteratorAggregate, \Countable, CollectionInterface
{
    protected $entities = [];

    /**
     * @param array $entities
     */
    public function __construct(array $entities = [])
    {
        $this->entities = $entities;
    }

    /**
     * {@inheritdoc}
     */
    public function add(EntityInterface $entity)
    {
        $this->entities[] = $entity;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function get($idx)
    {
        if (!array_key_exists($idx, $this->entities)) {
            throw new OutOfBoundsException('index not found, index:'.$idx);
        }

        return $this->entities[$idx];
    }

    /**
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        foreach ($this->entities as $key => $entity) {
            yield $key => $entity;

The expression yield $key => $entity returns the type Generator which is incompatible with the documented return type ArrayIterator.

        }
    }

    public function count()
    {
        return count($this->entities);
    }
}