summaryrefslogtreecommitdiffstats
path: root/lib/public/files
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/files')
-rw-r--r--lib/public/files/file.php1
-rw-r--r--lib/public/files/fileinfo.php138
-rw-r--r--lib/public/files/node.php2
-rw-r--r--lib/public/files/storage.php1
4 files changed, 142 insertions, 0 deletions
diff --git a/lib/public/files/file.php b/lib/public/files/file.php
index c6cda59f9b0..6208aeff426 100644
--- a/lib/public/files/file.php
+++ b/lib/public/files/file.php
@@ -43,6 +43,7 @@ interface File extends Node {
*
* @param string $data
* @throws \OCP\Files\NotPermittedException
+ * @return void
*/
public function putContent($data);
diff --git a/lib/public/files/fileinfo.php b/lib/public/files/fileinfo.php
new file mode 100644
index 00000000000..68ce45d3fa1
--- /dev/null
+++ b/lib/public/files/fileinfo.php
@@ -0,0 +1,138 @@
+<?php
+/**
+ * Copyright (c) 2014 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 FileInfo {
+ const TYPE_FILE = 'file';
+ const TYPE_FOLDER = 'folder';
+
+ /**
+ * Get the Etag of the file or folder
+ *
+ * @return string
+ */
+ public function getEtag();
+
+ /**
+ * Get the size in bytes for the file or folder
+ *
+ * @return int
+ */
+ public function getSize();
+
+ /**
+ * Get the last modified date as timestamp for the file or folder
+ *
+ * @return int
+ */
+ public function getMtime();
+
+ /**
+ * Get the name of the file or folder
+ *
+ * @return string
+ */
+ public function getName();
+
+ /**
+ * Get the path relative to the storage
+ *
+ * @return string
+ */
+ public function getInternalPath();
+
+ /**
+ * Get the absolute path
+ *
+ * @return string
+ */
+ public function getPath();
+
+ /**
+ * Get the full mimetype of the file or folder i.e. 'image/png'
+ *
+ * @return string
+ */
+ public function getMimetype();
+
+ /**
+ * Get the first part of the mimetype of the file or folder i.e. 'image'
+ *
+ * @return string
+ */
+ public function getMimePart();
+
+ /**
+ * Get the storage the file or folder is storage on
+ *
+ * @return \OCP\Files\Storage
+ */
+ public function getStorage();
+
+ /**
+ * Get the file id of the file or folder
+ *
+ * @return int
+ */
+ public function getId();
+
+ /**
+ * Check whether the file is encrypted
+ *
+ * @return bool
+ */
+ public function isEncrypted();
+
+ /**
+ * Get the permissions of the file or folder as bitmasked combination of the following constants
+ * \OCP\PERMISSION_CREATE
+ * \OCP\PERMISSION_READ
+ * \OCP\PERMISSION_UPDATE
+ * \OCP\PERMISSION_DELETE
+ * \OCP\PERMISSION_SHARE
+ * \OCP\PERMISSION_ALL
+ *
+ * @return int
+ */
+ public function getPermissions();
+
+ /**
+ * Check whether this is a file or a folder
+ *
+ * @return \OCP\Files\FileInfo::TYPE_FILE | \OCP\Files\FileInfo::TYPE_FOLDER
+ */
+ public function getType();
+
+ /**
+ * Check if the file or folder is readable
+ *
+ * @return bool
+ */
+ public function isReadable();
+
+ /**
+ * Check if a file is writable
+ *
+ * @return bool
+ */
+ public function isUpdateable();
+
+ /**
+ * Check if a file or folder can be deleted
+ *
+ * @return bool
+ */
+ public function isDeletable();
+
+ /**
+ * Check if a file or folder can be shared
+ *
+ * @return bool
+ */
+ public function isShareable();
+}
diff --git a/lib/public/files/node.php b/lib/public/files/node.php
index 972b1cfa492..a380394095b 100644
--- a/lib/public/files/node.php
+++ b/lib/public/files/node.php
@@ -41,6 +41,7 @@ interface Node {
/**
* Delete the file or folder
+ * @return void
*/
public function delete();
@@ -58,6 +59,7 @@ interface Node {
*
* @param int $mtime (optional) modified date as unix timestamp
* @throws \OCP\Files\NotPermittedException
+ * @return void
*/
public function touch($mtime = null);
diff --git a/lib/public/files/storage.php b/lib/public/files/storage.php
index fe30f8f50af..5ec8ac6245c 100644
--- a/lib/public/files/storage.php
+++ b/lib/public/files/storage.php
@@ -39,6 +39,7 @@ interface Storage {
* $parameters is a free form array with the configuration options needed to construct the storage
*
* @param array $parameters
+ * @return void
*/
public function __construct($parameters);