Add option to configure extra GET parameters

Author: danmichaelo

src/Client.php

@@ -77,7 +77,7 @@ public function __construct($url, $options = null, $httpClient = null)
      * @param int $count Number of records to request (optional)
      * @return string
      */
-    public function urlTo($cql, $start = 1, $count = 10)
+    public function urlTo($cql, $start = 1, $count = 10, $extraParams = array())
     {
         $qs = array(
             'operation' => 'searchRetrieve',
@@ -93,6 +93,10 @@ public function urlTo($cql, $start = 1, $count = 10)
             $qs['startRecord'] = $start;
         }
 
+        foreach ($extraParams as $key => $value) {
+            $qs[$key] = $value;
+        }
+
         return $this->url . '?' . http_build_query($qs);
     }
 
@@ -129,9 +133,9 @@ public function getHttpOptions()
      * @param int $count Number of records to request (optional)
      * @return SearchRetrieveResponse
      */
-    public function search($cql, $start = 1, $count = 10) {
+    public function search($cql, $start = 1, $count = 10, $extraParams = array()) {
 
-        $url = $this->urlTo($cql, $start, $count);
+        $url = $this->urlTo($cql, $start, $count, $extraParams);
         $options = $this->getHttpOptions();
 
         $res = $this->httpClient->get($url, $options)->send();
@@ -148,9 +152,9 @@ public function search($cql, $start = 1, $count = 10) {
      * @param mixed $httpClient A http client
      * @return Records
      */
-    public function records($cql, $count = 10, $httpClient = null)
+    public function records($cql, $count = 10, $extraParams = array(), $httpClient = null)
     {
-        return new Records($cql, $this, $count, $httpClient);
+        return new Records($cql, $this, $count, $extraParams, $httpClient);
     }
 
     /**

src/Records.php

@@ -25,6 +25,7 @@ class Records implements \Iterator {
 
 	private $position;
 	private $count;
+	private $extraParams;
 	private $cql;
 	private $client;
 	private $lastResponse;
@@ -39,9 +40,10 @@ class Records implements \Iterator {
      * @param int $count Number of records to request per request
      * @param mixed $httpClient A http client
      */
-	public function __construct($cql, Client $client, $count = 10, $httpClient = null) {
+	public function __construct($cql, Client $client, $count = 10, $extraParams = array(), $httpClient = null) {
 		$this->position = 1;
 		$this->count = $count; // number of records per request
+		$this->extraParams = $extraParams;
 		$this->cql = $cql;
 		$this->httpClient = $httpClient ?: new HttpClient;
 		$this->client = $client;
@@ -74,7 +76,7 @@ public function numberOfRecords()
      */
 	private function fetchMore()
 	{
-		$url = $this->client->urlTo($this->cql, $this->position, $this->count);
+		$url = $this->client->urlTo($this->cql, $this->position, $this->count, $this->extraParams);
 		$options = $this->client->getHttpOptions();
 
 		$res = $this->httpClient->get($url, $options)->send();

tests/ClientTest.php

@@ -20,6 +20,7 @@ public function testUrlTo()
         $sru1 = new Client($this->url);
         $expectedUrl1 = $this->url . '?operation=searchRetrieve&version=1.1&recordSchema=marcxml&maximumRecords=10&query=isbn%3D123';
         $expectedUrl2 = $this->url . '?operation=searchRetrieve&version=1.1&recordSchema=marcxml&maximumRecords=50&query=isbn%3D123&startRecord=2';
+        $expectedUrl5 = $this->url . '?operation=searchRetrieve&version=1.1&recordSchema=marcxml&maximumRecords=10&query=isbn%3D123&httpAccept=application%2Fxml';
 
         $sru3 = new Client($this->url, array('schema' => 'CUSTOMSCHEMA'));
         $expectedUrl3 = $this->url . '?operation=searchRetrieve&version=1.1&recordSchema=CUSTOMSCHEMA&maximumRecords=10&query=isbn%3D123';
@@ -31,6 +32,7 @@ public function testUrlTo()
         $this->assertEquals($expectedUrl2, $sru1->urlTo('isbn=123', 2, 50));
         $this->assertEquals($expectedUrl3, $sru3->urlTo('isbn=123'));
         $this->assertEquals($expectedUrl4, $sru4->urlTo('isbn=123'));
+        $this->assertEquals($expectedUrl5, $sru1->urlTo('isbn=123', 1, 10, array('httpAccept' => 'application/xml')));
     }
 
     public function testSearch()
@@ -181,7 +183,7 @@ public function testRecords()
         $http = $this->httpMockSingleResponse($this->makeDummyResponse(1));
 
         $sru1 = new Client($this->url);
-        $r = $sru1->records('test', 1, $http);
+        $r = $sru1->records('test', 1, array(), $http);
 
         $this->assertInstanceOf('Scriptotek\Sru\Records', $r);
     }

tests/RecordsTest.php

@@ -14,7 +14,7 @@ public function testIterating()
         $http = $this->httpMockSingleResponse($response);
 
 		$client = new Client($uri);
-		$records = new Records($cql, $client, 10, $http);
+		$records = new Records($cql, $client, 10, array(), $http);
 		$this->assertNull($records->error);
 		$this->assertEquals(8, $records->numberOfRecords());
 		$records->rewind();
@@ -51,7 +51,7 @@ public function testRepeatSameResponse()
 
 		// Request only one record in each request
 		$client = new Client($uri);
-		$rec = new Records($cql, $client, 1, $http);
+		$rec = new Records($cql, $client, 1, array(), $http);
 
 		// Jumping to position 2 should call fetchMore() and throw 
 		// an InvalidResponseException on getting the same response
@@ -75,7 +75,7 @@ public function testMultipleRequests()
         $cql = 'dummy';
 
 		$client = new Client($uri);
-		$records = new Records($cql, $client, 10, $http);
+		$records = new Records($cql, $client, 10, array(), $http);
 
 		$records->rewind();
 		foreach (range(1, $nrecs) as $n) {