@@ -31,37 +31,37 @@ |
||
31 | 31 | **/ |
32 | 32 | interface IMimeTypeLoader { |
33 | 33 | |
34 | - /** |
|
35 | - * Get a mimetype from its ID |
|
36 | - * |
|
37 | - * @param int $id |
|
38 | - * @return string|null |
|
39 | - * @since 8.2.0 |
|
40 | - */ |
|
41 | - public function getMimetypeById($id); |
|
34 | + /** |
|
35 | + * Get a mimetype from its ID |
|
36 | + * |
|
37 | + * @param int $id |
|
38 | + * @return string|null |
|
39 | + * @since 8.2.0 |
|
40 | + */ |
|
41 | + public function getMimetypeById($id); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Get a mimetype ID, adding the mimetype to the DB if it does not exist |
|
45 | - * |
|
46 | - * @param string $mimetype |
|
47 | - * @return int |
|
48 | - * @since 8.2.0 |
|
49 | - */ |
|
50 | - public function getId($mimetype); |
|
43 | + /** |
|
44 | + * Get a mimetype ID, adding the mimetype to the DB if it does not exist |
|
45 | + * |
|
46 | + * @param string $mimetype |
|
47 | + * @return int |
|
48 | + * @since 8.2.0 |
|
49 | + */ |
|
50 | + public function getId($mimetype); |
|
51 | 51 | |
52 | - /** |
|
53 | - * Test if a mimetype exists in the database |
|
54 | - * |
|
55 | - * @param string $mimetype |
|
56 | - * @return bool |
|
57 | - * @since 8.2.0 |
|
58 | - */ |
|
59 | - public function exists($mimetype); |
|
52 | + /** |
|
53 | + * Test if a mimetype exists in the database |
|
54 | + * |
|
55 | + * @param string $mimetype |
|
56 | + * @return bool |
|
57 | + * @since 8.2.0 |
|
58 | + */ |
|
59 | + public function exists($mimetype); |
|
60 | 60 | |
61 | - /** |
|
62 | - * Clear all loaded mimetypes, allow for re-loading |
|
63 | - * |
|
64 | - * @since 8.2.0 |
|
65 | - */ |
|
66 | - public function reset(); |
|
61 | + /** |
|
62 | + * Clear all loaded mimetypes, allow for re-loading |
|
63 | + * |
|
64 | + * @since 8.2.0 |
|
65 | + */ |
|
66 | + public function reset(); |
|
67 | 67 | } |
@@ -36,27 +36,27 @@ |
||
36 | 36 | * @since 7.0.0 |
37 | 37 | */ |
38 | 38 | class LockNotAcquiredException extends \Exception { |
39 | - /** @var string $path The path that could not be locked */ |
|
40 | - public $path; |
|
39 | + /** @var string $path The path that could not be locked */ |
|
40 | + public $path; |
|
41 | 41 | |
42 | - /** @var integer $lockType The type of the lock that was attempted */ |
|
43 | - public $lockType; |
|
42 | + /** @var integer $lockType The type of the lock that was attempted */ |
|
43 | + public $lockType; |
|
44 | 44 | |
45 | - /** |
|
46 | - * @since 7.0.0 |
|
47 | - */ |
|
48 | - public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
49 | - $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); |
|
50 | - parent::__construct($message, $code, $previous); |
|
51 | - } |
|
45 | + /** |
|
46 | + * @since 7.0.0 |
|
47 | + */ |
|
48 | + public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
49 | + $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); |
|
50 | + parent::__construct($message, $code, $previous); |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * custom string representation of object |
|
55 | - * |
|
56 | - * @return string |
|
57 | - * @since 7.0.0 |
|
58 | - */ |
|
59 | - public function __toString() { |
|
60 | - return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
61 | - } |
|
53 | + /** |
|
54 | + * custom string representation of object |
|
55 | + * |
|
56 | + * @return string |
|
57 | + * @since 7.0.0 |
|
58 | + */ |
|
59 | + public function __toString() { |
|
60 | + return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
61 | + } |
|
62 | 62 | } |
@@ -57,6 +57,6 @@ |
||
57 | 57 | * @since 7.0.0 |
58 | 58 | */ |
59 | 59 | public function __toString() { |
60 | - return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
60 | + return __CLASS__.": [{$this->code}]: {$this->message}\n"; |
|
61 | 61 | } |
62 | 62 | } |
@@ -31,36 +31,36 @@ |
||
31 | 31 | * @since 9.1.0 |
32 | 32 | */ |
33 | 33 | interface INotifyStorage { |
34 | - const NOTIFY_ADDED = 1; |
|
35 | - const NOTIFY_REMOVED = 2; |
|
36 | - const NOTIFY_MODIFIED = 3; |
|
37 | - const NOTIFY_RENAMED = 4; |
|
34 | + const NOTIFY_ADDED = 1; |
|
35 | + const NOTIFY_REMOVED = 2; |
|
36 | + const NOTIFY_MODIFIED = 3; |
|
37 | + const NOTIFY_RENAMED = 4; |
|
38 | 38 | |
39 | - /** |
|
40 | - * Start listening for update notifications |
|
41 | - * |
|
42 | - * The provided callback will be called for every incoming notification with the following parameters |
|
43 | - * - int $type the type of update, one of the INotifyStorage::NOTIFY_* constants |
|
44 | - * - string $path the path of the update |
|
45 | - * - string $renameTarget the target of the rename operation, only provided for rename updates |
|
46 | - * |
|
47 | - * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback |
|
48 | - * |
|
49 | - * @param string $path |
|
50 | - * @param callable $callback |
|
51 | - * |
|
52 | - * @since 9.1.0 |
|
53 | - * @deprecated 12.0.0 use INotifyStorage::notify()->listen() instead |
|
54 | - */ |
|
55 | - public function listen($path, callable $callback); |
|
39 | + /** |
|
40 | + * Start listening for update notifications |
|
41 | + * |
|
42 | + * The provided callback will be called for every incoming notification with the following parameters |
|
43 | + * - int $type the type of update, one of the INotifyStorage::NOTIFY_* constants |
|
44 | + * - string $path the path of the update |
|
45 | + * - string $renameTarget the target of the rename operation, only provided for rename updates |
|
46 | + * |
|
47 | + * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback |
|
48 | + * |
|
49 | + * @param string $path |
|
50 | + * @param callable $callback |
|
51 | + * |
|
52 | + * @since 9.1.0 |
|
53 | + * @deprecated 12.0.0 use INotifyStorage::notify()->listen() instead |
|
54 | + */ |
|
55 | + public function listen($path, callable $callback); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Start the notification handler for this storage |
|
59 | - * |
|
60 | - * @param $path |
|
61 | - * @return INotifyHandler |
|
62 | - * |
|
63 | - * @since 12.0.0 |
|
64 | - */ |
|
65 | - public function notify($path); |
|
57 | + /** |
|
58 | + * Start the notification handler for this storage |
|
59 | + * |
|
60 | + * @param $path |
|
61 | + * @return INotifyHandler |
|
62 | + * |
|
63 | + * @since 12.0.0 |
|
64 | + */ |
|
65 | + public function notify($path); |
|
66 | 66 | } |
@@ -30,25 +30,25 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IStorageFactory { |
33 | - /** |
|
34 | - * allow modifier storage behaviour by adding wrappers around storages |
|
35 | - * |
|
36 | - * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
37 | - * |
|
38 | - * @param string $wrapperName |
|
39 | - * @param callable $callback |
|
40 | - * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
41 | - * name registered |
|
42 | - * @since 8.0.0 |
|
43 | - */ |
|
44 | - public function addStorageWrapper($wrapperName, $callback); |
|
33 | + /** |
|
34 | + * allow modifier storage behaviour by adding wrappers around storages |
|
35 | + * |
|
36 | + * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
37 | + * |
|
38 | + * @param string $wrapperName |
|
39 | + * @param callable $callback |
|
40 | + * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
41 | + * name registered |
|
42 | + * @since 8.0.0 |
|
43 | + */ |
|
44 | + public function addStorageWrapper($wrapperName, $callback); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
48 | - * @param string $class |
|
49 | - * @param array $arguments |
|
50 | - * @return \OCP\Files\Storage |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
46 | + /** |
|
47 | + * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
48 | + * @param string $class |
|
49 | + * @param array $arguments |
|
50 | + * @return \OCP\Files\Storage |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
54 | 54 | } |
@@ -33,30 +33,30 @@ |
||
33 | 33 | * @since 9.0.0 |
34 | 34 | */ |
35 | 35 | interface ILockingStorage { |
36 | - /** |
|
37 | - * @param string $path The path of the file to acquire the lock for |
|
38 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
39 | - * @param \OCP\Lock\ILockingProvider $provider |
|
40 | - * @throws \OCP\Lock\LockedException |
|
41 | - * @since 9.0.0 |
|
42 | - */ |
|
43 | - public function acquireLock($path, $type, ILockingProvider $provider); |
|
36 | + /** |
|
37 | + * @param string $path The path of the file to acquire the lock for |
|
38 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
39 | + * @param \OCP\Lock\ILockingProvider $provider |
|
40 | + * @throws \OCP\Lock\LockedException |
|
41 | + * @since 9.0.0 |
|
42 | + */ |
|
43 | + public function acquireLock($path, $type, ILockingProvider $provider); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param string $path The path of the file to acquire the lock for |
|
47 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
48 | - * @param \OCP\Lock\ILockingProvider $provider |
|
49 | - * @throws \OCP\Lock\LockedException |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function releaseLock($path, $type, ILockingProvider $provider); |
|
45 | + /** |
|
46 | + * @param string $path The path of the file to acquire the lock for |
|
47 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
48 | + * @param \OCP\Lock\ILockingProvider $provider |
|
49 | + * @throws \OCP\Lock\LockedException |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function releaseLock($path, $type, ILockingProvider $provider); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param string $path The path of the file to change the lock for |
|
56 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
57 | - * @param \OCP\Lock\ILockingProvider $provider |
|
58 | - * @throws \OCP\Lock\LockedException |
|
59 | - * @since 9.0.0 |
|
60 | - */ |
|
61 | - public function changeLock($path, $type, ILockingProvider $provider); |
|
54 | + /** |
|
55 | + * @param string $path The path of the file to change the lock for |
|
56 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
57 | + * @param \OCP\Lock\ILockingProvider $provider |
|
58 | + * @throws \OCP\Lock\LockedException |
|
59 | + * @since 9.0.0 |
|
60 | + */ |
|
61 | + public function changeLock($path, $type, ILockingProvider $provider); |
|
62 | 62 | } |
@@ -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 | } |
@@ -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 | } |