nextcloud/lib/public/AppFramework/Http/JSONResponse.php

104 lines
2.6 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Bernhard Posselt <dev@bernhard-posselt.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2013-08-17 13:16:48 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2013-08-17 13:16:48 +04:00
*
*/
/**
* Public interface of ownCloud for apps to use.
* AppFramework\HTTP\JSONResponse class
*/
2013-08-21 03:00:26 +04:00
namespace OCP\AppFramework\Http;
2013-08-17 13:16:48 +04:00
use OCP\AppFramework\Http;
2013-08-17 13:16:48 +04:00
/**
* A renderer for JSON calls
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
class JSONResponse extends Response {
/**
* response data
* @var array|object
*/
2013-08-17 13:16:48 +04:00
protected $data;
/**
* constructor of JSONResponse
2013-08-17 13:16:48 +04:00
* @param array|object $data the object or array that should be transformed
* @param int $statusCode the Http status code, defaults to 200
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
parent::__construct();
2013-08-17 13:16:48 +04:00
$this->data = $data;
$this->setStatus($statusCode);
2014-11-05 14:04:56 +03:00
$this->addHeader('Content-Type', 'application/json; charset=utf-8');
2013-08-17 13:16:48 +04:00
}
/**
* Returns the rendered json
* @return string the rendered json
* @since 6.0.0
* @throws \Exception If data could not get encoded
2013-08-17 13:16:48 +04:00
*/
public function render() {
$response = json_encode($this->data, JSON_HEX_TAG);
if($response === false) {
throw new \Exception(sprintf('Could not json_encode due to invalid ' .
'non UTF-8 characters in the array: %s', var_export($this->data, true)));
}
return $response;
2013-08-17 13:16:48 +04:00
}
/**
* Sets values in the data json array
* @param array|object $data an array or object which will be transformed
2013-08-17 13:16:48 +04:00
* to JSON
2014-03-10 12:31:30 +04:00
* @return JSONResponse Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
2013-08-17 13:16:48 +04:00
*/
public function setData($data){
$this->data = $data;
2014-03-10 02:01:16 +04:00
return $this;
2013-08-17 13:16:48 +04:00
}
/**
* Used to get the set parameters
* @return array the data
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function getData(){
return $this->data;
}
}