@@ -33,151 +33,151 @@ |
||
33 | 33 | */ |
34 | 34 | interface IStorage { |
35 | 35 | |
36 | - /** |
|
37 | - * get user specific key |
|
38 | - * |
|
39 | - * @param string $uid ID if the user for whom we want the key |
|
40 | - * @param string $keyId id of the key |
|
41 | - * @param string $encryptionModuleId |
|
42 | - * |
|
43 | - * @return mixed key |
|
44 | - * @since 8.1.0 |
|
45 | - */ |
|
46 | - public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
36 | + /** |
|
37 | + * get user specific key |
|
38 | + * |
|
39 | + * @param string $uid ID if the user for whom we want the key |
|
40 | + * @param string $keyId id of the key |
|
41 | + * @param string $encryptionModuleId |
|
42 | + * |
|
43 | + * @return mixed key |
|
44 | + * @since 8.1.0 |
|
45 | + */ |
|
46 | + public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
47 | 47 | |
48 | - /** |
|
49 | - * get file specific key |
|
50 | - * |
|
51 | - * @param string $path path to file |
|
52 | - * @param string $keyId id of the key |
|
53 | - * @param string $encryptionModuleId |
|
54 | - * |
|
55 | - * @return mixed key |
|
56 | - * @since 8.1.0 |
|
57 | - */ |
|
58 | - public function getFileKey($path, $keyId, $encryptionModuleId); |
|
48 | + /** |
|
49 | + * get file specific key |
|
50 | + * |
|
51 | + * @param string $path path to file |
|
52 | + * @param string $keyId id of the key |
|
53 | + * @param string $encryptionModuleId |
|
54 | + * |
|
55 | + * @return mixed key |
|
56 | + * @since 8.1.0 |
|
57 | + */ |
|
58 | + public function getFileKey($path, $keyId, $encryptionModuleId); |
|
59 | 59 | |
60 | - /** |
|
61 | - * get system-wide encryption keys not related to a specific user, |
|
62 | - * e.g something like a key for public link shares |
|
63 | - * |
|
64 | - * @param string $keyId id of the key |
|
65 | - * @param string $encryptionModuleId |
|
66 | - * |
|
67 | - * @return mixed key |
|
68 | - * @since 8.1.0 |
|
69 | - */ |
|
70 | - public function getSystemUserKey($keyId, $encryptionModuleId); |
|
60 | + /** |
|
61 | + * get system-wide encryption keys not related to a specific user, |
|
62 | + * e.g something like a key for public link shares |
|
63 | + * |
|
64 | + * @param string $keyId id of the key |
|
65 | + * @param string $encryptionModuleId |
|
66 | + * |
|
67 | + * @return mixed key |
|
68 | + * @since 8.1.0 |
|
69 | + */ |
|
70 | + public function getSystemUserKey($keyId, $encryptionModuleId); |
|
71 | 71 | |
72 | - /** |
|
73 | - * set user specific key |
|
74 | - * |
|
75 | - * @param string $uid ID if the user for whom we want the key |
|
76 | - * @param string $keyId id of the key |
|
77 | - * @param mixed $key |
|
78 | - * @param string $encryptionModuleId |
|
79 | - * @since 8.1.0 |
|
80 | - */ |
|
81 | - public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
72 | + /** |
|
73 | + * set user specific key |
|
74 | + * |
|
75 | + * @param string $uid ID if the user for whom we want the key |
|
76 | + * @param string $keyId id of the key |
|
77 | + * @param mixed $key |
|
78 | + * @param string $encryptionModuleId |
|
79 | + * @since 8.1.0 |
|
80 | + */ |
|
81 | + public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
82 | 82 | |
83 | - /** |
|
84 | - * set file specific key |
|
85 | - * |
|
86 | - * @param string $path path to file |
|
87 | - * @param string $keyId id of the key |
|
88 | - * @param mixed $key |
|
89 | - * @param string $encryptionModuleId |
|
90 | - * @since 8.1.0 |
|
91 | - */ |
|
92 | - public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
83 | + /** |
|
84 | + * set file specific key |
|
85 | + * |
|
86 | + * @param string $path path to file |
|
87 | + * @param string $keyId id of the key |
|
88 | + * @param mixed $key |
|
89 | + * @param string $encryptionModuleId |
|
90 | + * @since 8.1.0 |
|
91 | + */ |
|
92 | + public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
93 | 93 | |
94 | - /** |
|
95 | - * set system-wide encryption keys not related to a specific user, |
|
96 | - * e.g something like a key for public link shares |
|
97 | - * |
|
98 | - * @param string $keyId id of the key |
|
99 | - * @param mixed $key |
|
100 | - * @param string $encryptionModuleId |
|
101 | - * |
|
102 | - * @return mixed key |
|
103 | - * @since 8.1.0 |
|
104 | - */ |
|
105 | - public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
94 | + /** |
|
95 | + * set system-wide encryption keys not related to a specific user, |
|
96 | + * e.g something like a key for public link shares |
|
97 | + * |
|
98 | + * @param string $keyId id of the key |
|
99 | + * @param mixed $key |
|
100 | + * @param string $encryptionModuleId |
|
101 | + * |
|
102 | + * @return mixed key |
|
103 | + * @since 8.1.0 |
|
104 | + */ |
|
105 | + public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
106 | 106 | |
107 | - /** |
|
108 | - * delete user specific key |
|
109 | - * |
|
110 | - * @param string $uid ID if the user for whom we want to delete the key |
|
111 | - * @param string $keyId id of the key |
|
112 | - * @param string $encryptionModuleId |
|
113 | - * |
|
114 | - * @return boolean False when the key could not be deleted |
|
115 | - * @since 8.1.0 |
|
116 | - */ |
|
117 | - public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
107 | + /** |
|
108 | + * delete user specific key |
|
109 | + * |
|
110 | + * @param string $uid ID if the user for whom we want to delete the key |
|
111 | + * @param string $keyId id of the key |
|
112 | + * @param string $encryptionModuleId |
|
113 | + * |
|
114 | + * @return boolean False when the key could not be deleted |
|
115 | + * @since 8.1.0 |
|
116 | + */ |
|
117 | + public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
118 | 118 | |
119 | - /** |
|
120 | - * delete file specific key |
|
121 | - * |
|
122 | - * @param string $path path to file |
|
123 | - * @param string $keyId id of the key |
|
124 | - * @param string $encryptionModuleId |
|
125 | - * |
|
126 | - * @return boolean False when the key could not be deleted |
|
127 | - * @since 8.1.0 |
|
128 | - */ |
|
129 | - public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
119 | + /** |
|
120 | + * delete file specific key |
|
121 | + * |
|
122 | + * @param string $path path to file |
|
123 | + * @param string $keyId id of the key |
|
124 | + * @param string $encryptionModuleId |
|
125 | + * |
|
126 | + * @return boolean False when the key could not be deleted |
|
127 | + * @since 8.1.0 |
|
128 | + */ |
|
129 | + public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
130 | 130 | |
131 | - /** |
|
132 | - * delete all file keys for a given file |
|
133 | - * |
|
134 | - * @param string $path to the file |
|
135 | - * |
|
136 | - * @return boolean False when the keys could not be deleted |
|
137 | - * @since 8.1.0 |
|
138 | - */ |
|
139 | - public function deleteAllFileKeys($path); |
|
131 | + /** |
|
132 | + * delete all file keys for a given file |
|
133 | + * |
|
134 | + * @param string $path to the file |
|
135 | + * |
|
136 | + * @return boolean False when the keys could not be deleted |
|
137 | + * @since 8.1.0 |
|
138 | + */ |
|
139 | + public function deleteAllFileKeys($path); |
|
140 | 140 | |
141 | - /** |
|
142 | - * delete system-wide encryption keys not related to a specific user, |
|
143 | - * e.g something like a key for public link shares |
|
144 | - * |
|
145 | - * @param string $keyId id of the key |
|
146 | - * @param string $encryptionModuleId |
|
147 | - * |
|
148 | - * @return boolean False when the key could not be deleted |
|
149 | - * @since 8.1.0 |
|
150 | - */ |
|
151 | - public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
141 | + /** |
|
142 | + * delete system-wide encryption keys not related to a specific user, |
|
143 | + * e.g something like a key for public link shares |
|
144 | + * |
|
145 | + * @param string $keyId id of the key |
|
146 | + * @param string $encryptionModuleId |
|
147 | + * |
|
148 | + * @return boolean False when the key could not be deleted |
|
149 | + * @since 8.1.0 |
|
150 | + */ |
|
151 | + public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
152 | 152 | |
153 | - /** |
|
154 | - * copy keys if a file was renamed |
|
155 | - * |
|
156 | - * @param string $source |
|
157 | - * @param string $target |
|
158 | - * @return boolean |
|
159 | - * @since 8.1.0 |
|
160 | - */ |
|
161 | - public function renameKeys($source, $target); |
|
153 | + /** |
|
154 | + * copy keys if a file was renamed |
|
155 | + * |
|
156 | + * @param string $source |
|
157 | + * @param string $target |
|
158 | + * @return boolean |
|
159 | + * @since 8.1.0 |
|
160 | + */ |
|
161 | + public function renameKeys($source, $target); |
|
162 | 162 | |
163 | - /** |
|
164 | - * move keys if a file was renamed |
|
165 | - * |
|
166 | - * @param string $source |
|
167 | - * @param string $target |
|
168 | - * @return boolean |
|
169 | - * @since 8.1.0 |
|
170 | - */ |
|
171 | - public function copyKeys($source, $target); |
|
163 | + /** |
|
164 | + * move keys if a file was renamed |
|
165 | + * |
|
166 | + * @param string $source |
|
167 | + * @param string $target |
|
168 | + * @return boolean |
|
169 | + * @since 8.1.0 |
|
170 | + */ |
|
171 | + public function copyKeys($source, $target); |
|
172 | 172 | |
173 | - /** |
|
174 | - * backup keys of a given encryption module |
|
175 | - * |
|
176 | - * @param string $encryptionModuleId |
|
177 | - * @param string $purpose |
|
178 | - * @param string $uid |
|
179 | - * @return bool |
|
180 | - * @since 12.0.0 |
|
181 | - */ |
|
182 | - public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
173 | + /** |
|
174 | + * backup keys of a given encryption module |
|
175 | + * |
|
176 | + * @param string $encryptionModuleId |
|
177 | + * @param string $purpose |
|
178 | + * @param string $uid |
|
179 | + * @return bool |
|
180 | + * @since 12.0.0 |
|
181 | + */ |
|
182 | + public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
183 | 183 | } |
@@ -46,7 +46,7 @@ |
||
46 | 46 | /** |
47 | 47 | * @since 9.2.0 |
48 | 48 | */ |
49 | - const EVENT = self::class . ':' . 'PreviewRequested'; |
|
49 | + const EVENT = self::class.':'.'PreviewRequested'; |
|
50 | 50 | |
51 | 51 | const MODE_FILL = 'fill'; |
52 | 52 | const MODE_COVER = 'cover'; |
@@ -43,86 +43,86 @@ |
||
43 | 43 | */ |
44 | 44 | interface IPreview { |
45 | 45 | |
46 | - /** |
|
47 | - * @since 9.2.0 |
|
48 | - */ |
|
49 | - const EVENT = self::class . ':' . 'PreviewRequested'; |
|
46 | + /** |
|
47 | + * @since 9.2.0 |
|
48 | + */ |
|
49 | + const EVENT = self::class . ':' . 'PreviewRequested'; |
|
50 | 50 | |
51 | - const MODE_FILL = 'fill'; |
|
52 | - const MODE_COVER = 'cover'; |
|
51 | + const MODE_FILL = 'fill'; |
|
52 | + const MODE_COVER = 'cover'; |
|
53 | 53 | |
54 | - /** |
|
55 | - * In order to improve lazy loading a closure can be registered which will be |
|
56 | - * called in case preview providers are actually requested |
|
57 | - * |
|
58 | - * $callable has to return an instance of \OCP\Preview\IProvider |
|
59 | - * |
|
60 | - * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider |
|
61 | - * @param \Closure $callable |
|
62 | - * @return void |
|
63 | - * @since 8.1.0 |
|
64 | - */ |
|
65 | - public function registerProvider($mimeTypeRegex, \Closure $callable); |
|
54 | + /** |
|
55 | + * In order to improve lazy loading a closure can be registered which will be |
|
56 | + * called in case preview providers are actually requested |
|
57 | + * |
|
58 | + * $callable has to return an instance of \OCP\Preview\IProvider |
|
59 | + * |
|
60 | + * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider |
|
61 | + * @param \Closure $callable |
|
62 | + * @return void |
|
63 | + * @since 8.1.0 |
|
64 | + */ |
|
65 | + public function registerProvider($mimeTypeRegex, \Closure $callable); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Get all providers |
|
69 | - * @return array |
|
70 | - * @since 8.1.0 |
|
71 | - */ |
|
72 | - public function getProviders(); |
|
67 | + /** |
|
68 | + * Get all providers |
|
69 | + * @return array |
|
70 | + * @since 8.1.0 |
|
71 | + */ |
|
72 | + public function getProviders(); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Does the manager have any providers |
|
76 | - * @return bool |
|
77 | - * @since 8.1.0 |
|
78 | - */ |
|
79 | - public function hasProviders(); |
|
74 | + /** |
|
75 | + * Does the manager have any providers |
|
76 | + * @return bool |
|
77 | + * @since 8.1.0 |
|
78 | + */ |
|
79 | + public function hasProviders(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Return a preview of a file |
|
83 | - * @param string $file The path to the file where you want a thumbnail from |
|
84 | - * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
85 | - * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
86 | - * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly |
|
87 | - * @return \OCP\IImage |
|
88 | - * @since 6.0.0 |
|
89 | - * @deprecated 11 Use getPreview |
|
90 | - */ |
|
91 | - public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false); |
|
81 | + /** |
|
82 | + * Return a preview of a file |
|
83 | + * @param string $file The path to the file where you want a thumbnail from |
|
84 | + * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
85 | + * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
86 | + * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly |
|
87 | + * @return \OCP\IImage |
|
88 | + * @since 6.0.0 |
|
89 | + * @deprecated 11 Use getPreview |
|
90 | + */ |
|
91 | + public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Returns a preview of a file |
|
95 | - * |
|
96 | - * The cache is searched first and if nothing usable was found then a preview is |
|
97 | - * generated by one of the providers |
|
98 | - * |
|
99 | - * @param File $file |
|
100 | - * @param int $width |
|
101 | - * @param int $height |
|
102 | - * @param bool $crop |
|
103 | - * @param string $mode |
|
104 | - * @param string $mimeType To force a given mimetype for the file (files_versions needs this) |
|
105 | - * @return ISimpleFile |
|
106 | - * @throws NotFoundException |
|
107 | - * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) |
|
108 | - * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 |
|
109 | - */ |
|
110 | - public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null); |
|
93 | + /** |
|
94 | + * Returns a preview of a file |
|
95 | + * |
|
96 | + * The cache is searched first and if nothing usable was found then a preview is |
|
97 | + * generated by one of the providers |
|
98 | + * |
|
99 | + * @param File $file |
|
100 | + * @param int $width |
|
101 | + * @param int $height |
|
102 | + * @param bool $crop |
|
103 | + * @param string $mode |
|
104 | + * @param string $mimeType To force a given mimetype for the file (files_versions needs this) |
|
105 | + * @return ISimpleFile |
|
106 | + * @throws NotFoundException |
|
107 | + * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) |
|
108 | + * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 |
|
109 | + */ |
|
110 | + public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null); |
|
111 | 111 | |
112 | - /** |
|
113 | - * Returns true if the passed mime type is supported |
|
114 | - * @param string $mimeType |
|
115 | - * @return boolean |
|
116 | - * @since 6.0.0 |
|
117 | - */ |
|
118 | - public function isMimeSupported($mimeType = '*'); |
|
112 | + /** |
|
113 | + * Returns true if the passed mime type is supported |
|
114 | + * @param string $mimeType |
|
115 | + * @return boolean |
|
116 | + * @since 6.0.0 |
|
117 | + */ |
|
118 | + public function isMimeSupported($mimeType = '*'); |
|
119 | 119 | |
120 | - /** |
|
121 | - * Check if a preview can be generated for a file |
|
122 | - * |
|
123 | - * @param \OCP\Files\FileInfo $file |
|
124 | - * @return bool |
|
125 | - * @since 8.0.0 |
|
126 | - */ |
|
127 | - public function isAvailable(\OCP\Files\FileInfo $file); |
|
120 | + /** |
|
121 | + * Check if a preview can be generated for a file |
|
122 | + * |
|
123 | + * @param \OCP\Files\FileInfo $file |
|
124 | + * @return bool |
|
125 | + * @since 8.0.0 |
|
126 | + */ |
|
127 | + public function isAvailable(\OCP\Files\FileInfo $file); |
|
128 | 128 | } |
@@ -33,46 +33,46 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISearch { |
35 | 35 | |
36 | - /** |
|
37 | - * Search all providers for $query |
|
38 | - * @param string $query |
|
39 | - * @param string[] $inApps optionally limit results to the given apps |
|
40 | - * @return array An array of OCP\Search\Result's |
|
41 | - * @deprecated 8.0.0 use searchPaged() with page and size |
|
42 | - * @since 7.0.0 - parameter $inApps was added in 8.0.0 |
|
43 | - */ |
|
44 | - public function search($query, array $inApps = array()); |
|
36 | + /** |
|
37 | + * Search all providers for $query |
|
38 | + * @param string $query |
|
39 | + * @param string[] $inApps optionally limit results to the given apps |
|
40 | + * @return array An array of OCP\Search\Result's |
|
41 | + * @deprecated 8.0.0 use searchPaged() with page and size |
|
42 | + * @since 7.0.0 - parameter $inApps was added in 8.0.0 |
|
43 | + */ |
|
44 | + public function search($query, array $inApps = array()); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Search all providers for $query |
|
48 | - * @param string $query |
|
49 | - * @param string[] $inApps optionally limit results to the given apps |
|
50 | - * @param int $page pages start at page 1 |
|
51 | - * @param int $size |
|
52 | - * @return array An array of OCP\Search\Result's |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30); |
|
46 | + /** |
|
47 | + * Search all providers for $query |
|
48 | + * @param string $query |
|
49 | + * @param string[] $inApps optionally limit results to the given apps |
|
50 | + * @param int $page pages start at page 1 |
|
51 | + * @param int $size |
|
52 | + * @return array An array of OCP\Search\Result's |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Register a new search provider to search with |
|
59 | - * @param string $class class name of a OCP\Search\Provider |
|
60 | - * @param array $options optional |
|
61 | - * @since 7.0.0 |
|
62 | - */ |
|
63 | - public function registerProvider($class, array $options = array()); |
|
57 | + /** |
|
58 | + * Register a new search provider to search with |
|
59 | + * @param string $class class name of a OCP\Search\Provider |
|
60 | + * @param array $options optional |
|
61 | + * @since 7.0.0 |
|
62 | + */ |
|
63 | + public function registerProvider($class, array $options = array()); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Remove one existing search provider |
|
67 | - * @param string $provider class name of a OCP\Search\Provider |
|
68 | - * @since 7.0.0 |
|
69 | - */ |
|
70 | - public function removeProvider($provider); |
|
65 | + /** |
|
66 | + * Remove one existing search provider |
|
67 | + * @param string $provider class name of a OCP\Search\Provider |
|
68 | + * @since 7.0.0 |
|
69 | + */ |
|
70 | + public function removeProvider($provider); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Remove all registered search providers |
|
74 | - * @since 7.0.0 |
|
75 | - */ |
|
76 | - public function clearProviders(); |
|
72 | + /** |
|
73 | + * Remove all registered search providers |
|
74 | + * @since 7.0.0 |
|
75 | + */ |
|
76 | + public function clearProviders(); |
|
77 | 77 | |
78 | 78 | } |
@@ -29,41 +29,41 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISystemTag { |
31 | 31 | |
32 | - /** |
|
33 | - * Returns the tag id |
|
34 | - * |
|
35 | - * @return string id |
|
36 | - * |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getId(); |
|
32 | + /** |
|
33 | + * Returns the tag id |
|
34 | + * |
|
35 | + * @return string id |
|
36 | + * |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getId(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Returns the tag display name |
|
43 | - * |
|
44 | - * @return string tag display name |
|
45 | - * |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function getName(); |
|
41 | + /** |
|
42 | + * Returns the tag display name |
|
43 | + * |
|
44 | + * @return string tag display name |
|
45 | + * |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function getName(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns whether the tag is visible for regular users |
|
52 | - * |
|
53 | - * @return bool true if visible, false otherwise |
|
54 | - * |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function isUserVisible(); |
|
50 | + /** |
|
51 | + * Returns whether the tag is visible for regular users |
|
52 | + * |
|
53 | + * @return bool true if visible, false otherwise |
|
54 | + * |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function isUserVisible(); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns whether the tag can be assigned to objects by regular users |
|
61 | - * |
|
62 | - * @return bool true if assignable, false otherwise |
|
63 | - * |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function isUserAssignable(); |
|
59 | + /** |
|
60 | + * Returns whether the tag can be assigned to objects by regular users |
|
61 | + * |
|
62 | + * @return bool true if assignable, false otherwise |
|
63 | + * |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function isUserAssignable(); |
|
67 | 67 | |
68 | 68 | } |
69 | 69 |
@@ -32,63 +32,63 @@ |
||
32 | 32 | */ |
33 | 33 | class MapperEvent extends Event { |
34 | 34 | |
35 | - const EVENT_ASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'; |
|
36 | - const EVENT_UNASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'; |
|
35 | + const EVENT_ASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'; |
|
36 | + const EVENT_UNASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'; |
|
37 | 37 | |
38 | - /** @var string */ |
|
39 | - protected $event; |
|
40 | - /** @var string */ |
|
41 | - protected $objectType; |
|
42 | - /** @var string */ |
|
43 | - protected $objectId; |
|
44 | - /** @var int[] */ |
|
45 | - protected $tags; |
|
38 | + /** @var string */ |
|
39 | + protected $event; |
|
40 | + /** @var string */ |
|
41 | + protected $objectType; |
|
42 | + /** @var string */ |
|
43 | + protected $objectId; |
|
44 | + /** @var int[] */ |
|
45 | + protected $tags; |
|
46 | 46 | |
47 | - /** |
|
48 | - * DispatcherEvent constructor. |
|
49 | - * |
|
50 | - * @param string $event |
|
51 | - * @param string $objectType |
|
52 | - * @param string $objectId |
|
53 | - * @param int[] $tags |
|
54 | - * @since 9.0.0 |
|
55 | - */ |
|
56 | - public function __construct($event, $objectType, $objectId, array $tags) { |
|
57 | - $this->event = $event; |
|
58 | - $this->objectType = $objectType; |
|
59 | - $this->objectId = $objectId; |
|
60 | - $this->tags = $tags; |
|
61 | - } |
|
47 | + /** |
|
48 | + * DispatcherEvent constructor. |
|
49 | + * |
|
50 | + * @param string $event |
|
51 | + * @param string $objectType |
|
52 | + * @param string $objectId |
|
53 | + * @param int[] $tags |
|
54 | + * @since 9.0.0 |
|
55 | + */ |
|
56 | + public function __construct($event, $objectType, $objectId, array $tags) { |
|
57 | + $this->event = $event; |
|
58 | + $this->objectType = $objectType; |
|
59 | + $this->objectId = $objectId; |
|
60 | + $this->tags = $tags; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return string |
|
65 | - * @since 9.0.0 |
|
66 | - */ |
|
67 | - public function getEvent() { |
|
68 | - return $this->event; |
|
69 | - } |
|
63 | + /** |
|
64 | + * @return string |
|
65 | + * @since 9.0.0 |
|
66 | + */ |
|
67 | + public function getEvent() { |
|
68 | + return $this->event; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * @return string |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public function getObjectType() { |
|
76 | - return $this->objectType; |
|
77 | - } |
|
71 | + /** |
|
72 | + * @return string |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public function getObjectType() { |
|
76 | + return $this->objectType; |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * @return string |
|
81 | - * @since 9.0.0 |
|
82 | - */ |
|
83 | - public function getObjectId() { |
|
84 | - return $this->objectId; |
|
85 | - } |
|
79 | + /** |
|
80 | + * @return string |
|
81 | + * @since 9.0.0 |
|
82 | + */ |
|
83 | + public function getObjectId() { |
|
84 | + return $this->objectId; |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * @return int[] |
|
89 | - * @since 9.0.0 |
|
90 | - */ |
|
91 | - public function getTags() { |
|
92 | - return $this->tags; |
|
93 | - } |
|
87 | + /** |
|
88 | + * @return int[] |
|
89 | + * @since 9.0.0 |
|
90 | + */ |
|
91 | + public function getTags() { |
|
92 | + return $this->tags; |
|
93 | + } |
|
94 | 94 | } |
@@ -33,28 +33,28 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISystemTagManagerFactory { |
35 | 35 | |
36 | - /** |
|
37 | - * Constructor for the system tag manager factory |
|
38 | - * |
|
39 | - * @param IServerContainer $serverContainer server container |
|
40 | - * @since 9.0.0 |
|
41 | - */ |
|
42 | - public function __construct(IServerContainer $serverContainer); |
|
36 | + /** |
|
37 | + * Constructor for the system tag manager factory |
|
38 | + * |
|
39 | + * @param IServerContainer $serverContainer server container |
|
40 | + * @since 9.0.0 |
|
41 | + */ |
|
42 | + public function __construct(IServerContainer $serverContainer); |
|
43 | 43 | |
44 | - /** |
|
45 | - * creates and returns an instance of the system tag manager |
|
46 | - * |
|
47 | - * @return ISystemTagManager |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function getManager(); |
|
44 | + /** |
|
45 | + * creates and returns an instance of the system tag manager |
|
46 | + * |
|
47 | + * @return ISystemTagManager |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function getManager(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * creates and returns an instance of the system tag object |
|
54 | - * mapper |
|
55 | - * |
|
56 | - * @return ISystemTagObjectMapper |
|
57 | - * @since 9.0.0 |
|
58 | - */ |
|
59 | - public function getObjectMapper(); |
|
52 | + /** |
|
53 | + * creates and returns an instance of the system tag object |
|
54 | + * mapper |
|
55 | + * |
|
56 | + * @return ISystemTagObjectMapper |
|
57 | + * @since 9.0.0 |
|
58 | + */ |
|
59 | + public function getObjectMapper(); |
|
60 | 60 | } |
@@ -30,102 +30,102 @@ |
||
30 | 30 | */ |
31 | 31 | interface ISystemTagObjectMapper { |
32 | 32 | |
33 | - /** |
|
34 | - * Get a list of tag ids for the given object ids. |
|
35 | - * |
|
36 | - * This returns an array that maps object id to tag ids |
|
37 | - * [ |
|
38 | - * 1 => array('id1', 'id2'), |
|
39 | - * 2 => array('id3', 'id2'), |
|
40 | - * 3 => array('id5'), |
|
41 | - * 4 => array() |
|
42 | - * ] |
|
43 | - * |
|
44 | - * Untagged objects will have an empty array associated. |
|
45 | - * |
|
46 | - * @param string|array $objIds object ids |
|
47 | - * @param string $objectType object type |
|
48 | - * |
|
49 | - * @return array with object id as key and an array |
|
50 | - * of tag ids as value |
|
51 | - * |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - public function getTagIdsForObjects($objIds, $objectType); |
|
33 | + /** |
|
34 | + * Get a list of tag ids for the given object ids. |
|
35 | + * |
|
36 | + * This returns an array that maps object id to tag ids |
|
37 | + * [ |
|
38 | + * 1 => array('id1', 'id2'), |
|
39 | + * 2 => array('id3', 'id2'), |
|
40 | + * 3 => array('id5'), |
|
41 | + * 4 => array() |
|
42 | + * ] |
|
43 | + * |
|
44 | + * Untagged objects will have an empty array associated. |
|
45 | + * |
|
46 | + * @param string|array $objIds object ids |
|
47 | + * @param string $objectType object type |
|
48 | + * |
|
49 | + * @return array with object id as key and an array |
|
50 | + * of tag ids as value |
|
51 | + * |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + public function getTagIdsForObjects($objIds, $objectType); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Get a list of objects tagged with $tagIds. |
|
58 | - * |
|
59 | - * @param string|array $tagIds Tag id or array of tag ids. |
|
60 | - * @param string $objectType object type |
|
61 | - * @param int $limit Count of object ids you want to get |
|
62 | - * @param string $offset The last object id you already received |
|
63 | - * |
|
64 | - * @return string[] array of object ids or empty array if none found |
|
65 | - * |
|
66 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
67 | - * given tags does not exist |
|
68 | - * @throws \InvalidArgumentException When a limit is specified together with |
|
69 | - * multiple tag ids |
|
70 | - * |
|
71 | - * @since 9.0.0 |
|
72 | - */ |
|
73 | - public function getObjectIdsForTags($tagIds, $objectType, $limit = 0, $offset = ''); |
|
56 | + /** |
|
57 | + * Get a list of objects tagged with $tagIds. |
|
58 | + * |
|
59 | + * @param string|array $tagIds Tag id or array of tag ids. |
|
60 | + * @param string $objectType object type |
|
61 | + * @param int $limit Count of object ids you want to get |
|
62 | + * @param string $offset The last object id you already received |
|
63 | + * |
|
64 | + * @return string[] array of object ids or empty array if none found |
|
65 | + * |
|
66 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
67 | + * given tags does not exist |
|
68 | + * @throws \InvalidArgumentException When a limit is specified together with |
|
69 | + * multiple tag ids |
|
70 | + * |
|
71 | + * @since 9.0.0 |
|
72 | + */ |
|
73 | + public function getObjectIdsForTags($tagIds, $objectType, $limit = 0, $offset = ''); |
|
74 | 74 | |
75 | - /** |
|
76 | - * Assign the given tags to the given object. |
|
77 | - * |
|
78 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
79 | - * will be assigned. |
|
80 | - * |
|
81 | - * If the relationship already existed, fail silently. |
|
82 | - * |
|
83 | - * @param string $objId object id |
|
84 | - * @param string $objectType object type |
|
85 | - * @param string|array $tagIds tag id or array of tag ids to assign |
|
86 | - * |
|
87 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
88 | - * given tags does not exist |
|
89 | - * |
|
90 | - * @since 9.0.0 |
|
91 | - */ |
|
92 | - public function assignTags($objId, $objectType, $tagIds); |
|
75 | + /** |
|
76 | + * Assign the given tags to the given object. |
|
77 | + * |
|
78 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
79 | + * will be assigned. |
|
80 | + * |
|
81 | + * If the relationship already existed, fail silently. |
|
82 | + * |
|
83 | + * @param string $objId object id |
|
84 | + * @param string $objectType object type |
|
85 | + * @param string|array $tagIds tag id or array of tag ids to assign |
|
86 | + * |
|
87 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
88 | + * given tags does not exist |
|
89 | + * |
|
90 | + * @since 9.0.0 |
|
91 | + */ |
|
92 | + public function assignTags($objId, $objectType, $tagIds); |
|
93 | 93 | |
94 | - /** |
|
95 | - * Unassign the given tags from the given object. |
|
96 | - * |
|
97 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
98 | - * will be unassigned. |
|
99 | - * |
|
100 | - * If the relationship did not exist in the first place, fail silently. |
|
101 | - * |
|
102 | - * @param string $objId object id |
|
103 | - * @param string $objectType object type |
|
104 | - * @param string|array $tagIds tag id or array of tag ids to unassign |
|
105 | - * |
|
106 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
107 | - * given tags does not exist |
|
108 | - * |
|
109 | - * @since 9.0.0 |
|
110 | - */ |
|
111 | - public function unassignTags($objId, $objectType, $tagIds); |
|
94 | + /** |
|
95 | + * Unassign the given tags from the given object. |
|
96 | + * |
|
97 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
98 | + * will be unassigned. |
|
99 | + * |
|
100 | + * If the relationship did not exist in the first place, fail silently. |
|
101 | + * |
|
102 | + * @param string $objId object id |
|
103 | + * @param string $objectType object type |
|
104 | + * @param string|array $tagIds tag id or array of tag ids to unassign |
|
105 | + * |
|
106 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
107 | + * given tags does not exist |
|
108 | + * |
|
109 | + * @since 9.0.0 |
|
110 | + */ |
|
111 | + public function unassignTags($objId, $objectType, $tagIds); |
|
112 | 112 | |
113 | - /** |
|
114 | - * Checks whether the given objects have the given tag. |
|
115 | - * |
|
116 | - * @param string|array $objIds object ids |
|
117 | - * @param string $objectType object type |
|
118 | - * @param string $tagId tag id to check |
|
119 | - * @param bool $all true to check that ALL objects have the tag assigned, |
|
120 | - * false to check that at least ONE object has the tag. |
|
121 | - * |
|
122 | - * @return bool true if the condition set by $all is matched, false |
|
123 | - * otherwise |
|
124 | - * |
|
125 | - * @throws \OCP\SystemTag\TagNotFoundException if the tag does not exist |
|
126 | - * |
|
127 | - * @since 9.0.0 |
|
128 | - */ |
|
129 | - public function haveTag($objIds, $objectType, $tagId, $all = true); |
|
113 | + /** |
|
114 | + * Checks whether the given objects have the given tag. |
|
115 | + * |
|
116 | + * @param string|array $objIds object ids |
|
117 | + * @param string $objectType object type |
|
118 | + * @param string $tagId tag id to check |
|
119 | + * @param bool $all true to check that ALL objects have the tag assigned, |
|
120 | + * false to check that at least ONE object has the tag. |
|
121 | + * |
|
122 | + * @return bool true if the condition set by $all is matched, false |
|
123 | + * otherwise |
|
124 | + * |
|
125 | + * @throws \OCP\SystemTag\TagNotFoundException if the tag does not exist |
|
126 | + * |
|
127 | + * @since 9.0.0 |
|
128 | + */ |
|
129 | + public function haveTag($objIds, $objectType, $tagId, $all = true); |
|
130 | 130 | |
131 | 131 | } |
@@ -32,46 +32,46 @@ |
||
32 | 32 | */ |
33 | 33 | class SystemTagsEntityEvent extends Event { |
34 | 34 | |
35 | - const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity'; |
|
35 | + const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
39 | - /** @var \Closure[] */ |
|
40 | - protected $collections; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | + /** @var \Closure[] */ |
|
40 | + protected $collections; |
|
41 | 41 | |
42 | - /** |
|
43 | - * SystemTagsEntityEvent constructor. |
|
44 | - * |
|
45 | - * @param string $event |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function __construct($event) { |
|
49 | - $this->event = $event; |
|
50 | - $this->collections = []; |
|
51 | - } |
|
42 | + /** |
|
43 | + * SystemTagsEntityEvent constructor. |
|
44 | + * |
|
45 | + * @param string $event |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function __construct($event) { |
|
49 | + $this->event = $event; |
|
50 | + $this->collections = []; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param string $name |
|
55 | - * @param \Closure $entityExistsFunction The closure should take one |
|
56 | - * argument, which is the id of the entity, that tags |
|
57 | - * should be handled for. The return should then be bool, |
|
58 | - * depending on whether tags are allowed (true) or not. |
|
59 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | - * @since 9.1.0 |
|
61 | - */ |
|
62 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | - if (isset($this->collections[$name])) { |
|
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | - } |
|
53 | + /** |
|
54 | + * @param string $name |
|
55 | + * @param \Closure $entityExistsFunction The closure should take one |
|
56 | + * argument, which is the id of the entity, that tags |
|
57 | + * should be handled for. The return should then be bool, |
|
58 | + * depending on whether tags are allowed (true) or not. |
|
59 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | + * @since 9.1.0 |
|
61 | + */ |
|
62 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | + if (isset($this->collections[$name])) { |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | + } |
|
66 | 66 | |
67 | - $this->collections[$name] = $entityExistsFunction; |
|
68 | - } |
|
67 | + $this->collections[$name] = $entityExistsFunction; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * @return \Closure[] |
|
72 | - * @since 9.1.0 |
|
73 | - */ |
|
74 | - public function getEntityCollections() { |
|
75 | - return $this->collections; |
|
76 | - } |
|
70 | + /** |
|
71 | + * @return \Closure[] |
|
72 | + * @since 9.1.0 |
|
73 | + */ |
|
74 | + public function getEntityCollections() { |
|
75 | + return $this->collections; |
|
76 | + } |
|
77 | 77 | } |
@@ -61,7 +61,7 @@ |
||
61 | 61 | */ |
62 | 62 | public function addEntityCollection($name, \Closure $entityExistsFunction) { |
63 | 63 | if (isset($this->collections[$name])) { |
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"'); |
|
65 | 65 | } |
66 | 66 | |
67 | 67 | $this->collections[$name] = $entityExistsFunction; |
@@ -28,45 +28,45 @@ |
||
28 | 28 | |
29 | 29 | class Credentials implements ICredentials { |
30 | 30 | |
31 | - /** @var string */ |
|
32 | - private $uid; |
|
31 | + /** @var string */ |
|
32 | + private $uid; |
|
33 | 33 | |
34 | - /** @var string */ |
|
35 | - private $loginName; |
|
34 | + /** @var string */ |
|
35 | + private $loginName; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - private $password; |
|
37 | + /** @var string */ |
|
38 | + private $password; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $uid |
|
42 | - * @param string $loginName |
|
43 | - * @param string $password |
|
44 | - */ |
|
45 | - public function __construct($uid, $loginName, $password) { |
|
46 | - $this->uid = $uid; |
|
47 | - $this->loginName = $loginName; |
|
48 | - $this->password = $password; |
|
49 | - } |
|
40 | + /** |
|
41 | + * @param string $uid |
|
42 | + * @param string $loginName |
|
43 | + * @param string $password |
|
44 | + */ |
|
45 | + public function __construct($uid, $loginName, $password) { |
|
46 | + $this->uid = $uid; |
|
47 | + $this->loginName = $loginName; |
|
48 | + $this->password = $password; |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - public function getUID() { |
|
55 | - return $this->uid; |
|
56 | - } |
|
51 | + /** |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + public function getUID() { |
|
55 | + return $this->uid; |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return string |
|
60 | - */ |
|
61 | - public function getLoginName() { |
|
62 | - return $this->loginName; |
|
63 | - } |
|
58 | + /** |
|
59 | + * @return string |
|
60 | + */ |
|
61 | + public function getLoginName() { |
|
62 | + return $this->loginName; |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function getPassword() { |
|
69 | - return $this->password; |
|
70 | - } |
|
65 | + /** |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function getPassword() { |
|
69 | + return $this->password; |
|
70 | + } |
|
71 | 71 | |
72 | 72 | } |