summaryrefslogtreecommitdiffstats
path: root/lib/public/encryption/iencryptionmodule.php
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/encryption/iencryptionmodule.php
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/encryption/iencryptionmodule.php')
-rw-r--r--lib/public/encryption/iencryptionmodule.php15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/public/encryption/iencryptionmodule.php b/lib/public/encryption/iencryptionmodule.php
index d22ca0ec86c..dc55f8939ef 100644
--- a/lib/public/encryption/iencryptionmodule.php
+++ b/lib/public/encryption/iencryptionmodule.php
@@ -21,10 +21,17 @@
namespace OCP\Encryption;
+/**
+ * Interface IEncryptionModule
+ *
+ * @package OCP\Encryption
+ * @since 8.1.0
+ */
interface IEncryptionModule {
/**
* @return string defining the technical unique id
+ * @since 8.1.0
*/
public function getId();
@@ -32,6 +39,7 @@ interface IEncryptionModule {
* In comparison to getKey() this function returns a human readable (maybe translated) name
*
* @return string
+ * @since 8.1.0
*/
public function getDisplayName();
@@ -48,6 +56,7 @@ interface IEncryptionModule {
* $return array $header contain data as key-value pairs which should be
* written to the header, in case of a write operation
* or if no additional data is needed return a empty array
+ * @since 8.1.0
*/
public function begin($path, $user, array $header, array $accessList);
@@ -59,6 +68,7 @@ interface IEncryptionModule {
* @param string $path to the file
* @return string remained data which should be written to the file in case
* of a write operation
+ * @since 8.1.0
*/
public function end($path);
@@ -67,6 +77,7 @@ interface IEncryptionModule {
*
* @param string $data you want to encrypt
* @return mixed encrypted data
+ * @since 8.1.0
*/
public function encrypt($data);
@@ -75,6 +86,7 @@ interface IEncryptionModule {
*
* @param string $data you want to decrypt
* @return mixed decrypted data
+ * @since 8.1.0
*/
public function decrypt($data);
@@ -85,6 +97,7 @@ interface IEncryptionModule {
* @param string $uid of the user who performs the operation
* @param array $accessList who has access to the file contains the key 'users' and 'public'
* @return boolean
+ * @since 8.1.0
*/
public function update($path, $uid, array $accessList);
@@ -93,6 +106,7 @@ interface IEncryptionModule {
*
* @param string $path
* @return boolean
+ * @since 8.1.0
*/
public function shouldEncrypt($path);
@@ -101,6 +115,7 @@ interface IEncryptionModule {
* ownCloud read/write files with a block size of 8192 byte
*
* @return integer
+ * @since 8.1.0
*/
public function getUnencryptedBlockSize();
}