diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-17 20:00:28 +0200 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-18 14:35:50 +0200 |
commit | 4a53542e457bf419007fcf63048eeb94d88ae514 (patch) | |
tree | 8caad7f40f505ea69c32cab25dde6dbc0b481e45 /lib/public/Files/ObjectStore | |
parent | 765782445a24fb1b239f2a3cd5c7b239ae4f6455 (diff) | |
download | nextcloud-server-4a53542e457bf419007fcf63048eeb94d88ae514.tar.gz nextcloud-server-4a53542e457bf419007fcf63048eeb94d88ae514.zip |
Move \OCP\Files to PSR-4
Diffstat (limited to 'lib/public/Files/ObjectStore')
-rw-r--r-- | lib/public/Files/ObjectStore/IObjectStore.php | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/lib/public/Files/ObjectStore/IObjectStore.php b/lib/public/Files/ObjectStore/IObjectStore.php new file mode 100644 index 00000000000..78be18fb2e9 --- /dev/null +++ b/lib/public/Files/ObjectStore/IObjectStore.php @@ -0,0 +1,62 @@ +<?php +/** + * @author Jörn Friedrich Dreyer <jfd@butonic.de> + * @author Morris Jobke <hey@morrisjobke.de> + * + * @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/> + * + */ +namespace OCP\Files\ObjectStore; + +/** + * Interface IObjectStore + * + * @package OCP\Files\ObjectStore + * @since 7.0.0 + */ +interface IObjectStore { + + /** + * @return string the container or bucket name where objects are stored + * @since 7.0.0 + */ + function getStorageId(); + + /** + * @param string $urn the unified resource name used to identify the object + * @return resource stream with the read data + * @throws \Exception when something goes wrong, message will be logged + * @since 7.0.0 + */ + function readObject($urn); + + /** + * @param string $urn the unified resource name used to identify the object + * @param resource $stream stream with the data to write + * @throws \Exception when something goes wrong, message will be logged + * @since 7.0.0 + */ + function writeObject($urn, $stream); + + /** + * @param string $urn the unified resource name used to identify the object + * @return void + * @throws \Exception when something goes wrong, message will be logged + * @since 7.0.0 + */ + function deleteObject($urn); + +} |