@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface IMountProvider { |
34 | - /** |
|
35 | - * Get all mountpoints applicable for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | - * @since 8.0.0 |
|
41 | - */ |
|
42 | - public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
34 | + /** |
|
35 | + * Get all mountpoints applicable for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | + * @since 8.0.0 |
|
41 | + */ |
|
42 | + public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
43 | 43 | } |
@@ -31,45 +31,45 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface IMountProviderCollection { |
34 | - /** |
|
35 | - * Get all configured mount points for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
39 | - * @since 8.0.0 |
|
40 | - */ |
|
41 | - public function getMountsForUser(IUser $user); |
|
34 | + /** |
|
35 | + * Get all configured mount points for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
39 | + * @since 8.0.0 |
|
40 | + */ |
|
41 | + public function getMountsForUser(IUser $user); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Get the configured home mount for this user |
|
45 | - * |
|
46 | - * @param \OCP\IUser $user |
|
47 | - * @return \OCP\Files\Mount\IMountPoint |
|
48 | - * @since 9.1.0 |
|
49 | - */ |
|
50 | - public function getHomeMountForUser(IUser $user); |
|
43 | + /** |
|
44 | + * Get the configured home mount for this user |
|
45 | + * |
|
46 | + * @param \OCP\IUser $user |
|
47 | + * @return \OCP\Files\Mount\IMountPoint |
|
48 | + * @since 9.1.0 |
|
49 | + */ |
|
50 | + public function getHomeMountForUser(IUser $user); |
|
51 | 51 | |
52 | - /** |
|
53 | - * Add a provider for mount points |
|
54 | - * |
|
55 | - * @param \OCP\Files\Config\IMountProvider $provider |
|
56 | - * @since 8.0.0 |
|
57 | - */ |
|
58 | - public function registerProvider(IMountProvider $provider); |
|
52 | + /** |
|
53 | + * Add a provider for mount points |
|
54 | + * |
|
55 | + * @param \OCP\Files\Config\IMountProvider $provider |
|
56 | + * @since 8.0.0 |
|
57 | + */ |
|
58 | + public function registerProvider(IMountProvider $provider); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Add a provider for home mount points |
|
62 | - * |
|
63 | - * @param \OCP\Files\Config\IHomeMountProvider $provider |
|
64 | - * @since 9.1.0 |
|
65 | - */ |
|
66 | - public function registerHomeProvider(IHomeMountProvider $provider); |
|
60 | + /** |
|
61 | + * Add a provider for home mount points |
|
62 | + * |
|
63 | + * @param \OCP\Files\Config\IHomeMountProvider $provider |
|
64 | + * @since 9.1.0 |
|
65 | + */ |
|
66 | + public function registerHomeProvider(IHomeMountProvider $provider); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Get the mount cache which can be used to search for mounts without setting up the filesystem |
|
70 | - * |
|
71 | - * @return IUserMountCache |
|
72 | - * @since 9.0.0 |
|
73 | - */ |
|
74 | - public function getMountCache(); |
|
68 | + /** |
|
69 | + * Get the mount cache which can be used to search for mounts without setting up the filesystem |
|
70 | + * |
|
71 | + * @return IUserMountCache |
|
72 | + * @since 9.0.0 |
|
73 | + */ |
|
74 | + public function getMountCache(); |
|
75 | 75 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 9.1.0 |
32 | 32 | */ |
33 | 33 | interface IHomeMountProvider { |
34 | - /** |
|
35 | - * Get all mountpoints applicable for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | - * @return \OCP\Files\Mount\IMountPoint|null |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
34 | + /** |
|
35 | + * Get all mountpoints applicable for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | + * @return \OCP\Files\Mount\IMountPoint|null |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function getHomeMountForUser(IUser $user, IStorageFactory $loader); |
|
43 | 43 | } |
@@ -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 | } |
@@ -33,68 +33,68 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISimpleFile { |
35 | 35 | |
36 | - /** |
|
37 | - * Get the name |
|
38 | - * |
|
39 | - * @return string |
|
40 | - * @since 11.0.0 |
|
41 | - */ |
|
42 | - public function getName(); |
|
36 | + /** |
|
37 | + * Get the name |
|
38 | + * |
|
39 | + * @return string |
|
40 | + * @since 11.0.0 |
|
41 | + */ |
|
42 | + public function getName(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * Get the size in bytes |
|
46 | - * |
|
47 | - * @return int |
|
48 | - * @since 11.0.0 |
|
49 | - */ |
|
50 | - public function getSize(); |
|
44 | + /** |
|
45 | + * Get the size in bytes |
|
46 | + * |
|
47 | + * @return int |
|
48 | + * @since 11.0.0 |
|
49 | + */ |
|
50 | + public function getSize(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * Get the ETag |
|
54 | - * |
|
55 | - * @return string |
|
56 | - * @since 11.0.0 |
|
57 | - */ |
|
58 | - public function getETag(); |
|
52 | + /** |
|
53 | + * Get the ETag |
|
54 | + * |
|
55 | + * @return string |
|
56 | + * @since 11.0.0 |
|
57 | + */ |
|
58 | + public function getETag(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Get the last modification time |
|
62 | - * |
|
63 | - * @return int |
|
64 | - * @since 11.0.0 |
|
65 | - */ |
|
66 | - public function getMTime(); |
|
60 | + /** |
|
61 | + * Get the last modification time |
|
62 | + * |
|
63 | + * @return int |
|
64 | + * @since 11.0.0 |
|
65 | + */ |
|
66 | + public function getMTime(); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Get the content |
|
70 | - * |
|
71 | - * @return string |
|
72 | - * @since 11.0.0 |
|
73 | - */ |
|
74 | - public function getContent(); |
|
68 | + /** |
|
69 | + * Get the content |
|
70 | + * |
|
71 | + * @return string |
|
72 | + * @since 11.0.0 |
|
73 | + */ |
|
74 | + public function getContent(); |
|
75 | 75 | |
76 | - /** |
|
77 | - * Overwrite the file |
|
78 | - * |
|
79 | - * @param string $data |
|
80 | - * @throws NotPermittedException |
|
81 | - * @since 11.0.0 |
|
82 | - */ |
|
83 | - public function putContent($data); |
|
76 | + /** |
|
77 | + * Overwrite the file |
|
78 | + * |
|
79 | + * @param string $data |
|
80 | + * @throws NotPermittedException |
|
81 | + * @since 11.0.0 |
|
82 | + */ |
|
83 | + public function putContent($data); |
|
84 | 84 | |
85 | - /** |
|
86 | - * Delete the file |
|
87 | - * |
|
88 | - * @throws NotPermittedException |
|
89 | - * @since 11.0.0 |
|
90 | - */ |
|
91 | - public function delete(); |
|
85 | + /** |
|
86 | + * Delete the file |
|
87 | + * |
|
88 | + * @throws NotPermittedException |
|
89 | + * @since 11.0.0 |
|
90 | + */ |
|
91 | + public function delete(); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Get the MimeType |
|
95 | - * |
|
96 | - * @return string |
|
97 | - * @since 11.0.0 |
|
98 | - */ |
|
99 | - public function getMimeType(); |
|
93 | + /** |
|
94 | + * Get the MimeType |
|
95 | + * |
|
96 | + * @return string |
|
97 | + * @since 11.0.0 |
|
98 | + */ |
|
99 | + public function getMimeType(); |
|
100 | 100 | } |
@@ -39,61 +39,61 @@ |
||
39 | 39 | * @since 6.0.0 |
40 | 40 | */ |
41 | 41 | interface File extends Node { |
42 | - /** |
|
43 | - * Get the content of the file as string |
|
44 | - * |
|
45 | - * @return string |
|
46 | - * @throws \OCP\Files\NotPermittedException |
|
47 | - * @since 6.0.0 |
|
48 | - */ |
|
49 | - public function getContent(); |
|
42 | + /** |
|
43 | + * Get the content of the file as string |
|
44 | + * |
|
45 | + * @return string |
|
46 | + * @throws \OCP\Files\NotPermittedException |
|
47 | + * @since 6.0.0 |
|
48 | + */ |
|
49 | + public function getContent(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Write to the file from string data |
|
53 | - * |
|
54 | - * @param string $data |
|
55 | - * @throws \OCP\Files\NotPermittedException |
|
56 | - * @return void |
|
57 | - * @since 6.0.0 |
|
58 | - */ |
|
59 | - public function putContent($data); |
|
51 | + /** |
|
52 | + * Write to the file from string data |
|
53 | + * |
|
54 | + * @param string $data |
|
55 | + * @throws \OCP\Files\NotPermittedException |
|
56 | + * @return void |
|
57 | + * @since 6.0.0 |
|
58 | + */ |
|
59 | + public function putContent($data); |
|
60 | 60 | |
61 | - /** |
|
62 | - * Get the mimetype of the file |
|
63 | - * |
|
64 | - * @return string |
|
65 | - * @since 6.0.0 |
|
66 | - */ |
|
67 | - public function getMimeType(); |
|
61 | + /** |
|
62 | + * Get the mimetype of the file |
|
63 | + * |
|
64 | + * @return string |
|
65 | + * @since 6.0.0 |
|
66 | + */ |
|
67 | + public function getMimeType(); |
|
68 | 68 | |
69 | - /** |
|
70 | - * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen |
|
71 | - * |
|
72 | - * @param string $mode |
|
73 | - * @return resource |
|
74 | - * @throws \OCP\Files\NotPermittedException |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function fopen($mode); |
|
69 | + /** |
|
70 | + * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen |
|
71 | + * |
|
72 | + * @param string $mode |
|
73 | + * @return resource |
|
74 | + * @throws \OCP\Files\NotPermittedException |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function fopen($mode); |
|
78 | 78 | |
79 | - /** |
|
80 | - * Compute the hash of the file |
|
81 | - * Type of hash is set with $type and can be anything supported by php's hash_file |
|
82 | - * |
|
83 | - * @param string $type |
|
84 | - * @param bool $raw |
|
85 | - * @return string |
|
86 | - * @since 6.0.0 |
|
87 | - */ |
|
88 | - public function hash($type, $raw = false); |
|
79 | + /** |
|
80 | + * Compute the hash of the file |
|
81 | + * Type of hash is set with $type and can be anything supported by php's hash_file |
|
82 | + * |
|
83 | + * @param string $type |
|
84 | + * @param bool $raw |
|
85 | + * @return string |
|
86 | + * @since 6.0.0 |
|
87 | + */ |
|
88 | + public function hash($type, $raw = false); |
|
89 | 89 | |
90 | - /** |
|
91 | - * Get the stored checksum for this file |
|
92 | - * |
|
93 | - * @return string |
|
94 | - * @since 9.0.0 |
|
95 | - * @throws InvalidPathException |
|
96 | - * @throws NotFoundException |
|
97 | - */ |
|
98 | - public function getChecksum(); |
|
90 | + /** |
|
91 | + * Get the stored checksum for this file |
|
92 | + * |
|
93 | + * @return string |
|
94 | + * @since 9.0.0 |
|
95 | + * @throws InvalidPathException |
|
96 | + * @throws NotFoundException |
|
97 | + */ |
|
98 | + public function getChecksum(); |
|
99 | 99 | } |
@@ -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 | } |
@@ -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 | } |