mirror of
https://github.com/nextcloud/server.git
synced 2025-02-07 09:59:46 +00:00
67 lines
1.6 KiB
PHP
67 lines
1.6 KiB
PHP
<?php
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
namespace OC\AppFramework\OCS;
|
|
|
|
use OCP\AppFramework\Http;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\OCSController;
|
|
|
|
/**
|
|
* @psalm-import-type DataResponseType from DataResponse
|
|
* @template S of Http::STATUS_*
|
|
* @template-covariant T of DataResponseType
|
|
* @template H of array<string, mixed>
|
|
* @template-extends BaseResponse<Http::STATUS_*, DataResponseType, array<string, mixed>>
|
|
*/
|
|
class V1Response extends BaseResponse {
|
|
/**
|
|
* The V1 endpoint has very limited http status codes basically everything
|
|
* is status 200 except 401
|
|
*
|
|
* @return Http::STATUS_*
|
|
*/
|
|
public function getStatus() {
|
|
$status = parent::getStatus();
|
|
if ($status === OCSController::RESPOND_UNAUTHORISED) {
|
|
return Http::STATUS_UNAUTHORIZED;
|
|
}
|
|
|
|
return Http::STATUS_OK;
|
|
}
|
|
|
|
/**
|
|
* In v1 all OK is 100
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getOCSStatus() {
|
|
$status = parent::getOCSStatus();
|
|
|
|
if ($status === Http::STATUS_OK) {
|
|
return 100;
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* Construct the meta part of the response
|
|
* And then late the base class render
|
|
*
|
|
* @return string
|
|
*/
|
|
public function render() {
|
|
$meta = [
|
|
'status' => $this->getOCSStatus() === 100 ? 'ok' : 'failure',
|
|
'statuscode' => $this->getOCSStatus(),
|
|
'message' => $this->getOCSStatus() === 100 ? 'OK' : $this->statusMessage ?? '',
|
|
'totalitems' => (string)($this->itemsCount ?? ''),
|
|
'itemsperpage' => (string)($this->itemsPerPage ?? ''),
|
|
];
|
|
|
|
return $this->renderResult($meta);
|
|
}
|
|
}
|