@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 7.0.0 |
31 | 31 | */ |
32 | 32 | interface ICacheFactory{ |
33 | - /** |
|
34 | - * Get a memory cache instance |
|
35 | - * |
|
36 | - * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps |
|
37 | - * |
|
38 | - * @param string $prefix |
|
39 | - * @return \OCP\ICache |
|
40 | - * @since 7.0.0 |
|
41 | - */ |
|
42 | - public function create($prefix = ''); |
|
33 | + /** |
|
34 | + * Get a memory cache instance |
|
35 | + * |
|
36 | + * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps |
|
37 | + * |
|
38 | + * @param string $prefix |
|
39 | + * @return \OCP\ICache |
|
40 | + * @since 7.0.0 |
|
41 | + */ |
|
42 | + public function create($prefix = ''); |
|
43 | 43 | |
44 | - /** |
|
45 | - * Check if any memory cache backend is available |
|
46 | - * |
|
47 | - * @return bool |
|
48 | - * @since 7.0.0 |
|
49 | - */ |
|
50 | - public function isAvailable(); |
|
44 | + /** |
|
45 | + * Check if any memory cache backend is available |
|
46 | + * |
|
47 | + * @return bool |
|
48 | + * @since 7.0.0 |
|
49 | + */ |
|
50 | + public function isAvailable(); |
|
51 | 51 | } |
@@ -42,68 +42,68 @@ |
||
42 | 42 | */ |
43 | 43 | interface ISession { |
44 | 44 | |
45 | - /** |
|
46 | - * Set a value in the session |
|
47 | - * |
|
48 | - * @param string $key |
|
49 | - * @param mixed $value |
|
50 | - * @since 6.0.0 |
|
51 | - */ |
|
52 | - public function set($key, $value); |
|
45 | + /** |
|
46 | + * Set a value in the session |
|
47 | + * |
|
48 | + * @param string $key |
|
49 | + * @param mixed $value |
|
50 | + * @since 6.0.0 |
|
51 | + */ |
|
52 | + public function set($key, $value); |
|
53 | 53 | |
54 | - /** |
|
55 | - * Get a value from the session |
|
56 | - * |
|
57 | - * @param string $key |
|
58 | - * @return mixed should return null if $key does not exist |
|
59 | - * @since 6.0.0 |
|
60 | - */ |
|
61 | - public function get($key); |
|
54 | + /** |
|
55 | + * Get a value from the session |
|
56 | + * |
|
57 | + * @param string $key |
|
58 | + * @return mixed should return null if $key does not exist |
|
59 | + * @since 6.0.0 |
|
60 | + */ |
|
61 | + public function get($key); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Check if a named key exists in the session |
|
65 | - * |
|
66 | - * @param string $key |
|
67 | - * @return bool |
|
68 | - * @since 6.0.0 |
|
69 | - */ |
|
70 | - public function exists($key); |
|
63 | + /** |
|
64 | + * Check if a named key exists in the session |
|
65 | + * |
|
66 | + * @param string $key |
|
67 | + * @return bool |
|
68 | + * @since 6.0.0 |
|
69 | + */ |
|
70 | + public function exists($key); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Remove a $key/$value pair from the session |
|
74 | - * |
|
75 | - * @param string $key |
|
76 | - * @since 6.0.0 |
|
77 | - */ |
|
78 | - public function remove($key); |
|
72 | + /** |
|
73 | + * Remove a $key/$value pair from the session |
|
74 | + * |
|
75 | + * @param string $key |
|
76 | + * @since 6.0.0 |
|
77 | + */ |
|
78 | + public function remove($key); |
|
79 | 79 | |
80 | - /** |
|
81 | - * Reset and recreate the session |
|
82 | - * @since 6.0.0 |
|
83 | - */ |
|
84 | - public function clear(); |
|
80 | + /** |
|
81 | + * Reset and recreate the session |
|
82 | + * @since 6.0.0 |
|
83 | + */ |
|
84 | + public function clear(); |
|
85 | 85 | |
86 | - /** |
|
87 | - * Close the session and release the lock |
|
88 | - * @since 7.0.0 |
|
89 | - */ |
|
90 | - public function close(); |
|
86 | + /** |
|
87 | + * Close the session and release the lock |
|
88 | + * @since 7.0.0 |
|
89 | + */ |
|
90 | + public function close(); |
|
91 | 91 | |
92 | - /** |
|
93 | - * Wrapper around session_regenerate_id |
|
94 | - * |
|
95 | - * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
96 | - * @return void |
|
97 | - * @since 9.0.0 |
|
98 | - */ |
|
99 | - public function regenerateId($deleteOldSession = true); |
|
92 | + /** |
|
93 | + * Wrapper around session_regenerate_id |
|
94 | + * |
|
95 | + * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
96 | + * @return void |
|
97 | + * @since 9.0.0 |
|
98 | + */ |
|
99 | + public function regenerateId($deleteOldSession = true); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Wrapper around session_id |
|
103 | - * |
|
104 | - * @return string |
|
105 | - * @throws SessionNotAvailableException |
|
106 | - * @since 9.1.0 |
|
107 | - */ |
|
108 | - public function getId(); |
|
101 | + /** |
|
102 | + * Wrapper around session_id |
|
103 | + * |
|
104 | + * @return string |
|
105 | + * @throws SessionNotAvailableException |
|
106 | + * @since 9.1.0 |
|
107 | + */ |
|
108 | + public function getId(); |
|
109 | 109 | } |
@@ -58,20 +58,20 @@ |
||
58 | 58 | * @since 8.0.0 |
59 | 59 | */ |
60 | 60 | class Constants { |
61 | - /** |
|
62 | - * CRUDS permissions. |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - const PERMISSION_CREATE = 4; |
|
66 | - const PERMISSION_READ = 1; |
|
67 | - const PERMISSION_UPDATE = 2; |
|
68 | - const PERMISSION_DELETE = 8; |
|
69 | - const PERMISSION_SHARE = 16; |
|
70 | - const PERMISSION_ALL = 31; |
|
61 | + /** |
|
62 | + * CRUDS permissions. |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + const PERMISSION_CREATE = 4; |
|
66 | + const PERMISSION_READ = 1; |
|
67 | + const PERMISSION_UPDATE = 2; |
|
68 | + const PERMISSION_DELETE = 8; |
|
69 | + const PERMISSION_SHARE = 16; |
|
70 | + const PERMISSION_ALL = 31; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no |
|
74 | - * longer support windows as server platform. |
|
75 | - */ |
|
76 | - const FILENAME_INVALID_CHARS = "\\/"; |
|
72 | + /** |
|
73 | + * @since 8.0.0 - Updated in 9.0.0 to allow all POSIX chars since we no |
|
74 | + * longer support windows as server platform. |
|
75 | + */ |
|
76 | + const FILENAME_INVALID_CHARS = "\\/"; |
|
77 | 77 | } |
@@ -31,77 +31,77 @@ |
||
31 | 31 | */ |
32 | 32 | interface IMountManager { |
33 | 33 | |
34 | - /** |
|
35 | - * Add a new mount |
|
36 | - * |
|
37 | - * @param \OCP\Files\Mount\IMountPoint $mount |
|
38 | - * @since 8.2.0 |
|
39 | - */ |
|
40 | - public function addMount(IMountPoint $mount); |
|
34 | + /** |
|
35 | + * Add a new mount |
|
36 | + * |
|
37 | + * @param \OCP\Files\Mount\IMountPoint $mount |
|
38 | + * @since 8.2.0 |
|
39 | + */ |
|
40 | + public function addMount(IMountPoint $mount); |
|
41 | 41 | |
42 | - /** |
|
43 | - * Remove a mount |
|
44 | - * |
|
45 | - * @param string $mountPoint |
|
46 | - * @since 8.2.0 |
|
47 | - */ |
|
48 | - public function removeMount($mountPoint); |
|
42 | + /** |
|
43 | + * Remove a mount |
|
44 | + * |
|
45 | + * @param string $mountPoint |
|
46 | + * @since 8.2.0 |
|
47 | + */ |
|
48 | + public function removeMount($mountPoint); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Change the location of a mount |
|
52 | - * |
|
53 | - * @param string $mountPoint |
|
54 | - * @param string $target |
|
55 | - * @since 8.2.0 |
|
56 | - */ |
|
57 | - public function moveMount($mountPoint, $target); |
|
50 | + /** |
|
51 | + * Change the location of a mount |
|
52 | + * |
|
53 | + * @param string $mountPoint |
|
54 | + * @param string $target |
|
55 | + * @since 8.2.0 |
|
56 | + */ |
|
57 | + public function moveMount($mountPoint, $target); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Find the mount for $path |
|
61 | - * |
|
62 | - * @param string $path |
|
63 | - * @return \OCP\Files\Mount\IMountPoint |
|
64 | - * @since 8.2.0 |
|
65 | - */ |
|
66 | - public function find($path); |
|
59 | + /** |
|
60 | + * Find the mount for $path |
|
61 | + * |
|
62 | + * @param string $path |
|
63 | + * @return \OCP\Files\Mount\IMountPoint |
|
64 | + * @since 8.2.0 |
|
65 | + */ |
|
66 | + public function find($path); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Find all mounts in $path |
|
70 | - * |
|
71 | - * @param string $path |
|
72 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
73 | - * @since 8.2.0 |
|
74 | - */ |
|
75 | - public function findIn($path); |
|
68 | + /** |
|
69 | + * Find all mounts in $path |
|
70 | + * |
|
71 | + * @param string $path |
|
72 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
73 | + * @since 8.2.0 |
|
74 | + */ |
|
75 | + public function findIn($path); |
|
76 | 76 | |
77 | - /** |
|
78 | - * Remove all registered mounts |
|
79 | - * |
|
80 | - * @since 8.2.0 |
|
81 | - */ |
|
82 | - public function clear(); |
|
77 | + /** |
|
78 | + * Remove all registered mounts |
|
79 | + * |
|
80 | + * @since 8.2.0 |
|
81 | + */ |
|
82 | + public function clear(); |
|
83 | 83 | |
84 | - /** |
|
85 | - * Find mounts by storage id |
|
86 | - * |
|
87 | - * @param string $id |
|
88 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
89 | - * @since 8.2.0 |
|
90 | - */ |
|
91 | - public function findByStorageId($id); |
|
84 | + /** |
|
85 | + * Find mounts by storage id |
|
86 | + * |
|
87 | + * @param string $id |
|
88 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
89 | + * @since 8.2.0 |
|
90 | + */ |
|
91 | + public function findByStorageId($id); |
|
92 | 92 | |
93 | - /** |
|
94 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
95 | - * @since 8.2.0 |
|
96 | - */ |
|
97 | - public function getAll(); |
|
93 | + /** |
|
94 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
95 | + * @since 8.2.0 |
|
96 | + */ |
|
97 | + public function getAll(); |
|
98 | 98 | |
99 | - /** |
|
100 | - * Find mounts by numeric storage id |
|
101 | - * |
|
102 | - * @param int $id |
|
103 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
104 | - * @since 8.2.0 |
|
105 | - */ |
|
106 | - public function findByNumericId($id); |
|
99 | + /** |
|
100 | + * Find mounts by numeric storage id |
|
101 | + * |
|
102 | + * @param int $id |
|
103 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
104 | + * @since 8.2.0 |
|
105 | + */ |
|
106 | + public function findByNumericId($id); |
|
107 | 107 | } |
@@ -34,46 +34,46 @@ |
||
34 | 34 | **/ |
35 | 35 | interface IMimeTypeDetector { |
36 | 36 | |
37 | - /** |
|
38 | - * detect mimetype only based on filename, content of file is not used |
|
39 | - * @param string $path |
|
40 | - * @return string |
|
41 | - * @since 8.2.0 |
|
42 | - **/ |
|
43 | - public function detectPath($path); |
|
37 | + /** |
|
38 | + * detect mimetype only based on filename, content of file is not used |
|
39 | + * @param string $path |
|
40 | + * @return string |
|
41 | + * @since 8.2.0 |
|
42 | + **/ |
|
43 | + public function detectPath($path); |
|
44 | 44 | |
45 | - /** |
|
46 | - * detect mimetype based on both filename and content |
|
47 | - * |
|
48 | - * @param string $path |
|
49 | - * @return string |
|
50 | - * @since 8.2.0 |
|
51 | - */ |
|
52 | - public function detect($path); |
|
45 | + /** |
|
46 | + * detect mimetype based on both filename and content |
|
47 | + * |
|
48 | + * @param string $path |
|
49 | + * @return string |
|
50 | + * @since 8.2.0 |
|
51 | + */ |
|
52 | + public function detect($path); |
|
53 | 53 | |
54 | - /** |
|
55 | - * Get a secure mimetype that won't expose potential XSS. |
|
56 | - * |
|
57 | - * @param string $mimeType |
|
58 | - * @return string |
|
59 | - * @since 8.2.0 |
|
60 | - */ |
|
61 | - public function getSecureMimeType($mimeType); |
|
54 | + /** |
|
55 | + * Get a secure mimetype that won't expose potential XSS. |
|
56 | + * |
|
57 | + * @param string $mimeType |
|
58 | + * @return string |
|
59 | + * @since 8.2.0 |
|
60 | + */ |
|
61 | + public function getSecureMimeType($mimeType); |
|
62 | 62 | |
63 | - /** |
|
64 | - * detect mimetype based on the content of a string |
|
65 | - * |
|
66 | - * @param string $data |
|
67 | - * @return string |
|
68 | - * @since 8.2.0 |
|
69 | - */ |
|
70 | - public function detectString($data); |
|
63 | + /** |
|
64 | + * detect mimetype based on the content of a string |
|
65 | + * |
|
66 | + * @param string $data |
|
67 | + * @return string |
|
68 | + * @since 8.2.0 |
|
69 | + */ |
|
70 | + public function detectString($data); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get path to the icon of a file type |
|
74 | - * @param string $mimeType the MIME type |
|
75 | - * @return string the url |
|
76 | - * @since 8.2.0 |
|
77 | - */ |
|
78 | - public function mimeTypeIcon($mimeType); |
|
72 | + /** |
|
73 | + * Get path to the icon of a file type |
|
74 | + * @param string $mimeType the MIME type |
|
75 | + * @return string the url |
|
76 | + * @since 8.2.0 |
|
77 | + */ |
|
78 | + public function mimeTypeIcon($mimeType); |
|
79 | 79 | } |
@@ -31,49 +31,49 @@ |
||
31 | 31 | * @since 9.0.0 |
32 | 32 | */ |
33 | 33 | interface ICachedMountInfo { |
34 | - /** |
|
35 | - * @return IUser |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function getUser(); |
|
34 | + /** |
|
35 | + * @return IUser |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function getUser(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return int the numeric storage id of the mount |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function getStorageId(); |
|
40 | + /** |
|
41 | + * @return int the numeric storage id of the mount |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function getStorageId(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return int the fileid of the root of the mount |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function getRootId(); |
|
46 | + /** |
|
47 | + * @return int the fileid of the root of the mount |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function getRootId(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return Node the root node of the mount |
|
54 | - * @since 9.0.0 |
|
55 | - */ |
|
56 | - public function getMountPointNode(); |
|
52 | + /** |
|
53 | + * @return Node the root node of the mount |
|
54 | + * @since 9.0.0 |
|
55 | + */ |
|
56 | + public function getMountPointNode(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return string the mount point of the mount for the user |
|
60 | - * @since 9.0.0 |
|
61 | - */ |
|
62 | - public function getMountPoint(); |
|
58 | + /** |
|
59 | + * @return string the mount point of the mount for the user |
|
60 | + * @since 9.0.0 |
|
61 | + */ |
|
62 | + public function getMountPoint(); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the id of the configured mount |
|
66 | - * |
|
67 | - * @return int|null mount id or null if not applicable |
|
68 | - * @since 9.1.0 |
|
69 | - */ |
|
70 | - public function getMountId(); |
|
64 | + /** |
|
65 | + * Get the id of the configured mount |
|
66 | + * |
|
67 | + * @return int|null mount id or null if not applicable |
|
68 | + * @since 9.1.0 |
|
69 | + */ |
|
70 | + public function getMountId(); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get the internal path (within the storage) of the root of the mount |
|
74 | - * |
|
75 | - * @return string |
|
76 | - * @since 11.0.0 |
|
77 | - */ |
|
78 | - public function getRootInternalPath(); |
|
72 | + /** |
|
73 | + * Get the internal path (within the storage) of the root of the mount |
|
74 | + * |
|
75 | + * @return string |
|
76 | + * @since 11.0.0 |
|
77 | + */ |
|
78 | + public function getRootInternalPath(); |
|
79 | 79 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface IMountProvider { |
34 | - /** |
|
35 | - * Get all mountpoints applicable for the user |
|
36 | - * |
|
37 | - * @param \OCP\IUser $user |
|
38 | - * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | - * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | - * @since 8.0.0 |
|
41 | - */ |
|
42 | - public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
34 | + /** |
|
35 | + * Get all mountpoints applicable for the user |
|
36 | + * |
|
37 | + * @param \OCP\IUser $user |
|
38 | + * @param \OCP\Files\Storage\IStorageFactory $loader |
|
39 | + * @return \OCP\Files\Mount\IMountPoint[] |
|
40 | + * @since 8.0.0 |
|
41 | + */ |
|
42 | + public function getMountsForUser(IUser $user, IStorageFactory $loader); |
|
43 | 43 | } |
@@ -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 | } |