Add numberOfRecords() to Records, and make sure it's available from start

Author: danmichaelo

README.md

@@ -30,7 +30,7 @@ and run `composer install` to get the latest version of the package.
 
 ```php
 require_once('vendor/autoload.php');
-use Scriptotek\SruClient;
+use Scriptotek\Sru\Client as SruClient;
 
 $url = 'http://sru.bibsys.no/search/biblioholdings';
 
@@ -40,11 +40,10 @@ $client = new SruClient($url, array(
     'user-agent' => 'OpenKat/0.1'
 ));
 
-$records = array();
-$response = $client->search('dc.title="Hello world"');
-while ($response && count($response->records) != 0) {
-	$records[] = array_merge($records, $response->records);
-	$response = $response->next();
+$records = $client->records('dc.title="Hello world"');
+foreach ($records as $record) {
+	echo "Got record " . $record->position . " of " . $records->numberOfRecords() . "\n";
+	// processRecord($record->data);
 }
 ```
 

src/Records.php

@@ -36,26 +36,36 @@ class Records implements \Iterator {
      *
      * @param string $cql Query
      * @param Client $client SRU client reference (optional)
-     * @param mixed $httpClient A http client
      * @param int $count Number of records to request per request
+     * @param mixed $httpClient A http client
      */
-	public function __construct($cql, Client $client, $httpClient = null, $count = 10) {
+	public function __construct($cql, Client $client, $count = 10, $httpClient = null) {
 		$this->position = 1;
 		$this->count = $count; // number of records per request
 		$this->cql = $cql;
 		$this->httpClient = $httpClient ?: new HttpClient;
 		$this->client = $client;
+		$this->fetchMore();
 	}
 
 	/**
      * Return error message from last reponse, if any
+     *
+     * @return string|null
      */
 	public function getError()
 	{
-		if (isset($this->lastResponse)) {
-			return $this->lastResponse->error;
-		}
-		return null;
+		return $this->lastResponse->error;
+	}
+
+	/**
+     * Return the number of records
+     *
+     * @return int|null
+     */
+	public function numberOfRecords()
+	{
+		return $this->lastResponse->numberOfRecords;
 	}
 
 	/**
@@ -78,14 +88,6 @@ private function fetchMore()
 		}
 	}
 
-	/**
-     * Rewind the Iterator to the first element
-     */
-	function rewind() {
-		$this->position = 1;
-		$this->fetchMore();
-	}
-
 	/**
      * Return the current element
      *
@@ -104,6 +106,17 @@ function key() {
 		return $this->position;
 	}
 
+	/**
+     * Rewind the Iterator to the first element
+     */
+	function rewind() {
+		if ($this->position != 1) {
+			$this->position = 1;
+			$this->data = array();
+			$this->fetchMore();
+		}
+	}
+
 	/**
      * Move forward to next element
      */
@@ -114,7 +127,7 @@ function next() {
 		}
 		++$this->position;
 
-		if (isset($this->lastResponse) && $this->position > $this->lastResponse->numberOfRecords) {
+		if ($this->position > $this->numberOfRecords()) {
 			return null;
 		}
 

tests/RecordsTest.php

@@ -14,8 +14,9 @@ public function testIterating()
         $http = $this->httpMockSingleResponse($response);
 
 		$client = new Client($uri);
-		$records = new Records($cql, $client, $http);
+		$records = new Records($cql, $client, 10, $http);
 		$this->assertNull($records->getError());
+		$this->assertEquals(8, $records->numberOfRecords());
 		$records->rewind();
 		$this->assertNull($records->getError());
 
@@ -41,16 +42,21 @@ public function testIterating()
 	 */
 	public function testRepeatSameResponse()
 	{
-		$response = $this->makeDummyResponse(1);
+		// Result set contains two records
+		$response = $this->makeDummyResponse(2, array('maxRecords' => 1));
 
         $http = $this->httpMockSingleResponse($response);
         $uri = 'http://localhost';
         $cql = 'dummy';
 
+		// Request only one record in each request
 		$client = new Client($uri);
-		$rec = new Records($cql, $client, $http);
-		$rec->next();
-		$rec->next();
+		$rec = new Records($cql, $client, 1, $http);
+
+		// Jumping to position 2 should call fetchMore() and throw 
+		// an InvalidResponseException on getting the same response
+		// as we got for position 1
+		$rec->next(); 
 	}
 
 
@@ -69,7 +75,7 @@ public function testMultipleRequests()
         $cql = 'dummy';
 
 		$client = new Client($uri);
-		$records = new Records($cql, $client, $http);
+		$records = new Records($cql, $client, 10, $http);
 
 		$records->rewind();
 		foreach (range(1, $nrecs) as $n) {