blob: a01ae5e200ddd5fa5a397ac35e3c903834c1cc18 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<?php
/**
* ownCloud
*
* @author Thomas Müller
* @copyright 2013 Thomas Müller deepdiver@owncloud.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* Server container interface
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* Class IServerContainer
* @package OCP
*
* This container holds all ownCloud services
*/
interface IServerContainer {
/**
* The contacts manager will act as a broker between consumers for contacts information and
* providers which actual deliver the contact information.
*
* @return \OCP\Contacts\IManager
*/
function getContactsManager();
/**
* The current request object holding all information about the request currently being processed
* is returned from this method.
* In case the current execution was not initiated by a web request null is returned
*
* @return \OCP\IRequest|null
*/
function getRequest();
/**
* Returns the preview manager which can create preview images for a given file
*
* @return \OCP\IPreview
*/
function getPreviewManager();
/**
* Returns the tag manager which can get and set tags for different object types
*
* @see \OCP\ITagManager::load()
* @return \OCP\ITagManager
*/
function getTagManager();
/**
* Returns the root folder of ownCloud's data directory
*
* @return \OCP\Files\Folder
*/
function getRootFolder();
/**
* Returns a view to ownCloud's files folder
*
* @param string $userId user ID
* @return \OCP\Files\Folder
*/
function getUserFolder($userId = null);
/**
* Returns an app-specific view in ownClouds data directory
*
* @return \OCP\Files\Folder
*/
function getAppFolder();
/**
* Returns a user manager
*
* @return \OCP\IUserManager
*/
function getUserManager();
/**
* Returns a group manager
*
* @return \OCP\IGroupManager
*/
function getGroupManager();
/**
* Returns the user session
*
* @return \OCP\IUserSession
*/
function getUserSession();
/**
* Returns the navigation manager
*
* @return \OCP\INavigationManager
*/
function getNavigationManager();
/**
* Returns the config manager
*
* @return \OCP\IConfig
*/
function getConfig();
/**
* Returns a Crypto instance
*
* @return \OCP\Security\ICrypto
*/
function getCrypto();
/**
* Returns a Hasher instance
*
* @return \OCP\Security\IHasher
*/
function getHasher();
/**
* Returns an instance of the db facade
* @deprecated use getDatabaseConnection, will be removed in ownCloud 10
* @return \OCP\IDb
*/
function getDb();
/**
* Returns the app config manager
*
* @return \OCP\IAppConfig
*/
function getAppConfig();
/**
* get an L10N instance
* @param string $app appid
* @param string $lang
* @return \OCP\IL10N
*/
function getL10N($app, $lang = null);
/**
* Returns the URL generator
*
* @return \OCP\IURLGenerator
*/
function getURLGenerator();
/**
* Returns the Helper
*
* @return \OCP\IHelper
*/
function getHelper();
/**
* Returns an ICache instance
*
* @return \OCP\ICache
*/
function getCache();
/**
* Returns an \OCP\CacheFactory instance
*
* @return \OCP\ICacheFactory
*/
function getMemCacheFactory();
/**
* Returns the current session
*
* @return \OCP\ISession
*/
function getSession();
/**
* Returns the activity manager
*
* @return \OCP\Activity\IManager
*/
function getActivityManager();
/**
* Returns the current session
*
* @return \OCP\IDBConnection
*/
function getDatabaseConnection();
/**
* Returns an avatar manager, used for avatar functionality
*
* @return \OCP\IAvatarManager
*/
function getAvatarManager();
/**
* Returns an job list for controlling background jobs
*
* @return \OCP\BackgroundJob\IJobList
*/
function getJobList();
/**
* Returns a logger instance
*
* @return \OCP\ILogger
*/
function getLogger();
/**
* Returns a router for generating and matching urls
*
* @return \OCP\Route\IRouter
*/
function getRouter();
/**
* Returns a search instance
*
* @return \OCP\ISearch
*/
function getSearch();
/**
* Get the certificate manager for the user
*
* @param \OCP\IUser $user (optional) if not specified the current loggedin user is used
* @return \OCP\ICertificateManager
*/
function getCertificateManager($user = null);
/**
* Create a new event source
*
* @return \OCP\IEventSource
*/
function createEventSource();
/**
* Returns an instance of the HTTP helper class
* @return \OC\HTTPHelper
* @deprecated Use \OCP\Http\Client\IClientService
*/
function getHTTPHelper();
/**
* Returns an instance of the HTTP client service
*
* @return \OCP\Http\Client\IClientService
*/
function getHTTPClientService();
/**
* Get the active event logger
*
* @return \OCP\Diagnostics\IEventLogger
*/
function getEventLogger();
/**
* Get the active query logger
*
* The returned logger only logs data when debug mode is enabled
*
* @return \OCP\Diagnostics\IQueryLogger
*/
function getQueryLogger();
/**
* Get the manager for temporary files and folders
*
* @return \OCP\ITempManager
*/
function getTempManager();
/**
* Get the app manager
*
* @return \OCP\App\IAppManager
*/
function getAppManager();
/**
* Get the webroot
*
* @return string
*/
function getWebRoot();
/**
* @return \OCP\Files\Config\IMountProviderCollection
*/
function getMountProviderCollection();
/**
* Get the IniWrapper
*
* @return \bantu\IniGetWrapper\IniGetWrapper
*/
function getIniWrapper();
/**
* @return \OCP\Command\IBus
*/
function getCommandBus();
/**
* Creates a new mailer
*
* @return \OCP\Mail\IMailer
*/
function getMailer();
}
|