diff options
Diffstat (limited to 'lib/public/files/file.php')
-rw-r--r-- | lib/public/files/file.php | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/lib/public/files/file.php b/lib/public/files/file.php new file mode 100644 index 00000000000..916b2edd6c4 --- /dev/null +++ b/lib/public/files/file.php @@ -0,0 +1,53 @@ +<?php +/** + * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Files; + +interface File extends Node { + /** + * Get the content of the file as string + * + * @return string + * @throws \OCP\Files\NotPermittedException + */ + public function getContent(); + + /** + * Write to the file from string data + * + * @param string $data + * @throws \OCP\Files\NotPermittedException + */ + public function putContent($data); + + /** + * Get the mimetype of the file + * + * @return string + */ + public function getMimeType(); + + /** + * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen + * + * @param string $mode + * @return resource + * @throws \OCP\Files\NotPermittedException + */ + public function fopen($mode); + + /** + * Compute the hash of the file + * Type of hash is set with $type and can be anything supported by php's hash_file + * + * @param string $type + * @param bool $raw + * @return string + */ + public function hash($type, $raw = false); +} |