diff options
Diffstat (limited to 'lib/public/Files/SimpleFS/ISimpleFile.php')
-rw-r--r-- | lib/public/Files/SimpleFS/ISimpleFile.php | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/lib/public/Files/SimpleFS/ISimpleFile.php b/lib/public/Files/SimpleFS/ISimpleFile.php new file mode 100644 index 00000000000..efd682e7855 --- /dev/null +++ b/lib/public/Files/SimpleFS/ISimpleFile.php @@ -0,0 +1,100 @@ +<?php +/** + * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl> + * + * @author Roeland Jago Douma <roeland@famdouma.nl> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * 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 + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ +namespace OCP\Files\SimpleFS; + +use OCP\Files\NotPermittedException; + +/** + * Interface ISimpleFile + * + * @package OCP\Files\SimpleFS + * @since 9.2.0 + * @internal This interface is experimental and might change for NC12 + */ +interface ISimpleFile { + + /** + * Get the name + * + * @return string + * @since 9.2.0 + */ + public function getName(); + + /** + * Get the size in bytes + * + * @return int + * @since 9.2.0 + */ + public function getSize(); + + /** + * Get the ETag + * + * @return string + * @since 9.2.0 + */ + public function getETag(); + + /** + * Get the last modification time + * + * @return int + * @since 9.2.0 + */ + public function getMTime(); + + /** + * Get the content + * + * @return string + * @since 9.2.0 + */ + public function getContent(); + + /** + * Overwrite the file + * + * @param string $data + * @throws NotPermittedException + * @since 9.2.0 + */ + public function putContent($data); + + /** + * Delete the file + * + * @throws NotPermittedException + * @since 9.2.0 + */ + public function delete(); + + /** + * Get the MimeType + * + * @return string + * @since 9.2.0 + */ + public function getMimeType(); +} |