Scriptotek\Sru\Records

Complexity

Total Complexity

15

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	numberOfRecords()	0	4	1
A	fetchMore()	0	13	3
A	current()	0	4	1
A	key()	0	4	1
A	rewind()	0	8	2
A	next()	0	19	5
A	valid()	0	4	1

<?php namespace Scriptotek\Sru;

/**
 * When iterating, methods are called in the following order:
 *
 * rewind()
 * valid()
 * current()
 *
 * next()
 * valid()
 * current()
 *
 * ...
 *
 * next()
 * valid()
 */
class Records implements \Iterator
{
    private $position;
    private $count;
    private $extraParams;
    private $cql;
    private $client;
    private $lastResponse;

    private $data = array();

    /**
     * Create a new records iterator
     *
     * @param string $cql Query
     * @param Client $client SRU client reference (optional)
     * @param int $count Number of records to request per request
     * @param array $extraParams Extra GET parameters
     */
    public function __construct($cql, Client $client, $count = 10, $extraParams = array())
    {
        $this->position = 1;
        $this->count = $count; // number of records per request
        $this->extraParams = $extraParams;
        $this->cql = $cql;
        $this->client = $client;
        $this->fetchMore();
    }

    /**
     * Return the number of records
     *
     * @return int
     */
    public function numberOfRecords()
    {
        return $this->lastResponse->numberOfRecords;
    }

    /**
     * Fetch more records from the service
     */
    private function fetchMore()
    {
        $url = $this->client->urlTo($this->cql, $this->position, $this->count, $this->extraParams);
        $body = $this->client->request('GET', $url);
        $this->lastResponse = new SearchRetrieveResponse($body);
        $this->data = $this->lastResponse->records;

        if (count($this->data) != 0 && $this->data[0]->position != $this->position) {
            throw new Exceptions\InvalidResponseException('Wrong index of first record in result set. '
                . 'Expected: ' .$this->position . ', got: ' . $this->data[0]->position
            );
        }
    }

    /**
     * Return the current element
     *
     * @return Record
     */
    public function current()
    {
        return $this->data[0];
    }

    /**
     * Return the key of the current element
     *
     * @return int
     */
    public function key()
    {
        return $this->position;
    }

    /**
     * Rewind the Iterator to the first element
     */
    public function rewind()
    {
        if ($this->position != 1) {
            $this->position = 1;
            $this->data = array();
            $this->fetchMore();
        }
    }

    /**
     * Move forward to next element
     */
    public function next()
    {
        if (count($this->data) > 0) {
            array_shift($this->data);
        }
        ++$this->position;

        if ($this->position > $this->numberOfRecords()) {
            return;
        }

        if (count($this->data) == 0) {
            $this->fetchMore();
        }

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

    /**
     * Check if current position is valid
     *
     * @return bool
     */
    public function valid()
    {
        return count($this->data) != 0;
    }
}