Add explain method to the client

Author: danmichaelo

src/Client.php

@@ -35,13 +35,13 @@ class Client {
      */
     protected $credentials;
 
-	/**
-	 * Create a new client
-	 *
-	 * @param string $url Base URL to the SRU service
-	 * @param array $options Associative array of options
-	 * @param HttpClient $httpClient
-	 */
+    /**
+     * Create a new client
+     *
+     * @param string $url Base URL to the SRU service
+     * @param array $options Associative array of options
+     * @param HttpClient $httpClient
+     */
     public function __construct($url, $options = null, $httpClient = null)
     {
         $this->url = $url;
@@ -80,8 +80,8 @@ public function __construct($url, $options = null, $httpClient = null)
     public function urlTo($cql, $start = 1, $count = 10)
     {
         $qs = array(
-            'version' => $this->version,
             'operation' => 'searchRetrieve',
+            'version' => $this->version,
             'recordSchema' => $this->schema,
             'maximumRecords' => $count,
             'query' => $cql
@@ -97,16 +97,12 @@ public function urlTo($cql, $start = 1, $count = 10)
     }
 
     /**
-     * Perform a searchRetrieveResponse request
+     * Get HTTP client configuration options (authentication, proxy, headers)
      * 
-     * @param string $cql
-     * @param int $start Start value in result set (optional)
-     * @param int $count Number of records to request (optional)
-     * @return Response
+     * @return array
      */
-    public function search($cql, $start = 1, $count = 10) {
-
-        $url = $this->urlTo($cql, $start, $count);
+    protected function getHttpOptions()
+    {
         $headers = array(
             'Accept' => 'application/xml'
         );
@@ -122,11 +118,46 @@ public function search($cql, $start = 1, $count = 10) {
         if ($this->proxy) {
             $options['proxy'] = $this->proxy;
         }
+        return $options;
+    }
+
+    /**
+     * Perform a searchRetrieve request
+     * 
+     * @param string $cql
+     * @param int $start Start value in result set (optional)
+     * @param int $count Number of records to request (optional)
+     * @return Response
+     */
+    public function search($cql, $start = 1, $count = 10) {
+
+        $url = $this->urlTo($cql, $start, $count);
+        $options = $this->getHttpOptions();
 
         $res = $this->httpClient->get($url, $options)->send();
         $body = $res->getBody(true);
 
         return new Response($body, $this);
+    }
+
+    /**
+     * Perform an explain request
+     * 
+     * @return ExplainResponse
+     */
+    public function explain() {
+
+        $url = $this->url . '?' . http_build_query(array(
+            'operation' => 'explain',
+            'version' => $this->version,
+            'recordSchema' => $this->schema
+        ));
+        $options = $this->getHttpOptions();
+
+        $res = $this->httpClient->get($url, $options)->send();
+        $body = $res->getBody(true);
+
+        return new ExplainResponse($body, $this);
 
     }
 

src/ExplainResponse.php

@@ -0,0 +1,47 @@
+<?php namespace Scriptotek\Sru;
+ 
+use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
+
+/**
+ * SRU explain response
+ */
+class ExplainResponse {
+
+    /** @var string Raw XML response */
+    protected $rawResponse;
+
+    /**
+     * Create a new explain response
+     *
+     * @param string $text Raw XML response
+     * @param Client $client SRU client reference (optional)
+     */
+    public function __construct($text, &$client = null)
+    {
+        $this->rawResponse = $text; 
+        try {
+            $doc = new QuiteSimpleXMLElement($text);
+        } catch (\Exception $e) {
+            throw new \Exception('Invalid XML received');
+        }
+
+        $doc->registerXPathNamespaces(array(
+            'srw' => 'http://www.loc.gov/zing/srw/',
+            'd' => 'http://www.loc.gov/zing/srw/diagnostic/'
+        ));
+
+        $this->client = $client;
+    }
+
+    /**
+     * Get the raw xml response
+     *
+     * @return string
+     */
+    public function asXml()
+    {
+        return $this->rawResponse;
+    }
+
+}
+

tests/ClientTest.php

@@ -14,14 +14,14 @@ class ClientTest extends TestCase {
     public function testUrlTo()
     {
         $sru1 = new Client($this->url);
-        $expectedUrl1 = $this->url . '?version=1.1&operation=searchRetrieve&recordSchema=marcxml&maximumRecords=10&query=isbn%3D123';
-        $expectedUrl2 = $this->url . '?version=1.1&operation=searchRetrieve&recordSchema=marcxml&maximumRecords=50&query=isbn%3D123&startRecord=2';
+        $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';
 
         $sru3 = new Client($this->url, array('schema' => 'CUSTOMSCHEMA'));
-        $expectedUrl3 = $this->url . '?version=1.1&operation=searchRetrieve&recordSchema=CUSTOMSCHEMA&maximumRecords=10&query=isbn%3D123';
+        $expectedUrl3 = $this->url . '?operation=searchRetrieve&version=1.1&recordSchema=CUSTOMSCHEMA&maximumRecords=10&query=isbn%3D123';
 
         $sru4 = new Client($this->url, array('version' => '0.9'));
-        $expectedUrl4 = $this->url . '?version=0.9&operation=searchRetrieve&recordSchema=marcxml&maximumRecords=10&query=isbn%3D123';
+        $expectedUrl4 = $this->url . '?operation=searchRetrieve&version=0.9&recordSchema=marcxml&maximumRecords=10&query=isbn%3D123';
 
         $this->assertEquals($expectedUrl1, $sru1->urlTo('isbn=123'));
         $this->assertEquals($expectedUrl2, $sru1->urlTo('isbn=123', 2, 50));