nextcloud/lib/public/AppFramework/OCSController.php

112 lines
3.5 KiB
PHP
Raw Normal View History

2015-02-05 16:02:17 +03: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>
* @author Morris Jobke <hey@morrisjobke.de>
2016-05-26 20:56:05 +03:00
* @author Stefan Weil <sw@weilnetz.de>
2015-10-05 21:54:56 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-02-05 16:02:17 +03:00
*
2015-03-26 13:44:34 +03:00
* @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\Controller class
*/
2015-02-05 16:02:17 +03:00
namespace OCP\AppFramework;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\OCSResponse;
use OCP\AppFramework\Http\Response;
2015-02-05 16:02:17 +03:00
use OCP\IRequest;
/**
* Base class to inherit your controllers from that are used for RESTful APIs
* @since 8.1.0
2015-02-05 16:02:17 +03:00
*/
abstract class OCSController extends ApiController {
/**
* constructor of the controller
* @param string $appName the name of the app
* @param IRequest $request an instance of the request
2015-08-03 22:03:11 +03:00
* @param string $corsMethods comma separated string of HTTP verbs which
2015-02-05 16:02:17 +03:00
* should be allowed for websites or webapps when calling your API, defaults to
* 'PUT, POST, GET, DELETE, PATCH'
* @param string $corsAllowedHeaders comma separated string of HTTP headers
2015-02-05 16:02:17 +03:00
* which should be allowed for websites or webapps when calling your API,
* defaults to 'Authorization, Content-Type, Accept'
* @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
* request should be cached, defaults to 1728000 seconds
* @since 8.1.0
2015-02-05 16:02:17 +03:00
*/
public function __construct($appName,
IRequest $request,
$corsMethods='PUT, POST, GET, DELETE, PATCH',
$corsAllowedHeaders='Authorization, Content-Type, Accept',
$corsMaxAge=1728000){
parent::__construct($appName, $request, $corsMethods,
$corsAllowedHeaders, $corsMaxAge);
$this->registerResponder('json', function ($data) {
return $this->buildOCSResponse('json', $data);
});
$this->registerResponder('xml', function ($data) {
return $this->buildOCSResponse('xml', $data);
});
}
/**
* Since the OCS endpoints default to XML we need to find out the format
* again
* @param mixed $response the value that was returned from a controller and
* is not a Response instance
* @param string $format the format for which a formatter has been registered
* @throws \DomainException if format does not match a registered formatter
* @return Response
* @since 9.1.0
*/
public function buildResponse($response, $format = 'xml') {
return parent::buildResponse($response, $format);
}
2015-02-05 16:02:17 +03:00
/**
* Unwrap data and build ocs response
* @param string $format json or xml
* @param DataResponse $data the data which should be transformed
* @since 8.1.0
* @return OCSResponse
2015-02-05 16:02:17 +03:00
*/
private function buildOCSResponse($format, DataResponse $data) {
2015-02-05 16:02:17 +03:00
$params = [
'statuscode' => 100,
'message' => 'OK',
'data' => $data->getData(),
2015-02-05 16:02:17 +03:00
'itemscount' => '',
'itemsperpage' => ''
];
return new OCSResponse(
2015-08-03 23:19:04 +03:00
$format, $params['statuscode'],
2015-08-03 22:03:11 +03:00
$params['message'], $params['data'],
2015-02-05 16:02:17 +03:00
$params['itemscount'], $params['itemsperpage']
);
}
}