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

105 lines
2.6 KiB
PHP
Raw Normal View History

2015-02-05 16:02:17 +03:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Morris Jobke <hey@morrisjobke.de>
2015-02-05 16:02:17 +03:00
*
2015-03-26 13:44:34 +03:00
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
2015-02-05 16:02:17 +03: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.
2015-02-05 16:02:17 +03:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2015-02-05 16:02:17 +03: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.
2015-02-05 16:02:17 +03: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/>
2015-02-05 16:02:17 +03:00
*
*/
/**
* Public interface of ownCloud for apps to use.
* AppFramework\HTTP\JSONResponse class
*/
2015-02-05 16:02:17 +03:00
namespace OCP\AppFramework\Http;
use OCP\AppFramework\Http;
use OC_OCS;
/**
* A renderer for OCS responses
* @since 8.1.0
2015-02-05 16:02:17 +03:00
*/
class OCSResponse extends Response {
private $data;
private $format;
private $statuscode;
private $message;
private $tag;
private $tagattribute;
private $dimension;
private $itemscount;
private $itemsperpage;
/**
* generates the xml or json response for the API call from an multidimenional data array.
* @param string $format
* @param string $status
* @param string $statuscode
* @param string $message
* @param array $data
* @param string $tag
* @param string $tagattribute
* @param int $dimension
* @param int|string $itemscount
* @param int|string $itemsperpage
* @since 8.1.0
2015-02-05 16:02:17 +03:00
*/
public function __construct($format, $status, $statuscode, $message,
$data=[], $tag='', $tagattribute='',
$dimension=-1, $itemscount='',
$itemsperpage='') {
$this->format = $format;
$this->setStatus($status);
2015-02-05 16:02:17 +03:00
$this->statuscode = $statuscode;
$this->message = $message;
$this->data = $data;
$this->tag = $tag;
$this->tagattribute = $tagattribute;
$this->dimension = $dimension;
$this->itemscount = $itemscount;
$this->itemsperpage = $itemsperpage;
// set the correct header based on the format parameter
if ($format === 'json') {
$this->addHeader(
'Content-Type', 'application/json; charset=utf-8'
);
} else {
$this->addHeader(
'Content-Type', 'application/xml; charset=utf-8'
);
}
}
/**
* @return string
* @since 8.1.0
*/
2015-02-05 16:02:17 +03:00
public function render() {
return OC_OCS::generateXml(
$this->format, $this->getStatus(), $this->statuscode, $this->message,
2015-02-05 16:02:17 +03:00
$this->data, $this->tag, $this->tagattribute, $this->dimension,
$this->itemscount, $this->itemsperpage
);
}
}