AlecRabbit\Spinner\Core\FrameCollection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	lastIndex()	0	6	1
A	__construct()	0	4	1
A	assertFrame()	0	8	2
A	get()	0	3	1
A	initialize()	0	6	2

<?php

declare(strict_types=1);
// 20.03.23
namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Spinner\Contract\IFrame;
use AlecRabbit\Spinner\Contract\IFrameCollection;
use AlecRabbit\Spinner\Exception\DomainException;
use AlecRabbit\Spinner\Exception\InvalidArgumentException;
use ArrayObject;
use Traversable;

/**
 * @template T of IFrame
 * @extends ArrayObject<int,T>
 * @implements IFrameCollection<T>
 */
final class FrameCollection extends ArrayObject implements IFrameCollection
{
    /**
     * @throws InvalidArgumentException
     */
    public function __construct(Traversable $frames)
    {
        parent::__construct();
        $this->initialize($frames);
    }

    /**
     * @throws InvalidArgumentException
     */
    private function initialize(Traversable $frames): void
    {
        /** @var T $frame */
        foreach ($frames as $frame) {
            self::assertFrame($frame);
            $this->append($frame);
        }
    }

    /**
     * @throws InvalidArgumentException
     */
    private static function assertFrame(mixed $frame): void
    {
        if (!$frame instanceof IFrame) {
            throw new InvalidArgumentException(
                sprintf(
                    'Frame must be instance of %s. %s given.', // TODO: clarify message
                    IFrame::class,
                    get_debug_type($frame)
                )
            );
        }
    }

    /** @inheritdoc */
    public function lastIndex(): int
    {
        return

The expression return array_key_last($this->getArrayCopy()) ?? ThrowNode could return the type string which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

            array_key_last($this->getArrayCopy())
            ??
            throw new DomainException('Empty collection.');
    }

    public function get(int $index): IFrame
    {
        return $this->offsetGet($index);
    }
}