@@ -56,479 +56,479 @@ |
||
56 | 56 | */ |
57 | 57 | interface IServerContainer extends IContainer { |
58 | 58 | |
59 | - /** |
|
60 | - * The contacts manager will act as a broker between consumers for contacts information and |
|
61 | - * providers which actual deliver the contact information. |
|
62 | - * |
|
63 | - * @return \OCP\Contacts\IManager |
|
64 | - * @since 6.0.0 |
|
65 | - */ |
|
66 | - public function getContactsManager(); |
|
67 | - |
|
68 | - /** |
|
69 | - * The current request object holding all information about the request currently being processed |
|
70 | - * is returned from this method. |
|
71 | - * In case the current execution was not initiated by a web request null is returned |
|
72 | - * |
|
73 | - * @return \OCP\IRequest |
|
74 | - * @since 6.0.0 |
|
75 | - */ |
|
76 | - public function getRequest(); |
|
77 | - |
|
78 | - /** |
|
79 | - * Returns the preview manager which can create preview images for a given file |
|
80 | - * |
|
81 | - * @return \OCP\IPreview |
|
82 | - * @since 6.0.0 |
|
83 | - */ |
|
84 | - public function getPreviewManager(); |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns the tag manager which can get and set tags for different object types |
|
88 | - * |
|
89 | - * @see \OCP\ITagManager::load() |
|
90 | - * @return \OCP\ITagManager |
|
91 | - * @since 6.0.0 |
|
92 | - */ |
|
93 | - public function getTagManager(); |
|
94 | - |
|
95 | - /** |
|
96 | - * Returns the root folder of ownCloud's data directory |
|
97 | - * |
|
98 | - * @return \OCP\Files\IRootFolder |
|
99 | - * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
100 | - */ |
|
101 | - public function getRootFolder(); |
|
102 | - |
|
103 | - /** |
|
104 | - * Returns a view to ownCloud's files folder |
|
105 | - * |
|
106 | - * @param string $userId user ID |
|
107 | - * @return \OCP\Files\Folder |
|
108 | - * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
109 | - * @see getUserFolder in \OCP\Files\IRootFolder |
|
110 | - */ |
|
111 | - public function getUserFolder($userId = null); |
|
112 | - |
|
113 | - /** |
|
114 | - * Returns an app-specific view in ownClouds data directory |
|
115 | - * |
|
116 | - * @return \OCP\Files\Folder |
|
117 | - * @since 6.0.0 |
|
118 | - * @deprecated since 9.2.0 use IAppData |
|
119 | - */ |
|
120 | - public function getAppFolder(); |
|
121 | - |
|
122 | - /** |
|
123 | - * Returns a user manager |
|
124 | - * |
|
125 | - * @return \OCP\IUserManager |
|
126 | - * @since 8.0.0 |
|
127 | - */ |
|
128 | - public function getUserManager(); |
|
129 | - |
|
130 | - /** |
|
131 | - * Returns a group manager |
|
132 | - * |
|
133 | - * @return \OCP\IGroupManager |
|
134 | - * @since 8.0.0 |
|
135 | - */ |
|
136 | - public function getGroupManager(); |
|
137 | - |
|
138 | - /** |
|
139 | - * Returns the user session |
|
140 | - * |
|
141 | - * @return \OCP\IUserSession |
|
142 | - * @since 6.0.0 |
|
143 | - */ |
|
144 | - public function getUserSession(); |
|
145 | - |
|
146 | - /** |
|
147 | - * Returns the navigation manager |
|
148 | - * |
|
149 | - * @return \OCP\INavigationManager |
|
150 | - * @since 6.0.0 |
|
151 | - */ |
|
152 | - public function getNavigationManager(); |
|
153 | - |
|
154 | - /** |
|
155 | - * Returns the config manager |
|
156 | - * |
|
157 | - * @return \OCP\IConfig |
|
158 | - * @since 6.0.0 |
|
159 | - */ |
|
160 | - public function getConfig(); |
|
161 | - |
|
162 | - /** |
|
163 | - * Returns a Crypto instance |
|
164 | - * |
|
165 | - * @return \OCP\Security\ICrypto |
|
166 | - * @since 8.0.0 |
|
167 | - */ |
|
168 | - public function getCrypto(); |
|
169 | - |
|
170 | - /** |
|
171 | - * Returns a Hasher instance |
|
172 | - * |
|
173 | - * @return \OCP\Security\IHasher |
|
174 | - * @since 8.0.0 |
|
175 | - */ |
|
176 | - public function getHasher(); |
|
177 | - |
|
178 | - /** |
|
179 | - * Returns a SecureRandom instance |
|
180 | - * |
|
181 | - * @return \OCP\Security\ISecureRandom |
|
182 | - * @since 8.1.0 |
|
183 | - */ |
|
184 | - public function getSecureRandom(); |
|
185 | - |
|
186 | - /** |
|
187 | - * Returns a CredentialsManager instance |
|
188 | - * |
|
189 | - * @return \OCP\Security\ICredentialsManager |
|
190 | - * @since 9.0.0 |
|
191 | - */ |
|
192 | - public function getCredentialsManager(); |
|
193 | - |
|
194 | - /** |
|
195 | - * Returns the app config manager |
|
196 | - * |
|
197 | - * @return \OCP\IAppConfig |
|
198 | - * @since 7.0.0 |
|
199 | - */ |
|
200 | - public function getAppConfig(); |
|
201 | - |
|
202 | - /** |
|
203 | - * @return \OCP\L10N\IFactory |
|
204 | - * @since 8.2.0 |
|
205 | - */ |
|
206 | - public function getL10NFactory(); |
|
207 | - |
|
208 | - /** |
|
209 | - * get an L10N instance |
|
210 | - * @param string $app appid |
|
211 | - * @param string $lang |
|
212 | - * @return \OCP\IL10N |
|
213 | - * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
214 | - */ |
|
215 | - public function getL10N($app, $lang = null); |
|
216 | - |
|
217 | - /** |
|
218 | - * @return \OC\Encryption\Manager |
|
219 | - * @since 8.1.0 |
|
220 | - */ |
|
221 | - public function getEncryptionManager(); |
|
222 | - |
|
223 | - /** |
|
224 | - * @return \OC\Encryption\File |
|
225 | - * @since 8.1.0 |
|
226 | - */ |
|
227 | - public function getEncryptionFilesHelper(); |
|
228 | - |
|
229 | - /** |
|
230 | - * @return \OCP\Encryption\Keys\IStorage |
|
231 | - * @since 8.1.0 |
|
232 | - */ |
|
233 | - public function getEncryptionKeyStorage(); |
|
234 | - |
|
235 | - /** |
|
236 | - * Returns the URL generator |
|
237 | - * |
|
238 | - * @return \OCP\IURLGenerator |
|
239 | - * @since 6.0.0 |
|
240 | - */ |
|
241 | - public function getURLGenerator(); |
|
242 | - |
|
243 | - /** |
|
244 | - * Returns the Helper |
|
245 | - * |
|
246 | - * @return \OCP\IHelper |
|
247 | - * @since 6.0.0 |
|
248 | - */ |
|
249 | - public function getHelper(); |
|
250 | - |
|
251 | - /** |
|
252 | - * Returns an ICache instance |
|
253 | - * |
|
254 | - * @return \OCP\ICache |
|
255 | - * @since 6.0.0 |
|
256 | - */ |
|
257 | - public function getCache(); |
|
258 | - |
|
259 | - /** |
|
260 | - * Returns an \OCP\CacheFactory instance |
|
261 | - * |
|
262 | - * @return \OCP\ICacheFactory |
|
263 | - * @since 7.0.0 |
|
264 | - */ |
|
265 | - public function getMemCacheFactory(); |
|
266 | - |
|
267 | - /** |
|
268 | - * Returns the current session |
|
269 | - * |
|
270 | - * @return \OCP\ISession |
|
271 | - * @since 6.0.0 |
|
272 | - */ |
|
273 | - public function getSession(); |
|
274 | - |
|
275 | - /** |
|
276 | - * Returns the activity manager |
|
277 | - * |
|
278 | - * @return \OCP\Activity\IManager |
|
279 | - * @since 6.0.0 |
|
280 | - */ |
|
281 | - public function getActivityManager(); |
|
282 | - |
|
283 | - /** |
|
284 | - * Returns the current session |
|
285 | - * |
|
286 | - * @return \OCP\IDBConnection |
|
287 | - * @since 6.0.0 |
|
288 | - */ |
|
289 | - public function getDatabaseConnection(); |
|
290 | - |
|
291 | - /** |
|
292 | - * Returns an avatar manager, used for avatar functionality |
|
293 | - * |
|
294 | - * @return \OCP\IAvatarManager |
|
295 | - * @since 6.0.0 |
|
296 | - */ |
|
297 | - public function getAvatarManager(); |
|
298 | - |
|
299 | - /** |
|
300 | - * Returns an job list for controlling background jobs |
|
301 | - * |
|
302 | - * @return \OCP\BackgroundJob\IJobList |
|
303 | - * @since 7.0.0 |
|
304 | - */ |
|
305 | - public function getJobList(); |
|
306 | - |
|
307 | - /** |
|
308 | - * Returns a logger instance |
|
309 | - * |
|
310 | - * @return \OCP\ILogger |
|
311 | - * @since 8.0.0 |
|
312 | - */ |
|
313 | - public function getLogger(); |
|
314 | - |
|
315 | - /** |
|
316 | - * Returns a router for generating and matching urls |
|
317 | - * |
|
318 | - * @return \OCP\Route\IRouter |
|
319 | - * @since 7.0.0 |
|
320 | - */ |
|
321 | - public function getRouter(); |
|
322 | - |
|
323 | - /** |
|
324 | - * Returns a search instance |
|
325 | - * |
|
326 | - * @return \OCP\ISearch |
|
327 | - * @since 7.0.0 |
|
328 | - */ |
|
329 | - public function getSearch(); |
|
330 | - |
|
331 | - /** |
|
332 | - * Get the certificate manager for the user |
|
333 | - * |
|
334 | - * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
335 | - * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
336 | - * @since 8.0.0 |
|
337 | - */ |
|
338 | - public function getCertificateManager($userId = null); |
|
339 | - |
|
340 | - /** |
|
341 | - * Create a new event source |
|
342 | - * |
|
343 | - * @return \OCP\IEventSource |
|
344 | - * @since 8.0.0 |
|
345 | - */ |
|
346 | - public function createEventSource(); |
|
347 | - |
|
348 | - /** |
|
349 | - * Returns an instance of the HTTP helper class |
|
350 | - * @return \OC\HTTPHelper |
|
351 | - * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService |
|
352 | - * @since 8.0.0 |
|
353 | - */ |
|
354 | - public function getHTTPHelper(); |
|
355 | - |
|
356 | - /** |
|
357 | - * Returns an instance of the HTTP client service |
|
358 | - * |
|
359 | - * @return \OCP\Http\Client\IClientService |
|
360 | - * @since 8.1.0 |
|
361 | - */ |
|
362 | - public function getHTTPClientService(); |
|
363 | - |
|
364 | - /** |
|
365 | - * Get the active event logger |
|
366 | - * |
|
367 | - * @return \OCP\Diagnostics\IEventLogger |
|
368 | - * @since 8.0.0 |
|
369 | - */ |
|
370 | - public function getEventLogger(); |
|
371 | - |
|
372 | - /** |
|
373 | - * Get the active query logger |
|
374 | - * |
|
375 | - * The returned logger only logs data when debug mode is enabled |
|
376 | - * |
|
377 | - * @return \OCP\Diagnostics\IQueryLogger |
|
378 | - * @since 8.0.0 |
|
379 | - */ |
|
380 | - public function getQueryLogger(); |
|
381 | - |
|
382 | - /** |
|
383 | - * Get the manager for temporary files and folders |
|
384 | - * |
|
385 | - * @return \OCP\ITempManager |
|
386 | - * @since 8.0.0 |
|
387 | - */ |
|
388 | - public function getTempManager(); |
|
389 | - |
|
390 | - /** |
|
391 | - * Get the app manager |
|
392 | - * |
|
393 | - * @return \OCP\App\IAppManager |
|
394 | - * @since 8.0.0 |
|
395 | - */ |
|
396 | - public function getAppManager(); |
|
397 | - |
|
398 | - /** |
|
399 | - * Get the webroot |
|
400 | - * |
|
401 | - * @return string |
|
402 | - * @since 8.0.0 |
|
403 | - */ |
|
404 | - public function getWebRoot(); |
|
405 | - |
|
406 | - /** |
|
407 | - * @return \OCP\Files\Config\IMountProviderCollection |
|
408 | - * @since 8.0.0 |
|
409 | - */ |
|
410 | - public function getMountProviderCollection(); |
|
411 | - |
|
412 | - /** |
|
413 | - * Get the IniWrapper |
|
414 | - * |
|
415 | - * @return \bantu\IniGetWrapper\IniGetWrapper |
|
416 | - * @since 8.0.0 |
|
417 | - */ |
|
418 | - public function getIniWrapper(); |
|
419 | - /** |
|
420 | - * @return \OCP\Command\IBus |
|
421 | - * @since 8.1.0 |
|
422 | - */ |
|
423 | - public function getCommandBus(); |
|
424 | - |
|
425 | - /** |
|
426 | - * Creates a new mailer |
|
427 | - * |
|
428 | - * @return \OCP\Mail\IMailer |
|
429 | - * @since 8.1.0 |
|
430 | - */ |
|
431 | - public function getMailer(); |
|
432 | - |
|
433 | - /** |
|
434 | - * Get the locking provider |
|
435 | - * |
|
436 | - * @return \OCP\Lock\ILockingProvider |
|
437 | - * @since 8.1.0 |
|
438 | - */ |
|
439 | - public function getLockingProvider(); |
|
440 | - |
|
441 | - /** |
|
442 | - * @return \OCP\Files\Mount\IMountManager |
|
443 | - * @since 8.2.0 |
|
444 | - */ |
|
445 | - public function getMountManager(); |
|
446 | - |
|
447 | - /** |
|
448 | - * Get the MimeTypeDetector |
|
449 | - * |
|
450 | - * @return \OCP\Files\IMimeTypeDetector |
|
451 | - * @since 8.2.0 |
|
452 | - */ |
|
453 | - public function getMimeTypeDetector(); |
|
454 | - |
|
455 | - /** |
|
456 | - * Get the MimeTypeLoader |
|
457 | - * |
|
458 | - * @return \OCP\Files\IMimeTypeLoader |
|
459 | - * @since 8.2.0 |
|
460 | - */ |
|
461 | - public function getMimeTypeLoader(); |
|
462 | - |
|
463 | - /** |
|
464 | - * Get the EventDispatcher |
|
465 | - * |
|
466 | - * @return EventDispatcherInterface |
|
467 | - * @since 8.2.0 |
|
468 | - */ |
|
469 | - public function getEventDispatcher(); |
|
470 | - |
|
471 | - /** |
|
472 | - * Get the Notification Manager |
|
473 | - * |
|
474 | - * @return \OCP\Notification\IManager |
|
475 | - * @since 9.0.0 |
|
476 | - */ |
|
477 | - public function getNotificationManager(); |
|
478 | - |
|
479 | - /** |
|
480 | - * @return \OCP\Comments\ICommentsManager |
|
481 | - * @since 9.0.0 |
|
482 | - */ |
|
483 | - public function getCommentsManager(); |
|
484 | - |
|
485 | - /** |
|
486 | - * Returns the system-tag manager |
|
487 | - * |
|
488 | - * @return \OCP\SystemTag\ISystemTagManager |
|
489 | - * |
|
490 | - * @since 9.0.0 |
|
491 | - */ |
|
492 | - public function getSystemTagManager(); |
|
493 | - |
|
494 | - /** |
|
495 | - * Returns the system-tag object mapper |
|
496 | - * |
|
497 | - * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
498 | - * |
|
499 | - * @since 9.0.0 |
|
500 | - */ |
|
501 | - public function getSystemTagObjectMapper(); |
|
502 | - |
|
503 | - /** |
|
504 | - * Returns the share manager |
|
505 | - * |
|
506 | - * @return \OCP\Share\IManager |
|
507 | - * @since 9.0.0 |
|
508 | - */ |
|
509 | - public function getShareManager(); |
|
510 | - |
|
511 | - /** |
|
512 | - * @return IContentSecurityPolicyManager |
|
513 | - * @since 9.0.0 |
|
514 | - */ |
|
515 | - public function getContentSecurityPolicyManager(); |
|
516 | - |
|
517 | - /** |
|
518 | - * @return \OCP\IDateTimeZone |
|
519 | - * @since 8.0.0 |
|
520 | - */ |
|
521 | - public function getDateTimeZone(); |
|
522 | - |
|
523 | - /** |
|
524 | - * @return \OCP\IDateTimeFormatter |
|
525 | - * @since 8.0.0 |
|
526 | - */ |
|
527 | - public function getDateTimeFormatter(); |
|
528 | - |
|
529 | - /** |
|
530 | - * @return \OCP\Federation\ICloudIdManager |
|
531 | - * @since 12.0.0 |
|
532 | - */ |
|
533 | - public function getCloudIdManager(); |
|
59 | + /** |
|
60 | + * The contacts manager will act as a broker between consumers for contacts information and |
|
61 | + * providers which actual deliver the contact information. |
|
62 | + * |
|
63 | + * @return \OCP\Contacts\IManager |
|
64 | + * @since 6.0.0 |
|
65 | + */ |
|
66 | + public function getContactsManager(); |
|
67 | + |
|
68 | + /** |
|
69 | + * The current request object holding all information about the request currently being processed |
|
70 | + * is returned from this method. |
|
71 | + * In case the current execution was not initiated by a web request null is returned |
|
72 | + * |
|
73 | + * @return \OCP\IRequest |
|
74 | + * @since 6.0.0 |
|
75 | + */ |
|
76 | + public function getRequest(); |
|
77 | + |
|
78 | + /** |
|
79 | + * Returns the preview manager which can create preview images for a given file |
|
80 | + * |
|
81 | + * @return \OCP\IPreview |
|
82 | + * @since 6.0.0 |
|
83 | + */ |
|
84 | + public function getPreviewManager(); |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns the tag manager which can get and set tags for different object types |
|
88 | + * |
|
89 | + * @see \OCP\ITagManager::load() |
|
90 | + * @return \OCP\ITagManager |
|
91 | + * @since 6.0.0 |
|
92 | + */ |
|
93 | + public function getTagManager(); |
|
94 | + |
|
95 | + /** |
|
96 | + * Returns the root folder of ownCloud's data directory |
|
97 | + * |
|
98 | + * @return \OCP\Files\IRootFolder |
|
99 | + * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder |
|
100 | + */ |
|
101 | + public function getRootFolder(); |
|
102 | + |
|
103 | + /** |
|
104 | + * Returns a view to ownCloud's files folder |
|
105 | + * |
|
106 | + * @param string $userId user ID |
|
107 | + * @return \OCP\Files\Folder |
|
108 | + * @since 6.0.0 - parameter $userId was added in 8.0.0 |
|
109 | + * @see getUserFolder in \OCP\Files\IRootFolder |
|
110 | + */ |
|
111 | + public function getUserFolder($userId = null); |
|
112 | + |
|
113 | + /** |
|
114 | + * Returns an app-specific view in ownClouds data directory |
|
115 | + * |
|
116 | + * @return \OCP\Files\Folder |
|
117 | + * @since 6.0.0 |
|
118 | + * @deprecated since 9.2.0 use IAppData |
|
119 | + */ |
|
120 | + public function getAppFolder(); |
|
121 | + |
|
122 | + /** |
|
123 | + * Returns a user manager |
|
124 | + * |
|
125 | + * @return \OCP\IUserManager |
|
126 | + * @since 8.0.0 |
|
127 | + */ |
|
128 | + public function getUserManager(); |
|
129 | + |
|
130 | + /** |
|
131 | + * Returns a group manager |
|
132 | + * |
|
133 | + * @return \OCP\IGroupManager |
|
134 | + * @since 8.0.0 |
|
135 | + */ |
|
136 | + public function getGroupManager(); |
|
137 | + |
|
138 | + /** |
|
139 | + * Returns the user session |
|
140 | + * |
|
141 | + * @return \OCP\IUserSession |
|
142 | + * @since 6.0.0 |
|
143 | + */ |
|
144 | + public function getUserSession(); |
|
145 | + |
|
146 | + /** |
|
147 | + * Returns the navigation manager |
|
148 | + * |
|
149 | + * @return \OCP\INavigationManager |
|
150 | + * @since 6.0.0 |
|
151 | + */ |
|
152 | + public function getNavigationManager(); |
|
153 | + |
|
154 | + /** |
|
155 | + * Returns the config manager |
|
156 | + * |
|
157 | + * @return \OCP\IConfig |
|
158 | + * @since 6.0.0 |
|
159 | + */ |
|
160 | + public function getConfig(); |
|
161 | + |
|
162 | + /** |
|
163 | + * Returns a Crypto instance |
|
164 | + * |
|
165 | + * @return \OCP\Security\ICrypto |
|
166 | + * @since 8.0.0 |
|
167 | + */ |
|
168 | + public function getCrypto(); |
|
169 | + |
|
170 | + /** |
|
171 | + * Returns a Hasher instance |
|
172 | + * |
|
173 | + * @return \OCP\Security\IHasher |
|
174 | + * @since 8.0.0 |
|
175 | + */ |
|
176 | + public function getHasher(); |
|
177 | + |
|
178 | + /** |
|
179 | + * Returns a SecureRandom instance |
|
180 | + * |
|
181 | + * @return \OCP\Security\ISecureRandom |
|
182 | + * @since 8.1.0 |
|
183 | + */ |
|
184 | + public function getSecureRandom(); |
|
185 | + |
|
186 | + /** |
|
187 | + * Returns a CredentialsManager instance |
|
188 | + * |
|
189 | + * @return \OCP\Security\ICredentialsManager |
|
190 | + * @since 9.0.0 |
|
191 | + */ |
|
192 | + public function getCredentialsManager(); |
|
193 | + |
|
194 | + /** |
|
195 | + * Returns the app config manager |
|
196 | + * |
|
197 | + * @return \OCP\IAppConfig |
|
198 | + * @since 7.0.0 |
|
199 | + */ |
|
200 | + public function getAppConfig(); |
|
201 | + |
|
202 | + /** |
|
203 | + * @return \OCP\L10N\IFactory |
|
204 | + * @since 8.2.0 |
|
205 | + */ |
|
206 | + public function getL10NFactory(); |
|
207 | + |
|
208 | + /** |
|
209 | + * get an L10N instance |
|
210 | + * @param string $app appid |
|
211 | + * @param string $lang |
|
212 | + * @return \OCP\IL10N |
|
213 | + * @since 6.0.0 - parameter $lang was added in 8.0.0 |
|
214 | + */ |
|
215 | + public function getL10N($app, $lang = null); |
|
216 | + |
|
217 | + /** |
|
218 | + * @return \OC\Encryption\Manager |
|
219 | + * @since 8.1.0 |
|
220 | + */ |
|
221 | + public function getEncryptionManager(); |
|
222 | + |
|
223 | + /** |
|
224 | + * @return \OC\Encryption\File |
|
225 | + * @since 8.1.0 |
|
226 | + */ |
|
227 | + public function getEncryptionFilesHelper(); |
|
228 | + |
|
229 | + /** |
|
230 | + * @return \OCP\Encryption\Keys\IStorage |
|
231 | + * @since 8.1.0 |
|
232 | + */ |
|
233 | + public function getEncryptionKeyStorage(); |
|
234 | + |
|
235 | + /** |
|
236 | + * Returns the URL generator |
|
237 | + * |
|
238 | + * @return \OCP\IURLGenerator |
|
239 | + * @since 6.0.0 |
|
240 | + */ |
|
241 | + public function getURLGenerator(); |
|
242 | + |
|
243 | + /** |
|
244 | + * Returns the Helper |
|
245 | + * |
|
246 | + * @return \OCP\IHelper |
|
247 | + * @since 6.0.0 |
|
248 | + */ |
|
249 | + public function getHelper(); |
|
250 | + |
|
251 | + /** |
|
252 | + * Returns an ICache instance |
|
253 | + * |
|
254 | + * @return \OCP\ICache |
|
255 | + * @since 6.0.0 |
|
256 | + */ |
|
257 | + public function getCache(); |
|
258 | + |
|
259 | + /** |
|
260 | + * Returns an \OCP\CacheFactory instance |
|
261 | + * |
|
262 | + * @return \OCP\ICacheFactory |
|
263 | + * @since 7.0.0 |
|
264 | + */ |
|
265 | + public function getMemCacheFactory(); |
|
266 | + |
|
267 | + /** |
|
268 | + * Returns the current session |
|
269 | + * |
|
270 | + * @return \OCP\ISession |
|
271 | + * @since 6.0.0 |
|
272 | + */ |
|
273 | + public function getSession(); |
|
274 | + |
|
275 | + /** |
|
276 | + * Returns the activity manager |
|
277 | + * |
|
278 | + * @return \OCP\Activity\IManager |
|
279 | + * @since 6.0.0 |
|
280 | + */ |
|
281 | + public function getActivityManager(); |
|
282 | + |
|
283 | + /** |
|
284 | + * Returns the current session |
|
285 | + * |
|
286 | + * @return \OCP\IDBConnection |
|
287 | + * @since 6.0.0 |
|
288 | + */ |
|
289 | + public function getDatabaseConnection(); |
|
290 | + |
|
291 | + /** |
|
292 | + * Returns an avatar manager, used for avatar functionality |
|
293 | + * |
|
294 | + * @return \OCP\IAvatarManager |
|
295 | + * @since 6.0.0 |
|
296 | + */ |
|
297 | + public function getAvatarManager(); |
|
298 | + |
|
299 | + /** |
|
300 | + * Returns an job list for controlling background jobs |
|
301 | + * |
|
302 | + * @return \OCP\BackgroundJob\IJobList |
|
303 | + * @since 7.0.0 |
|
304 | + */ |
|
305 | + public function getJobList(); |
|
306 | + |
|
307 | + /** |
|
308 | + * Returns a logger instance |
|
309 | + * |
|
310 | + * @return \OCP\ILogger |
|
311 | + * @since 8.0.0 |
|
312 | + */ |
|
313 | + public function getLogger(); |
|
314 | + |
|
315 | + /** |
|
316 | + * Returns a router for generating and matching urls |
|
317 | + * |
|
318 | + * @return \OCP\Route\IRouter |
|
319 | + * @since 7.0.0 |
|
320 | + */ |
|
321 | + public function getRouter(); |
|
322 | + |
|
323 | + /** |
|
324 | + * Returns a search instance |
|
325 | + * |
|
326 | + * @return \OCP\ISearch |
|
327 | + * @since 7.0.0 |
|
328 | + */ |
|
329 | + public function getSearch(); |
|
330 | + |
|
331 | + /** |
|
332 | + * Get the certificate manager for the user |
|
333 | + * |
|
334 | + * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager |
|
335 | + * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in |
|
336 | + * @since 8.0.0 |
|
337 | + */ |
|
338 | + public function getCertificateManager($userId = null); |
|
339 | + |
|
340 | + /** |
|
341 | + * Create a new event source |
|
342 | + * |
|
343 | + * @return \OCP\IEventSource |
|
344 | + * @since 8.0.0 |
|
345 | + */ |
|
346 | + public function createEventSource(); |
|
347 | + |
|
348 | + /** |
|
349 | + * Returns an instance of the HTTP helper class |
|
350 | + * @return \OC\HTTPHelper |
|
351 | + * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService |
|
352 | + * @since 8.0.0 |
|
353 | + */ |
|
354 | + public function getHTTPHelper(); |
|
355 | + |
|
356 | + /** |
|
357 | + * Returns an instance of the HTTP client service |
|
358 | + * |
|
359 | + * @return \OCP\Http\Client\IClientService |
|
360 | + * @since 8.1.0 |
|
361 | + */ |
|
362 | + public function getHTTPClientService(); |
|
363 | + |
|
364 | + /** |
|
365 | + * Get the active event logger |
|
366 | + * |
|
367 | + * @return \OCP\Diagnostics\IEventLogger |
|
368 | + * @since 8.0.0 |
|
369 | + */ |
|
370 | + public function getEventLogger(); |
|
371 | + |
|
372 | + /** |
|
373 | + * Get the active query logger |
|
374 | + * |
|
375 | + * The returned logger only logs data when debug mode is enabled |
|
376 | + * |
|
377 | + * @return \OCP\Diagnostics\IQueryLogger |
|
378 | + * @since 8.0.0 |
|
379 | + */ |
|
380 | + public function getQueryLogger(); |
|
381 | + |
|
382 | + /** |
|
383 | + * Get the manager for temporary files and folders |
|
384 | + * |
|
385 | + * @return \OCP\ITempManager |
|
386 | + * @since 8.0.0 |
|
387 | + */ |
|
388 | + public function getTempManager(); |
|
389 | + |
|
390 | + /** |
|
391 | + * Get the app manager |
|
392 | + * |
|
393 | + * @return \OCP\App\IAppManager |
|
394 | + * @since 8.0.0 |
|
395 | + */ |
|
396 | + public function getAppManager(); |
|
397 | + |
|
398 | + /** |
|
399 | + * Get the webroot |
|
400 | + * |
|
401 | + * @return string |
|
402 | + * @since 8.0.0 |
|
403 | + */ |
|
404 | + public function getWebRoot(); |
|
405 | + |
|
406 | + /** |
|
407 | + * @return \OCP\Files\Config\IMountProviderCollection |
|
408 | + * @since 8.0.0 |
|
409 | + */ |
|
410 | + public function getMountProviderCollection(); |
|
411 | + |
|
412 | + /** |
|
413 | + * Get the IniWrapper |
|
414 | + * |
|
415 | + * @return \bantu\IniGetWrapper\IniGetWrapper |
|
416 | + * @since 8.0.0 |
|
417 | + */ |
|
418 | + public function getIniWrapper(); |
|
419 | + /** |
|
420 | + * @return \OCP\Command\IBus |
|
421 | + * @since 8.1.0 |
|
422 | + */ |
|
423 | + public function getCommandBus(); |
|
424 | + |
|
425 | + /** |
|
426 | + * Creates a new mailer |
|
427 | + * |
|
428 | + * @return \OCP\Mail\IMailer |
|
429 | + * @since 8.1.0 |
|
430 | + */ |
|
431 | + public function getMailer(); |
|
432 | + |
|
433 | + /** |
|
434 | + * Get the locking provider |
|
435 | + * |
|
436 | + * @return \OCP\Lock\ILockingProvider |
|
437 | + * @since 8.1.0 |
|
438 | + */ |
|
439 | + public function getLockingProvider(); |
|
440 | + |
|
441 | + /** |
|
442 | + * @return \OCP\Files\Mount\IMountManager |
|
443 | + * @since 8.2.0 |
|
444 | + */ |
|
445 | + public function getMountManager(); |
|
446 | + |
|
447 | + /** |
|
448 | + * Get the MimeTypeDetector |
|
449 | + * |
|
450 | + * @return \OCP\Files\IMimeTypeDetector |
|
451 | + * @since 8.2.0 |
|
452 | + */ |
|
453 | + public function getMimeTypeDetector(); |
|
454 | + |
|
455 | + /** |
|
456 | + * Get the MimeTypeLoader |
|
457 | + * |
|
458 | + * @return \OCP\Files\IMimeTypeLoader |
|
459 | + * @since 8.2.0 |
|
460 | + */ |
|
461 | + public function getMimeTypeLoader(); |
|
462 | + |
|
463 | + /** |
|
464 | + * Get the EventDispatcher |
|
465 | + * |
|
466 | + * @return EventDispatcherInterface |
|
467 | + * @since 8.2.0 |
|
468 | + */ |
|
469 | + public function getEventDispatcher(); |
|
470 | + |
|
471 | + /** |
|
472 | + * Get the Notification Manager |
|
473 | + * |
|
474 | + * @return \OCP\Notification\IManager |
|
475 | + * @since 9.0.0 |
|
476 | + */ |
|
477 | + public function getNotificationManager(); |
|
478 | + |
|
479 | + /** |
|
480 | + * @return \OCP\Comments\ICommentsManager |
|
481 | + * @since 9.0.0 |
|
482 | + */ |
|
483 | + public function getCommentsManager(); |
|
484 | + |
|
485 | + /** |
|
486 | + * Returns the system-tag manager |
|
487 | + * |
|
488 | + * @return \OCP\SystemTag\ISystemTagManager |
|
489 | + * |
|
490 | + * @since 9.0.0 |
|
491 | + */ |
|
492 | + public function getSystemTagManager(); |
|
493 | + |
|
494 | + /** |
|
495 | + * Returns the system-tag object mapper |
|
496 | + * |
|
497 | + * @return \OCP\SystemTag\ISystemTagObjectMapper |
|
498 | + * |
|
499 | + * @since 9.0.0 |
|
500 | + */ |
|
501 | + public function getSystemTagObjectMapper(); |
|
502 | + |
|
503 | + /** |
|
504 | + * Returns the share manager |
|
505 | + * |
|
506 | + * @return \OCP\Share\IManager |
|
507 | + * @since 9.0.0 |
|
508 | + */ |
|
509 | + public function getShareManager(); |
|
510 | + |
|
511 | + /** |
|
512 | + * @return IContentSecurityPolicyManager |
|
513 | + * @since 9.0.0 |
|
514 | + */ |
|
515 | + public function getContentSecurityPolicyManager(); |
|
516 | + |
|
517 | + /** |
|
518 | + * @return \OCP\IDateTimeZone |
|
519 | + * @since 8.0.0 |
|
520 | + */ |
|
521 | + public function getDateTimeZone(); |
|
522 | + |
|
523 | + /** |
|
524 | + * @return \OCP\IDateTimeFormatter |
|
525 | + * @since 8.0.0 |
|
526 | + */ |
|
527 | + public function getDateTimeFormatter(); |
|
528 | + |
|
529 | + /** |
|
530 | + * @return \OCP\Federation\ICloudIdManager |
|
531 | + * @since 12.0.0 |
|
532 | + */ |
|
533 | + public function getCloudIdManager(); |
|
534 | 534 | } |
@@ -26,9 +26,9 @@ |
||
26 | 26 | * @since 8.2.0 |
27 | 27 | */ |
28 | 28 | interface IQueryFunction { |
29 | - /** |
|
30 | - * @return string |
|
31 | - * @since 8.2.0 |
|
32 | - */ |
|
33 | - public function __toString(); |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + * @since 8.2.0 |
|
32 | + */ |
|
33 | + public function __toString(); |
|
34 | 34 | } |
@@ -26,9 +26,9 @@ |
||
26 | 26 | * @since 8.2.0 |
27 | 27 | */ |
28 | 28 | interface ILiteral { |
29 | - /** |
|
30 | - * @return string |
|
31 | - * @since 8.2.0 |
|
32 | - */ |
|
33 | - public function __toString(); |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + * @since 8.2.0 |
|
32 | + */ |
|
33 | + public function __toString(); |
|
34 | 34 | } |
@@ -28,39 +28,39 @@ |
||
28 | 28 | * @since 8.2.0 |
29 | 29 | */ |
30 | 30 | interface ICompositeExpression { |
31 | - /** |
|
32 | - * Adds multiple parts to composite expression. |
|
33 | - * |
|
34 | - * @param array $parts |
|
35 | - * |
|
36 | - * @return ICompositeExpression |
|
37 | - * @since 8.2.0 |
|
38 | - */ |
|
39 | - public function addMultiple(array $parts = array()); |
|
31 | + /** |
|
32 | + * Adds multiple parts to composite expression. |
|
33 | + * |
|
34 | + * @param array $parts |
|
35 | + * |
|
36 | + * @return ICompositeExpression |
|
37 | + * @since 8.2.0 |
|
38 | + */ |
|
39 | + public function addMultiple(array $parts = array()); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Adds an expression to composite expression. |
|
43 | - * |
|
44 | - * @param mixed $part |
|
45 | - * |
|
46 | - * @return ICompositeExpression |
|
47 | - * @since 8.2.0 |
|
48 | - */ |
|
49 | - public function add($part); |
|
41 | + /** |
|
42 | + * Adds an expression to composite expression. |
|
43 | + * |
|
44 | + * @param mixed $part |
|
45 | + * |
|
46 | + * @return ICompositeExpression |
|
47 | + * @since 8.2.0 |
|
48 | + */ |
|
49 | + public function add($part); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Retrieves the amount of expressions on composite expression. |
|
53 | - * |
|
54 | - * @return integer |
|
55 | - * @since 8.2.0 |
|
56 | - */ |
|
57 | - public function count(); |
|
51 | + /** |
|
52 | + * Retrieves the amount of expressions on composite expression. |
|
53 | + * |
|
54 | + * @return integer |
|
55 | + * @since 8.2.0 |
|
56 | + */ |
|
57 | + public function count(); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns the type of this composite expression (AND/OR). |
|
61 | - * |
|
62 | - * @return string |
|
63 | - * @since 8.2.0 |
|
64 | - */ |
|
65 | - public function getType(); |
|
59 | + /** |
|
60 | + * Returns the type of this composite expression (AND/OR). |
|
61 | + * |
|
62 | + * @return string |
|
63 | + * @since 8.2.0 |
|
64 | + */ |
|
65 | + public function getType(); |
|
66 | 66 | } |
@@ -26,9 +26,9 @@ |
||
26 | 26 | * @since 8.2.0 |
27 | 27 | */ |
28 | 28 | interface IParameter { |
29 | - /** |
|
30 | - * @return string |
|
31 | - * @since 8.2.0 |
|
32 | - */ |
|
33 | - public function __toString(); |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + * @since 8.2.0 |
|
32 | + */ |
|
33 | + public function __toString(); |
|
34 | 34 | } |
@@ -33,153 +33,153 @@ |
||
33 | 33 | // This means that they should be used by apps instead of the internal ownCloud classes |
34 | 34 | namespace OCP { |
35 | 35 | |
36 | - /** |
|
37 | - * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
38 | - * |
|
39 | - * Contacts in general will be expressed as an array of key-value-pairs. |
|
40 | - * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
41 | - * |
|
42 | - * Proposed workflow for working with contacts: |
|
43 | - * - search for the contacts |
|
44 | - * - manipulate the results array |
|
45 | - * - createOrUpdate will save the given contacts overwriting the existing data |
|
46 | - * |
|
47 | - * For updating it is mandatory to keep the id. |
|
48 | - * Without an id a new contact will be created. |
|
49 | - * |
|
50 | - * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - class Contacts { |
|
36 | + /** |
|
37 | + * This class provides access to the contacts app. Use this class exclusively if you want to access contacts. |
|
38 | + * |
|
39 | + * Contacts in general will be expressed as an array of key-value-pairs. |
|
40 | + * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1 |
|
41 | + * |
|
42 | + * Proposed workflow for working with contacts: |
|
43 | + * - search for the contacts |
|
44 | + * - manipulate the results array |
|
45 | + * - createOrUpdate will save the given contacts overwriting the existing data |
|
46 | + * |
|
47 | + * For updating it is mandatory to keep the id. |
|
48 | + * Without an id a new contact will be created. |
|
49 | + * |
|
50 | + * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + class Contacts { |
|
54 | 54 | |
55 | - /** |
|
56 | - * This function is used to search and find contacts within the users address books. |
|
57 | - * In case $pattern is empty all contacts will be returned. |
|
58 | - * |
|
59 | - * Example: |
|
60 | - * Following function shows how to search for contacts for the name and the email address. |
|
61 | - * |
|
62 | - * public static function getMatchingRecipient($term) { |
|
63 | - * // The API is not active -> nothing to do |
|
64 | - * if (!\OCP\Contacts::isEnabled()) { |
|
65 | - * return array(); |
|
66 | - * } |
|
67 | - * |
|
68 | - * $result = \OCP\Contacts::search($term, array('FN', 'EMAIL')); |
|
69 | - * $receivers = array(); |
|
70 | - * foreach ($result as $r) { |
|
71 | - * $id = $r['id']; |
|
72 | - * $fn = $r['FN']; |
|
73 | - * $email = $r['EMAIL']; |
|
74 | - * if (!is_array($email)) { |
|
75 | - * $email = array($email); |
|
76 | - * } |
|
77 | - * |
|
78 | - * // loop through all email addresses of this contact |
|
79 | - * foreach ($email as $e) { |
|
80 | - * $displayName = $fn . " <$e>"; |
|
81 | - * $receivers[] = array( |
|
82 | - * 'id' => $id, |
|
83 | - * 'label' => $displayName, |
|
84 | - * 'value' => $displayName); |
|
85 | - * } |
|
86 | - * } |
|
87 | - * |
|
88 | - * return $receivers; |
|
89 | - * } |
|
90 | - * |
|
91 | - * |
|
92 | - * @param string $pattern which should match within the $searchProperties |
|
93 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
94 | - * @param array $options - for future use. One should always have options! |
|
95 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
96 | - * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
97 | - * @since 5.0.0 |
|
98 | - */ |
|
99 | - public static function search($pattern, $searchProperties = array(), $options = array()) { |
|
100 | - $cm = \OC::$server->getContactsManager(); |
|
101 | - return $cm->search($pattern, $searchProperties, $options); |
|
102 | - } |
|
55 | + /** |
|
56 | + * This function is used to search and find contacts within the users address books. |
|
57 | + * In case $pattern is empty all contacts will be returned. |
|
58 | + * |
|
59 | + * Example: |
|
60 | + * Following function shows how to search for contacts for the name and the email address. |
|
61 | + * |
|
62 | + * public static function getMatchingRecipient($term) { |
|
63 | + * // The API is not active -> nothing to do |
|
64 | + * if (!\OCP\Contacts::isEnabled()) { |
|
65 | + * return array(); |
|
66 | + * } |
|
67 | + * |
|
68 | + * $result = \OCP\Contacts::search($term, array('FN', 'EMAIL')); |
|
69 | + * $receivers = array(); |
|
70 | + * foreach ($result as $r) { |
|
71 | + * $id = $r['id']; |
|
72 | + * $fn = $r['FN']; |
|
73 | + * $email = $r['EMAIL']; |
|
74 | + * if (!is_array($email)) { |
|
75 | + * $email = array($email); |
|
76 | + * } |
|
77 | + * |
|
78 | + * // loop through all email addresses of this contact |
|
79 | + * foreach ($email as $e) { |
|
80 | + * $displayName = $fn . " <$e>"; |
|
81 | + * $receivers[] = array( |
|
82 | + * 'id' => $id, |
|
83 | + * 'label' => $displayName, |
|
84 | + * 'value' => $displayName); |
|
85 | + * } |
|
86 | + * } |
|
87 | + * |
|
88 | + * return $receivers; |
|
89 | + * } |
|
90 | + * |
|
91 | + * |
|
92 | + * @param string $pattern which should match within the $searchProperties |
|
93 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
94 | + * @param array $options - for future use. One should always have options! |
|
95 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
96 | + * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
97 | + * @since 5.0.0 |
|
98 | + */ |
|
99 | + public static function search($pattern, $searchProperties = array(), $options = array()) { |
|
100 | + $cm = \OC::$server->getContactsManager(); |
|
101 | + return $cm->search($pattern, $searchProperties, $options); |
|
102 | + } |
|
103 | 103 | |
104 | - /** |
|
105 | - * This function can be used to delete the contact identified by the given id |
|
106 | - * |
|
107 | - * @param object $id the unique identifier to a contact |
|
108 | - * @param string $address_book_key |
|
109 | - * @return bool successful or not |
|
110 | - * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
111 | - * @since 5.0.0 |
|
112 | - */ |
|
113 | - public static function delete($id, $address_book_key) { |
|
114 | - $cm = \OC::$server->getContactsManager(); |
|
115 | - return $cm->delete($id, $address_book_key); |
|
116 | - } |
|
104 | + /** |
|
105 | + * This function can be used to delete the contact identified by the given id |
|
106 | + * |
|
107 | + * @param object $id the unique identifier to a contact |
|
108 | + * @param string $address_book_key |
|
109 | + * @return bool successful or not |
|
110 | + * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
111 | + * @since 5.0.0 |
|
112 | + */ |
|
113 | + public static function delete($id, $address_book_key) { |
|
114 | + $cm = \OC::$server->getContactsManager(); |
|
115 | + return $cm->delete($id, $address_book_key); |
|
116 | + } |
|
117 | 117 | |
118 | - /** |
|
119 | - * This function is used to create a new contact if 'id' is not given or not present. |
|
120 | - * Otherwise the contact will be updated by replacing the entire data set. |
|
121 | - * |
|
122 | - * @param array $properties this array if key-value-pairs defines a contact |
|
123 | - * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
124 | - * @return array an array representing the contact just created or updated |
|
125 | - * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
126 | - * @since 5.0.0 |
|
127 | - */ |
|
128 | - public static function createOrUpdate($properties, $address_book_key) { |
|
129 | - $cm = \OC::$server->getContactsManager(); |
|
130 | - return $cm->createOrUpdate($properties, $address_book_key); |
|
131 | - } |
|
118 | + /** |
|
119 | + * This function is used to create a new contact if 'id' is not given or not present. |
|
120 | + * Otherwise the contact will be updated by replacing the entire data set. |
|
121 | + * |
|
122 | + * @param array $properties this array if key-value-pairs defines a contact |
|
123 | + * @param string $address_book_key identifier of the address book in which the contact shall be created or updated |
|
124 | + * @return array an array representing the contact just created or updated |
|
125 | + * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
126 | + * @since 5.0.0 |
|
127 | + */ |
|
128 | + public static function createOrUpdate($properties, $address_book_key) { |
|
129 | + $cm = \OC::$server->getContactsManager(); |
|
130 | + return $cm->createOrUpdate($properties, $address_book_key); |
|
131 | + } |
|
132 | 132 | |
133 | - /** |
|
134 | - * Check if contacts are available (e.g. contacts app enabled) |
|
135 | - * |
|
136 | - * @return bool true if enabled, false if not |
|
137 | - * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
138 | - * @since 5.0.0 |
|
139 | - */ |
|
140 | - public static function isEnabled() { |
|
141 | - $cm = \OC::$server->getContactsManager(); |
|
142 | - return $cm->isEnabled(); |
|
143 | - } |
|
133 | + /** |
|
134 | + * Check if contacts are available (e.g. contacts app enabled) |
|
135 | + * |
|
136 | + * @return bool true if enabled, false if not |
|
137 | + * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
138 | + * @since 5.0.0 |
|
139 | + */ |
|
140 | + public static function isEnabled() { |
|
141 | + $cm = \OC::$server->getContactsManager(); |
|
142 | + return $cm->isEnabled(); |
|
143 | + } |
|
144 | 144 | |
145 | - /** |
|
146 | - * @param \OCP\IAddressBook $address_book |
|
147 | - * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
148 | - * @since 5.0.0 |
|
149 | - */ |
|
150 | - public static function registerAddressBook(\OCP\IAddressBook $address_book) { |
|
151 | - $cm = \OC::$server->getContactsManager(); |
|
152 | - $cm->registerAddressBook($address_book); |
|
153 | - } |
|
145 | + /** |
|
146 | + * @param \OCP\IAddressBook $address_book |
|
147 | + * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
148 | + * @since 5.0.0 |
|
149 | + */ |
|
150 | + public static function registerAddressBook(\OCP\IAddressBook $address_book) { |
|
151 | + $cm = \OC::$server->getContactsManager(); |
|
152 | + $cm->registerAddressBook($address_book); |
|
153 | + } |
|
154 | 154 | |
155 | - /** |
|
156 | - * @param \OCP\IAddressBook $address_book |
|
157 | - * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
158 | - * @since 5.0.0 |
|
159 | - */ |
|
160 | - public static function unregisterAddressBook(\OCP\IAddressBook $address_book) { |
|
161 | - $cm = \OC::$server->getContactsManager(); |
|
162 | - $cm->unregisterAddressBook($address_book); |
|
163 | - } |
|
155 | + /** |
|
156 | + * @param \OCP\IAddressBook $address_book |
|
157 | + * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
158 | + * @since 5.0.0 |
|
159 | + */ |
|
160 | + public static function unregisterAddressBook(\OCP\IAddressBook $address_book) { |
|
161 | + $cm = \OC::$server->getContactsManager(); |
|
162 | + $cm->unregisterAddressBook($address_book); |
|
163 | + } |
|
164 | 164 | |
165 | - /** |
|
166 | - * @return array |
|
167 | - * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
168 | - * @since 5.0.0 |
|
169 | - */ |
|
170 | - public static function getAddressBooks() { |
|
171 | - $cm = \OC::$server->getContactsManager(); |
|
172 | - return $cm->getAddressBooks(); |
|
173 | - } |
|
165 | + /** |
|
166 | + * @return array |
|
167 | + * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
168 | + * @since 5.0.0 |
|
169 | + */ |
|
170 | + public static function getAddressBooks() { |
|
171 | + $cm = \OC::$server->getContactsManager(); |
|
172 | + return $cm->getAddressBooks(); |
|
173 | + } |
|
174 | 174 | |
175 | - /** |
|
176 | - * removes all registered address book instances |
|
177 | - * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
178 | - * @since 5.0.0 |
|
179 | - */ |
|
180 | - public static function clear() { |
|
181 | - $cm = \OC::$server->getContactsManager(); |
|
182 | - $cm->clear(); |
|
183 | - } |
|
184 | - } |
|
175 | + /** |
|
176 | + * removes all registered address book instances |
|
177 | + * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager(); |
|
178 | + * @since 5.0.0 |
|
179 | + */ |
|
180 | + public static function clear() { |
|
181 | + $cm = \OC::$server->getContactsManager(); |
|
182 | + $cm->clear(); |
|
183 | + } |
|
184 | + } |
|
185 | 185 | } |
@@ -29,44 +29,44 @@ |
||
29 | 29 | * @since 8.0.0 |
30 | 30 | */ |
31 | 31 | interface ICertificateManager { |
32 | - /** |
|
33 | - * Returns all certificates trusted by the user |
|
34 | - * |
|
35 | - * @return \OCP\ICertificate[] |
|
36 | - * @since 8.0.0 |
|
37 | - */ |
|
38 | - public function listCertificates(); |
|
32 | + /** |
|
33 | + * Returns all certificates trusted by the user |
|
34 | + * |
|
35 | + * @return \OCP\ICertificate[] |
|
36 | + * @since 8.0.0 |
|
37 | + */ |
|
38 | + public function listCertificates(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $certificate the certificate data |
|
42 | - * @param string $name the filename for the certificate |
|
43 | - * @return \OCP\ICertificate |
|
44 | - * @throws \Exception If the certificate could not get added |
|
45 | - * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
46 | - */ |
|
47 | - public function addCertificate($certificate, $name); |
|
40 | + /** |
|
41 | + * @param string $certificate the certificate data |
|
42 | + * @param string $name the filename for the certificate |
|
43 | + * @return \OCP\ICertificate |
|
44 | + * @throws \Exception If the certificate could not get added |
|
45 | + * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
46 | + */ |
|
47 | + public function addCertificate($certificate, $name); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $name |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function removeCertificate($name); |
|
49 | + /** |
|
50 | + * @param string $name |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function removeCertificate($name); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Get the path to the certificate bundle for this user |
|
57 | - * |
|
58 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
59 | - * @return string |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function getCertificateBundle($uid = ''); |
|
55 | + /** |
|
56 | + * Get the path to the certificate bundle for this user |
|
57 | + * |
|
58 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
59 | + * @return string |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function getCertificateBundle($uid = ''); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the full local path to the certificate bundle for this user |
|
66 | - * |
|
67 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
68 | - * @return string |
|
69 | - * @since 9.0.0 |
|
70 | - */ |
|
71 | - public function getAbsoluteBundlePath($uid = ''); |
|
64 | + /** |
|
65 | + * Get the full local path to the certificate bundle for this user |
|
66 | + * |
|
67 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
68 | + * @return string |
|
69 | + * @since 9.0.0 |
|
70 | + */ |
|
71 | + public function getAbsoluteBundlePath($uid = ''); |
|
72 | 72 | } |
@@ -33,14 +33,14 @@ |
||
33 | 33 | |
34 | 34 | interface IAvatarManager { |
35 | 35 | |
36 | - /** |
|
37 | - * return a user specific instance of \OCP\IAvatar |
|
38 | - * @see \OCP\IAvatar |
|
39 | - * @param string $user the ownCloud user id |
|
40 | - * @return \OCP\IAvatar |
|
41 | - * @throws \Exception In case the username is potentially dangerous |
|
42 | - * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
43 | - * @since 6.0.0 |
|
44 | - */ |
|
45 | - public function getAvatar($user); |
|
36 | + /** |
|
37 | + * return a user specific instance of \OCP\IAvatar |
|
38 | + * @see \OCP\IAvatar |
|
39 | + * @param string $user the ownCloud user id |
|
40 | + * @return \OCP\IAvatar |
|
41 | + * @throws \Exception In case the username is potentially dangerous |
|
42 | + * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
43 | + * @since 6.0.0 |
|
44 | + */ |
|
45 | + public function getAvatar($user); |
|
46 | 46 | } |
@@ -29,158 +29,158 @@ |
||
29 | 29 | * @since 8.1.0 |
30 | 30 | */ |
31 | 31 | interface IImage { |
32 | - /** |
|
33 | - * Determine whether the object contains an image resource. |
|
34 | - * |
|
35 | - * @return bool |
|
36 | - * @since 8.1.0 |
|
37 | - */ |
|
38 | - public function valid(); |
|
39 | - |
|
40 | - /** |
|
41 | - * Returns the MIME type of the image or an empty string if no image is loaded. |
|
42 | - * |
|
43 | - * @return string |
|
44 | - * @since 8.1.0 |
|
45 | - */ |
|
46 | - public function mimeType(); |
|
47 | - |
|
48 | - /** |
|
49 | - * Returns the width of the image or -1 if no image is loaded. |
|
50 | - * |
|
51 | - * @return int |
|
52 | - * @since 8.1.0 |
|
53 | - */ |
|
54 | - public function width(); |
|
55 | - |
|
56 | - /** |
|
57 | - * Returns the height of the image or -1 if no image is loaded. |
|
58 | - * |
|
59 | - * @return int |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function height(); |
|
63 | - |
|
64 | - /** |
|
65 | - * Returns the width when the image orientation is top-left. |
|
66 | - * |
|
67 | - * @return int |
|
68 | - * @since 8.1.0 |
|
69 | - */ |
|
70 | - public function widthTopLeft(); |
|
71 | - |
|
72 | - /** |
|
73 | - * Returns the height when the image orientation is top-left. |
|
74 | - * |
|
75 | - * @return int |
|
76 | - * @since 8.1.0 |
|
77 | - */ |
|
78 | - public function heightTopLeft(); |
|
79 | - |
|
80 | - /** |
|
81 | - * Outputs the image. |
|
82 | - * |
|
83 | - * @param string $mimeType |
|
84 | - * @return bool |
|
85 | - * @since 8.1.0 |
|
86 | - */ |
|
87 | - public function show($mimeType = null); |
|
88 | - |
|
89 | - /** |
|
90 | - * Saves the image. |
|
91 | - * |
|
92 | - * @param string $filePath |
|
93 | - * @param string $mimeType |
|
94 | - * @return bool |
|
95 | - * @since 8.1.0 |
|
96 | - */ |
|
97 | - public function save($filePath = null, $mimeType = null); |
|
98 | - |
|
99 | - /** |
|
100 | - * @return resource Returns the image resource in any. |
|
101 | - * @since 8.1.0 |
|
102 | - */ |
|
103 | - public function resource(); |
|
104 | - |
|
105 | - /** |
|
106 | - * @return string Returns the raw image data. |
|
107 | - * @since 8.1.0 |
|
108 | - */ |
|
109 | - public function data(); |
|
110 | - |
|
111 | - /** |
|
112 | - * (I'm open for suggestions on better method name ;) |
|
113 | - * Get the orientation based on EXIF data. |
|
114 | - * |
|
115 | - * @return int The orientation or -1 if no EXIF data is available. |
|
116 | - * @since 8.1.0 |
|
117 | - */ |
|
118 | - public function getOrientation(); |
|
119 | - |
|
120 | - /** |
|
121 | - * (I'm open for suggestions on better method name ;) |
|
122 | - * Fixes orientation based on EXIF data. |
|
123 | - * |
|
124 | - * @return bool |
|
125 | - * @since 8.1.0 |
|
126 | - */ |
|
127 | - public function fixOrientation(); |
|
128 | - |
|
129 | - /** |
|
130 | - * Resizes the image preserving ratio. |
|
131 | - * |
|
132 | - * @param integer $maxSize The maximum size of either the width or height. |
|
133 | - * @return bool |
|
134 | - * @since 8.1.0 |
|
135 | - */ |
|
136 | - public function resize($maxSize); |
|
137 | - |
|
138 | - /** |
|
139 | - * @param int $width |
|
140 | - * @param int $height |
|
141 | - * @return bool |
|
142 | - * @since 8.1.0 |
|
143 | - */ |
|
144 | - public function preciseResize($width, $height); |
|
145 | - |
|
146 | - /** |
|
147 | - * Crops the image to the middle square. If the image is already square it just returns. |
|
148 | - * |
|
149 | - * @param int $size maximum size for the result (optional) |
|
150 | - * @return bool for success or failure |
|
151 | - * @since 8.1.0 |
|
152 | - */ |
|
153 | - public function centerCrop($size = 0); |
|
154 | - |
|
155 | - /** |
|
156 | - * Crops the image from point $x$y with dimension $wx$h. |
|
157 | - * |
|
158 | - * @param int $x Horizontal position |
|
159 | - * @param int $y Vertical position |
|
160 | - * @param int $w Width |
|
161 | - * @param int $h Height |
|
162 | - * @return bool for success or failure |
|
163 | - * @since 8.1.0 |
|
164 | - */ |
|
165 | - public function crop($x, $y, $w, $h); |
|
166 | - |
|
167 | - /** |
|
168 | - * Resizes the image to fit within a boundary while preserving ratio. |
|
169 | - * |
|
170 | - * @param integer $maxWidth |
|
171 | - * @param integer $maxHeight |
|
172 | - * @return bool |
|
173 | - * @since 8.1.0 |
|
174 | - */ |
|
175 | - public function fitIn($maxWidth, $maxHeight); |
|
176 | - |
|
177 | - /** |
|
178 | - * Shrinks the image to fit within a boundary while preserving ratio. |
|
179 | - * |
|
180 | - * @param integer $maxWidth |
|
181 | - * @param integer $maxHeight |
|
182 | - * @return bool |
|
183 | - * @since 8.1.0 |
|
184 | - */ |
|
185 | - public function scaleDownToFit($maxWidth, $maxHeight); |
|
32 | + /** |
|
33 | + * Determine whether the object contains an image resource. |
|
34 | + * |
|
35 | + * @return bool |
|
36 | + * @since 8.1.0 |
|
37 | + */ |
|
38 | + public function valid(); |
|
39 | + |
|
40 | + /** |
|
41 | + * Returns the MIME type of the image or an empty string if no image is loaded. |
|
42 | + * |
|
43 | + * @return string |
|
44 | + * @since 8.1.0 |
|
45 | + */ |
|
46 | + public function mimeType(); |
|
47 | + |
|
48 | + /** |
|
49 | + * Returns the width of the image or -1 if no image is loaded. |
|
50 | + * |
|
51 | + * @return int |
|
52 | + * @since 8.1.0 |
|
53 | + */ |
|
54 | + public function width(); |
|
55 | + |
|
56 | + /** |
|
57 | + * Returns the height of the image or -1 if no image is loaded. |
|
58 | + * |
|
59 | + * @return int |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function height(); |
|
63 | + |
|
64 | + /** |
|
65 | + * Returns the width when the image orientation is top-left. |
|
66 | + * |
|
67 | + * @return int |
|
68 | + * @since 8.1.0 |
|
69 | + */ |
|
70 | + public function widthTopLeft(); |
|
71 | + |
|
72 | + /** |
|
73 | + * Returns the height when the image orientation is top-left. |
|
74 | + * |
|
75 | + * @return int |
|
76 | + * @since 8.1.0 |
|
77 | + */ |
|
78 | + public function heightTopLeft(); |
|
79 | + |
|
80 | + /** |
|
81 | + * Outputs the image. |
|
82 | + * |
|
83 | + * @param string $mimeType |
|
84 | + * @return bool |
|
85 | + * @since 8.1.0 |
|
86 | + */ |
|
87 | + public function show($mimeType = null); |
|
88 | + |
|
89 | + /** |
|
90 | + * Saves the image. |
|
91 | + * |
|
92 | + * @param string $filePath |
|
93 | + * @param string $mimeType |
|
94 | + * @return bool |
|
95 | + * @since 8.1.0 |
|
96 | + */ |
|
97 | + public function save($filePath = null, $mimeType = null); |
|
98 | + |
|
99 | + /** |
|
100 | + * @return resource Returns the image resource in any. |
|
101 | + * @since 8.1.0 |
|
102 | + */ |
|
103 | + public function resource(); |
|
104 | + |
|
105 | + /** |
|
106 | + * @return string Returns the raw image data. |
|
107 | + * @since 8.1.0 |
|
108 | + */ |
|
109 | + public function data(); |
|
110 | + |
|
111 | + /** |
|
112 | + * (I'm open for suggestions on better method name ;) |
|
113 | + * Get the orientation based on EXIF data. |
|
114 | + * |
|
115 | + * @return int The orientation or -1 if no EXIF data is available. |
|
116 | + * @since 8.1.0 |
|
117 | + */ |
|
118 | + public function getOrientation(); |
|
119 | + |
|
120 | + /** |
|
121 | + * (I'm open for suggestions on better method name ;) |
|
122 | + * Fixes orientation based on EXIF data. |
|
123 | + * |
|
124 | + * @return bool |
|
125 | + * @since 8.1.0 |
|
126 | + */ |
|
127 | + public function fixOrientation(); |
|
128 | + |
|
129 | + /** |
|
130 | + * Resizes the image preserving ratio. |
|
131 | + * |
|
132 | + * @param integer $maxSize The maximum size of either the width or height. |
|
133 | + * @return bool |
|
134 | + * @since 8.1.0 |
|
135 | + */ |
|
136 | + public function resize($maxSize); |
|
137 | + |
|
138 | + /** |
|
139 | + * @param int $width |
|
140 | + * @param int $height |
|
141 | + * @return bool |
|
142 | + * @since 8.1.0 |
|
143 | + */ |
|
144 | + public function preciseResize($width, $height); |
|
145 | + |
|
146 | + /** |
|
147 | + * Crops the image to the middle square. If the image is already square it just returns. |
|
148 | + * |
|
149 | + * @param int $size maximum size for the result (optional) |
|
150 | + * @return bool for success or failure |
|
151 | + * @since 8.1.0 |
|
152 | + */ |
|
153 | + public function centerCrop($size = 0); |
|
154 | + |
|
155 | + /** |
|
156 | + * Crops the image from point $x$y with dimension $wx$h. |
|
157 | + * |
|
158 | + * @param int $x Horizontal position |
|
159 | + * @param int $y Vertical position |
|
160 | + * @param int $w Width |
|
161 | + * @param int $h Height |
|
162 | + * @return bool for success or failure |
|
163 | + * @since 8.1.0 |
|
164 | + */ |
|
165 | + public function crop($x, $y, $w, $h); |
|
166 | + |
|
167 | + /** |
|
168 | + * Resizes the image to fit within a boundary while preserving ratio. |
|
169 | + * |
|
170 | + * @param integer $maxWidth |
|
171 | + * @param integer $maxHeight |
|
172 | + * @return bool |
|
173 | + * @since 8.1.0 |
|
174 | + */ |
|
175 | + public function fitIn($maxWidth, $maxHeight); |
|
176 | + |
|
177 | + /** |
|
178 | + * Shrinks the image to fit within a boundary while preserving ratio. |
|
179 | + * |
|
180 | + * @param integer $maxWidth |
|
181 | + * @param integer $maxHeight |
|
182 | + * @return bool |
|
183 | + * @since 8.1.0 |
|
184 | + */ |
|
185 | + public function scaleDownToFit($maxWidth, $maxHeight); |
|
186 | 186 | } |