interface/modules/zend_modules/library/Zend/Json/Server/Response.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\Json\Json;
  13
  14 class Response
  15 {
  16     /**
  17      * Response error
  18      * @var null|Error
  19      */
  20     protected $error;
  21
  22     /**
  23      * Request ID
  24      * @var mixed
  25      */
  26     protected $id;
  27
  28     /**
  29      * Result
  30      * @var mixed
  31      */
  32     protected $result;
  33
  34     /**
  35      * Service map
  36      * @var Smd
  37      */
  38     protected $serviceMap;
  39
  40     /**
  41      * JSON-RPC version
  42      * @var string
  43      */
  44     protected $version;
  45
  46     /**
  47      * @var $args
  48      */
  49     protected $args;
  50
  51     /**
  52      * Set response state
  53      *
  54      * @param  array $options
  55      * @return Response
  56      */
  57     public function setOptions(array $options)
  58     {
  59         // re-produce error state
  60         if (isset($options['error']) && is_array($options['error'])) {
  61             $error = $options['error'];
  62             $options['error'] = new Error($error['message'], $error['code'], $error['data']);
  63         }
  64
  65         $methods = get_class_methods($this);
  66         foreach ($options as $key => $value) {
  67             $method = 'set' . ucfirst($key);
  68             if (in_array($method, $methods)) {
  69                 $this->$method($value);
  70             } elseif ($key == 'jsonrpc') {
  71                 $this->setVersion($value);
  72             }
  73         }
  74         return $this;
  75     }
  76
  77     /**
  78      * Set response state based on JSON
  79      *
  80      * @param  string $json
  81      * @return void
  82      */
  83     public function loadJson($json)
  84     {
  85         $options = Json::decode($json, Json::TYPE_ARRAY);
  86         $this->setOptions($options);
  87     }
  88
  89     /**
  90      * Set result
  91      *
  92      * @param  mixed $value
  93      * @return Response
  94      */
  95     public function setResult($value)
  96     {
  97         $this->result = $value;
  98         return $this;
  99     }
 100
 101     /**
 102      * Get result
 103      *
 104      * @return mixed
 105      */
 106     public function getResult()
 107     {
 108         return $this->result;
 109     }
 110
 111     // RPC error, if response results in fault
 112     /**
 113      * Set result error
 114      *
 115      * @param  mixed $error
 116      * @return Response
 117      */
 118     public function setError(Error $error = null)
 119     {
 120         $this->error = $error;
 121         return $this;
 122     }
 123
 124     /**
 125      * Get response error
 126      *
 127      * @return null|Error
 128      */
 129     public function getError()
 130     {
 131         return $this->error;
 132     }
 133
 134     /**
 135      * Is the response an error?
 136      *
 137      * @return bool
 138      */
 139     public function isError()
 140     {
 141         return $this->getError() instanceof Error;
 142     }
 143
 144     /**
 145      * Set request ID
 146      *
 147      * @param  mixed $name
 148      * @return Response
 149      */
 150     public function setId($name)
 151     {
 152         $this->id = $name;
 153         return $this;
 154     }
 155
 156     /**
 157      * Get request ID
 158      *
 159      * @return mixed
 160      */
 161     public function getId()
 162     {
 163         return $this->id;
 164     }
 165
 166     /**
 167      * Set JSON-RPC version
 168      *
 169      * @param  string $version
 170      * @return Response
 171      */
 172     public function setVersion($version)
 173     {
 174         $version = (string) $version;
 175         if ('2.0' == $version) {
 176             $this->version = '2.0';
 177         } else {
 178             $this->version = null;
 179         }
 180
 181         return $this;
 182     }
 183
 184     /**
 185      * Retrieve JSON-RPC version
 186      *
 187      * @return string
 188      */
 189     public function getVersion()
 190     {
 191         return $this->version;
 192     }
 193
 194     /**
 195      * Cast to JSON
 196      *
 197      * @return string
 198      */
 199     public function toJson()
 200     {
 201         if ($this->isError()) {
 202             $response = array(
 203                 'error'  => $this->getError()->toArray(),
 204                 'id'     => $this->getId(),
 205             );
 206         } else {
 207             $response = array(
 208                 'result' => $this->getResult(),
 209                 'id'     => $this->getId(),
 210             );
 211         }
 212
 213         if (null !== ($version = $this->getVersion())) {
 214             $response['jsonrpc'] = $version;
 215         }
 216
 217         return \Zend\Json\Json::encode($response);
 218     }
 219
 220     /**
 221      * Retrieve args
 222      *
 223      * @return mixed
 224      */
 225     public function getArgs()
 226     {
 227         return $this->args;
 228     }
 229
 230     /**
 231      * Set args
 232      *
 233      * @param mixed $args
 234      * @return self
 235      */
 236     public function setArgs($args)
 237     {
 238         $this->args = $args;
 239         return $this;
 240     }
 241
 242     /**
 243      * Set service map object
 244      *
 245      * @param  Smd $serviceMap
 246      * @return Response
 247      */
 248     public function setServiceMap($serviceMap)
 249     {
 250         $this->serviceMap = $serviceMap;
 251         return $this;
 252     }
 253
 254     /**
 255      * Retrieve service map
 256      *
 257      * @return Smd|null
 258      */
 259     public function getServiceMap()
 260     {
 261         return $this->serviceMap;
 262     }
 263
 264     /**
 265      * Cast to string (JSON)
 266      *
 267      * @return string
 268      */
 269     public function __toString()
 270     {
 271         return $this->toJson();
 272     }
 273 }