@@ -29,311 +29,311 @@ |
||
29 | 29 | * @since 11.0.0 |
30 | 30 | */ |
31 | 31 | class Definitions { |
32 | - /** |
|
33 | - * @var array |
|
34 | - * @since 11.0.0 |
|
35 | - */ |
|
36 | - public $definitions = [ |
|
37 | - 'addressbook' => [ |
|
38 | - 'author' => 'Nextcloud', |
|
39 | - 'app' => 'dav', |
|
40 | - 'since' => '11.0.0', |
|
41 | - 'parameters' => [ |
|
42 | - 'id' => [ |
|
43 | - 'since' => '11.0.0', |
|
44 | - 'required' => true, |
|
45 | - 'description' => 'The id used to identify the addressbook on the instance', |
|
46 | - 'example' => '42', |
|
47 | - ], |
|
48 | - 'name' => [ |
|
49 | - 'since' => '11.0.0', |
|
50 | - 'required' => true, |
|
51 | - 'description' => 'The display name of the addressbook which should be used in the visual representation', |
|
52 | - 'example' => 'Contacts', |
|
53 | - ], |
|
54 | - ], |
|
55 | - ], |
|
56 | - 'addressbook-contact' => [ |
|
57 | - 'author' => 'Nextcloud', |
|
58 | - 'app' => 'dav', |
|
59 | - 'since' => '11.0.0', |
|
60 | - 'parameters' => [ |
|
61 | - 'id' => [ |
|
62 | - 'since' => '11.0.0', |
|
63 | - 'required' => true, |
|
64 | - 'description' => 'The id used to identify the contact on the instance', |
|
65 | - 'example' => '42', |
|
66 | - ], |
|
67 | - 'name' => [ |
|
68 | - 'since' => '11.0.0', |
|
69 | - 'required' => true, |
|
70 | - 'description' => 'The display name of the contact which should be used in the visual representation', |
|
71 | - 'example' => 'John Doe', |
|
72 | - ], |
|
73 | - ], |
|
74 | - ], |
|
75 | - 'announcement' => [ |
|
76 | - 'author' => 'Joas Schilling', |
|
77 | - 'app' => 'announcementcenter', |
|
78 | - 'since' => '11.0.0', |
|
79 | - 'parameters' => [ |
|
80 | - 'id' => [ |
|
81 | - 'since' => '11.0.0', |
|
82 | - 'required' => true, 'description' => 'The id used to identify the announcement on the instance', |
|
83 | - 'example' => '42', |
|
84 | - ], |
|
85 | - 'name' => [ |
|
86 | - 'since' => '11.0.0', |
|
87 | - 'required' => true, |
|
88 | - 'description' => 'The announcement subject which should be used in the visual representation', |
|
89 | - 'example' => 'file.txt', |
|
90 | - ], |
|
91 | - 'link' => [ |
|
92 | - 'since' => '11.0.0', |
|
93 | - 'required' => false, |
|
94 | - 'description' => 'The full URL to the file', |
|
95 | - 'example' => 'http://localhost/index.php/apps/announcements/#23', |
|
96 | - ], |
|
97 | - ], |
|
98 | - ], |
|
99 | - 'app' => [ |
|
100 | - 'author' => 'Nextcloud', |
|
101 | - 'app' => 'updatenotification', |
|
102 | - 'since' => '11.0.0', |
|
103 | - 'parameters' => [ |
|
104 | - 'id' => [ |
|
105 | - 'since' => '11.0.0', |
|
106 | - 'required' => true, 'description' => 'The app id', |
|
107 | - 'example' => 'updatenotification', |
|
108 | - ], |
|
109 | - 'name' => [ |
|
110 | - 'since' => '11.0.0', |
|
111 | - 'required' => true, |
|
112 | - 'description' => 'The name of the app which should be used in the visual representation', |
|
113 | - 'example' => 'Update notification', |
|
114 | - ], |
|
115 | - ], |
|
116 | - ], |
|
117 | - 'calendar' => [ |
|
118 | - 'author' => 'Nextcloud', |
|
119 | - 'app' => 'dav', |
|
120 | - 'since' => '11.0.0', |
|
121 | - 'parameters' => [ |
|
122 | - 'id' => [ |
|
123 | - 'since' => '11.0.0', |
|
124 | - 'required' => true, |
|
125 | - 'description' => 'The id used to identify the calendar on the instance', |
|
126 | - 'example' => '42', |
|
127 | - ], |
|
128 | - 'name' => [ |
|
129 | - 'since' => '11.0.0', |
|
130 | - 'required' => true, |
|
131 | - 'description' => 'The display name of the calendar which should be used in the visual representation', |
|
132 | - 'example' => 'Personal', |
|
133 | - ], |
|
134 | - ], |
|
135 | - ], |
|
136 | - 'calendar-event' => [ |
|
137 | - 'author' => 'Nextcloud', |
|
138 | - 'app' => 'dav', |
|
139 | - 'since' => '11.0.0', |
|
140 | - 'parameters' => [ |
|
141 | - 'id' => [ |
|
142 | - 'since' => '11.0.0', |
|
143 | - 'required' => true, |
|
144 | - 'description' => 'The id used to identify the event on the instance', |
|
145 | - 'example' => '42', |
|
146 | - ], |
|
147 | - 'name' => [ |
|
148 | - 'since' => '11.0.0', |
|
149 | - 'required' => true, |
|
150 | - 'description' => 'The display name of the event which should be used in the visual representation', |
|
151 | - 'example' => 'Workout', |
|
152 | - ], |
|
153 | - ], |
|
154 | - ], |
|
155 | - 'call' => [ |
|
156 | - 'author' => 'Nextcloud', |
|
157 | - 'app' => 'spreed', |
|
158 | - 'since' => '11.0.2', |
|
159 | - 'parameters' => [ |
|
160 | - 'id' => [ |
|
161 | - 'since' => '11.0.2', |
|
162 | - 'required' => true, |
|
163 | - 'description' => 'The id used to identify the call on the instance', |
|
164 | - 'example' => '42', |
|
165 | - ], |
|
166 | - 'name' => [ |
|
167 | - 'since' => '11.0.2', |
|
168 | - 'required' => true, |
|
169 | - 'description' => 'The display name of the call which should be used in the visual representation', |
|
170 | - 'example' => 'Company call', |
|
171 | - ], |
|
172 | - 'call-type' => [ |
|
173 | - 'since' => '11.0.2', |
|
174 | - 'required' => true, |
|
175 | - 'description' => 'The type of the call: one2one, group or public', |
|
176 | - 'example' => 'one2one', |
|
177 | - ], |
|
178 | - ], |
|
179 | - ], |
|
180 | - 'email' => [ |
|
181 | - 'author' => 'Nextcloud', |
|
182 | - 'app' => 'sharebymail', |
|
183 | - 'since' => '11.0.0', |
|
184 | - 'parameters' => [ |
|
185 | - 'id' => [ |
|
186 | - 'since' => '11.0.0', |
|
187 | - 'required' => true, |
|
188 | - 'description' => 'The mail-address used to identify the event on the instance', |
|
189 | - 'example' => 'test@localhost', |
|
190 | - ], |
|
191 | - 'name' => [ |
|
192 | - 'since' => '11.0.0', |
|
193 | - 'required' => true, |
|
194 | - 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation', |
|
195 | - 'example' => 'Foo Bar', |
|
196 | - ], |
|
197 | - ], |
|
198 | - ], |
|
199 | - 'file' => [ |
|
200 | - 'author' => 'Nextcloud', |
|
201 | - 'app' => 'dav', |
|
202 | - 'since' => '11.0.0', |
|
203 | - 'parameters' => [ |
|
204 | - 'id' => [ |
|
205 | - 'since' => '11.0.0', |
|
206 | - 'required' => true, |
|
207 | - 'description' => 'The id used to identify the file on the instance', |
|
208 | - 'example' => '42', |
|
209 | - ], |
|
210 | - 'name' => [ |
|
211 | - 'since' => '11.0.0', |
|
212 | - 'required' => true, |
|
213 | - 'description' => 'The file name which should be used in the visual representation', |
|
214 | - 'example' => 'file.txt', |
|
215 | - ], |
|
216 | - 'path' => [ |
|
217 | - 'since' => '11.0.0', |
|
218 | - 'required' => true, |
|
219 | - 'description' => 'The full path of the file for the user, should not start with a slash', |
|
220 | - 'example' => 'path/to/file.txt', |
|
221 | - ], |
|
222 | - 'link' => [ |
|
223 | - 'since' => '11.0.0', |
|
224 | - 'required' => false, |
|
225 | - 'description' => 'The full URL to the file', |
|
226 | - 'example' => 'http://localhost/index.php/f/42', |
|
227 | - ], |
|
228 | - ], |
|
229 | - ], |
|
230 | - 'pending-federated-share' => [ |
|
231 | - 'author' => 'Nextcloud', |
|
232 | - 'app' => 'dav', |
|
233 | - 'since' => '11.0.0', |
|
234 | - 'parameters' => [ |
|
235 | - 'id' => [ |
|
236 | - 'since' => '11.0.0', |
|
237 | - 'required' => true, |
|
238 | - 'description' => 'The id used to identify the federated share on the instance', |
|
239 | - 'example' => '42', |
|
240 | - ], |
|
241 | - 'name' => [ |
|
242 | - 'since' => '11.0.0', |
|
243 | - 'required' => true, |
|
244 | - 'description' => 'The name of the shared item which should be used in the visual representation', |
|
245 | - 'example' => 'file.txt', |
|
246 | - ], |
|
247 | - ], |
|
248 | - ], |
|
249 | - 'systemtag' => [ |
|
250 | - 'author' => 'Nextcloud', |
|
251 | - 'app' => 'core', |
|
252 | - 'since' => '11.0.0', |
|
253 | - 'parameters' => [ |
|
254 | - 'id' => [ |
|
255 | - 'since' => '11.0.0', |
|
256 | - 'required' => true, |
|
257 | - 'description' => 'The id used to identify the systemtag on the instance', |
|
258 | - 'example' => '23', |
|
259 | - ], |
|
260 | - 'name' => [ |
|
261 | - 'since' => '11.0.0', |
|
262 | - 'required' => true, |
|
263 | - 'description' => 'The display name of the systemtag which should be used in the visual representation', |
|
264 | - 'example' => 'Project 1', |
|
265 | - ], |
|
266 | - 'visibility' => [ |
|
267 | - 'since' => '11.0.0', |
|
268 | - 'required' => true, |
|
269 | - 'description' => 'If the user can see the systemtag', |
|
270 | - 'example' => '1', |
|
271 | - ], |
|
272 | - 'assignable' => [ |
|
273 | - 'since' => '11.0.0', |
|
274 | - 'required' => true, |
|
275 | - 'description' => 'If the user can assign the systemtag', |
|
276 | - 'example' => '0', |
|
277 | - ], |
|
278 | - ], |
|
279 | - ], |
|
280 | - 'user' => [ |
|
281 | - 'author' => 'Nextcloud', |
|
282 | - 'app' => 'core', |
|
283 | - 'since' => '11.0.0', |
|
284 | - 'parameters' => [ |
|
285 | - 'id' => [ |
|
286 | - 'since' => '11.0.0', |
|
287 | - 'required' => true, |
|
288 | - 'description' => 'The id used to identify the user on the instance', |
|
289 | - 'example' => 'johndoe', |
|
290 | - ], |
|
291 | - 'name' => [ |
|
292 | - 'since' => '11.0.0', |
|
293 | - 'required' => true, |
|
294 | - 'description' => 'The display name of the user which should be used in the visual representation', |
|
295 | - 'example' => 'John Doe', |
|
296 | - ], |
|
297 | - 'server' => [ |
|
298 | - 'since' => '11.0.0', |
|
299 | - 'required' => false, |
|
300 | - 'description' => 'The URL of the instance the user lives on', |
|
301 | - 'example' => 'localhost', |
|
302 | - ], |
|
303 | - ], |
|
304 | - ], |
|
305 | - 'user-group' => [ |
|
306 | - 'author' => 'Nextcloud', |
|
307 | - 'app' => 'core', |
|
308 | - 'since' => '11.0.0', |
|
309 | - 'parameters' => [ |
|
310 | - 'id' => [ |
|
311 | - 'since' => '11.0.0', |
|
312 | - 'required' => true, |
|
313 | - 'description' => 'The id used to identify the group on the instance', |
|
314 | - 'example' => 'supportteam', |
|
315 | - ], |
|
316 | - 'name' => [ |
|
317 | - 'since' => '11.0.0', |
|
318 | - 'required' => true, |
|
319 | - 'description' => 'The display name of the group which should be used in the visual representation', |
|
320 | - 'example' => 'Support Team', |
|
321 | - ], |
|
322 | - ], |
|
323 | - ], |
|
324 | - ]; |
|
32 | + /** |
|
33 | + * @var array |
|
34 | + * @since 11.0.0 |
|
35 | + */ |
|
36 | + public $definitions = [ |
|
37 | + 'addressbook' => [ |
|
38 | + 'author' => 'Nextcloud', |
|
39 | + 'app' => 'dav', |
|
40 | + 'since' => '11.0.0', |
|
41 | + 'parameters' => [ |
|
42 | + 'id' => [ |
|
43 | + 'since' => '11.0.0', |
|
44 | + 'required' => true, |
|
45 | + 'description' => 'The id used to identify the addressbook on the instance', |
|
46 | + 'example' => '42', |
|
47 | + ], |
|
48 | + 'name' => [ |
|
49 | + 'since' => '11.0.0', |
|
50 | + 'required' => true, |
|
51 | + 'description' => 'The display name of the addressbook which should be used in the visual representation', |
|
52 | + 'example' => 'Contacts', |
|
53 | + ], |
|
54 | + ], |
|
55 | + ], |
|
56 | + 'addressbook-contact' => [ |
|
57 | + 'author' => 'Nextcloud', |
|
58 | + 'app' => 'dav', |
|
59 | + 'since' => '11.0.0', |
|
60 | + 'parameters' => [ |
|
61 | + 'id' => [ |
|
62 | + 'since' => '11.0.0', |
|
63 | + 'required' => true, |
|
64 | + 'description' => 'The id used to identify the contact on the instance', |
|
65 | + 'example' => '42', |
|
66 | + ], |
|
67 | + 'name' => [ |
|
68 | + 'since' => '11.0.0', |
|
69 | + 'required' => true, |
|
70 | + 'description' => 'The display name of the contact which should be used in the visual representation', |
|
71 | + 'example' => 'John Doe', |
|
72 | + ], |
|
73 | + ], |
|
74 | + ], |
|
75 | + 'announcement' => [ |
|
76 | + 'author' => 'Joas Schilling', |
|
77 | + 'app' => 'announcementcenter', |
|
78 | + 'since' => '11.0.0', |
|
79 | + 'parameters' => [ |
|
80 | + 'id' => [ |
|
81 | + 'since' => '11.0.0', |
|
82 | + 'required' => true, 'description' => 'The id used to identify the announcement on the instance', |
|
83 | + 'example' => '42', |
|
84 | + ], |
|
85 | + 'name' => [ |
|
86 | + 'since' => '11.0.0', |
|
87 | + 'required' => true, |
|
88 | + 'description' => 'The announcement subject which should be used in the visual representation', |
|
89 | + 'example' => 'file.txt', |
|
90 | + ], |
|
91 | + 'link' => [ |
|
92 | + 'since' => '11.0.0', |
|
93 | + 'required' => false, |
|
94 | + 'description' => 'The full URL to the file', |
|
95 | + 'example' => 'http://localhost/index.php/apps/announcements/#23', |
|
96 | + ], |
|
97 | + ], |
|
98 | + ], |
|
99 | + 'app' => [ |
|
100 | + 'author' => 'Nextcloud', |
|
101 | + 'app' => 'updatenotification', |
|
102 | + 'since' => '11.0.0', |
|
103 | + 'parameters' => [ |
|
104 | + 'id' => [ |
|
105 | + 'since' => '11.0.0', |
|
106 | + 'required' => true, 'description' => 'The app id', |
|
107 | + 'example' => 'updatenotification', |
|
108 | + ], |
|
109 | + 'name' => [ |
|
110 | + 'since' => '11.0.0', |
|
111 | + 'required' => true, |
|
112 | + 'description' => 'The name of the app which should be used in the visual representation', |
|
113 | + 'example' => 'Update notification', |
|
114 | + ], |
|
115 | + ], |
|
116 | + ], |
|
117 | + 'calendar' => [ |
|
118 | + 'author' => 'Nextcloud', |
|
119 | + 'app' => 'dav', |
|
120 | + 'since' => '11.0.0', |
|
121 | + 'parameters' => [ |
|
122 | + 'id' => [ |
|
123 | + 'since' => '11.0.0', |
|
124 | + 'required' => true, |
|
125 | + 'description' => 'The id used to identify the calendar on the instance', |
|
126 | + 'example' => '42', |
|
127 | + ], |
|
128 | + 'name' => [ |
|
129 | + 'since' => '11.0.0', |
|
130 | + 'required' => true, |
|
131 | + 'description' => 'The display name of the calendar which should be used in the visual representation', |
|
132 | + 'example' => 'Personal', |
|
133 | + ], |
|
134 | + ], |
|
135 | + ], |
|
136 | + 'calendar-event' => [ |
|
137 | + 'author' => 'Nextcloud', |
|
138 | + 'app' => 'dav', |
|
139 | + 'since' => '11.0.0', |
|
140 | + 'parameters' => [ |
|
141 | + 'id' => [ |
|
142 | + 'since' => '11.0.0', |
|
143 | + 'required' => true, |
|
144 | + 'description' => 'The id used to identify the event on the instance', |
|
145 | + 'example' => '42', |
|
146 | + ], |
|
147 | + 'name' => [ |
|
148 | + 'since' => '11.0.0', |
|
149 | + 'required' => true, |
|
150 | + 'description' => 'The display name of the event which should be used in the visual representation', |
|
151 | + 'example' => 'Workout', |
|
152 | + ], |
|
153 | + ], |
|
154 | + ], |
|
155 | + 'call' => [ |
|
156 | + 'author' => 'Nextcloud', |
|
157 | + 'app' => 'spreed', |
|
158 | + 'since' => '11.0.2', |
|
159 | + 'parameters' => [ |
|
160 | + 'id' => [ |
|
161 | + 'since' => '11.0.2', |
|
162 | + 'required' => true, |
|
163 | + 'description' => 'The id used to identify the call on the instance', |
|
164 | + 'example' => '42', |
|
165 | + ], |
|
166 | + 'name' => [ |
|
167 | + 'since' => '11.0.2', |
|
168 | + 'required' => true, |
|
169 | + 'description' => 'The display name of the call which should be used in the visual representation', |
|
170 | + 'example' => 'Company call', |
|
171 | + ], |
|
172 | + 'call-type' => [ |
|
173 | + 'since' => '11.0.2', |
|
174 | + 'required' => true, |
|
175 | + 'description' => 'The type of the call: one2one, group or public', |
|
176 | + 'example' => 'one2one', |
|
177 | + ], |
|
178 | + ], |
|
179 | + ], |
|
180 | + 'email' => [ |
|
181 | + 'author' => 'Nextcloud', |
|
182 | + 'app' => 'sharebymail', |
|
183 | + 'since' => '11.0.0', |
|
184 | + 'parameters' => [ |
|
185 | + 'id' => [ |
|
186 | + 'since' => '11.0.0', |
|
187 | + 'required' => true, |
|
188 | + 'description' => 'The mail-address used to identify the event on the instance', |
|
189 | + 'example' => 'test@localhost', |
|
190 | + ], |
|
191 | + 'name' => [ |
|
192 | + 'since' => '11.0.0', |
|
193 | + 'required' => true, |
|
194 | + 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation', |
|
195 | + 'example' => 'Foo Bar', |
|
196 | + ], |
|
197 | + ], |
|
198 | + ], |
|
199 | + 'file' => [ |
|
200 | + 'author' => 'Nextcloud', |
|
201 | + 'app' => 'dav', |
|
202 | + 'since' => '11.0.0', |
|
203 | + 'parameters' => [ |
|
204 | + 'id' => [ |
|
205 | + 'since' => '11.0.0', |
|
206 | + 'required' => true, |
|
207 | + 'description' => 'The id used to identify the file on the instance', |
|
208 | + 'example' => '42', |
|
209 | + ], |
|
210 | + 'name' => [ |
|
211 | + 'since' => '11.0.0', |
|
212 | + 'required' => true, |
|
213 | + 'description' => 'The file name which should be used in the visual representation', |
|
214 | + 'example' => 'file.txt', |
|
215 | + ], |
|
216 | + 'path' => [ |
|
217 | + 'since' => '11.0.0', |
|
218 | + 'required' => true, |
|
219 | + 'description' => 'The full path of the file for the user, should not start with a slash', |
|
220 | + 'example' => 'path/to/file.txt', |
|
221 | + ], |
|
222 | + 'link' => [ |
|
223 | + 'since' => '11.0.0', |
|
224 | + 'required' => false, |
|
225 | + 'description' => 'The full URL to the file', |
|
226 | + 'example' => 'http://localhost/index.php/f/42', |
|
227 | + ], |
|
228 | + ], |
|
229 | + ], |
|
230 | + 'pending-federated-share' => [ |
|
231 | + 'author' => 'Nextcloud', |
|
232 | + 'app' => 'dav', |
|
233 | + 'since' => '11.0.0', |
|
234 | + 'parameters' => [ |
|
235 | + 'id' => [ |
|
236 | + 'since' => '11.0.0', |
|
237 | + 'required' => true, |
|
238 | + 'description' => 'The id used to identify the federated share on the instance', |
|
239 | + 'example' => '42', |
|
240 | + ], |
|
241 | + 'name' => [ |
|
242 | + 'since' => '11.0.0', |
|
243 | + 'required' => true, |
|
244 | + 'description' => 'The name of the shared item which should be used in the visual representation', |
|
245 | + 'example' => 'file.txt', |
|
246 | + ], |
|
247 | + ], |
|
248 | + ], |
|
249 | + 'systemtag' => [ |
|
250 | + 'author' => 'Nextcloud', |
|
251 | + 'app' => 'core', |
|
252 | + 'since' => '11.0.0', |
|
253 | + 'parameters' => [ |
|
254 | + 'id' => [ |
|
255 | + 'since' => '11.0.0', |
|
256 | + 'required' => true, |
|
257 | + 'description' => 'The id used to identify the systemtag on the instance', |
|
258 | + 'example' => '23', |
|
259 | + ], |
|
260 | + 'name' => [ |
|
261 | + 'since' => '11.0.0', |
|
262 | + 'required' => true, |
|
263 | + 'description' => 'The display name of the systemtag which should be used in the visual representation', |
|
264 | + 'example' => 'Project 1', |
|
265 | + ], |
|
266 | + 'visibility' => [ |
|
267 | + 'since' => '11.0.0', |
|
268 | + 'required' => true, |
|
269 | + 'description' => 'If the user can see the systemtag', |
|
270 | + 'example' => '1', |
|
271 | + ], |
|
272 | + 'assignable' => [ |
|
273 | + 'since' => '11.0.0', |
|
274 | + 'required' => true, |
|
275 | + 'description' => 'If the user can assign the systemtag', |
|
276 | + 'example' => '0', |
|
277 | + ], |
|
278 | + ], |
|
279 | + ], |
|
280 | + 'user' => [ |
|
281 | + 'author' => 'Nextcloud', |
|
282 | + 'app' => 'core', |
|
283 | + 'since' => '11.0.0', |
|
284 | + 'parameters' => [ |
|
285 | + 'id' => [ |
|
286 | + 'since' => '11.0.0', |
|
287 | + 'required' => true, |
|
288 | + 'description' => 'The id used to identify the user on the instance', |
|
289 | + 'example' => 'johndoe', |
|
290 | + ], |
|
291 | + 'name' => [ |
|
292 | + 'since' => '11.0.0', |
|
293 | + 'required' => true, |
|
294 | + 'description' => 'The display name of the user which should be used in the visual representation', |
|
295 | + 'example' => 'John Doe', |
|
296 | + ], |
|
297 | + 'server' => [ |
|
298 | + 'since' => '11.0.0', |
|
299 | + 'required' => false, |
|
300 | + 'description' => 'The URL of the instance the user lives on', |
|
301 | + 'example' => 'localhost', |
|
302 | + ], |
|
303 | + ], |
|
304 | + ], |
|
305 | + 'user-group' => [ |
|
306 | + 'author' => 'Nextcloud', |
|
307 | + 'app' => 'core', |
|
308 | + 'since' => '11.0.0', |
|
309 | + 'parameters' => [ |
|
310 | + 'id' => [ |
|
311 | + 'since' => '11.0.0', |
|
312 | + 'required' => true, |
|
313 | + 'description' => 'The id used to identify the group on the instance', |
|
314 | + 'example' => 'supportteam', |
|
315 | + ], |
|
316 | + 'name' => [ |
|
317 | + 'since' => '11.0.0', |
|
318 | + 'required' => true, |
|
319 | + 'description' => 'The display name of the group which should be used in the visual representation', |
|
320 | + 'example' => 'Support Team', |
|
321 | + ], |
|
322 | + ], |
|
323 | + ], |
|
324 | + ]; |
|
325 | 325 | |
326 | - /** |
|
327 | - * @param string $type |
|
328 | - * @return array |
|
329 | - * @throws InvalidObjectExeption |
|
330 | - * @since 11.0.0 |
|
331 | - */ |
|
332 | - public function getDefinition($type) { |
|
333 | - if (isset($this->definitions[$type])) { |
|
334 | - return $this->definitions[$type]; |
|
335 | - } |
|
326 | + /** |
|
327 | + * @param string $type |
|
328 | + * @return array |
|
329 | + * @throws InvalidObjectExeption |
|
330 | + * @since 11.0.0 |
|
331 | + */ |
|
332 | + public function getDefinition($type) { |
|
333 | + if (isset($this->definitions[$type])) { |
|
334 | + return $this->definitions[$type]; |
|
335 | + } |
|
336 | 336 | |
337 | - throw new InvalidObjectExeption('Object type is undefined'); |
|
338 | - } |
|
337 | + throw new InvalidObjectExeption('Object type is undefined'); |
|
338 | + } |
|
339 | 339 | } |
@@ -40,80 +40,80 @@ |
||
40 | 40 | */ |
41 | 41 | interface GroupInterface { |
42 | 42 | |
43 | - /** |
|
44 | - * actions that user backends can define |
|
45 | - */ |
|
46 | - const CREATE_GROUP = 0x00000001; |
|
47 | - const DELETE_GROUP = 0x00000010; |
|
48 | - const ADD_TO_GROUP = 0x00000100; |
|
49 | - const REMOVE_FROM_GOUP = 0x00001000; // oops |
|
50 | - const REMOVE_FROM_GROUP = 0x00001000; |
|
51 | - //OBSOLETE const GET_DISPLAYNAME = 0x00010000; |
|
52 | - const COUNT_USERS = 0x00100000; |
|
53 | - const GROUP_DETAILS = 0x01000000; |
|
43 | + /** |
|
44 | + * actions that user backends can define |
|
45 | + */ |
|
46 | + const CREATE_GROUP = 0x00000001; |
|
47 | + const DELETE_GROUP = 0x00000010; |
|
48 | + const ADD_TO_GROUP = 0x00000100; |
|
49 | + const REMOVE_FROM_GOUP = 0x00001000; // oops |
|
50 | + const REMOVE_FROM_GROUP = 0x00001000; |
|
51 | + //OBSOLETE const GET_DISPLAYNAME = 0x00010000; |
|
52 | + const COUNT_USERS = 0x00100000; |
|
53 | + const GROUP_DETAILS = 0x01000000; |
|
54 | 54 | |
55 | - /** |
|
56 | - * Check if backend implements actions |
|
57 | - * @param int $actions bitwise-or'ed actions |
|
58 | - * @return boolean |
|
59 | - * @since 4.5.0 |
|
60 | - * |
|
61 | - * Returns the supported actions as int to be |
|
62 | - * compared with \OC_Group_Backend::CREATE_GROUP etc. |
|
63 | - */ |
|
64 | - public function implementsActions($actions); |
|
55 | + /** |
|
56 | + * Check if backend implements actions |
|
57 | + * @param int $actions bitwise-or'ed actions |
|
58 | + * @return boolean |
|
59 | + * @since 4.5.0 |
|
60 | + * |
|
61 | + * Returns the supported actions as int to be |
|
62 | + * compared with \OC_Group_Backend::CREATE_GROUP etc. |
|
63 | + */ |
|
64 | + public function implementsActions($actions); |
|
65 | 65 | |
66 | - /** |
|
67 | - * is user in group? |
|
68 | - * @param string $uid uid of the user |
|
69 | - * @param string $gid gid of the group |
|
70 | - * @return bool |
|
71 | - * @since 4.5.0 |
|
72 | - * |
|
73 | - * Checks whether the user is member of a group or not. |
|
74 | - */ |
|
75 | - public function inGroup($uid, $gid); |
|
66 | + /** |
|
67 | + * is user in group? |
|
68 | + * @param string $uid uid of the user |
|
69 | + * @param string $gid gid of the group |
|
70 | + * @return bool |
|
71 | + * @since 4.5.0 |
|
72 | + * |
|
73 | + * Checks whether the user is member of a group or not. |
|
74 | + */ |
|
75 | + public function inGroup($uid, $gid); |
|
76 | 76 | |
77 | - /** |
|
78 | - * Get all groups a user belongs to |
|
79 | - * @param string $uid Name of the user |
|
80 | - * @return array an array of group names |
|
81 | - * @since 4.5.0 |
|
82 | - * |
|
83 | - * This function fetches all groups a user belongs to. It does not check |
|
84 | - * if the user exists at all. |
|
85 | - */ |
|
86 | - public function getUserGroups($uid); |
|
77 | + /** |
|
78 | + * Get all groups a user belongs to |
|
79 | + * @param string $uid Name of the user |
|
80 | + * @return array an array of group names |
|
81 | + * @since 4.5.0 |
|
82 | + * |
|
83 | + * This function fetches all groups a user belongs to. It does not check |
|
84 | + * if the user exists at all. |
|
85 | + */ |
|
86 | + public function getUserGroups($uid); |
|
87 | 87 | |
88 | - /** |
|
89 | - * get a list of all groups |
|
90 | - * @param string $search |
|
91 | - * @param int $limit |
|
92 | - * @param int $offset |
|
93 | - * @return array an array of group names |
|
94 | - * @since 4.5.0 |
|
95 | - * |
|
96 | - * Returns a list with all groups |
|
97 | - */ |
|
98 | - public function getGroups($search = '', $limit = -1, $offset = 0); |
|
88 | + /** |
|
89 | + * get a list of all groups |
|
90 | + * @param string $search |
|
91 | + * @param int $limit |
|
92 | + * @param int $offset |
|
93 | + * @return array an array of group names |
|
94 | + * @since 4.5.0 |
|
95 | + * |
|
96 | + * Returns a list with all groups |
|
97 | + */ |
|
98 | + public function getGroups($search = '', $limit = -1, $offset = 0); |
|
99 | 99 | |
100 | - /** |
|
101 | - * check if a group exists |
|
102 | - * @param string $gid |
|
103 | - * @return bool |
|
104 | - * @since 4.5.0 |
|
105 | - */ |
|
106 | - public function groupExists($gid); |
|
100 | + /** |
|
101 | + * check if a group exists |
|
102 | + * @param string $gid |
|
103 | + * @return bool |
|
104 | + * @since 4.5.0 |
|
105 | + */ |
|
106 | + public function groupExists($gid); |
|
107 | 107 | |
108 | - /** |
|
109 | - * get a list of all users in a group |
|
110 | - * @param string $gid |
|
111 | - * @param string $search |
|
112 | - * @param int $limit |
|
113 | - * @param int $offset |
|
114 | - * @return array an array of user ids |
|
115 | - * @since 4.5.0 |
|
116 | - */ |
|
117 | - public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
108 | + /** |
|
109 | + * get a list of all users in a group |
|
110 | + * @param string $gid |
|
111 | + * @param string $search |
|
112 | + * @param int $limit |
|
113 | + * @param int $offset |
|
114 | + * @return array an array of user ids |
|
115 | + * @since 4.5.0 |
|
116 | + */ |
|
117 | + public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
118 | 118 | |
119 | 119 | } |
@@ -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 | } |
@@ -32,318 +32,318 @@ |
||
32 | 32 | * @since 8.2.0 |
33 | 33 | */ |
34 | 34 | interface IExpressionBuilder { |
35 | - /** |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - const EQ = ExpressionBuilder::EQ; |
|
39 | - /** |
|
40 | - * @since 9.0.0 |
|
41 | - */ |
|
42 | - const NEQ = ExpressionBuilder::NEQ; |
|
43 | - /** |
|
44 | - * @since 9.0.0 |
|
45 | - */ |
|
46 | - const LT = ExpressionBuilder::LT; |
|
47 | - /** |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - const LTE = ExpressionBuilder::LTE; |
|
51 | - /** |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - const GT = ExpressionBuilder::GT; |
|
55 | - /** |
|
56 | - * @since 9.0.0 |
|
57 | - */ |
|
58 | - const GTE = ExpressionBuilder::GTE; |
|
35 | + /** |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + const EQ = ExpressionBuilder::EQ; |
|
39 | + /** |
|
40 | + * @since 9.0.0 |
|
41 | + */ |
|
42 | + const NEQ = ExpressionBuilder::NEQ; |
|
43 | + /** |
|
44 | + * @since 9.0.0 |
|
45 | + */ |
|
46 | + const LT = ExpressionBuilder::LT; |
|
47 | + /** |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + const LTE = ExpressionBuilder::LTE; |
|
51 | + /** |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + const GT = ExpressionBuilder::GT; |
|
55 | + /** |
|
56 | + * @since 9.0.0 |
|
57 | + */ |
|
58 | + const GTE = ExpressionBuilder::GTE; |
|
59 | 59 | |
60 | - /** |
|
61 | - * Creates a conjunction of the given boolean expressions. |
|
62 | - * |
|
63 | - * Example: |
|
64 | - * |
|
65 | - * [php] |
|
66 | - * // (u.type = ?) AND (u.role = ?) |
|
67 | - * $expr->andX('u.type = ?', 'u.role = ?')); |
|
68 | - * |
|
69 | - * @param mixed $x Optional clause. Defaults = null, but requires |
|
70 | - * at least one defined when converting to string. |
|
71 | - * |
|
72 | - * @return \OCP\DB\QueryBuilder\ICompositeExpression |
|
73 | - * @since 8.2.0 |
|
74 | - */ |
|
75 | - public function andX($x = null); |
|
60 | + /** |
|
61 | + * Creates a conjunction of the given boolean expressions. |
|
62 | + * |
|
63 | + * Example: |
|
64 | + * |
|
65 | + * [php] |
|
66 | + * // (u.type = ?) AND (u.role = ?) |
|
67 | + * $expr->andX('u.type = ?', 'u.role = ?')); |
|
68 | + * |
|
69 | + * @param mixed $x Optional clause. Defaults = null, but requires |
|
70 | + * at least one defined when converting to string. |
|
71 | + * |
|
72 | + * @return \OCP\DB\QueryBuilder\ICompositeExpression |
|
73 | + * @since 8.2.0 |
|
74 | + */ |
|
75 | + public function andX($x = null); |
|
76 | 76 | |
77 | - /** |
|
78 | - * Creates a disjunction of the given boolean expressions. |
|
79 | - * |
|
80 | - * Example: |
|
81 | - * |
|
82 | - * [php] |
|
83 | - * // (u.type = ?) OR (u.role = ?) |
|
84 | - * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); |
|
85 | - * |
|
86 | - * @param mixed $x Optional clause. Defaults = null, but requires |
|
87 | - * at least one defined when converting to string. |
|
88 | - * |
|
89 | - * @return \OCP\DB\QueryBuilder\ICompositeExpression |
|
90 | - * @since 8.2.0 |
|
91 | - */ |
|
92 | - public function orX($x = null); |
|
77 | + /** |
|
78 | + * Creates a disjunction of the given boolean expressions. |
|
79 | + * |
|
80 | + * Example: |
|
81 | + * |
|
82 | + * [php] |
|
83 | + * // (u.type = ?) OR (u.role = ?) |
|
84 | + * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); |
|
85 | + * |
|
86 | + * @param mixed $x Optional clause. Defaults = null, but requires |
|
87 | + * at least one defined when converting to string. |
|
88 | + * |
|
89 | + * @return \OCP\DB\QueryBuilder\ICompositeExpression |
|
90 | + * @since 8.2.0 |
|
91 | + */ |
|
92 | + public function orX($x = null); |
|
93 | 93 | |
94 | - /** |
|
95 | - * Creates a comparison expression. |
|
96 | - * |
|
97 | - * @param mixed $x The left expression. |
|
98 | - * @param string $operator One of the IExpressionBuilder::* constants. |
|
99 | - * @param mixed $y The right expression. |
|
100 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
101 | - * required when comparing text fields for oci compatibility |
|
102 | - * |
|
103 | - * @return string |
|
104 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
105 | - */ |
|
106 | - public function comparison($x, $operator, $y, $type = null); |
|
94 | + /** |
|
95 | + * Creates a comparison expression. |
|
96 | + * |
|
97 | + * @param mixed $x The left expression. |
|
98 | + * @param string $operator One of the IExpressionBuilder::* constants. |
|
99 | + * @param mixed $y The right expression. |
|
100 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
101 | + * required when comparing text fields for oci compatibility |
|
102 | + * |
|
103 | + * @return string |
|
104 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
105 | + */ |
|
106 | + public function comparison($x, $operator, $y, $type = null); |
|
107 | 107 | |
108 | - /** |
|
109 | - * Creates an equality comparison expression with the given arguments. |
|
110 | - * |
|
111 | - * First argument is considered the left expression and the second is the right expression. |
|
112 | - * When converted to string, it will generated a <left expr> = <right expr>. Example: |
|
113 | - * |
|
114 | - * [php] |
|
115 | - * // u.id = ? |
|
116 | - * $expr->eq('u.id', '?'); |
|
117 | - * |
|
118 | - * @param mixed $x The left expression. |
|
119 | - * @param mixed $y The right expression. |
|
120 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
121 | - * required when comparing text fields for oci compatibility |
|
122 | - * |
|
123 | - * @return string |
|
124 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
125 | - */ |
|
126 | - public function eq($x, $y, $type = null); |
|
108 | + /** |
|
109 | + * Creates an equality comparison expression with the given arguments. |
|
110 | + * |
|
111 | + * First argument is considered the left expression and the second is the right expression. |
|
112 | + * When converted to string, it will generated a <left expr> = <right expr>. Example: |
|
113 | + * |
|
114 | + * [php] |
|
115 | + * // u.id = ? |
|
116 | + * $expr->eq('u.id', '?'); |
|
117 | + * |
|
118 | + * @param mixed $x The left expression. |
|
119 | + * @param mixed $y The right expression. |
|
120 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
121 | + * required when comparing text fields for oci compatibility |
|
122 | + * |
|
123 | + * @return string |
|
124 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
125 | + */ |
|
126 | + public function eq($x, $y, $type = null); |
|
127 | 127 | |
128 | - /** |
|
129 | - * Creates a non equality comparison expression with the given arguments. |
|
130 | - * First argument is considered the left expression and the second is the right expression. |
|
131 | - * When converted to string, it will generated a <left expr> <> <right expr>. Example: |
|
132 | - * |
|
133 | - * [php] |
|
134 | - * // u.id <> 1 |
|
135 | - * $q->where($q->expr()->neq('u.id', '1')); |
|
136 | - * |
|
137 | - * @param mixed $x The left expression. |
|
138 | - * @param mixed $y The right expression. |
|
139 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
140 | - * required when comparing text fields for oci compatibility |
|
141 | - * |
|
142 | - * @return string |
|
143 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
144 | - */ |
|
145 | - public function neq($x, $y, $type = null); |
|
128 | + /** |
|
129 | + * Creates a non equality comparison expression with the given arguments. |
|
130 | + * First argument is considered the left expression and the second is the right expression. |
|
131 | + * When converted to string, it will generated a <left expr> <> <right expr>. Example: |
|
132 | + * |
|
133 | + * [php] |
|
134 | + * // u.id <> 1 |
|
135 | + * $q->where($q->expr()->neq('u.id', '1')); |
|
136 | + * |
|
137 | + * @param mixed $x The left expression. |
|
138 | + * @param mixed $y The right expression. |
|
139 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
140 | + * required when comparing text fields for oci compatibility |
|
141 | + * |
|
142 | + * @return string |
|
143 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
144 | + */ |
|
145 | + public function neq($x, $y, $type = null); |
|
146 | 146 | |
147 | - /** |
|
148 | - * Creates a lower-than comparison expression with the given arguments. |
|
149 | - * First argument is considered the left expression and the second is the right expression. |
|
150 | - * When converted to string, it will generated a <left expr> < <right expr>. Example: |
|
151 | - * |
|
152 | - * [php] |
|
153 | - * // u.id < ? |
|
154 | - * $q->where($q->expr()->lt('u.id', '?')); |
|
155 | - * |
|
156 | - * @param mixed $x The left expression. |
|
157 | - * @param mixed $y The right expression. |
|
158 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
159 | - * required when comparing text fields for oci compatibility |
|
160 | - * |
|
161 | - * @return string |
|
162 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
163 | - */ |
|
164 | - public function lt($x, $y, $type = null); |
|
147 | + /** |
|
148 | + * Creates a lower-than comparison expression with the given arguments. |
|
149 | + * First argument is considered the left expression and the second is the right expression. |
|
150 | + * When converted to string, it will generated a <left expr> < <right expr>. Example: |
|
151 | + * |
|
152 | + * [php] |
|
153 | + * // u.id < ? |
|
154 | + * $q->where($q->expr()->lt('u.id', '?')); |
|
155 | + * |
|
156 | + * @param mixed $x The left expression. |
|
157 | + * @param mixed $y The right expression. |
|
158 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
159 | + * required when comparing text fields for oci compatibility |
|
160 | + * |
|
161 | + * @return string |
|
162 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
163 | + */ |
|
164 | + public function lt($x, $y, $type = null); |
|
165 | 165 | |
166 | - /** |
|
167 | - * Creates a lower-than-equal comparison expression with the given arguments. |
|
168 | - * First argument is considered the left expression and the second is the right expression. |
|
169 | - * When converted to string, it will generated a <left expr> <= <right expr>. Example: |
|
170 | - * |
|
171 | - * [php] |
|
172 | - * // u.id <= ? |
|
173 | - * $q->where($q->expr()->lte('u.id', '?')); |
|
174 | - * |
|
175 | - * @param mixed $x The left expression. |
|
176 | - * @param mixed $y The right expression. |
|
177 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
178 | - * required when comparing text fields for oci compatibility |
|
179 | - * |
|
180 | - * @return string |
|
181 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
182 | - */ |
|
183 | - public function lte($x, $y, $type = null); |
|
166 | + /** |
|
167 | + * Creates a lower-than-equal comparison expression with the given arguments. |
|
168 | + * First argument is considered the left expression and the second is the right expression. |
|
169 | + * When converted to string, it will generated a <left expr> <= <right expr>. Example: |
|
170 | + * |
|
171 | + * [php] |
|
172 | + * // u.id <= ? |
|
173 | + * $q->where($q->expr()->lte('u.id', '?')); |
|
174 | + * |
|
175 | + * @param mixed $x The left expression. |
|
176 | + * @param mixed $y The right expression. |
|
177 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
178 | + * required when comparing text fields for oci compatibility |
|
179 | + * |
|
180 | + * @return string |
|
181 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
182 | + */ |
|
183 | + public function lte($x, $y, $type = null); |
|
184 | 184 | |
185 | - /** |
|
186 | - * Creates a greater-than comparison expression with the given arguments. |
|
187 | - * First argument is considered the left expression and the second is the right expression. |
|
188 | - * When converted to string, it will generated a <left expr> > <right expr>. Example: |
|
189 | - * |
|
190 | - * [php] |
|
191 | - * // u.id > ? |
|
192 | - * $q->where($q->expr()->gt('u.id', '?')); |
|
193 | - * |
|
194 | - * @param mixed $x The left expression. |
|
195 | - * @param mixed $y The right expression. |
|
196 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
197 | - * required when comparing text fields for oci compatibility |
|
198 | - * |
|
199 | - * @return string |
|
200 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
201 | - */ |
|
202 | - public function gt($x, $y, $type = null); |
|
185 | + /** |
|
186 | + * Creates a greater-than comparison expression with the given arguments. |
|
187 | + * First argument is considered the left expression and the second is the right expression. |
|
188 | + * When converted to string, it will generated a <left expr> > <right expr>. Example: |
|
189 | + * |
|
190 | + * [php] |
|
191 | + * // u.id > ? |
|
192 | + * $q->where($q->expr()->gt('u.id', '?')); |
|
193 | + * |
|
194 | + * @param mixed $x The left expression. |
|
195 | + * @param mixed $y The right expression. |
|
196 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
197 | + * required when comparing text fields for oci compatibility |
|
198 | + * |
|
199 | + * @return string |
|
200 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
201 | + */ |
|
202 | + public function gt($x, $y, $type = null); |
|
203 | 203 | |
204 | - /** |
|
205 | - * Creates a greater-than-equal comparison expression with the given arguments. |
|
206 | - * First argument is considered the left expression and the second is the right expression. |
|
207 | - * When converted to string, it will generated a <left expr> >= <right expr>. Example: |
|
208 | - * |
|
209 | - * [php] |
|
210 | - * // u.id >= ? |
|
211 | - * $q->where($q->expr()->gte('u.id', '?')); |
|
212 | - * |
|
213 | - * @param mixed $x The left expression. |
|
214 | - * @param mixed $y The right expression. |
|
215 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
216 | - * required when comparing text fields for oci compatibility |
|
217 | - * |
|
218 | - * @return string |
|
219 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
220 | - */ |
|
221 | - public function gte($x, $y, $type = null); |
|
204 | + /** |
|
205 | + * Creates a greater-than-equal comparison expression with the given arguments. |
|
206 | + * First argument is considered the left expression and the second is the right expression. |
|
207 | + * When converted to string, it will generated a <left expr> >= <right expr>. Example: |
|
208 | + * |
|
209 | + * [php] |
|
210 | + * // u.id >= ? |
|
211 | + * $q->where($q->expr()->gte('u.id', '?')); |
|
212 | + * |
|
213 | + * @param mixed $x The left expression. |
|
214 | + * @param mixed $y The right expression. |
|
215 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
216 | + * required when comparing text fields for oci compatibility |
|
217 | + * |
|
218 | + * @return string |
|
219 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
220 | + */ |
|
221 | + public function gte($x, $y, $type = null); |
|
222 | 222 | |
223 | - /** |
|
224 | - * Creates an IS NULL expression with the given arguments. |
|
225 | - * |
|
226 | - * @param string $x The field in string format to be restricted by IS NULL. |
|
227 | - * |
|
228 | - * @return string |
|
229 | - * @since 8.2.0 |
|
230 | - */ |
|
231 | - public function isNull($x); |
|
223 | + /** |
|
224 | + * Creates an IS NULL expression with the given arguments. |
|
225 | + * |
|
226 | + * @param string $x The field in string format to be restricted by IS NULL. |
|
227 | + * |
|
228 | + * @return string |
|
229 | + * @since 8.2.0 |
|
230 | + */ |
|
231 | + public function isNull($x); |
|
232 | 232 | |
233 | - /** |
|
234 | - * Creates an IS NOT NULL expression with the given arguments. |
|
235 | - * |
|
236 | - * @param string $x The field in string format to be restricted by IS NOT NULL. |
|
237 | - * |
|
238 | - * @return string |
|
239 | - * @since 8.2.0 |
|
240 | - */ |
|
241 | - public function isNotNull($x); |
|
233 | + /** |
|
234 | + * Creates an IS NOT NULL expression with the given arguments. |
|
235 | + * |
|
236 | + * @param string $x The field in string format to be restricted by IS NOT NULL. |
|
237 | + * |
|
238 | + * @return string |
|
239 | + * @since 8.2.0 |
|
240 | + */ |
|
241 | + public function isNotNull($x); |
|
242 | 242 | |
243 | - /** |
|
244 | - * Creates a LIKE() comparison expression with the given arguments. |
|
245 | - * |
|
246 | - * @param string $x Field in string format to be inspected by LIKE() comparison. |
|
247 | - * @param mixed $y Argument to be used in LIKE() comparison. |
|
248 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
249 | - * required when comparing text fields for oci compatibility |
|
250 | - * |
|
251 | - * @return string |
|
252 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
253 | - */ |
|
254 | - public function like($x, $y, $type = null); |
|
243 | + /** |
|
244 | + * Creates a LIKE() comparison expression with the given arguments. |
|
245 | + * |
|
246 | + * @param string $x Field in string format to be inspected by LIKE() comparison. |
|
247 | + * @param mixed $y Argument to be used in LIKE() comparison. |
|
248 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
249 | + * required when comparing text fields for oci compatibility |
|
250 | + * |
|
251 | + * @return string |
|
252 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
253 | + */ |
|
254 | + public function like($x, $y, $type = null); |
|
255 | 255 | |
256 | - /** |
|
257 | - * Creates a NOT LIKE() comparison expression with the given arguments. |
|
258 | - * |
|
259 | - * @param string $x Field in string format to be inspected by NOT LIKE() comparison. |
|
260 | - * @param mixed $y Argument to be used in NOT LIKE() comparison. |
|
261 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
262 | - * required when comparing text fields for oci compatibility |
|
263 | - * |
|
264 | - * @return string |
|
265 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
266 | - */ |
|
267 | - public function notLike($x, $y, $type = null); |
|
256 | + /** |
|
257 | + * Creates a NOT LIKE() comparison expression with the given arguments. |
|
258 | + * |
|
259 | + * @param string $x Field in string format to be inspected by NOT LIKE() comparison. |
|
260 | + * @param mixed $y Argument to be used in NOT LIKE() comparison. |
|
261 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
262 | + * required when comparing text fields for oci compatibility |
|
263 | + * |
|
264 | + * @return string |
|
265 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
266 | + */ |
|
267 | + public function notLike($x, $y, $type = null); |
|
268 | 268 | |
269 | - /** |
|
270 | - * Creates a ILIKE() comparison expression with the given arguments. |
|
271 | - * |
|
272 | - * @param string $x Field in string format to be inspected by ILIKE() comparison. |
|
273 | - * @param mixed $y Argument to be used in ILIKE() comparison. |
|
274 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
275 | - * required when comparing text fields for oci compatibility |
|
276 | - * |
|
277 | - * @return string |
|
278 | - * @since 9.0.0 |
|
279 | - */ |
|
280 | - public function iLike($x, $y, $type = null); |
|
269 | + /** |
|
270 | + * Creates a ILIKE() comparison expression with the given arguments. |
|
271 | + * |
|
272 | + * @param string $x Field in string format to be inspected by ILIKE() comparison. |
|
273 | + * @param mixed $y Argument to be used in ILIKE() comparison. |
|
274 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
275 | + * required when comparing text fields for oci compatibility |
|
276 | + * |
|
277 | + * @return string |
|
278 | + * @since 9.0.0 |
|
279 | + */ |
|
280 | + public function iLike($x, $y, $type = null); |
|
281 | 281 | |
282 | - /** |
|
283 | - * Creates a IN () comparison expression with the given arguments. |
|
284 | - * |
|
285 | - * @param string $x The field in string format to be inspected by IN() comparison. |
|
286 | - * @param string|array $y The placeholder or the array of values to be used by IN() comparison. |
|
287 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
288 | - * required when comparing text fields for oci compatibility |
|
289 | - * |
|
290 | - * @return string |
|
291 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
292 | - */ |
|
293 | - public function in($x, $y, $type = null); |
|
282 | + /** |
|
283 | + * Creates a IN () comparison expression with the given arguments. |
|
284 | + * |
|
285 | + * @param string $x The field in string format to be inspected by IN() comparison. |
|
286 | + * @param string|array $y The placeholder or the array of values to be used by IN() comparison. |
|
287 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
288 | + * required when comparing text fields for oci compatibility |
|
289 | + * |
|
290 | + * @return string |
|
291 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
292 | + */ |
|
293 | + public function in($x, $y, $type = null); |
|
294 | 294 | |
295 | - /** |
|
296 | - * Creates a NOT IN () comparison expression with the given arguments. |
|
297 | - * |
|
298 | - * @param string $x The field in string format to be inspected by NOT IN() comparison. |
|
299 | - * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. |
|
300 | - * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
301 | - * required when comparing text fields for oci compatibility |
|
302 | - * |
|
303 | - * @return string |
|
304 | - * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
305 | - */ |
|
306 | - public function notIn($x, $y, $type = null); |
|
295 | + /** |
|
296 | + * Creates a NOT IN () comparison expression with the given arguments. |
|
297 | + * |
|
298 | + * @param string $x The field in string format to be inspected by NOT IN() comparison. |
|
299 | + * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. |
|
300 | + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants |
|
301 | + * required when comparing text fields for oci compatibility |
|
302 | + * |
|
303 | + * @return string |
|
304 | + * @since 8.2.0 - Parameter $type was added in 9.0.0 |
|
305 | + */ |
|
306 | + public function notIn($x, $y, $type = null); |
|
307 | 307 | |
308 | 308 | |
309 | - /** |
|
310 | - * Creates a bitwise AND comparison |
|
311 | - * |
|
312 | - * @param string|ILiteral $x The field or value to check |
|
313 | - * @param int $y Bitmap that must be set |
|
314 | - * @return IQueryFunction |
|
315 | - * @since 12.0.0 |
|
316 | - */ |
|
317 | - public function bitwiseAnd($x, $y); |
|
309 | + /** |
|
310 | + * Creates a bitwise AND comparison |
|
311 | + * |
|
312 | + * @param string|ILiteral $x The field or value to check |
|
313 | + * @param int $y Bitmap that must be set |
|
314 | + * @return IQueryFunction |
|
315 | + * @since 12.0.0 |
|
316 | + */ |
|
317 | + public function bitwiseAnd($x, $y); |
|
318 | 318 | |
319 | - /** |
|
320 | - * Creates a bitwise OR comparison |
|
321 | - * |
|
322 | - * @param string|ILiteral $x The field or value to check |
|
323 | - * @param int $y Bitmap that must be set |
|
324 | - * @return IQueryFunction |
|
325 | - * @since 12.0.0 |
|
326 | - */ |
|
327 | - public function bitwiseOr($x, $y); |
|
319 | + /** |
|
320 | + * Creates a bitwise OR comparison |
|
321 | + * |
|
322 | + * @param string|ILiteral $x The field or value to check |
|
323 | + * @param int $y Bitmap that must be set |
|
324 | + * @return IQueryFunction |
|
325 | + * @since 12.0.0 |
|
326 | + */ |
|
327 | + public function bitwiseOr($x, $y); |
|
328 | 328 | |
329 | - /** |
|
330 | - * Quotes a given input parameter. |
|
331 | - * |
|
332 | - * @param mixed $input The parameter to be quoted. |
|
333 | - * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants |
|
334 | - * |
|
335 | - * @return string |
|
336 | - * @since 8.2.0 |
|
337 | - */ |
|
338 | - public function literal($input, $type = null); |
|
329 | + /** |
|
330 | + * Quotes a given input parameter. |
|
331 | + * |
|
332 | + * @param mixed $input The parameter to be quoted. |
|
333 | + * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants |
|
334 | + * |
|
335 | + * @return string |
|
336 | + * @since 8.2.0 |
|
337 | + */ |
|
338 | + public function literal($input, $type = null); |
|
339 | 339 | |
340 | - /** |
|
341 | - * Returns a IQueryFunction that casts the column to the given type |
|
342 | - * |
|
343 | - * @param string $column |
|
344 | - * @param mixed $type One of IQueryBuilder::PARAM_* |
|
345 | - * @return string |
|
346 | - * @since 9.0.0 |
|
347 | - */ |
|
348 | - public function castColumn($column, $type); |
|
340 | + /** |
|
341 | + * Returns a IQueryFunction that casts the column to the given type |
|
342 | + * |
|
343 | + * @param string $column |
|
344 | + * @param mixed $type One of IQueryBuilder::PARAM_* |
|
345 | + * @return string |
|
346 | + * @since 9.0.0 |
|
347 | + */ |
|
348 | + public function castColumn($column, $type); |
|
349 | 349 | } |
@@ -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 | } |