@@ -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 | } |
@@ -30,25 +30,25 @@ |
||
30 | 30 | */ |
31 | 31 | interface ISettings { |
32 | 32 | |
33 | - /** |
|
34 | - * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | - * @since 9.1 |
|
36 | - */ |
|
37 | - public function getForm(); |
|
33 | + /** |
|
34 | + * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | + * @since 9.1 |
|
36 | + */ |
|
37 | + public function getForm(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string the section ID, e.g. 'sharing' |
|
41 | - * @since 9.1 |
|
42 | - */ |
|
43 | - public function getSection(); |
|
39 | + /** |
|
40 | + * @return string the section ID, e.g. 'sharing' |
|
41 | + * @since 9.1 |
|
42 | + */ |
|
43 | + public function getSection(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return int whether the form should be rather on the top or bottom of |
|
47 | - * the admin section. The forms are arranged in ascending order of the |
|
48 | - * priority values. It is required to return a value between 0 and 100. |
|
49 | - * |
|
50 | - * E.g.: 70 |
|
51 | - * @since 9.1 |
|
52 | - */ |
|
53 | - public function getPriority(); |
|
45 | + /** |
|
46 | + * @return int whether the form should be rather on the top or bottom of |
|
47 | + * the admin section. The forms are arranged in ascending order of the |
|
48 | + * priority values. It is required to return a value between 0 and 100. |
|
49 | + * |
|
50 | + * E.g.: 70 |
|
51 | + * @since 9.1 |
|
52 | + */ |
|
53 | + public function getPriority(); |
|
54 | 54 | } |
@@ -28,31 +28,31 @@ |
||
28 | 28 | * @since 9.1 |
29 | 29 | */ |
30 | 30 | interface ISection { |
31 | - /** |
|
32 | - * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | - * e.g. 'ldap' |
|
34 | - * |
|
35 | - * @returns string |
|
36 | - * @since 9.1 |
|
37 | - */ |
|
38 | - public function getID(); |
|
31 | + /** |
|
32 | + * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | + * e.g. 'ldap' |
|
34 | + * |
|
35 | + * @returns string |
|
36 | + * @since 9.1 |
|
37 | + */ |
|
38 | + public function getID(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | - * integration'. Use the L10N service to translate it. |
|
43 | - * |
|
44 | - * @return string |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function getName(); |
|
40 | + /** |
|
41 | + * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | + * integration'. Use the L10N service to translate it. |
|
43 | + * |
|
44 | + * @return string |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function getName(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @return int whether the form should be rather on the top or bottom of |
|
51 | - * the settings navigation. The sections are arranged in ascending order of |
|
52 | - * the priority values. It is required to return a value between 0 and 99. |
|
53 | - * |
|
54 | - * E.g.: 70 |
|
55 | - * @since 9.1 |
|
56 | - */ |
|
57 | - public function getPriority(); |
|
49 | + /** |
|
50 | + * @return int whether the form should be rather on the top or bottom of |
|
51 | + * the settings navigation. The sections are arranged in ascending order of |
|
52 | + * the priority values. It is required to return a value between 0 and 99. |
|
53 | + * |
|
54 | + * E.g.: 70 |
|
55 | + * @since 9.1 |
|
56 | + */ |
|
57 | + public function getPriority(); |
|
58 | 58 | } |
@@ -27,12 +27,12 @@ |
||
27 | 27 | * @since 12 |
28 | 28 | */ |
29 | 29 | interface IIconSection extends ISection { |
30 | - /** |
|
31 | - * returns the relative path to an 16*16 icon describing the section. |
|
32 | - * e.g. '/core/img/places/files.svg' |
|
33 | - * |
|
34 | - * @returns string |
|
35 | - * @since 12 |
|
36 | - */ |
|
37 | - public function getIcon(); |
|
30 | + /** |
|
31 | + * returns the relative path to an 16*16 icon describing the section. |
|
32 | + * e.g. '/core/img/places/files.svg' |
|
33 | + * |
|
34 | + * @returns string |
|
35 | + * @since 12 |
|
36 | + */ |
|
37 | + public function getIcon(); |
|
38 | 38 | } |
@@ -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 | } |
@@ -58,20 +58,20 @@ |
||
58 | 58 | * @since 8.0.0 |
59 | 59 | */ |
60 | 60 | class Constants { |
61 | - /** |
|
62 | - * CRUDS permissions. |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - const PERMISSION_CREATE = 4; |
|
66 | - const PERMISSION_READ = 1; |
|
67 | - const PERMISSION_UPDATE = 2; |
|
68 | - const PERMISSION_DELETE = 8; |
|
69 | - const PERMISSION_SHARE = 16; |
|
70 | - const PERMISSION_ALL = 31; |
|
61 | + /** |
|
62 | + * CRUDS permissions. |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + const PERMISSION_CREATE = 4; |
|
66 | + const PERMISSION_READ = 1; |
|
67 | + const PERMISSION_UPDATE = 2; |
|
68 | + const PERMISSION_DELETE = 8; |
|
69 | + const PERMISSION_SHARE = 16; |
|
70 | + const PERMISSION_ALL = 31; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no |
|
74 | - * longer support windows as server platform. |
|
75 | - */ |
|
76 | - const FILENAME_INVALID_CHARS = "\\/"; |
|
72 | + /** |
|
73 | + * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no |
|
74 | + * longer support windows as server platform. |
|
75 | + */ |
|
76 | + const FILENAME_INVALID_CHARS = "\\/"; |
|
77 | 77 | } |
@@ -34,46 +34,46 @@ |
||
34 | 34 | **/ |
35 | 35 | interface IMimeTypeDetector { |
36 | 36 | |
37 | - /** |
|
38 | - * detect mimetype only based on filename, content of file is not used |
|
39 | - * @param string $path |
|
40 | - * @return string |
|
41 | - * @since 8.2.0 |
|
42 | - **/ |
|
43 | - public function detectPath($path); |
|
37 | + /** |
|
38 | + * detect mimetype only based on filename, content of file is not used |
|
39 | + * @param string $path |
|
40 | + * @return string |
|
41 | + * @since 8.2.0 |
|
42 | + **/ |
|
43 | + public function detectPath($path); |
|
44 | 44 | |
45 | - /** |
|
46 | - * detect mimetype based on both filename and content |
|
47 | - * |
|
48 | - * @param string $path |
|
49 | - * @return string |
|
50 | - * @since 8.2.0 |
|
51 | - */ |
|
52 | - public function detect($path); |
|
45 | + /** |
|
46 | + * detect mimetype based on both filename and content |
|
47 | + * |
|
48 | + * @param string $path |
|
49 | + * @return string |
|
50 | + * @since 8.2.0 |
|
51 | + */ |
|
52 | + public function detect($path); |
|
53 | 53 | |
54 | - /** |
|
55 | - * Get a secure mimetype that won't expose potential XSS. |
|
56 | - * |
|
57 | - * @param string $mimeType |
|
58 | - * @return string |
|
59 | - * @since 8.2.0 |
|
60 | - */ |
|
61 | - public function getSecureMimeType($mimeType); |
|
54 | + /** |
|
55 | + * Get a secure mimetype that won't expose potential XSS. |
|
56 | + * |
|
57 | + * @param string $mimeType |
|
58 | + * @return string |
|
59 | + * @since 8.2.0 |
|
60 | + */ |
|
61 | + public function getSecureMimeType($mimeType); |
|
62 | 62 | |
63 | - /** |
|
64 | - * detect mimetype based on the content of a string |
|
65 | - * |
|
66 | - * @param string $data |
|
67 | - * @return string |
|
68 | - * @since 8.2.0 |
|
69 | - */ |
|
70 | - public function detectString($data); |
|
63 | + /** |
|
64 | + * detect mimetype based on the content of a string |
|
65 | + * |
|
66 | + * @param string $data |
|
67 | + * @return string |
|
68 | + * @since 8.2.0 |
|
69 | + */ |
|
70 | + public function detectString($data); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get path to the icon of a file type |
|
74 | - * @param string $mimeType the MIME type |
|
75 | - * @return string the url |
|
76 | - * @since 8.2.0 |
|
77 | - */ |
|
78 | - public function mimeTypeIcon($mimeType); |
|
72 | + /** |
|
73 | + * Get path to the icon of a file type |
|
74 | + * @param string $mimeType the MIME type |
|
75 | + * @return string the url |
|
76 | + * @since 8.2.0 |
|
77 | + */ |
|
78 | + public function mimeTypeIcon($mimeType); |
|
79 | 79 | } |
@@ -31,49 +31,49 @@ |
||
31 | 31 | * @since 9.0.0 |
32 | 32 | */ |
33 | 33 | interface ICachedMountInfo { |
34 | - /** |
|
35 | - * @return IUser |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function getUser(); |
|
34 | + /** |
|
35 | + * @return IUser |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function getUser(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return int the numeric storage id of the mount |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function getStorageId(); |
|
40 | + /** |
|
41 | + * @return int the numeric storage id of the mount |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function getStorageId(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return int the fileid of the root of the mount |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function getRootId(); |
|
46 | + /** |
|
47 | + * @return int the fileid of the root of the mount |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function getRootId(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return Node the root node of the mount |
|
54 | - * @since 9.0.0 |
|
55 | - */ |
|
56 | - public function getMountPointNode(); |
|
52 | + /** |
|
53 | + * @return Node the root node of the mount |
|
54 | + * @since 9.0.0 |
|
55 | + */ |
|
56 | + public function getMountPointNode(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return string the mount point of the mount for the user |
|
60 | - * @since 9.0.0 |
|
61 | - */ |
|
62 | - public function getMountPoint(); |
|
58 | + /** |
|
59 | + * @return string the mount point of the mount for the user |
|
60 | + * @since 9.0.0 |
|
61 | + */ |
|
62 | + public function getMountPoint(); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the id of the configured mount |
|
66 | - * |
|
67 | - * @return int|null mount id or null if not applicable |
|
68 | - * @since 9.1.0 |
|
69 | - */ |
|
70 | - public function getMountId(); |
|
64 | + /** |
|
65 | + * Get the id of the configured mount |
|
66 | + * |
|
67 | + * @return int|null mount id or null if not applicable |
|
68 | + * @since 9.1.0 |
|
69 | + */ |
|
70 | + public function getMountId(); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get the internal path (within the storage) of the root of the mount |
|
74 | - * |
|
75 | - * @return string |
|
76 | - * @since 11.0.0 |
|
77 | - */ |
|
78 | - public function getRootInternalPath(); |
|
72 | + /** |
|
73 | + * Get the internal path (within the storage) of the root of the mount |
|
74 | + * |
|
75 | + * @return string |
|
76 | + * @since 11.0.0 |
|
77 | + */ |
|
78 | + public function getRootInternalPath(); |
|
79 | 79 | } |
@@ -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 | } |