nextcloud/lib/public/appframework/http/jsonresponse.php

86 lines
2.0 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
/**
* ownCloud - App Framework
2013-08-17 13:16:48 +04:00
*
* @author Bernhard Posselt
* @copyright 2012 Bernhard Posselt <dev@bernhard-posselt.com>
2013-08-17 13:16:48 +04:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
2013-08-17 13:16:48 +04:00
*
* This library 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
* 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
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. 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
*/
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
*/
public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
$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
*/
public function render(){
return json_encode($this->data);
}
/**
* 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
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
*/
public function getData(){
return $this->data;
}
}