/usr/share/php/Icinga/Web/Response/JsonResponse.php is in php-icinga 2.1.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | <?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Web\Response;
use Zend_Controller_Action_HelperBroker;
use Icinga\Web\Response;
/**
* HTTP response in JSON format
*/
class JsonResponse extends Response
{
/**
* Status identifier for failed API calls due to an error on the server
*
* @var string
*/
const STATUS_ERROR = 'error';
/**
* Status identifier for rejected API calls most due to invalid data or call conditions
*
* @var string
*/
const STATUS_FAIL = 'fail';
/**
* Status identifier for successful API requests
*
* @var string
*/
const STATUS_SUCCESS = 'success';
/**
* JSON encoding options
*
* @var int
*/
protected $encodingOptions = 0;
/**
* Error message if the API call failed due to a server error
*
* @var string|null
*/
protected $errorMessage;
/**
* Fail data for rejected API calls
*
* @var array|null
*/
protected $failData;
/**
* API request status
*
* @var string
*/
protected $status;
/**
* Success data for successful API requests
*
* @var array|null
*/
protected $successData;
/**
* Get the JSON encoding options
*
* @return int
*/
public function getEncodingOptions()
{
return $this->encodingOptions;
}
/**
* Set the JSON encoding options
*
* @param int $encodingOptions
*
* @return $this
*/
public function setEncodingOptions($encodingOptions)
{
$this->encodingOptions = (int) $encodingOptions;
return $this;
}
/**
* Get the error message if the API call failed due to a server error
*
* @return string|null
*/
public function getErrorMessage()
{
return $this->errorMessage;
}
/**
* Set the error message if the API call failed due to a server error
*
* @param string $errorMessage
*
* @return $this
*/
public function setErrorMessage($errorMessage)
{
$this->errorMessage = (string) $errorMessage;
$this->status = static::STATUS_ERROR;
return $this;
}
/**
* Get the fail data for rejected API calls
*
* @return array|null
*/
public function getFailData()
{
return $this->failData;
}
/**
* Set the fail data for rejected API calls
*
* @param array $failData
*
* @return $this
*/
public function setFailData(array $failData)
{
$this->failData = $failData;
$this->status = static::STATUS_FAIL;
return $this;
}
/**
* Get the data for successful API requests
*
* @return array|null
*/
public function getSuccessData()
{
return (! is_array($this->successData) || empty($this->successData)) ? null : $this->successData;
}
/**
* Set the data for successful API requests
*
* @param array $successData
*
* @return $this
*/
public function setSuccessData(array $successData = null)
{
$this->successData = $successData;
$this->status = static::STATUS_SUCCESS;
return $this;
}
/**
* {@inheritdoc}
*/
public function outputBody()
{
$body = array(
'status' => $this->status
);
switch ($this->status) {
case static::STATUS_ERROR:
$body['message'] = $this->getErrorMessage();
break;
case static::STATUS_FAIL:
$body['data'] = $this->getFailData();
break;
case static::STATUS_SUCCESS:
$body['data'] = $this->getSuccessData();
break;
}
echo json_encode($body, $this->getEncodingOptions());
}
/**
* {@inheritdoc}
*/
public function sendHeaders()
{
$this->setHeader('Content-Type', 'application/json', true);
parent::sendHeaders();
}
/**
* {@inheritdoc}
*/
public function sendResponse()
{
Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer')->setNoRender(true);
parent::sendResponse();
exit;
}
}
|