@@ -30,19 +30,19 @@ |
||
| 30 | 30 | * @since 8.1.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IBus { |
| 33 | - /** |
|
| 34 | - * Schedule a command to be fired |
|
| 35 | - * |
|
| 36 | - * @param \OCP\Command\ICommand | callable $command |
|
| 37 | - * @since 8.1.0 |
|
| 38 | - */ |
|
| 39 | - public function push($command); |
|
| 33 | + /** |
|
| 34 | + * Schedule a command to be fired |
|
| 35 | + * |
|
| 36 | + * @param \OCP\Command\ICommand | callable $command |
|
| 37 | + * @since 8.1.0 |
|
| 38 | + */ |
|
| 39 | + public function push($command); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Require all commands using a trait to be run synchronous |
|
| 43 | - * |
|
| 44 | - * @param string $trait |
|
| 45 | - * @since 8.1.0 |
|
| 46 | - */ |
|
| 47 | - public function requireSync($trait); |
|
| 41 | + /** |
|
| 42 | + * Require all commands using a trait to be run synchronous |
|
| 43 | + * |
|
| 44 | + * @param string $trait |
|
| 45 | + * @since 8.1.0 |
|
| 46 | + */ |
|
| 47 | + public function requireSync($trait); |
|
| 48 | 48 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 5.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface Share_Backend_File_Dependent extends Share_Backend { |
| 34 | - /** |
|
| 35 | - * Get the file path of the item |
|
| 36 | - * @param string $itemSource |
|
| 37 | - * @param string $uidOwner User that is the owner of shared item |
|
| 38 | - * @return string|false |
|
| 39 | - * @since 5.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getFilePath($itemSource, $uidOwner); |
|
| 34 | + /** |
|
| 35 | + * Get the file path of the item |
|
| 36 | + * @param string $itemSource |
|
| 37 | + * @param string $uidOwner User that is the owner of shared item |
|
| 38 | + * @return string|false |
|
| 39 | + * @since 5.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getFilePath($itemSource, $uidOwner); |
|
| 42 | 42 | |
| 43 | 43 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IMountProvider { |
| 34 | - /** |
|
| 35 | - * Get all mountpoints applicable for the user |
|
| 36 | - * |
|
| 37 | - * @param \OCP\IUser $user |
|
| 38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
| 40 | - * @since 8.0.0 |
|
| 41 | - */ |
|
| 42 | - public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
| 34 | + /** |
|
| 35 | + * Get all mountpoints applicable for the user |
|
| 36 | + * |
|
| 37 | + * @param \OCP\IUser $user |
|
| 38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
| 40 | + * @since 8.0.0 |
|
| 41 | + */ |
|
| 42 | + public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
| 43 | 43 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 9.1.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IHomeMountProvider { |
| 34 | - /** |
|
| 35 | - * Get all mountpoints applicable for the user |
|
| 36 | - * |
|
| 37 | - * @param \OCP\IUser $user |
|
| 38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | - * @return \OCP\Files\Mount\IMountPoint|null |
|
| 40 | - * @since 9.1.0 |
|
| 41 | - */ |
|
| 42 | - public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
| 34 | + /** |
|
| 35 | + * Get all mountpoints applicable for the user |
|
| 36 | + * |
|
| 37 | + * @param \OCP\IUser $user |
|
| 38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
| 39 | + * @return \OCP\Files\Mount\IMountPoint|null |
|
| 40 | + * @since 9.1.0 |
|
| 41 | + */ |
|
| 42 | + public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
| 43 | 43 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |