@@ -31,24 +31,24 @@ |
||
31 | 31 | * @since 18.0.0 |
32 | 32 | */ |
33 | 33 | class FolderScannedEvent extends Event { |
34 | - /** @var string */ |
|
35 | - private $absolutePath; |
|
34 | + /** @var string */ |
|
35 | + private $absolutePath; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @param string $absolutePath |
|
39 | - * |
|
40 | - * @since 18.0.0 |
|
41 | - */ |
|
42 | - public function __construct(string $absolutePath) { |
|
43 | - parent::__construct(); |
|
44 | - $this->absolutePath = $absolutePath; |
|
45 | - } |
|
37 | + /** |
|
38 | + * @param string $absolutePath |
|
39 | + * |
|
40 | + * @since 18.0.0 |
|
41 | + */ |
|
42 | + public function __construct(string $absolutePath) { |
|
43 | + parent::__construct(); |
|
44 | + $this->absolutePath = $absolutePath; |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * @return string |
|
49 | - * @since 18.0.0 |
|
50 | - */ |
|
51 | - public function getAbsolutePath(): string { |
|
52 | - return $this->absolutePath; |
|
53 | - } |
|
47 | + /** |
|
48 | + * @return string |
|
49 | + * @since 18.0.0 |
|
50 | + */ |
|
51 | + public function getAbsolutePath(): string { |
|
52 | + return $this->absolutePath; |
|
53 | + } |
|
54 | 54 | } |
@@ -30,133 +30,133 @@ |
||
30 | 30 | * @since 24.0.0 |
31 | 31 | */ |
32 | 32 | interface ILock { |
33 | - /** |
|
34 | - * User owned manual lock |
|
35 | - * |
|
36 | - * This lock type is initiated by a user manually through the web UI or clients |
|
37 | - * and will limit editing capabilities on the file to the lock owning user. |
|
38 | - * |
|
39 | - * @since 24.0.0 |
|
40 | - */ |
|
41 | - public const TYPE_USER = 0; |
|
42 | - |
|
43 | - /** |
|
44 | - * App owned lock |
|
45 | - * |
|
46 | - * This lock type is created by collaborative apps like Text or Office to avoid |
|
47 | - * outside changes through WevDAV or other apps. |
|
48 | - * @since 24.0.0 |
|
49 | - * |
|
50 | - */ |
|
51 | - public const TYPE_APP = 1; |
|
52 | - |
|
53 | - /** |
|
54 | - * Token owned lock |
|
55 | - * |
|
56 | - * This lock type will bind the ownership to the provided lock token. Any request |
|
57 | - * that aims to modify the file will be required to sent the token, the user |
|
58 | - * itself is not able to write to files without the token. This will allow |
|
59 | - * to limit the locking to an individual client. |
|
60 | - * |
|
61 | - * @since 24.0.0 |
|
62 | - */ |
|
63 | - public const TYPE_TOKEN = 2; |
|
64 | - |
|
65 | - /** |
|
66 | - * WebDAV Lock scope exclusive |
|
67 | - * |
|
68 | - * @since 24.0.0 |
|
69 | - */ |
|
70 | - public const LOCK_EXCLUSIVE = 1; |
|
71 | - |
|
72 | - /** |
|
73 | - * WebDAV Lock scope shared |
|
74 | - * |
|
75 | - * @since 24.0.0 |
|
76 | - */ |
|
77 | - public const LOCK_SHARED = 2; |
|
78 | - |
|
79 | - /** |
|
80 | - * Lock only the resource the lock is applied to |
|
81 | - * |
|
82 | - * @since 24.0.0 |
|
83 | - */ |
|
84 | - public const LOCK_DEPTH_ZERO = 0; |
|
85 | - |
|
86 | - /** |
|
87 | - * Lock app resources under the locked one with infinite depth |
|
88 | - * |
|
89 | - * @since 24.0.0 |
|
90 | - */ |
|
91 | - public const LOCK_DEPTH_INFINITE = -1; |
|
92 | - |
|
93 | - /** |
|
94 | - * Type of the lock |
|
95 | - * |
|
96 | - * @psalm-return ILock::TYPE_* |
|
97 | - * @since 24.0.0 |
|
98 | - */ |
|
99 | - public function getType(): int; |
|
100 | - |
|
101 | - /** |
|
102 | - * Owner that holds the lock |
|
103 | - * |
|
104 | - * Depending on the lock type this is: |
|
105 | - * - ILock::TYPE_USER: A user id |
|
106 | - * - ILock::TYPE_APP: An app id |
|
107 | - * - ILock::TYPE_TOKEN: A user id |
|
108 | - * |
|
109 | - * @since 24.0.0 |
|
110 | - */ |
|
111 | - public function getOwner(): string; |
|
112 | - |
|
113 | - /** |
|
114 | - * File id that the lock is holding |
|
115 | - * |
|
116 | - * @since 24.0.0 |
|
117 | - */ |
|
118 | - public function getFileId(): int; |
|
119 | - |
|
120 | - /** |
|
121 | - * Timeout of the lock in seconds starting from the created at time |
|
122 | - * |
|
123 | - * @since 24.0.0 |
|
124 | - */ |
|
125 | - public function getTimeout(): int; |
|
126 | - |
|
127 | - /** |
|
128 | - * Unix timestamp of the lock creation time |
|
129 | - * |
|
130 | - * @since 24.0.0 |
|
131 | - */ |
|
132 | - public function getCreatedAt(): int; |
|
133 | - |
|
134 | - /** |
|
135 | - * Token string as a unique identifier for the lock, usually a UUID |
|
136 | - * |
|
137 | - * @since 24.0.0 |
|
138 | - */ |
|
139 | - public function getToken(): string; |
|
140 | - |
|
141 | - /** |
|
142 | - * Lock depth to apply the lock to child resources |
|
143 | - * |
|
144 | - * @since 24.0.0 |
|
145 | - */ |
|
146 | - public function getDepth(): int; |
|
147 | - |
|
148 | - /** |
|
149 | - * WebDAV lock scope |
|
150 | - * |
|
151 | - * @since 24.0.0 |
|
152 | - * @psalm-return ILock::LOCK_EXCLUSIVE|ILock::LOCK_SHARED |
|
153 | - */ |
|
154 | - public function getScope(): int; |
|
155 | - |
|
156 | - /** |
|
157 | - * String representation of the lock to identify it through logging |
|
158 | - * |
|
159 | - * @since 24.0.0 |
|
160 | - */ |
|
161 | - public function __toString(): string; |
|
33 | + /** |
|
34 | + * User owned manual lock |
|
35 | + * |
|
36 | + * This lock type is initiated by a user manually through the web UI or clients |
|
37 | + * and will limit editing capabilities on the file to the lock owning user. |
|
38 | + * |
|
39 | + * @since 24.0.0 |
|
40 | + */ |
|
41 | + public const TYPE_USER = 0; |
|
42 | + |
|
43 | + /** |
|
44 | + * App owned lock |
|
45 | + * |
|
46 | + * This lock type is created by collaborative apps like Text or Office to avoid |
|
47 | + * outside changes through WevDAV or other apps. |
|
48 | + * @since 24.0.0 |
|
49 | + * |
|
50 | + */ |
|
51 | + public const TYPE_APP = 1; |
|
52 | + |
|
53 | + /** |
|
54 | + * Token owned lock |
|
55 | + * |
|
56 | + * This lock type will bind the ownership to the provided lock token. Any request |
|
57 | + * that aims to modify the file will be required to sent the token, the user |
|
58 | + * itself is not able to write to files without the token. This will allow |
|
59 | + * to limit the locking to an individual client. |
|
60 | + * |
|
61 | + * @since 24.0.0 |
|
62 | + */ |
|
63 | + public const TYPE_TOKEN = 2; |
|
64 | + |
|
65 | + /** |
|
66 | + * WebDAV Lock scope exclusive |
|
67 | + * |
|
68 | + * @since 24.0.0 |
|
69 | + */ |
|
70 | + public const LOCK_EXCLUSIVE = 1; |
|
71 | + |
|
72 | + /** |
|
73 | + * WebDAV Lock scope shared |
|
74 | + * |
|
75 | + * @since 24.0.0 |
|
76 | + */ |
|
77 | + public const LOCK_SHARED = 2; |
|
78 | + |
|
79 | + /** |
|
80 | + * Lock only the resource the lock is applied to |
|
81 | + * |
|
82 | + * @since 24.0.0 |
|
83 | + */ |
|
84 | + public const LOCK_DEPTH_ZERO = 0; |
|
85 | + |
|
86 | + /** |
|
87 | + * Lock app resources under the locked one with infinite depth |
|
88 | + * |
|
89 | + * @since 24.0.0 |
|
90 | + */ |
|
91 | + public const LOCK_DEPTH_INFINITE = -1; |
|
92 | + |
|
93 | + /** |
|
94 | + * Type of the lock |
|
95 | + * |
|
96 | + * @psalm-return ILock::TYPE_* |
|
97 | + * @since 24.0.0 |
|
98 | + */ |
|
99 | + public function getType(): int; |
|
100 | + |
|
101 | + /** |
|
102 | + * Owner that holds the lock |
|
103 | + * |
|
104 | + * Depending on the lock type this is: |
|
105 | + * - ILock::TYPE_USER: A user id |
|
106 | + * - ILock::TYPE_APP: An app id |
|
107 | + * - ILock::TYPE_TOKEN: A user id |
|
108 | + * |
|
109 | + * @since 24.0.0 |
|
110 | + */ |
|
111 | + public function getOwner(): string; |
|
112 | + |
|
113 | + /** |
|
114 | + * File id that the lock is holding |
|
115 | + * |
|
116 | + * @since 24.0.0 |
|
117 | + */ |
|
118 | + public function getFileId(): int; |
|
119 | + |
|
120 | + /** |
|
121 | + * Timeout of the lock in seconds starting from the created at time |
|
122 | + * |
|
123 | + * @since 24.0.0 |
|
124 | + */ |
|
125 | + public function getTimeout(): int; |
|
126 | + |
|
127 | + /** |
|
128 | + * Unix timestamp of the lock creation time |
|
129 | + * |
|
130 | + * @since 24.0.0 |
|
131 | + */ |
|
132 | + public function getCreatedAt(): int; |
|
133 | + |
|
134 | + /** |
|
135 | + * Token string as a unique identifier for the lock, usually a UUID |
|
136 | + * |
|
137 | + * @since 24.0.0 |
|
138 | + */ |
|
139 | + public function getToken(): string; |
|
140 | + |
|
141 | + /** |
|
142 | + * Lock depth to apply the lock to child resources |
|
143 | + * |
|
144 | + * @since 24.0.0 |
|
145 | + */ |
|
146 | + public function getDepth(): int; |
|
147 | + |
|
148 | + /** |
|
149 | + * WebDAV lock scope |
|
150 | + * |
|
151 | + * @since 24.0.0 |
|
152 | + * @psalm-return ILock::LOCK_EXCLUSIVE|ILock::LOCK_SHARED |
|
153 | + */ |
|
154 | + public function getScope(): int; |
|
155 | + |
|
156 | + /** |
|
157 | + * String representation of the lock to identify it through logging |
|
158 | + * |
|
159 | + * @since 24.0.0 |
|
160 | + */ |
|
161 | + public function __toString(): string; |
|
162 | 162 | } |
@@ -32,26 +32,26 @@ |
||
32 | 32 | * @since 24.0.0 |
33 | 33 | */ |
34 | 34 | interface ILockProvider { |
35 | - /** |
|
36 | - * @throws PreConditionNotMetException |
|
37 | - * @throws NoLockProviderException |
|
38 | - * @psalm-return list<ILock> |
|
39 | - * @since 24.0.0 |
|
40 | - */ |
|
41 | - public function getLocks(int $fileId): array; |
|
35 | + /** |
|
36 | + * @throws PreConditionNotMetException |
|
37 | + * @throws NoLockProviderException |
|
38 | + * @psalm-return list<ILock> |
|
39 | + * @since 24.0.0 |
|
40 | + */ |
|
41 | + public function getLocks(int $fileId): array; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @throws PreConditionNotMetException |
|
45 | - * @throws OwnerLockedException |
|
46 | - * @throws NoLockProviderException |
|
47 | - * @since 24.0.0 |
|
48 | - */ |
|
49 | - public function lock(LockContext $lockInfo): ILock; |
|
43 | + /** |
|
44 | + * @throws PreConditionNotMetException |
|
45 | + * @throws OwnerLockedException |
|
46 | + * @throws NoLockProviderException |
|
47 | + * @since 24.0.0 |
|
48 | + */ |
|
49 | + public function lock(LockContext $lockInfo): ILock; |
|
50 | 50 | |
51 | - /** |
|
52 | - * @throws PreConditionNotMetException |
|
53 | - * @throws NoLockProviderException |
|
54 | - * @since 24.0.0 |
|
55 | - */ |
|
56 | - public function unlock(LockContext $lockInfo): void; |
|
51 | + /** |
|
52 | + * @throws PreConditionNotMetException |
|
53 | + * @throws NoLockProviderException |
|
54 | + * @since 24.0.0 |
|
55 | + */ |
|
56 | + public function unlock(LockContext $lockInfo): void; |
|
57 | 57 | } |
@@ -10,11 +10,11 @@ |
||
10 | 10 | * @since 25.0.0 |
11 | 11 | */ |
12 | 12 | interface IAppDataFactory { |
13 | - /** |
|
14 | - * Get the AppData folder for the specified $appId |
|
15 | - * @param string $appId |
|
16 | - * @return IAppData |
|
17 | - * @since 25.0.0 |
|
18 | - */ |
|
19 | - public function get(string $appId): IAppData; |
|
13 | + /** |
|
14 | + * Get the AppData folder for the specified $appId |
|
15 | + * @param string $appId |
|
16 | + * @return IAppData |
|
17 | + * @since 25.0.0 |
|
18 | + */ |
|
19 | + public function get(string $appId): IAppData; |
|
20 | 20 | } |
@@ -49,51 +49,51 @@ |
||
49 | 49 | * |
50 | 50 | */ |
51 | 51 | abstract class AFilesDocument extends IndexDocument { |
52 | - /** |
|
53 | - * Returns the owner of the document/file. |
|
54 | - * |
|
55 | - * @since 15.0.0 |
|
56 | - * |
|
57 | - * @return string |
|
58 | - */ |
|
59 | - abstract public function getOwnerId(): string; |
|
52 | + /** |
|
53 | + * Returns the owner of the document/file. |
|
54 | + * |
|
55 | + * @since 15.0.0 |
|
56 | + * |
|
57 | + * @return string |
|
58 | + */ |
|
59 | + abstract public function getOwnerId(): string; |
|
60 | 60 | |
61 | 61 | |
62 | - /** |
|
63 | - * Returns the current viewer of the document/file. |
|
64 | - * |
|
65 | - * @since 15.0.0 |
|
66 | - * |
|
67 | - * @return string |
|
68 | - */ |
|
69 | - abstract public function getViewerId(): string; |
|
62 | + /** |
|
63 | + * Returns the current viewer of the document/file. |
|
64 | + * |
|
65 | + * @since 15.0.0 |
|
66 | + * |
|
67 | + * @return string |
|
68 | + */ |
|
69 | + abstract public function getViewerId(): string; |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * Returns the type of the document/file. |
|
74 | - * |
|
75 | - * @since 15.0.0 |
|
76 | - * |
|
77 | - * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
78 | - */ |
|
79 | - abstract public function getType(): string; |
|
72 | + /** |
|
73 | + * Returns the type of the document/file. |
|
74 | + * |
|
75 | + * @since 15.0.0 |
|
76 | + * |
|
77 | + * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
78 | + */ |
|
79 | + abstract public function getType(): string; |
|
80 | 80 | |
81 | 81 | |
82 | - /** |
|
83 | - * Returns the mimetype of the document/file. |
|
84 | - * |
|
85 | - * @since 15.0.0 |
|
86 | - * |
|
87 | - * @return string |
|
88 | - */ |
|
89 | - abstract public function getMimetype(): string; |
|
82 | + /** |
|
83 | + * Returns the mimetype of the document/file. |
|
84 | + * |
|
85 | + * @since 15.0.0 |
|
86 | + * |
|
87 | + * @return string |
|
88 | + */ |
|
89 | + abstract public function getMimetype(): string; |
|
90 | 90 | |
91 | - /** |
|
92 | - * Returns the path of the document/file. |
|
93 | - * |
|
94 | - * @since 15.0.0 |
|
95 | - * |
|
96 | - * @return string |
|
97 | - */ |
|
98 | - abstract public function getPath(): string; |
|
91 | + /** |
|
92 | + * Returns the path of the document/file. |
|
93 | + * |
|
94 | + * @since 15.0.0 |
|
95 | + * |
|
96 | + * @return string |
|
97 | + */ |
|
98 | + abstract public function getPath(): string; |
|
99 | 99 | } |
@@ -30,19 +30,19 @@ |
||
30 | 30 | * @since 12.0.1 |
31 | 31 | */ |
32 | 32 | interface IConfig { |
33 | - /** |
|
34 | - * check if global scale is enabled |
|
35 | - * |
|
36 | - * @since 12.0.1 |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function isGlobalScaleEnabled(); |
|
33 | + /** |
|
34 | + * check if global scale is enabled |
|
35 | + * |
|
36 | + * @since 12.0.1 |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function isGlobalScaleEnabled(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * check if federation should only be used internally in a global scale setup |
|
43 | - * |
|
44 | - * @since 12.0.1 |
|
45 | - * @return bool |
|
46 | - */ |
|
47 | - public function onlyInternalFederation(); |
|
41 | + /** |
|
42 | + * check if federation should only be used internally in a global scale setup |
|
43 | + * |
|
44 | + * @since 12.0.1 |
|
45 | + * @return bool |
|
46 | + */ |
|
47 | + public function onlyInternalFederation(); |
|
48 | 48 | } |
@@ -35,17 +35,17 @@ |
||
35 | 35 | * @since 12.0.0 |
36 | 36 | */ |
37 | 37 | interface IDiscoveryService { |
38 | - /** |
|
39 | - * Discover OCS end-points |
|
40 | - * |
|
41 | - * If no valid discovery data is found the defaults are returned |
|
42 | - * |
|
43 | - * @since 12.0.0 |
|
44 | - * |
|
45 | - * @param string $remote |
|
46 | - * @param string $service the service you want to discover |
|
47 | - * @param bool $skipCache We won't check if the data is in the cache. This is useful if a background job is updating the status - Added in 14.0.0 |
|
48 | - * @return array |
|
49 | - */ |
|
50 | - public function discover(string $remote, string $service, bool $skipCache = false): array; |
|
38 | + /** |
|
39 | + * Discover OCS end-points |
|
40 | + * |
|
41 | + * If no valid discovery data is found the defaults are returned |
|
42 | + * |
|
43 | + * @since 12.0.0 |
|
44 | + * |
|
45 | + * @param string $remote |
|
46 | + * @param string $service the service you want to discover |
|
47 | + * @param bool $skipCache We won't check if the data is in the cache. This is useful if a background job is updating the status - Added in 14.0.0 |
|
48 | + * @return array |
|
49 | + */ |
|
50 | + public function discover(string $remote, string $service, bool $skipCache = false): array; |
|
51 | 51 | } |
@@ -36,39 +36,39 @@ |
||
36 | 36 | * @since 26.0.0 |
37 | 37 | */ |
38 | 38 | final class AutoSubmitted { |
39 | - /** |
|
40 | - * Name of the Header as used in the final message later |
|
41 | - * |
|
42 | - * @var string |
|
43 | - * @since 26.0.0 |
|
44 | - */ |
|
45 | - public const HEADER = 'Auto-Submitted'; |
|
39 | + /** |
|
40 | + * Name of the Header as used in the final message later |
|
41 | + * |
|
42 | + * @var string |
|
43 | + * @since 26.0.0 |
|
44 | + */ |
|
45 | + public const HEADER = 'Auto-Submitted'; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Indicates that a message was NOT automatically generated, but was |
|
49 | - * created by a human (or following human interaction). It is the equivalent |
|
50 | - * to the absence of an Auto-Submitted header altogether. |
|
51 | - * |
|
52 | - * @var string |
|
53 | - * @since 26.0.0 |
|
54 | - */ |
|
55 | - public const VALUE_NO = 'no'; |
|
47 | + /** |
|
48 | + * Indicates that a message was NOT automatically generated, but was |
|
49 | + * created by a human (or following human interaction). It is the equivalent |
|
50 | + * to the absence of an Auto-Submitted header altogether. |
|
51 | + * |
|
52 | + * @var string |
|
53 | + * @since 26.0.0 |
|
54 | + */ |
|
55 | + public const VALUE_NO = 'no'; |
|
56 | 56 | |
57 | - /** |
|
58 | - * Indicates that a message was generated by an automatic process, and is |
|
59 | - * not a direct response to another message |
|
60 | - * |
|
61 | - * @var string |
|
62 | - * @since 26.0.0 |
|
63 | - */ |
|
64 | - public const VALUE_AUTO_GENERATED = 'auto-generated'; |
|
57 | + /** |
|
58 | + * Indicates that a message was generated by an automatic process, and is |
|
59 | + * not a direct response to another message |
|
60 | + * |
|
61 | + * @var string |
|
62 | + * @since 26.0.0 |
|
63 | + */ |
|
64 | + public const VALUE_AUTO_GENERATED = 'auto-generated'; |
|
65 | 65 | |
66 | - /** |
|
67 | - * Indicates that a message was automatically generated as a direct response |
|
68 | - * to another message. |
|
69 | - * |
|
70 | - * @var string |
|
71 | - * @since 26.0.0 |
|
72 | - */ |
|
73 | - public const VALUE_AUTO_REPLIED = 'auto-replied'; |
|
66 | + /** |
|
67 | + * Indicates that a message was automatically generated as a direct response |
|
68 | + * to another message. |
|
69 | + * |
|
70 | + * @var string |
|
71 | + * @since 26.0.0 |
|
72 | + */ |
|
73 | + public const VALUE_AUTO_REPLIED = 'auto-replied'; |
|
74 | 74 | } |
@@ -35,23 +35,23 @@ |
||
35 | 35 | * @since 19.0.0 |
36 | 36 | */ |
37 | 37 | class BeforeMessageSent extends Event { |
38 | - /** @var IMessage */ |
|
39 | - private $message; |
|
38 | + /** @var IMessage */ |
|
39 | + private $message; |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param IMessage $message |
|
43 | - * @since 19.0.0 |
|
44 | - */ |
|
45 | - public function __construct(IMessage $message) { |
|
46 | - parent::__construct(); |
|
47 | - $this->message = $message; |
|
48 | - } |
|
41 | + /** |
|
42 | + * @param IMessage $message |
|
43 | + * @since 19.0.0 |
|
44 | + */ |
|
45 | + public function __construct(IMessage $message) { |
|
46 | + parent::__construct(); |
|
47 | + $this->message = $message; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * @return IMessage |
|
52 | - * @since 19.0.0 |
|
53 | - */ |
|
54 | - public function getMessage(): IMessage { |
|
55 | - return $this->message; |
|
56 | - } |
|
50 | + /** |
|
51 | + * @return IMessage |
|
52 | + * @since 19.0.0 |
|
53 | + */ |
|
54 | + public function getMessage(): IMessage { |
|
55 | + return $this->message; |
|
56 | + } |
|
57 | 57 | } |