@@ -36,12 +36,12 @@ |
||
| 36 | 36 | */ |
| 37 | 37 | interface ICapability { |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Function an app uses to return the capabilities |
|
| 41 | - * |
|
| 42 | - * @return array Array containing the apps capabilities |
|
| 43 | - * @since 8.2.0 |
|
| 44 | - */ |
|
| 45 | - public function getCapabilities(); |
|
| 39 | + /** |
|
| 40 | + * Function an app uses to return the capabilities |
|
| 41 | + * |
|
| 42 | + * @return array Array containing the apps capabilities |
|
| 43 | + * @since 8.2.0 |
|
| 44 | + */ |
|
| 45 | + public function getCapabilities(); |
|
| 46 | 46 | } |
| 47 | 47 | |
@@ -28,22 +28,22 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | interface IRepairStep { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Returns the step's name |
|
| 33 | - * |
|
| 34 | - * @return string |
|
| 35 | - * @since 9.1.0 |
|
| 36 | - */ |
|
| 37 | - public function getName(); |
|
| 31 | + /** |
|
| 32 | + * Returns the step's name |
|
| 33 | + * |
|
| 34 | + * @return string |
|
| 35 | + * @since 9.1.0 |
|
| 36 | + */ |
|
| 37 | + public function getName(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Run repair step. |
|
| 41 | - * Must throw exception on error. |
|
| 42 | - * |
|
| 43 | - * @param IOutput $output |
|
| 44 | - * @throws \Exception in case of failure |
|
| 45 | - * @since 9.1.0 |
|
| 46 | - */ |
|
| 47 | - public function run(IOutput $output); |
|
| 39 | + /** |
|
| 40 | + * Run repair step. |
|
| 41 | + * Must throw exception on error. |
|
| 42 | + * |
|
| 43 | + * @param IOutput $output |
|
| 44 | + * @throws \Exception in case of failure |
|
| 45 | + * @since 9.1.0 |
|
| 46 | + */ |
|
| 47 | + public function run(IOutput $output); |
|
| 48 | 48 | |
| 49 | 49 | } |
@@ -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 | } |
@@ -30,13 +30,13 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class SabrePluginException extends Exception { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Returns the HTTP statuscode for this exception |
|
| 35 | - * |
|
| 36 | - * @return int |
|
| 37 | - * @since 8.2.0 |
|
| 38 | - */ |
|
| 39 | - public function getHTTPCode() { |
|
| 40 | - return $this->code; |
|
| 41 | - } |
|
| 33 | + /** |
|
| 34 | + * Returns the HTTP statuscode for this exception |
|
| 35 | + * |
|
| 36 | + * @return int |
|
| 37 | + * @since 8.2.0 |
|
| 38 | + */ |
|
| 39 | + public function getHTTPCode() { |
|
| 40 | + return $this->code; |
|
| 41 | + } |
|
| 42 | 42 | } |
@@ -33,65 +33,65 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | interface Share_Backend { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Check if this $itemSource exist for the user |
|
| 38 | - * @param string $itemSource |
|
| 39 | - * @param string $uidOwner Owner of the item |
|
| 40 | - * @return boolean|null Source |
|
| 41 | - * |
|
| 42 | - * Return false if the item does not exist for the user |
|
| 43 | - * @since 5.0.0 |
|
| 44 | - */ |
|
| 45 | - public function isValidSource($itemSource, $uidOwner); |
|
| 36 | + /** |
|
| 37 | + * Check if this $itemSource exist for the user |
|
| 38 | + * @param string $itemSource |
|
| 39 | + * @param string $uidOwner Owner of the item |
|
| 40 | + * @return boolean|null Source |
|
| 41 | + * |
|
| 42 | + * Return false if the item does not exist for the user |
|
| 43 | + * @since 5.0.0 |
|
| 44 | + */ |
|
| 45 | + public function isValidSource($itemSource, $uidOwner); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Get a unique name of the item for the specified user |
|
| 49 | - * @param string $itemSource |
|
| 50 | - * @param string|false $shareWith User the item is being shared with |
|
| 51 | - * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7 |
|
| 52 | - * @return string Target name |
|
| 53 | - * |
|
| 54 | - * This function needs to verify that the user does not already have an item with this name. |
|
| 55 | - * If it does generate a new name e.g. name_# |
|
| 56 | - * @since 5.0.0 |
|
| 57 | - */ |
|
| 58 | - public function generateTarget($itemSource, $shareWith, $exclude = null); |
|
| 47 | + /** |
|
| 48 | + * Get a unique name of the item for the specified user |
|
| 49 | + * @param string $itemSource |
|
| 50 | + * @param string|false $shareWith User the item is being shared with |
|
| 51 | + * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7 |
|
| 52 | + * @return string Target name |
|
| 53 | + * |
|
| 54 | + * This function needs to verify that the user does not already have an item with this name. |
|
| 55 | + * If it does generate a new name e.g. name_# |
|
| 56 | + * @since 5.0.0 |
|
| 57 | + */ |
|
| 58 | + public function generateTarget($itemSource, $shareWith, $exclude = null); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Converts the shared item sources back into the item in the specified format |
|
| 62 | - * @param array $items Shared items |
|
| 63 | - * @param int $format |
|
| 64 | - * @return array |
|
| 65 | - * |
|
| 66 | - * The items array is a 3-dimensional array with the item_source as the |
|
| 67 | - * first key and the share id as the second key to an array with the share |
|
| 68 | - * info. |
|
| 69 | - * |
|
| 70 | - * The key/value pairs included in the share info depend on the function originally called: |
|
| 71 | - * If called by getItem(s)Shared: id, item_type, item, item_source, |
|
| 72 | - * share_type, share_with, permissions, stime, file_source |
|
| 73 | - * |
|
| 74 | - * If called by getItem(s)SharedWith: id, item_type, item, item_source, |
|
| 75 | - * item_target, share_type, share_with, permissions, stime, file_source, |
|
| 76 | - * file_target |
|
| 77 | - * |
|
| 78 | - * This function allows the backend to control the output of shared items with custom formats. |
|
| 79 | - * It is only called through calls to the public getItem(s)Shared(With) functions. |
|
| 80 | - * @since 5.0.0 |
|
| 81 | - */ |
|
| 82 | - public function formatItems($items, $format, $parameters = null); |
|
| 60 | + /** |
|
| 61 | + * Converts the shared item sources back into the item in the specified format |
|
| 62 | + * @param array $items Shared items |
|
| 63 | + * @param int $format |
|
| 64 | + * @return array |
|
| 65 | + * |
|
| 66 | + * The items array is a 3-dimensional array with the item_source as the |
|
| 67 | + * first key and the share id as the second key to an array with the share |
|
| 68 | + * info. |
|
| 69 | + * |
|
| 70 | + * The key/value pairs included in the share info depend on the function originally called: |
|
| 71 | + * If called by getItem(s)Shared: id, item_type, item, item_source, |
|
| 72 | + * share_type, share_with, permissions, stime, file_source |
|
| 73 | + * |
|
| 74 | + * If called by getItem(s)SharedWith: id, item_type, item, item_source, |
|
| 75 | + * item_target, share_type, share_with, permissions, stime, file_source, |
|
| 76 | + * file_target |
|
| 77 | + * |
|
| 78 | + * This function allows the backend to control the output of shared items with custom formats. |
|
| 79 | + * It is only called through calls to the public getItem(s)Shared(With) functions. |
|
| 80 | + * @since 5.0.0 |
|
| 81 | + */ |
|
| 82 | + public function formatItems($items, $format, $parameters = null); |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Check if a given share type is allowd by the back-end |
|
| 86 | - * |
|
| 87 | - * @param int $shareType share type |
|
| 88 | - * @return boolean |
|
| 89 | - * |
|
| 90 | - * The back-end can enable/disable specific share types. Just return true if |
|
| 91 | - * the back-end doesn't provide any specific settings for it and want to allow |
|
| 92 | - * all share types defined by the share API |
|
| 93 | - * @since 8.0.0 |
|
| 94 | - */ |
|
| 95 | - public function isShareTypeAllowed($shareType); |
|
| 84 | + /** |
|
| 85 | + * Check if a given share type is allowd by the back-end |
|
| 86 | + * |
|
| 87 | + * @param int $shareType share type |
|
| 88 | + * @return boolean |
|
| 89 | + * |
|
| 90 | + * The back-end can enable/disable specific share types. Just return true if |
|
| 91 | + * the back-end doesn't provide any specific settings for it and want to allow |
|
| 92 | + * all share types defined by the share API |
|
| 93 | + * @since 8.0.0 |
|
| 94 | + */ |
|
| 95 | + public function isShareTypeAllowed($shareType); |
|
| 96 | 96 | |
| 97 | 97 | } |
@@ -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 | } |