lamoda / php-metrics

src/Common/Source/IterableMetricSource.php

<?php

namespace Lamoda\Metric\Common\Source;

use Lamoda\Metric\Common\MetricInterface;
use Lamoda\Metric\Common\MetricSourceInterface;

final class IterableMetricSource implements \IteratorAggregate, MetricSourceInterface
{
    /** @var MetricInterface[]|\Traversable|iterable */
    private $metrics;

    /**
     * @param iterable|MetricInterface[] $metrics
     */
    public function __construct(iterable $metrics)
    {
        if (\is_array($metrics)) {
            $metrics = new \ArrayIterator($metrics);
        }

        $this->metrics = $metrics;
    }

    /** {@inheritdoc} */
    public function getMetrics(): \Traversable
    {
        return $this->metrics;

The expression return $this->metrics could return the type Lamoda\Metric\Common\MetricInterface[]|iterable which is incompatible with the type-hinted return Traversable. Consider adding an additional type-check to rule them out.

    }

    /** {@inheritdoc} */
    public function getIterator(): \Traversable
    {
        return $this->getMetrics();
    }
}