@@ -29,28 +29,28 @@ |
||
29 | 29 | * @since 12.0.0 |
30 | 30 | */ |
31 | 31 | interface IChange { |
32 | - const ADDED = 1; |
|
33 | - const REMOVED = 2; |
|
34 | - const MODIFIED = 3; |
|
35 | - const RENAMED = 4; |
|
32 | + const ADDED = 1; |
|
33 | + const REMOVED = 2; |
|
34 | + const MODIFIED = 3; |
|
35 | + const RENAMED = 4; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Get the type of the change |
|
39 | - * |
|
40 | - * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED |
|
41 | - * |
|
42 | - * @since 12.0.0 |
|
43 | - */ |
|
44 | - public function getType(); |
|
37 | + /** |
|
38 | + * Get the type of the change |
|
39 | + * |
|
40 | + * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED |
|
41 | + * |
|
42 | + * @since 12.0.0 |
|
43 | + */ |
|
44 | + public function getType(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Get the path of the file that was changed relative to the root of the storage |
|
48 | - * |
|
49 | - * Note, for rename changes this path is the old path for the file |
|
50 | - * |
|
51 | - * @return mixed |
|
52 | - * |
|
53 | - * @since 12.0.0 |
|
54 | - */ |
|
55 | - public function getPath(); |
|
46 | + /** |
|
47 | + * Get the path of the file that was changed relative to the root of the storage |
|
48 | + * |
|
49 | + * Note, for rename changes this path is the old path for the file |
|
50 | + * |
|
51 | + * @return mixed |
|
52 | + * |
|
53 | + * @since 12.0.0 |
|
54 | + */ |
|
55 | + public function getPath(); |
|
56 | 56 | } |
@@ -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 | } |
@@ -40,241 +40,241 @@ |
||
40 | 40 | * @since 6.0.0 - extends FileInfo was added in 8.0.0 |
41 | 41 | */ |
42 | 42 | interface Node extends FileInfo { |
43 | - /** |
|
44 | - * Move the file or folder to a new location |
|
45 | - * |
|
46 | - * @param string $targetPath the absolute target path |
|
47 | - * @throws \OCP\Files\NotPermittedException |
|
48 | - * @return \OCP\Files\Node |
|
49 | - * @since 6.0.0 |
|
50 | - */ |
|
51 | - public function move($targetPath); |
|
43 | + /** |
|
44 | + * Move the file or folder to a new location |
|
45 | + * |
|
46 | + * @param string $targetPath the absolute target path |
|
47 | + * @throws \OCP\Files\NotPermittedException |
|
48 | + * @return \OCP\Files\Node |
|
49 | + * @since 6.0.0 |
|
50 | + */ |
|
51 | + public function move($targetPath); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Delete the file or folder |
|
55 | - * @return void |
|
56 | - * @since 6.0.0 |
|
57 | - */ |
|
58 | - public function delete(); |
|
53 | + /** |
|
54 | + * Delete the file or folder |
|
55 | + * @return void |
|
56 | + * @since 6.0.0 |
|
57 | + */ |
|
58 | + public function delete(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Cope the file or folder to a new location |
|
62 | - * |
|
63 | - * @param string $targetPath the absolute target path |
|
64 | - * @return \OCP\Files\Node |
|
65 | - * @since 6.0.0 |
|
66 | - */ |
|
67 | - public function copy($targetPath); |
|
60 | + /** |
|
61 | + * Cope the file or folder to a new location |
|
62 | + * |
|
63 | + * @param string $targetPath the absolute target path |
|
64 | + * @return \OCP\Files\Node |
|
65 | + * @since 6.0.0 |
|
66 | + */ |
|
67 | + public function copy($targetPath); |
|
68 | 68 | |
69 | - /** |
|
70 | - * Change the modified date of the file or folder |
|
71 | - * If $mtime is omitted the current time will be used |
|
72 | - * |
|
73 | - * @param int $mtime (optional) modified date as unix timestamp |
|
74 | - * @throws \OCP\Files\NotPermittedException |
|
75 | - * @return void |
|
76 | - * @since 6.0.0 |
|
77 | - */ |
|
78 | - public function touch($mtime = null); |
|
69 | + /** |
|
70 | + * Change the modified date of the file or folder |
|
71 | + * If $mtime is omitted the current time will be used |
|
72 | + * |
|
73 | + * @param int $mtime (optional) modified date as unix timestamp |
|
74 | + * @throws \OCP\Files\NotPermittedException |
|
75 | + * @return void |
|
76 | + * @since 6.0.0 |
|
77 | + */ |
|
78 | + public function touch($mtime = null); |
|
79 | 79 | |
80 | - /** |
|
81 | - * Get the storage backend the file or folder is stored on |
|
82 | - * |
|
83 | - * @return \OCP\Files\Storage |
|
84 | - * @throws \OCP\Files\NotFoundException |
|
85 | - * @since 6.0.0 |
|
86 | - */ |
|
87 | - public function getStorage(); |
|
80 | + /** |
|
81 | + * Get the storage backend the file or folder is stored on |
|
82 | + * |
|
83 | + * @return \OCP\Files\Storage |
|
84 | + * @throws \OCP\Files\NotFoundException |
|
85 | + * @since 6.0.0 |
|
86 | + */ |
|
87 | + public function getStorage(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Get the full path of the file or folder |
|
91 | - * |
|
92 | - * @return string |
|
93 | - * @since 6.0.0 |
|
94 | - */ |
|
95 | - public function getPath(); |
|
89 | + /** |
|
90 | + * Get the full path of the file or folder |
|
91 | + * |
|
92 | + * @return string |
|
93 | + * @since 6.0.0 |
|
94 | + */ |
|
95 | + public function getPath(); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Get the path of the file or folder relative to the mountpoint of it's storage |
|
99 | - * |
|
100 | - * @return string |
|
101 | - * @since 6.0.0 |
|
102 | - */ |
|
103 | - public function getInternalPath(); |
|
97 | + /** |
|
98 | + * Get the path of the file or folder relative to the mountpoint of it's storage |
|
99 | + * |
|
100 | + * @return string |
|
101 | + * @since 6.0.0 |
|
102 | + */ |
|
103 | + public function getInternalPath(); |
|
104 | 104 | |
105 | - /** |
|
106 | - * Get the internal file id for the file or folder |
|
107 | - * |
|
108 | - * @return int |
|
109 | - * @throws InvalidPathException |
|
110 | - * @throws NotFoundException |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function getId(); |
|
105 | + /** |
|
106 | + * Get the internal file id for the file or folder |
|
107 | + * |
|
108 | + * @return int |
|
109 | + * @throws InvalidPathException |
|
110 | + * @throws NotFoundException |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function getId(); |
|
114 | 114 | |
115 | - /** |
|
116 | - * Get metadata of the file or folder |
|
117 | - * The returned array contains the following values: |
|
118 | - * - mtime |
|
119 | - * - size |
|
120 | - * |
|
121 | - * @return array |
|
122 | - * @since 6.0.0 |
|
123 | - */ |
|
124 | - public function stat(); |
|
115 | + /** |
|
116 | + * Get metadata of the file or folder |
|
117 | + * The returned array contains the following values: |
|
118 | + * - mtime |
|
119 | + * - size |
|
120 | + * |
|
121 | + * @return array |
|
122 | + * @since 6.0.0 |
|
123 | + */ |
|
124 | + public function stat(); |
|
125 | 125 | |
126 | - /** |
|
127 | - * Get the modified date of the file or folder as unix timestamp |
|
128 | - * |
|
129 | - * @return int |
|
130 | - * @throws InvalidPathException |
|
131 | - * @throws NotFoundException |
|
132 | - * @since 6.0.0 |
|
133 | - */ |
|
134 | - public function getMTime(); |
|
126 | + /** |
|
127 | + * Get the modified date of the file or folder as unix timestamp |
|
128 | + * |
|
129 | + * @return int |
|
130 | + * @throws InvalidPathException |
|
131 | + * @throws NotFoundException |
|
132 | + * @since 6.0.0 |
|
133 | + */ |
|
134 | + public function getMTime(); |
|
135 | 135 | |
136 | - /** |
|
137 | - * Get the size of the file or folder in bytes |
|
138 | - * |
|
139 | - * @return int |
|
140 | - * @throws InvalidPathException |
|
141 | - * @throws NotFoundException |
|
142 | - * @since 6.0.0 |
|
143 | - */ |
|
144 | - public function getSize(); |
|
136 | + /** |
|
137 | + * Get the size of the file or folder in bytes |
|
138 | + * |
|
139 | + * @return int |
|
140 | + * @throws InvalidPathException |
|
141 | + * @throws NotFoundException |
|
142 | + * @since 6.0.0 |
|
143 | + */ |
|
144 | + public function getSize(); |
|
145 | 145 | |
146 | - /** |
|
147 | - * Get the Etag of the file or folder |
|
148 | - * The Etag is an string id used to detect changes to a file or folder, |
|
149 | - * every time the file or folder is changed the Etag will change to |
|
150 | - * |
|
151 | - * @return string |
|
152 | - * @throws InvalidPathException |
|
153 | - * @throws NotFoundException |
|
154 | - * @since 6.0.0 |
|
155 | - */ |
|
156 | - public function getEtag(); |
|
146 | + /** |
|
147 | + * Get the Etag of the file or folder |
|
148 | + * The Etag is an string id used to detect changes to a file or folder, |
|
149 | + * every time the file or folder is changed the Etag will change to |
|
150 | + * |
|
151 | + * @return string |
|
152 | + * @throws InvalidPathException |
|
153 | + * @throws NotFoundException |
|
154 | + * @since 6.0.0 |
|
155 | + */ |
|
156 | + public function getEtag(); |
|
157 | 157 | |
158 | 158 | |
159 | - /** |
|
160 | - * Get the permissions of the file or folder as a combination of one or more of the following constants: |
|
161 | - * - \OCP\Constants::PERMISSION_READ |
|
162 | - * - \OCP\Constants::PERMISSION_UPDATE |
|
163 | - * - \OCP\Constants::PERMISSION_CREATE |
|
164 | - * - \OCP\Constants::PERMISSION_DELETE |
|
165 | - * - \OCP\Constants::PERMISSION_SHARE |
|
166 | - * |
|
167 | - * @return int |
|
168 | - * @throws InvalidPathException |
|
169 | - * @throws NotFoundException |
|
170 | - * @since 6.0.0 - namespace of constants has changed in 8.0.0 |
|
171 | - */ |
|
172 | - public function getPermissions(); |
|
159 | + /** |
|
160 | + * Get the permissions of the file or folder as a combination of one or more of the following constants: |
|
161 | + * - \OCP\Constants::PERMISSION_READ |
|
162 | + * - \OCP\Constants::PERMISSION_UPDATE |
|
163 | + * - \OCP\Constants::PERMISSION_CREATE |
|
164 | + * - \OCP\Constants::PERMISSION_DELETE |
|
165 | + * - \OCP\Constants::PERMISSION_SHARE |
|
166 | + * |
|
167 | + * @return int |
|
168 | + * @throws InvalidPathException |
|
169 | + * @throws NotFoundException |
|
170 | + * @since 6.0.0 - namespace of constants has changed in 8.0.0 |
|
171 | + */ |
|
172 | + public function getPermissions(); |
|
173 | 173 | |
174 | - /** |
|
175 | - * Check if the file or folder is readable |
|
176 | - * |
|
177 | - * @return bool |
|
178 | - * @throws InvalidPathException |
|
179 | - * @throws NotFoundException |
|
180 | - * @since 6.0.0 |
|
181 | - */ |
|
182 | - public function isReadable(); |
|
174 | + /** |
|
175 | + * Check if the file or folder is readable |
|
176 | + * |
|
177 | + * @return bool |
|
178 | + * @throws InvalidPathException |
|
179 | + * @throws NotFoundException |
|
180 | + * @since 6.0.0 |
|
181 | + */ |
|
182 | + public function isReadable(); |
|
183 | 183 | |
184 | - /** |
|
185 | - * Check if the file or folder is writable |
|
186 | - * |
|
187 | - * @return bool |
|
188 | - * @throws InvalidPathException |
|
189 | - * @throws NotFoundException |
|
190 | - * @since 6.0.0 |
|
191 | - */ |
|
192 | - public function isUpdateable(); |
|
184 | + /** |
|
185 | + * Check if the file or folder is writable |
|
186 | + * |
|
187 | + * @return bool |
|
188 | + * @throws InvalidPathException |
|
189 | + * @throws NotFoundException |
|
190 | + * @since 6.0.0 |
|
191 | + */ |
|
192 | + public function isUpdateable(); |
|
193 | 193 | |
194 | - /** |
|
195 | - * Check if the file or folder is deletable |
|
196 | - * |
|
197 | - * @return bool |
|
198 | - * @throws InvalidPathException |
|
199 | - * @throws NotFoundException |
|
200 | - * @since 6.0.0 |
|
201 | - */ |
|
202 | - public function isDeletable(); |
|
194 | + /** |
|
195 | + * Check if the file or folder is deletable |
|
196 | + * |
|
197 | + * @return bool |
|
198 | + * @throws InvalidPathException |
|
199 | + * @throws NotFoundException |
|
200 | + * @since 6.0.0 |
|
201 | + */ |
|
202 | + public function isDeletable(); |
|
203 | 203 | |
204 | - /** |
|
205 | - * Check if the file or folder is shareable |
|
206 | - * |
|
207 | - * @return bool |
|
208 | - * @throws InvalidPathException |
|
209 | - * @throws NotFoundException |
|
210 | - * @since 6.0.0 |
|
211 | - */ |
|
212 | - public function isShareable(); |
|
204 | + /** |
|
205 | + * Check if the file or folder is shareable |
|
206 | + * |
|
207 | + * @return bool |
|
208 | + * @throws InvalidPathException |
|
209 | + * @throws NotFoundException |
|
210 | + * @since 6.0.0 |
|
211 | + */ |
|
212 | + public function isShareable(); |
|
213 | 213 | |
214 | - /** |
|
215 | - * Get the parent folder of the file or folder |
|
216 | - * |
|
217 | - * @return Folder |
|
218 | - * @since 6.0.0 |
|
219 | - */ |
|
220 | - public function getParent(); |
|
214 | + /** |
|
215 | + * Get the parent folder of the file or folder |
|
216 | + * |
|
217 | + * @return Folder |
|
218 | + * @since 6.0.0 |
|
219 | + */ |
|
220 | + public function getParent(); |
|
221 | 221 | |
222 | - /** |
|
223 | - * Get the filename of the file or folder |
|
224 | - * |
|
225 | - * @return string |
|
226 | - * @since 6.0.0 |
|
227 | - */ |
|
228 | - public function getName(); |
|
222 | + /** |
|
223 | + * Get the filename of the file or folder |
|
224 | + * |
|
225 | + * @return string |
|
226 | + * @since 6.0.0 |
|
227 | + */ |
|
228 | + public function getName(); |
|
229 | 229 | |
230 | - /** |
|
231 | - * Acquire a lock on this file or folder. |
|
232 | - * |
|
233 | - * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks |
|
234 | - * can be active at the same time. |
|
235 | - * An exclusive lock will prevent any other lock from being created (both shared and exclusive). |
|
236 | - * |
|
237 | - * A locked exception will be thrown if any conflicting lock already exists |
|
238 | - * |
|
239 | - * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all* |
|
240 | - * other operations for that file, even within the same php process. |
|
241 | - * |
|
242 | - * Acquiring any lock on a file will also create a shared lock on all parent folders of that file. |
|
243 | - * |
|
244 | - * Note that in most cases you won't need to manually manage the locks for any files you're working with, |
|
245 | - * any filesystem operation will automatically acquire the relevant locks for that operation. |
|
246 | - * |
|
247 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
248 | - * @throws \OCP\Lock\LockedException |
|
249 | - * @since 9.1.0 |
|
250 | - */ |
|
251 | - public function lock($type); |
|
230 | + /** |
|
231 | + * Acquire a lock on this file or folder. |
|
232 | + * |
|
233 | + * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks |
|
234 | + * can be active at the same time. |
|
235 | + * An exclusive lock will prevent any other lock from being created (both shared and exclusive). |
|
236 | + * |
|
237 | + * A locked exception will be thrown if any conflicting lock already exists |
|
238 | + * |
|
239 | + * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all* |
|
240 | + * other operations for that file, even within the same php process. |
|
241 | + * |
|
242 | + * Acquiring any lock on a file will also create a shared lock on all parent folders of that file. |
|
243 | + * |
|
244 | + * Note that in most cases you won't need to manually manage the locks for any files you're working with, |
|
245 | + * any filesystem operation will automatically acquire the relevant locks for that operation. |
|
246 | + * |
|
247 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
248 | + * @throws \OCP\Lock\LockedException |
|
249 | + * @since 9.1.0 |
|
250 | + */ |
|
251 | + public function lock($type); |
|
252 | 252 | |
253 | - /** |
|
254 | - * Check the type of an existing lock. |
|
255 | - * |
|
256 | - * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file, |
|
257 | - * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place. |
|
258 | - * |
|
259 | - * A locked exception will be thrown when these preconditions are not met. |
|
260 | - * Note that this is also the case if no existing lock exists for the file. |
|
261 | - * |
|
262 | - * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
263 | - * @throws \OCP\Lock\LockedException |
|
264 | - * @since 9.1.0 |
|
265 | - */ |
|
266 | - public function changeLock($targetType); |
|
253 | + /** |
|
254 | + * Check the type of an existing lock. |
|
255 | + * |
|
256 | + * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file, |
|
257 | + * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place. |
|
258 | + * |
|
259 | + * A locked exception will be thrown when these preconditions are not met. |
|
260 | + * Note that this is also the case if no existing lock exists for the file. |
|
261 | + * |
|
262 | + * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
263 | + * @throws \OCP\Lock\LockedException |
|
264 | + * @since 9.1.0 |
|
265 | + */ |
|
266 | + public function changeLock($targetType); |
|
267 | 267 | |
268 | - /** |
|
269 | - * Release an existing lock. |
|
270 | - * |
|
271 | - * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file. |
|
272 | - * |
|
273 | - * Note that this method will not give any sort of error when trying to free a lock that doesn't exist. |
|
274 | - * |
|
275 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
276 | - * @throws \OCP\Lock\LockedException |
|
277 | - * @since 9.1.0 |
|
278 | - */ |
|
279 | - public function unlock($type); |
|
268 | + /** |
|
269 | + * Release an existing lock. |
|
270 | + * |
|
271 | + * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file. |
|
272 | + * |
|
273 | + * Note that this method will not give any sort of error when trying to free a lock that doesn't exist. |
|
274 | + * |
|
275 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
276 | + * @throws \OCP\Lock\LockedException |
|
277 | + * @since 9.1.0 |
|
278 | + */ |
|
279 | + public function unlock($type); |
|
280 | 280 | } |
@@ -30,47 +30,47 @@ |
||
30 | 30 | * @since 9.0.0 |
31 | 31 | */ |
32 | 32 | interface IUpdater { |
33 | - /** |
|
34 | - * Get the propagator for etags and mtime for the view the updater works on |
|
35 | - * |
|
36 | - * @return IPropagator |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getPropagator(); |
|
33 | + /** |
|
34 | + * Get the propagator for etags and mtime for the view the updater works on |
|
35 | + * |
|
36 | + * @return IPropagator |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getPropagator(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
43 | - * |
|
44 | - * @param string $path the path of the file to propagate the changes for |
|
45 | - * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function propagate($path, $time = null); |
|
41 | + /** |
|
42 | + * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
43 | + * |
|
44 | + * @param string $path the path of the file to propagate the changes for |
|
45 | + * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function propagate($path, $time = null); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
52 | - * |
|
53 | - * @param string $path |
|
54 | - * @param int $time |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function update($path, $time = null); |
|
50 | + /** |
|
51 | + * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
52 | + * |
|
53 | + * @param string $path |
|
54 | + * @param int $time |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function update($path, $time = null); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
61 | - * |
|
62 | - * @param string $path |
|
63 | - * @since 9.0.0 |
|
64 | - */ |
|
65 | - public function remove($path); |
|
59 | + /** |
|
60 | + * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
61 | + * |
|
62 | + * @param string $path |
|
63 | + * @since 9.0.0 |
|
64 | + */ |
|
65 | + public function remove($path); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
69 | - * |
|
70 | - * @param IStorage $sourceStorage |
|
71 | - * @param string $source |
|
72 | - * @param string $target |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
67 | + /** |
|
68 | + * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
69 | + * |
|
70 | + * @param IStorage $sourceStorage |
|
71 | + * @param string $source |
|
72 | + * @param string $target |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
76 | 76 | } |
@@ -28,108 +28,108 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface ICacheEntry { |
31 | - const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
31 | + const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
32 | 32 | |
33 | - /** |
|
34 | - * Get the numeric id of a file |
|
35 | - * |
|
36 | - * @return int |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getId(); |
|
33 | + /** |
|
34 | + * Get the numeric id of a file |
|
35 | + * |
|
36 | + * @return int |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getId(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Get the numeric id for the storage |
|
43 | - * |
|
44 | - * @return int |
|
45 | - * @since 9.0.0 |
|
46 | - */ |
|
47 | - public function getStorageId(); |
|
41 | + /** |
|
42 | + * Get the numeric id for the storage |
|
43 | + * |
|
44 | + * @return int |
|
45 | + * @since 9.0.0 |
|
46 | + */ |
|
47 | + public function getStorageId(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * Get the path of the file relative to the storage root |
|
51 | - * |
|
52 | - * @return string |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function getPath(); |
|
49 | + /** |
|
50 | + * Get the path of the file relative to the storage root |
|
51 | + * |
|
52 | + * @return string |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function getPath(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Get the file name |
|
59 | - * |
|
60 | - * @return string |
|
61 | - * @since 9.0.0 |
|
62 | - */ |
|
63 | - public function getName(); |
|
57 | + /** |
|
58 | + * Get the file name |
|
59 | + * |
|
60 | + * @return string |
|
61 | + * @since 9.0.0 |
|
62 | + */ |
|
63 | + public function getName(); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Get the full mimetype |
|
67 | - * |
|
68 | - * @return string |
|
69 | - * @since 9.0.0 |
|
70 | - */ |
|
71 | - public function getMimeType(); |
|
65 | + /** |
|
66 | + * Get the full mimetype |
|
67 | + * |
|
68 | + * @return string |
|
69 | + * @since 9.0.0 |
|
70 | + */ |
|
71 | + public function getMimeType(); |
|
72 | 72 | |
73 | - /** |
|
74 | - * Get the first part of the mimetype |
|
75 | - * |
|
76 | - * @return string |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function getMimePart(); |
|
73 | + /** |
|
74 | + * Get the first part of the mimetype |
|
75 | + * |
|
76 | + * @return string |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function getMimePart(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Get the file size in bytes |
|
83 | - * |
|
84 | - * @return int |
|
85 | - * @since 9.0.0 |
|
86 | - */ |
|
87 | - public function getSize(); |
|
81 | + /** |
|
82 | + * Get the file size in bytes |
|
83 | + * |
|
84 | + * @return int |
|
85 | + * @since 9.0.0 |
|
86 | + */ |
|
87 | + public function getSize(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Get the last modified date as unix timestamp |
|
91 | - * |
|
92 | - * @return int |
|
93 | - * @since 9.0.0 |
|
94 | - */ |
|
95 | - public function getMTime(); |
|
89 | + /** |
|
90 | + * Get the last modified date as unix timestamp |
|
91 | + * |
|
92 | + * @return int |
|
93 | + * @since 9.0.0 |
|
94 | + */ |
|
95 | + public function getMTime(); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Get the last modified date on the storage as unix timestamp |
|
99 | - * |
|
100 | - * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
101 | - * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
102 | - * |
|
103 | - * @return int |
|
104 | - * @since 9.0.0 |
|
105 | - */ |
|
106 | - public function getStorageMTime(); |
|
97 | + /** |
|
98 | + * Get the last modified date on the storage as unix timestamp |
|
99 | + * |
|
100 | + * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
101 | + * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
102 | + * |
|
103 | + * @return int |
|
104 | + * @since 9.0.0 |
|
105 | + */ |
|
106 | + public function getStorageMTime(); |
|
107 | 107 | |
108 | - /** |
|
109 | - * Get the etag for the file |
|
110 | - * |
|
111 | - * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
112 | - * Etag for folders change whenever a file in the folder has changed |
|
113 | - * |
|
114 | - * @return string |
|
115 | - * @since 9.0.0 |
|
116 | - */ |
|
117 | - public function getEtag(); |
|
108 | + /** |
|
109 | + * Get the etag for the file |
|
110 | + * |
|
111 | + * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
112 | + * Etag for folders change whenever a file in the folder has changed |
|
113 | + * |
|
114 | + * @return string |
|
115 | + * @since 9.0.0 |
|
116 | + */ |
|
117 | + public function getEtag(); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
121 | - * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
122 | - * |
|
123 | - * @return int |
|
124 | - * @since 9.0.0 |
|
125 | - */ |
|
126 | - public function getPermissions(); |
|
119 | + /** |
|
120 | + * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
121 | + * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
122 | + * |
|
123 | + * @return int |
|
124 | + * @since 9.0.0 |
|
125 | + */ |
|
126 | + public function getPermissions(); |
|
127 | 127 | |
128 | - /** |
|
129 | - * Check if the file is encrypted |
|
130 | - * |
|
131 | - * @return bool |
|
132 | - * @since 9.0.0 |
|
133 | - */ |
|
134 | - public function isEncrypted(); |
|
128 | + /** |
|
129 | + * Check if the file is encrypted |
|
130 | + * |
|
131 | + * @return bool |
|
132 | + * @since 9.0.0 |
|
133 | + */ |
|
134 | + public function isEncrypted(); |
|
135 | 135 | } |
@@ -28,56 +28,56 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IWatcher { |
31 | - const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
32 | - const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
33 | - const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
31 | + const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
32 | + const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
33 | + const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
34 | 34 | |
35 | - /** |
|
36 | - * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function setPolicy($policy); |
|
35 | + /** |
|
36 | + * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function setPolicy($policy); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function getPolicy(); |
|
41 | + /** |
|
42 | + * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function getPolicy(); |
|
46 | 46 | |
47 | - /** |
|
48 | - * check $path for updates and update if needed |
|
49 | - * |
|
50 | - * @param string $path |
|
51 | - * @param ICacheEntry|null $cachedEntry |
|
52 | - * @return boolean true if path was updated |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function checkUpdate($path, $cachedEntry = null); |
|
47 | + /** |
|
48 | + * check $path for updates and update if needed |
|
49 | + * |
|
50 | + * @param string $path |
|
51 | + * @param ICacheEntry|null $cachedEntry |
|
52 | + * @return boolean true if path was updated |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function checkUpdate($path, $cachedEntry = null); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Update the cache for changes to $path |
|
59 | - * |
|
60 | - * @param string $path |
|
61 | - * @param ICacheEntry $cachedData |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function update($path, $cachedData); |
|
57 | + /** |
|
58 | + * Update the cache for changes to $path |
|
59 | + * |
|
60 | + * @param string $path |
|
61 | + * @param ICacheEntry $cachedData |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function update($path, $cachedData); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Check if the cache for $path needs to be updated |
|
68 | - * |
|
69 | - * @param string $path |
|
70 | - * @param ICacheEntry $cachedData |
|
71 | - * @return bool |
|
72 | - * @since 9.0.0 |
|
73 | - */ |
|
74 | - public function needsUpdate($path, $cachedData); |
|
66 | + /** |
|
67 | + * Check if the cache for $path needs to be updated |
|
68 | + * |
|
69 | + * @param string $path |
|
70 | + * @param ICacheEntry $cachedData |
|
71 | + * @return bool |
|
72 | + * @since 9.0.0 |
|
73 | + */ |
|
74 | + public function needsUpdate($path, $cachedData); |
|
75 | 75 | |
76 | - /** |
|
77 | - * remove deleted files in $path from the cache |
|
78 | - * |
|
79 | - * @param string $path |
|
80 | - * @since 9.0.0 |
|
81 | - */ |
|
82 | - public function cleanFolder($path); |
|
76 | + /** |
|
77 | + * remove deleted files in $path from the cache |
|
78 | + * |
|
79 | + * @param string $path |
|
80 | + * @since 9.0.0 |
|
81 | + */ |
|
82 | + public function cleanFolder($path); |
|
83 | 83 | } |
@@ -28,29 +28,29 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IPropagator { |
31 | - /** |
|
32 | - * Mark the beginning of a propagation batch |
|
33 | - * |
|
34 | - * Note that not all cache setups support propagation in which case this will be a noop |
|
35 | - * |
|
36 | - * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
37 | - * before the batch is committed. |
|
38 | - * |
|
39 | - * @since 9.1.0 |
|
40 | - */ |
|
41 | - public function beginBatch(); |
|
31 | + /** |
|
32 | + * Mark the beginning of a propagation batch |
|
33 | + * |
|
34 | + * Note that not all cache setups support propagation in which case this will be a noop |
|
35 | + * |
|
36 | + * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
37 | + * before the batch is committed. |
|
38 | + * |
|
39 | + * @since 9.1.0 |
|
40 | + */ |
|
41 | + public function beginBatch(); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Commit the active propagation batch |
|
45 | - * |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function commitBatch(); |
|
43 | + /** |
|
44 | + * Commit the active propagation batch |
|
45 | + * |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function commitBatch(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param string $internalPath |
|
52 | - * @param int $time |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function propagateChange($internalPath, $time); |
|
50 | + /** |
|
51 | + * @param string $internalPath |
|
52 | + * @param int $time |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function propagateChange($internalPath, $time); |
|
56 | 56 | } |
@@ -28,57 +28,57 @@ |
||
28 | 28 | * @since 9.0.0 |
29 | 29 | */ |
30 | 30 | interface IScanner { |
31 | - const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders |
|
32 | - const SCAN_RECURSIVE = true; |
|
33 | - const SCAN_SHALLOW = false; |
|
31 | + const SCAN_RECURSIVE_INCOMPLETE = 2; // only recursive into not fully scanned folders |
|
32 | + const SCAN_RECURSIVE = true; |
|
33 | + const SCAN_SHALLOW = false; |
|
34 | 34 | |
35 | - const REUSE_NONE = 0; |
|
36 | - const REUSE_ETAG = 1; |
|
37 | - const REUSE_SIZE = 2; |
|
35 | + const REUSE_NONE = 0; |
|
36 | + const REUSE_ETAG = 1; |
|
37 | + const REUSE_SIZE = 2; |
|
38 | 38 | |
39 | - /** |
|
40 | - * scan a single file and store it in the cache |
|
41 | - * |
|
42 | - * @param string $file |
|
43 | - * @param int $reuseExisting |
|
44 | - * @param int $parentId |
|
45 | - * @param array | null $cacheData existing data in the cache for the file to be scanned |
|
46 | - * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
47 | - * @return array an array of metadata of the scanned file |
|
48 | - * @throws \OC\ServerNotAvailableException |
|
49 | - * @throws \OCP\Lock\LockedException |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true); |
|
39 | + /** |
|
40 | + * scan a single file and store it in the cache |
|
41 | + * |
|
42 | + * @param string $file |
|
43 | + * @param int $reuseExisting |
|
44 | + * @param int $parentId |
|
45 | + * @param array | null $cacheData existing data in the cache for the file to be scanned |
|
46 | + * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
47 | + * @return array an array of metadata of the scanned file |
|
48 | + * @throws \OC\ServerNotAvailableException |
|
49 | + * @throws \OCP\Lock\LockedException |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true); |
|
53 | 53 | |
54 | - /** |
|
55 | - * scan a folder and all its children |
|
56 | - * |
|
57 | - * @param string $path |
|
58 | - * @param bool $recursive |
|
59 | - * @param int $reuse |
|
60 | - * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
61 | - * @return array an array of the meta data of the scanned file or folder |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true); |
|
54 | + /** |
|
55 | + * scan a folder and all its children |
|
56 | + * |
|
57 | + * @param string $path |
|
58 | + * @param bool $recursive |
|
59 | + * @param int $reuse |
|
60 | + * @param bool $lock set to false to disable getting an additional read lock during scanning |
|
61 | + * @return array an array of the meta data of the scanned file or folder |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true); |
|
65 | 65 | |
66 | - /** |
|
67 | - * check if the file should be ignored when scanning |
|
68 | - * NOTE: files with a '.part' extension are ignored as well! |
|
69 | - * prevents unfinished put requests to be scanned |
|
70 | - * |
|
71 | - * @param string $file |
|
72 | - * @return boolean |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public static function isPartialFile($file); |
|
66 | + /** |
|
67 | + * check if the file should be ignored when scanning |
|
68 | + * NOTE: files with a '.part' extension are ignored as well! |
|
69 | + * prevents unfinished put requests to be scanned |
|
70 | + * |
|
71 | + * @param string $file |
|
72 | + * @return boolean |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public static function isPartialFile($file); |
|
76 | 76 | |
77 | - /** |
|
78 | - * walk over any folders that are not fully scanned yet and scan them |
|
79 | - * |
|
80 | - * @since 9.0.0 |
|
81 | - */ |
|
82 | - public function backgroundScan(); |
|
77 | + /** |
|
78 | + * walk over any folders that are not fully scanned yet and scan them |
|
79 | + * |
|
80 | + * @since 9.0.0 |
|
81 | + */ |
|
82 | + public function backgroundScan(); |
|
83 | 83 | } |
84 | 84 |