Linode\EntityCollection

Complexity

Total Complexity

13

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	rewind()	0	3	1
A	valid()	0	3	2
A	current()	0	5	1
A	key()	0	3	1
A	loadPage()	0	16	3
A	count()	0	3	1
A	next()	0	6	3
A	__construct()	0	12	1

<?php

// ---------------------------------------------------------------------
//
//  Copyright (C) 2018-2024 Artem Rodygin
//
//  You should have received a copy of the MIT License along with
//  this file. If not, see <https://opensource.org/licenses/MIT>.
//
// ---------------------------------------------------------------------

namespace Linode;

use Psr\Http\Message\ResponseInterface;

/**
 * A collection of Linode entities.
 */
final class EntityCollection implements \Countable, \Iterator
{
    /** @var callable */
    private $apiHandler;

    /** @var callable */
    private $entityFactory;

    /** @var int Current page (one-based index). */
    private int $currentPage;

    /** @var int Current entity (zero-based index). */
    private int $currentEntity;

    /** @var int Total number of entities. */
    private int $totalEntities;

    /** @var int Number of loaded entities. */
    private int $loadedEntities;

    /** @var null|\SplFixedArray Entities (JSON objects). */
    private ?\SplFixedArray $entitiesData;

    /**
     * @param callable $apiHandler    Function to make an API call.
     * @param callable $entityFactory Function to create entities using JSON (@see AbstractRepository::jsonToEntity).
     */
    public function __construct(callable $apiHandler, callable $entityFactory)
    {
        $this->apiHandler    = $apiHandler;
        $this->entityFactory = $entityFactory;

        $this->currentPage    = 0;
        $this->currentEntity  = 0;
        $this->totalEntities  = 0;
        $this->loadedEntities = 0;
        $this->entitiesData   = null;

        $this->loadPage();
    }

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

    public function key(): int
    {
        return $this->currentEntity;
    }

    public function current(): mixed
    {
        $json = $this->entitiesData[$this->currentEntity];

        return ($this->entityFactory)($json);
    }

    public function valid(): bool
    {
        return $this->currentEntity >= 0 && $this->currentEntity < $this->totalEntities;
    }

    public function next(): void
    {
        $this->currentEntity++;

        if ($this->currentEntity >= $this->loadedEntities && $this->loadedEntities < $this->totalEntities) {
            $this->loadPage();
        }
    }

    public function rewind(): void
    {
        $this->currentEntity = 0;
    }

    /**
     * Loads next page of data.
     */
    private function loadPage(): void
    {
        /** @var ResponseInterface $response */
        $response = ($this->apiHandler)(++$this->currentPage);
        $contents = $response->getBody()->getContents();
        $json     = json_decode($contents, true);

        // Whether we are loading for the first time.
        if (null === $this->entitiesData) {
            $this->totalEntities = $json['results'] ?? 0;

            $this->entitiesData = new \SplFixedArray($this->totalEntities);
        }

        foreach ($json['data'] ?? [] as $entry) {
            $this->entitiesData[$this->loadedEntities++] = $entry;
        }
    }
}