interface/modules/zend_modules/library/Zend/Json/Server/Client.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Json\Server;
  11
  12 use Zend\Http\Client as HttpClient;
  13 use Zend\Server\Client as ServerClient;
  14
  15 class Client implements ServerClient
  16 {
  17     /**
  18      * Full address of the JSON-RPC service.
  19      *
  20      * @var string
  21      */
  22     protected $serverAddress;
  23
  24     /**
  25      * HTTP Client to use for requests.
  26      *
  27      * @var HttpClient
  28      */
  29     protected $httpClient;
  30
  31     /**
  32      * Request of the last method call.
  33      *
  34      * @var Request
  35      */
  36     protected $lastRequest;
  37
  38     /**
  39      * Response received from the last method call.
  40      *
  41      * @var Response
  42      */
  43     protected $lastResponse;
  44
  45     /**
  46      * Request ID counter.
  47      *
  48      * @var int
  49      */
  50     protected $id = 0;
  51
  52     /**
  53      * Create a new JSON-RPC client to a remote server.
  54      *
  55      * @param string $server Full address of the JSON-RPC service.
  56      * @param HttpClient $httpClient HTTP Client to use for requests.
  57      */
  58     public function __construct($server, HttpClient $httpClient = null)
  59     {
  60         $this->httpClient = $httpClient ?: new HttpClient();
  61         $this->serverAddress = $server;
  62     }
  63
  64     /**
  65      * Sets the HTTP client object to use for connecting the JSON-RPC server.
  66      *
  67      * @param  HttpClient $httpClient New HTTP client to use.
  68      * @return Client Self instance.
  69      */
  70     public function setHttpClient(HttpClient $httpClient)
  71     {
  72         $this->httpClient = $httpClient;
  73         return $this;
  74     }
  75
  76     /**
  77      * Gets the HTTP client object.
  78      *
  79      * @return HttpClient HTTP client.
  80      */
  81     public function getHttpClient()
  82     {
  83         return $this->httpClient;
  84     }
  85
  86     /**
  87      * The request of the last method call.
  88      *
  89      * @return Request Request instance.
  90      */
  91     public function getLastRequest()
  92     {
  93         return $this->lastRequest;
  94     }
  95
  96     /**
  97      * The response received from the last method call.
  98      *
  99      * @return Response Response instance.
 100      */
 101     public function getLastResponse()
 102     {
 103         return $this->lastResponse;
 104     }
 105
 106     /**
 107      * Perform an JSOC-RPC request and return a response.
 108      *
 109      * @param  Request $request Request.
 110      * @return Response Response.
 111      * @throws Exception\HttpException When HTTP communication fails.
 112      */
 113     public function doRequest($request)
 114     {
 115         $this->lastRequest = $request;
 116
 117         $httpRequest = $this->httpClient->getRequest();
 118         if ($httpRequest->getUriString() === null) {
 119             $this->httpClient->setUri($this->serverAddress);
 120         }
 121
 122         $headers = $httpRequest->getHeaders();
 123         $headers->addHeaders(array(
 124             'Content-Type' => 'application/json',
 125             'Accept'       => 'application/json',
 126         ));
 127
 128         if (!$headers->get('User-Agent')) {
 129             $headers->addHeaderLine('User-Agent', 'Zend_Json_Server_Client');
 130         }
 131
 132         $this->httpClient->setRawBody($request->__toString());
 133         $this->httpClient->setMethod('POST');
 134         $httpResponse = $this->httpClient->send();
 135
 136         if (!$httpResponse->isSuccess()) {
 137             throw new Exception\HttpException(
 138                 $httpResponse->getReasonPhrase(),
 139                 $httpResponse->getStatusCode()
 140             );
 141         }
 142
 143         $response = new Response();
 144
 145         $this->lastResponse = $response;
 146
 147         // import all response data form JSON HTTP response
 148         $response->loadJson($httpResponse->getBody());
 149
 150         return $response;
 151     }
 152
 153     /**
 154      * Send an JSON-RPC request to the service (for a specific method).
 155      *
 156      * @param  string $method Name of the method we want to call.
 157      * @param  array $params Array of parameters for the method.
 158      * @return mixed Method call results.
 159      * @throws Exception\ErrorException When remote call fails.
 160      */
 161     public function call($method, $params = array())
 162     {
 163         $request = $this->createRequest($method, $params);
 164
 165         $response = $this->doRequest($request);
 166
 167         if ($response->isError()) {
 168             $error = $response->getError();
 169             throw new Exception\ErrorException(
 170                 $error->getMessage(),
 171                 $error->getCode()
 172             );
 173         }
 174
 175         return $response->getResult();
 176     }
 177
 178     /**
 179      * Create request object.
 180      *
 181      * @param  string $method Method to call.
 182      * @param  array $params List of arguments.
 183      * @return Request Created request.
 184      */
 185     protected function createRequest($method, array $params)
 186     {
 187         $request = new Request();
 188         $request->setMethod($method)
 189             ->setParams($params)
 190             ->setId(++$this->id);
 191         return $request;
 192     }
 193 }