@@ -31,88 +31,88 @@ |
||
| 31 | 31 | * @since 7.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IRoute { |
| 34 | - /** |
|
| 35 | - * Specify PATCH as the method to use with this route |
|
| 36 | - * @return \OCP\Route\IRoute |
|
| 37 | - * @since 7.0.0 |
|
| 38 | - */ |
|
| 39 | - public function patch(); |
|
| 34 | + /** |
|
| 35 | + * Specify PATCH as the method to use with this route |
|
| 36 | + * @return \OCP\Route\IRoute |
|
| 37 | + * @since 7.0.0 |
|
| 38 | + */ |
|
| 39 | + public function patch(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Specify the method when this route is to be used |
|
| 43 | - * |
|
| 44 | - * @param string $method HTTP method (uppercase) |
|
| 45 | - * @return \OCP\Route\IRoute |
|
| 46 | - * @since 7.0.0 |
|
| 47 | - */ |
|
| 48 | - public function method($method); |
|
| 41 | + /** |
|
| 42 | + * Specify the method when this route is to be used |
|
| 43 | + * |
|
| 44 | + * @param string $method HTTP method (uppercase) |
|
| 45 | + * @return \OCP\Route\IRoute |
|
| 46 | + * @since 7.0.0 |
|
| 47 | + */ |
|
| 48 | + public function method($method); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The action to execute when this route matches, includes a file like |
|
| 52 | - * it is called directly |
|
| 53 | - * |
|
| 54 | - * @param string $file |
|
| 55 | - * @return void |
|
| 56 | - * @since 7.0.0 |
|
| 57 | - */ |
|
| 58 | - public function actionInclude($file); |
|
| 50 | + /** |
|
| 51 | + * The action to execute when this route matches, includes a file like |
|
| 52 | + * it is called directly |
|
| 53 | + * |
|
| 54 | + * @param string $file |
|
| 55 | + * @return void |
|
| 56 | + * @since 7.0.0 |
|
| 57 | + */ |
|
| 58 | + public function actionInclude($file); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Specify GET as the method to use with this route |
|
| 62 | - * @return \OCP\Route\IRoute |
|
| 63 | - * @since 7.0.0 |
|
| 64 | - */ |
|
| 65 | - public function get(); |
|
| 60 | + /** |
|
| 61 | + * Specify GET as the method to use with this route |
|
| 62 | + * @return \OCP\Route\IRoute |
|
| 63 | + * @since 7.0.0 |
|
| 64 | + */ |
|
| 65 | + public function get(); |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Specify POST as the method to use with this route |
|
| 69 | - * @return \OCP\Route\IRoute |
|
| 70 | - * @since 7.0.0 |
|
| 71 | - */ |
|
| 72 | - public function post(); |
|
| 67 | + /** |
|
| 68 | + * Specify POST as the method to use with this route |
|
| 69 | + * @return \OCP\Route\IRoute |
|
| 70 | + * @since 7.0.0 |
|
| 71 | + */ |
|
| 72 | + public function post(); |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Specify DELETE as the method to use with this route |
|
| 76 | - * @return \OCP\Route\IRoute |
|
| 77 | - * @since 7.0.0 |
|
| 78 | - */ |
|
| 79 | - public function delete(); |
|
| 74 | + /** |
|
| 75 | + * Specify DELETE as the method to use with this route |
|
| 76 | + * @return \OCP\Route\IRoute |
|
| 77 | + * @since 7.0.0 |
|
| 78 | + */ |
|
| 79 | + public function delete(); |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * The action to execute when this route matches |
|
| 83 | - * |
|
| 84 | - * @param string|callable $class the class or a callable |
|
| 85 | - * @param string $function the function to use with the class |
|
| 86 | - * @return \OCP\Route\IRoute |
|
| 87 | - * |
|
| 88 | - * This function is called with $class set to a callable or |
|
| 89 | - * to the class with $function |
|
| 90 | - * @since 7.0.0 |
|
| 91 | - */ |
|
| 92 | - public function action($class, $function = null); |
|
| 81 | + /** |
|
| 82 | + * The action to execute when this route matches |
|
| 83 | + * |
|
| 84 | + * @param string|callable $class the class or a callable |
|
| 85 | + * @param string $function the function to use with the class |
|
| 86 | + * @return \OCP\Route\IRoute |
|
| 87 | + * |
|
| 88 | + * This function is called with $class set to a callable or |
|
| 89 | + * to the class with $function |
|
| 90 | + * @since 7.0.0 |
|
| 91 | + */ |
|
| 92 | + public function action($class, $function = null); |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Defaults to use for this route |
|
| 96 | - * |
|
| 97 | - * @param array $defaults The defaults |
|
| 98 | - * @return \OCP\Route\IRoute |
|
| 99 | - * @since 7.0.0 |
|
| 100 | - */ |
|
| 101 | - public function defaults($defaults); |
|
| 94 | + /** |
|
| 95 | + * Defaults to use for this route |
|
| 96 | + * |
|
| 97 | + * @param array $defaults The defaults |
|
| 98 | + * @return \OCP\Route\IRoute |
|
| 99 | + * @since 7.0.0 |
|
| 100 | + */ |
|
| 101 | + public function defaults($defaults); |
|
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Requirements for this route |
|
| 105 | - * |
|
| 106 | - * @param array $requirements The requirements |
|
| 107 | - * @return \OCP\Route\IRoute |
|
| 108 | - * @since 7.0.0 |
|
| 109 | - */ |
|
| 110 | - public function requirements($requirements); |
|
| 103 | + /** |
|
| 104 | + * Requirements for this route |
|
| 105 | + * |
|
| 106 | + * @param array $requirements The requirements |
|
| 107 | + * @return \OCP\Route\IRoute |
|
| 108 | + * @since 7.0.0 |
|
| 109 | + */ |
|
| 110 | + public function requirements($requirements); |
|
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Specify PUT as the method to use with this route |
|
| 114 | - * @return \OCP\Route\IRoute |
|
| 115 | - * @since 7.0.0 |
|
| 116 | - */ |
|
| 117 | - public function put(); |
|
| 112 | + /** |
|
| 113 | + * Specify PUT as the method to use with this route |
|
| 114 | + * @return \OCP\Route\IRoute |
|
| 115 | + * @since 7.0.0 |
|
| 116 | + */ |
|
| 117 | + public function put(); |
|
| 118 | 118 | } |
@@ -30,9 +30,9 @@ |
||
| 30 | 30 | * @since 8.1.0 |
| 31 | 31 | */ |
| 32 | 32 | interface ICommand { |
| 33 | - /** |
|
| 34 | - * Run the command |
|
| 35 | - * @since 8.1.0 |
|
| 36 | - */ |
|
| 37 | - public function handle(); |
|
| 33 | + /** |
|
| 34 | + * Run the command |
|
| 35 | + * @since 8.1.0 |
|
| 36 | + */ |
|
| 37 | + public function handle(); |
|
| 38 | 38 | } |
@@ -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 | } |