mirror of
https://github.com/nextcloud/server.git
synced 2026-02-03 20:41:22 -05:00
caff1023ea
To continue this formatting madness, here's a tiny patch that adds unified formatting for control structures like if and loops as well as classes, their methods and anonymous functions. This basically forces the constructs to start on the same line. This is not exactly what PSR2 wants, but I think we can have a few exceptions with "our" style. The starting of braces on the same line is pracrically standard for our code. This also removes and empty lines from method/function bodies at the beginning and end. Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
104 lines
2.7 KiB
PHP
104 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* 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.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* 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.
|
|
*
|
|
* 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/>
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Public interface of ownCloud for apps to use.
|
|
* AppFramework\HTTP\JSONResponse class
|
|
*/
|
|
|
|
namespace OCP\AppFramework\Http;
|
|
|
|
use OCP\AppFramework\Http;
|
|
|
|
/**
|
|
* A renderer for JSON calls
|
|
* @since 6.0.0
|
|
*/
|
|
class JSONResponse extends Response {
|
|
|
|
/**
|
|
* response data
|
|
* @var array|object
|
|
*/
|
|
protected $data;
|
|
|
|
|
|
/**
|
|
* constructor of JSONResponse
|
|
* @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
|
|
*/
|
|
public function __construct($data=[], $statusCode=Http::STATUS_OK) {
|
|
parent::__construct();
|
|
|
|
$this->data = $data;
|
|
$this->setStatus($statusCode);
|
|
$this->addHeader('Content-Type', 'application/json; charset=utf-8');
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the rendered json
|
|
* @return string the rendered json
|
|
* @since 6.0.0
|
|
* @throws \Exception If data could not get encoded
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Sets values in the data json array
|
|
* @param array|object $data an array or object which will be transformed
|
|
* to JSON
|
|
* @return JSONResponse Reference to this object
|
|
* @since 6.0.0 - return value was added in 7.0.0
|
|
*/
|
|
public function setData($data) {
|
|
$this->data = $data;
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Used to get the set parameters
|
|
* @return array the data
|
|
* @since 6.0.0
|
|
*/
|
|
public function getData() {
|
|
return $this->data;
|
|
}
|
|
}
|