summaryrefslogtreecommitdiffstats
path: root/lib/public/files/objectstore
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/files/objectstore
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/files/objectstore')
-rw-r--r--lib/public/files/objectstore/iobjectstore.php18
1 files changed, 14 insertions, 4 deletions
diff --git a/lib/public/files/objectstore/iobjectstore.php b/lib/public/files/objectstore/iobjectstore.php
index 0eeecc1204d..5943731849e 100644
--- a/lib/public/files/objectstore/iobjectstore.php
+++ b/lib/public/files/objectstore/iobjectstore.php
@@ -21,32 +21,42 @@
*/
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
+ * @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
+ * @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
+ * @throws \Exception when something goes wrong, message will be logged
+ * @since 7.0.0
*/
function deleteObject($urn);
-} \ No newline at end of file
+}