diff options
Diffstat (limited to 'lib/public/appframework/ocscontroller.php')
-rw-r--r-- | lib/public/appframework/ocscontroller.php | 102 |
1 files changed, 0 insertions, 102 deletions
diff --git a/lib/public/appframework/ocscontroller.php b/lib/public/appframework/ocscontroller.php deleted file mode 100644 index b0e77c5d1ec..00000000000 --- a/lib/public/appframework/ocscontroller.php +++ /dev/null @@ -1,102 +0,0 @@ -<?php -/** - * @author Bernhard Posselt <dev@bernhard-posselt.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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\Controller class - */ - -namespace OCP\AppFramework; - -use OCP\AppFramework\Http\DataResponse; -use OCP\AppFramework\Http\OCSResponse; -use OCP\IRequest; - - -/** - * Base class to inherit your controllers from that are used for RESTful APIs - * @since 8.1.0 - */ -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 - * @param string $corsMethods comma separated string of HTTP verbs which - * should be allowed for websites or webapps when calling your API, defaults to - * 'PUT, POST, GET, DELETE, PATCH' - * @param string $corsAllowedHeaders comma seperated string of HTTP headers - * 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 - */ - 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); - }); - } - - - /** - * Unwrap data and build ocs response - * @param string $format json or xml - * @param array|DataResponse $data the data which should be transformed - * @since 8.1.0 - */ - private function buildOCSResponse($format, $data) { - if ($data instanceof DataResponse) { - $data = $data->getData(); - } - - $params = [ - 'statuscode' => 100, - 'message' => 'OK', - 'data' => [], - 'itemscount' => '', - 'itemsperpage' => '' - ]; - - foreach ($data as $key => $value) { - $params[$key] = $value; - } - - return new OCSResponse( - $format, $params['statuscode'], - $params['message'], $params['data'], - $params['itemscount'], $params['itemsperpage'] - ); - } - -} |