Scriptotek\Alma\Model\SimplePagedLazyResourceList

Complexity

Total Complexity

12

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	findKey()	0	9	3
B	fetchBatch()	0	25	6
A	isInitialized()	0	4	1
A	count()	0	8	2

<?php

namespace Scriptotek\Alma\Model;

use Scriptotek\Alma\Exception\ClientException;

/**
 * A SimplePagedLazyResourceList is a list that is paged using the `offset`
 * and `limit` parameters and that provides a `totalRecordCount` in the first response,
 * so that we can return a count without having to retrieve all the pages.
 * A list which is not of this type is the Analytics report row list.
 */
abstract class SimplePagedLazyResourceList extends PagedLazyResourceList
{
    /* @var integer */
    protected $offset = 0;

    /* @var integer */
    protected $limit = 10;

    /* @var integer */
    protected $totalRecordCount = null;

    protected function findKey($data)
    {
        foreach (array_keys((array) $data) as $key) {
            if ($key != 'total_record_count') {
                return $key;
            }
        }
        throw new ClientException('No resource key found in response object');
    }

    protected function fetchBatch()
    {
        if (!is_null($this->totalRecordCount) && $this->offset >= $this->totalRecordCount) {
            return;
        }

        $response = $this->client->getJSON($this->url('', [
            'offset' => $this->offset,
            'limit' => $this->limit,
        ]));

        if (is_null($this->totalRecordCount)) {
            $this->totalRecordCount = $response->total_record_count;
        }

        if ($this->totalRecordCount === 0) {
            return;
        }

        $key = $this->findKey($response);
        foreach ($response->{$key} as $res) {
            $this->resources[] = $this->convertToResource($res);
        }
        $this->offset = count($this->resources);
    }

    /**
     * Check if we have the full representation of our data object.
     *
     * @param \stdClass $data
     * @return boolean
     */
    protected function isInitialized($data)
    {
        return count($data) === $this->totalRecordCount;
    }

    /**
     * Total number of resources.
     * @link http://php.net/manual/en/countable.count.php
     * @return int
     */
    public function count()
    {
        if (is_null($this->totalRecordCount)) {
            $this->fetchBatch();
        }

        return $this->totalRecordCount;
    }
}