@@ -30,25 +30,25 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IStorageFactory { |
33 | - /** |
|
34 | - * allow modifier storage behaviour by adding wrappers around storages |
|
35 | - * |
|
36 | - * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
37 | - * |
|
38 | - * @param string $wrapperName |
|
39 | - * @param callable $callback |
|
40 | - * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
41 | - * name registered |
|
42 | - * @since 8.0.0 |
|
43 | - */ |
|
44 | - public function addStorageWrapper($wrapperName, $callback); |
|
33 | + /** |
|
34 | + * allow modifier storage behaviour by adding wrappers around storages |
|
35 | + * |
|
36 | + * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
37 | + * |
|
38 | + * @param string $wrapperName |
|
39 | + * @param callable $callback |
|
40 | + * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
41 | + * name registered |
|
42 | + * @since 8.0.0 |
|
43 | + */ |
|
44 | + public function addStorageWrapper($wrapperName, $callback); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
48 | - * @param string $class |
|
49 | - * @param array $arguments |
|
50 | - * @return \OCP\Files\Storage |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
46 | + /** |
|
47 | + * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
48 | + * @param string $class |
|
49 | + * @param array $arguments |
|
50 | + * @return \OCP\Files\Storage |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
54 | 54 | } |
@@ -33,30 +33,30 @@ |
||
33 | 33 | * @since 9.0.0 |
34 | 34 | */ |
35 | 35 | interface ILockingStorage { |
36 | - /** |
|
37 | - * @param string $path The path of the file to acquire the lock for |
|
38 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
39 | - * @param \OCP\Lock\ILockingProvider $provider |
|
40 | - * @throws \OCP\Lock\LockedException |
|
41 | - * @since 9.0.0 |
|
42 | - */ |
|
43 | - public function acquireLock($path, $type, ILockingProvider $provider); |
|
36 | + /** |
|
37 | + * @param string $path The path of the file to acquire the lock for |
|
38 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
39 | + * @param \OCP\Lock\ILockingProvider $provider |
|
40 | + * @throws \OCP\Lock\LockedException |
|
41 | + * @since 9.0.0 |
|
42 | + */ |
|
43 | + public function acquireLock($path, $type, ILockingProvider $provider); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param string $path The path of the file to acquire the lock for |
|
47 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
48 | - * @param \OCP\Lock\ILockingProvider $provider |
|
49 | - * @throws \OCP\Lock\LockedException |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function releaseLock($path, $type, ILockingProvider $provider); |
|
45 | + /** |
|
46 | + * @param string $path The path of the file to acquire the lock for |
|
47 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
48 | + * @param \OCP\Lock\ILockingProvider $provider |
|
49 | + * @throws \OCP\Lock\LockedException |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function releaseLock($path, $type, ILockingProvider $provider); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param string $path The path of the file to change the lock for |
|
56 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
57 | - * @param \OCP\Lock\ILockingProvider $provider |
|
58 | - * @throws \OCP\Lock\LockedException |
|
59 | - * @since 9.0.0 |
|
60 | - */ |
|
61 | - public function changeLock($path, $type, ILockingProvider $provider); |
|
54 | + /** |
|
55 | + * @param string $path The path of the file to change the lock for |
|
56 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
57 | + * @param \OCP\Lock\ILockingProvider $provider |
|
58 | + * @throws \OCP\Lock\LockedException |
|
59 | + * @since 9.0.0 |
|
60 | + */ |
|
61 | + public function changeLock($path, $type, ILockingProvider $provider); |
|
62 | 62 | } |
@@ -30,35 +30,35 @@ |
||
30 | 30 | * @since 12.0.0 |
31 | 31 | */ |
32 | 32 | interface INotifyHandler { |
33 | - /** |
|
34 | - * Start listening for update notifications |
|
35 | - * |
|
36 | - * The provided callback will be called for every incoming notification with the following parameters |
|
37 | - * - IChange|IRenameChange $change |
|
38 | - * |
|
39 | - * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback |
|
40 | - * |
|
41 | - * @param callable $callback |
|
42 | - * |
|
43 | - * @since 12.0.0 |
|
44 | - */ |
|
45 | - public function listen(callable $callback); |
|
33 | + /** |
|
34 | + * Start listening for update notifications |
|
35 | + * |
|
36 | + * The provided callback will be called for every incoming notification with the following parameters |
|
37 | + * - IChange|IRenameChange $change |
|
38 | + * |
|
39 | + * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback |
|
40 | + * |
|
41 | + * @param callable $callback |
|
42 | + * |
|
43 | + * @since 12.0.0 |
|
44 | + */ |
|
45 | + public function listen(callable $callback); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Get all changes detected since the start of the notify process or the last call to getChanges |
|
49 | - * |
|
50 | - * @return IChange[] |
|
51 | - * |
|
52 | - * @since 12.0.0 |
|
53 | - */ |
|
54 | - public function getChanges(); |
|
47 | + /** |
|
48 | + * Get all changes detected since the start of the notify process or the last call to getChanges |
|
49 | + * |
|
50 | + * @return IChange[] |
|
51 | + * |
|
52 | + * @since 12.0.0 |
|
53 | + */ |
|
54 | + public function getChanges(); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Stop listening for changes |
|
58 | - * |
|
59 | - * Note that any pending changes will be discarded |
|
60 | - * |
|
61 | - * @since 12.0.0 |
|
62 | - */ |
|
63 | - public function stop(); |
|
56 | + /** |
|
57 | + * Stop listening for changes |
|
58 | + * |
|
59 | + * Note that any pending changes will be discarded |
|
60 | + * |
|
61 | + * @since 12.0.0 |
|
62 | + */ |
|
63 | + public function stop(); |
|
64 | 64 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 12.0.0 |
30 | 30 | */ |
31 | 31 | interface IRenameChange extends IChange { |
32 | - /** |
|
33 | - * Get the new path of the renamed file relative to the storage root |
|
34 | - * |
|
35 | - * @return string |
|
36 | - * |
|
37 | - * @since 12.0.0 |
|
38 | - */ |
|
39 | - public function getTargetPath(); |
|
32 | + /** |
|
33 | + * Get the new path of the renamed file relative to the storage root |
|
34 | + * |
|
35 | + * @return string |
|
36 | + * |
|
37 | + * @since 12.0.0 |
|
38 | + */ |
|
39 | + public function getTargetPath(); |
|
40 | 40 | } |
@@ -30,47 +30,47 @@ |
||
30 | 30 | * @since 9.0.0 |
31 | 31 | */ |
32 | 32 | interface IUpdater { |
33 | - /** |
|
34 | - * Get the propagator for etags and mtime for the view the updater works on |
|
35 | - * |
|
36 | - * @return IPropagator |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getPropagator(); |
|
33 | + /** |
|
34 | + * Get the propagator for etags and mtime for the view the updater works on |
|
35 | + * |
|
36 | + * @return IPropagator |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getPropagator(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
43 | - * |
|
44 | - * @param string $path the path of the file to propagate the changes for |
|
45 | - * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function propagate($path, $time = null); |
|
41 | + /** |
|
42 | + * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
43 | + * |
|
44 | + * @param string $path the path of the file to propagate the changes for |
|
45 | + * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function propagate($path, $time = null); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
52 | - * |
|
53 | - * @param string $path |
|
54 | - * @param int $time |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function update($path, $time = null); |
|
50 | + /** |
|
51 | + * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
52 | + * |
|
53 | + * @param string $path |
|
54 | + * @param int $time |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function update($path, $time = null); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
61 | - * |
|
62 | - * @param string $path |
|
63 | - * @since 9.0.0 |
|
64 | - */ |
|
65 | - public function remove($path); |
|
59 | + /** |
|
60 | + * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
61 | + * |
|
62 | + * @param string $path |
|
63 | + * @since 9.0.0 |
|
64 | + */ |
|
65 | + public function remove($path); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
69 | - * |
|
70 | - * @param IStorage $sourceStorage |
|
71 | - * @param string $source |
|
72 | - * @param string $target |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
67 | + /** |
|
68 | + * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
69 | + * |
|
70 | + * @param IStorage $sourceStorage |
|
71 | + * @param string $source |
|
72 | + * @param string $target |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
76 | 76 | } |
@@ -29,17 +29,17 @@ |
||
29 | 29 | * @since 11.0.0 |
30 | 30 | */ |
31 | 31 | interface IDeletionFlagSupport { |
32 | - /** |
|
33 | - * Flag record for deletion. |
|
34 | - * @param string $uid user id |
|
35 | - * @since 11.0.0 |
|
36 | - */ |
|
37 | - public function flagRecord($uid); |
|
32 | + /** |
|
33 | + * Flag record for deletion. |
|
34 | + * @param string $uid user id |
|
35 | + * @since 11.0.0 |
|
36 | + */ |
|
37 | + public function flagRecord($uid); |
|
38 | 38 | |
39 | - /** |
|
40 | - * Unflag record for deletion. |
|
41 | - * @param string $uid user id |
|
42 | - * @since 11.0.0 |
|
43 | - */ |
|
44 | - public function unflagRecord($uid); |
|
39 | + /** |
|
40 | + * Unflag record for deletion. |
|
41 | + * @param string $uid user id |
|
42 | + * @since 11.0.0 |
|
43 | + */ |
|
44 | + public function unflagRecord($uid); |
|
45 | 45 | } |
@@ -27,12 +27,12 @@ |
||
27 | 27 | * @since 8.2.0 |
28 | 28 | */ |
29 | 29 | class AutoloadNotAllowedException extends \DomainException { |
30 | - /** |
|
31 | - * @param string $path |
|
32 | - * @since 8.2.0 |
|
33 | - */ |
|
34 | - public function __construct($path) { |
|
35 | - parent::__construct('Autoload path not allowed: '.$path); |
|
36 | - } |
|
30 | + /** |
|
31 | + * @param string $path |
|
32 | + * @since 8.2.0 |
|
33 | + */ |
|
34 | + public function __construct($path) { |
|
35 | + parent::__construct('Autoload path not allowed: '.$path); |
|
36 | + } |
|
37 | 37 | } |
38 | 38 |
@@ -25,26 +25,26 @@ |
||
25 | 25 | * @since 9.2 |
26 | 26 | */ |
27 | 27 | interface ILockdownManager { |
28 | - /** |
|
29 | - * Enable the lockdown restrictions |
|
30 | - * |
|
31 | - * @since 9.2 |
|
32 | - */ |
|
33 | - public function enable(); |
|
28 | + /** |
|
29 | + * Enable the lockdown restrictions |
|
30 | + * |
|
31 | + * @since 9.2 |
|
32 | + */ |
|
33 | + public function enable(); |
|
34 | 34 | |
35 | - /** |
|
36 | - * Set the active token to get the restrictions from and enable the lockdown |
|
37 | - * |
|
38 | - * @param IToken $token |
|
39 | - * @since 9.2 |
|
40 | - */ |
|
41 | - public function setToken(IToken $token); |
|
35 | + /** |
|
36 | + * Set the active token to get the restrictions from and enable the lockdown |
|
37 | + * |
|
38 | + * @param IToken $token |
|
39 | + * @since 9.2 |
|
40 | + */ |
|
41 | + public function setToken(IToken $token); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Check whether or not filesystem access is allowed |
|
45 | - * |
|
46 | - * @return bool |
|
47 | - * @since 9.2 |
|
48 | - */ |
|
49 | - public function canAccessFilesystem(); |
|
43 | + /** |
|
44 | + * Check whether or not filesystem access is allowed |
|
45 | + * |
|
46 | + * @return bool |
|
47 | + * @since 9.2 |
|
48 | + */ |
|
49 | + public function canAccessFilesystem(); |
|
50 | 50 | } |
@@ -31,11 +31,11 @@ |
||
31 | 31 | * @since 5.0.0 |
32 | 32 | */ |
33 | 33 | interface Share_Backend_Collection extends Share_Backend { |
34 | - /** |
|
35 | - * Get the sources of the children of the item |
|
36 | - * @param string $itemSource |
|
37 | - * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
38 | - * @since 5.0.0 |
|
39 | - */ |
|
40 | - public function getChildren($itemSource); |
|
34 | + /** |
|
35 | + * Get the sources of the children of the item |
|
36 | + * @param string $itemSource |
|
37 | + * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
38 | + * @since 5.0.0 |
|
39 | + */ |
|
40 | + public function getChildren($itemSource); |
|
41 | 41 | } |