Commit | Line | Data |
---|---|---|
45ca63d0 TD |
1 | |
2 | <!doctype html> | |
3 | <html lang="en" class="no-js"> | |
4 | <head> | |
5 | ||
6 | <meta charset="utf-8"> | |
7 | <meta name="viewport" content="width=device-width,initial-scale=1"> | |
8 | ||
9 | ||
10 | ||
11 | ||
fb962f09 WG |
12 | <link rel="icon" href="../../../assets/default.favicon.ico"> |
13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0"> | |
45ca63d0 TD |
14 | |
15 | ||
16 | ||
17 | <title>acpSearchProvider - WoltLab Suite Documentation</title> | |
18 | ||
19 | ||
20 | ||
fb962f09 | 21 | <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css"> |
45ca63d0 TD |
22 | |
23 | ||
fb962f09 | 24 | <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css"> |
45ca63d0 TD |
25 | |
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
fd8430cb WG |
34 | |
35 | ||
45ca63d0 TD |
36 | |
37 | ||
38 | <link rel="stylesheet" href="../../../stylesheets/extra.css"> | |
39 | ||
40 | ||
41 | ||
42 | ||
43 | ||
44 | </head> | |
45 | ||
46 | ||
47 | ||
48 | ||
49 | ||
50 | ||
51 | ||
52 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
45ca63d0 TD |
53 | |
54 | ||
fb962f09 WG |
55 | <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
56 | ||
45ca63d0 TD |
57 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
58 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
59 | <label class="md-overlay" for="__drawer"></label> | |
60 | <div data-md-component="skip"> | |
61 | ||
62 | ||
63 | <a href="#acp-search-provider-package-installation-plugin" class="md-skip"> | |
64 | Skip to content | |
65 | </a> | |
66 | ||
67 | </div> | |
68 | <div data-md-component="announce"> | |
69 | ||
70 | <aside class="md-announce"> | |
71 | <div class="md-announce__inner md-grid md-typeset"> | |
72 | ||
73 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
74 | ||
75 | </div> | |
76 | </aside> | |
77 | ||
78 | </div> | |
79 | ||
fb962f09 | 80 | <header class="md-header" data-md-component="header"> |
45ca63d0 | 81 | <nav class="md-header__inner md-grid" aria-label="Header"> |
fb962f09 | 82 | <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
83 | |
84 | <img src="../../../assets/logo.png" alt="logo"> | |
85 | ||
86 | </a> | |
87 | <label class="md-header__button md-icon" for="__drawer"> | |
88 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> | |
89 | </label> | |
90 | <div class="md-header__title" data-md-component="header-title"> | |
91 | <div class="md-header__ellipsis"> | |
92 | <div class="md-header__topic"> | |
93 | <span class="md-ellipsis"> | |
94 | WoltLab Suite Documentation | |
95 | </span> | |
96 | </div> | |
97 | <div class="md-header__topic" data-md-component="header-topic"> | |
98 | <span class="md-ellipsis"> | |
99 | ||
100 | acpSearchProvider | |
101 | ||
102 | </span> | |
103 | </div> | |
104 | </div> | |
45ca63d0 TD |
105 | </div> |
106 | ||
fb962f09 WG |
107 | |
108 | ||
a3639e76 WG |
109 | <label class="md-header__button md-icon" for="__search"> |
110 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
111 | </label> | |
112 | ||
113 | <div class="md-search" data-md-component="search" role="dialog"> | |
114 | <label class="md-search__overlay" for="__search"></label> | |
115 | <div class="md-search__inner" role="search"> | |
116 | <form class="md-search__form" name="search"> | |
117 | <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required> | |
118 | <label class="md-search__icon md-icon" for="__search"> | |
119 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
120 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> | |
121 | </label> | |
122 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
fb962f09 | 123 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> |
a3639e76 WG |
124 | </button> |
125 | </form> | |
126 | <div class="md-search__output"> | |
127 | <div class="md-search__scrollwrap" data-md-scrollfix> | |
128 | <div class="md-search-result" data-md-component="search-result"> | |
129 | <div class="md-search-result__meta"> | |
130 | Initializing search | |
131 | </div> | |
132 | <ol class="md-search-result__list"></ol> | |
133 | </div> | |
134 | </div> | |
135 | </div> | |
136 | </div> | |
137 | </div> | |
138 | ||
45ca63d0 | 139 | |
7124f4cb WG |
140 | <div class="md-header__source"> |
141 | ||
142 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
143 | <div class="md-source__icon md-icon"> | |
144 | ||
fb962f09 | 145 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
146 | </div> |
147 | <div class="md-source__repository"> | |
148 | GitHub | |
149 | </div> | |
150 | </a> | |
151 | </div> | |
152 | ||
45ca63d0 TD |
153 | </nav> |
154 | </header> | |
155 | ||
156 | <div class="md-container" data-md-component="container"> | |
157 | ||
158 | ||
159 | ||
160 | ||
161 | <main class="md-main" data-md-component="main"> | |
162 | <div class="md-main__inner md-grid"> | |
163 | ||
164 | ||
165 | ||
166 | <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > | |
167 | <div class="md-sidebar__scrollwrap"> | |
168 | <div class="md-sidebar__inner"> | |
169 | ||
170 | ||
171 | ||
45ca63d0 TD |
172 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
173 | <label class="md-nav__title" for="__drawer"> | |
fb962f09 | 174 | <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
175 | |
176 | <img src="../../../assets/logo.png" alt="logo"> | |
177 | ||
178 | </a> | |
179 | WoltLab Suite Documentation | |
180 | </label> | |
181 | ||
7124f4cb WG |
182 | <div class="md-nav__source"> |
183 | ||
184 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
185 | <div class="md-source__icon md-icon"> | |
186 | ||
fb962f09 | 187 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
188 | </div> |
189 | <div class="md-source__repository"> | |
190 | GitHub | |
191 | </div> | |
192 | </a> | |
193 | </div> | |
194 | ||
45ca63d0 TD |
195 | <ul class="md-nav__list" data-md-scrollfix> |
196 | ||
197 | ||
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | <li class="md-nav__item"> | |
205 | <a href="../../../getting-started/" class="md-nav__link"> | |
206 | Getting Started | |
207 | </a> | |
208 | </li> | |
209 | ||
210 | ||
211 | ||
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | ||
218 | ||
219 | ||
220 | <li class="md-nav__item md-nav__item--nested"> | |
221 | ||
222 | ||
223 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > | |
224 | ||
225 | <label class="md-nav__link" for="__nav_2"> | |
226 | PHP API | |
227 | <span class="md-nav__icon md-icon"></span> | |
228 | </label> | |
229 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
230 | <label class="md-nav__title" for="__nav_2"> | |
231 | <span class="md-nav__icon md-icon"></span> | |
232 | PHP API | |
233 | </label> | |
234 | <ul class="md-nav__list" data-md-scrollfix> | |
235 | ||
236 | ||
237 | ||
238 | ||
239 | ||
240 | <li class="md-nav__item"> | |
241 | <a href="../../../php/pages/" class="md-nav__link"> | |
242 | Pages | |
243 | </a> | |
244 | </li> | |
245 | ||
246 | ||
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | <li class="md-nav__item"> | |
253 | <a href="../../../php/database-objects/" class="md-nav__link"> | |
254 | Database Objects | |
255 | </a> | |
256 | </li> | |
257 | ||
258 | ||
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | <li class="md-nav__item"> | |
265 | <a href="../../../php/database-access/" class="md-nav__link"> | |
266 | Database Access | |
267 | </a> | |
268 | </li> | |
269 | ||
270 | ||
271 | ||
272 | ||
273 | ||
274 | ||
275 | ||
276 | <li class="md-nav__item"> | |
277 | <a href="../../../php/exceptions/" class="md-nav__link"> | |
278 | Exceptions | |
279 | </a> | |
280 | </li> | |
281 | ||
282 | ||
283 | ||
284 | ||
285 | ||
286 | ||
287 | ||
288 | ||
289 | <li class="md-nav__item md-nav__item--nested"> | |
290 | ||
291 | ||
292 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
293 | ||
294 | <label class="md-nav__link" for="__nav_2_5"> | |
295 | API | |
296 | <span class="md-nav__icon md-icon"></span> | |
297 | </label> | |
298 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
299 | <label class="md-nav__title" for="__nav_2_5"> | |
300 | <span class="md-nav__icon md-icon"></span> | |
301 | API | |
302 | </label> | |
303 | <ul class="md-nav__list" data-md-scrollfix> | |
304 | ||
305 | ||
306 | ||
307 | ||
308 | ||
309 | <li class="md-nav__item"> | |
310 | <a href="../../../php/api/caches/" class="md-nav__link"> | |
311 | Caches | |
312 | </a> | |
313 | </li> | |
314 | ||
315 | ||
316 | ||
317 | ||
318 | ||
319 | ||
320 | ||
321 | <li class="md-nav__item"> | |
322 | <a href="../../../php/api/comments/" class="md-nav__link"> | |
323 | Comments | |
324 | </a> | |
325 | </li> | |
326 | ||
327 | ||
328 | ||
329 | ||
330 | ||
331 | ||
332 | ||
333 | <li class="md-nav__item"> | |
334 | <a href="../../../php/api/cronjobs/" class="md-nav__link"> | |
335 | Cronjobs | |
336 | </a> | |
337 | </li> | |
338 | ||
339 | ||
340 | ||
341 | ||
342 | ||
343 | ||
344 | ||
345 | <li class="md-nav__item"> | |
346 | <a href="../../../php/api/events/" class="md-nav__link"> | |
347 | Events | |
348 | </a> | |
349 | </li> | |
350 | ||
351 | ||
352 | ||
353 | ||
354 | ||
355 | ||
356 | ||
357 | ||
358 | <li class="md-nav__item md-nav__item--nested"> | |
359 | ||
360 | ||
361 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
362 | ||
363 | <label class="md-nav__link" for="__nav_2_5_5"> | |
364 | Form Builder | |
365 | <span class="md-nav__icon md-icon"></span> | |
366 | </label> | |
367 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
368 | <label class="md-nav__title" for="__nav_2_5_5"> | |
369 | <span class="md-nav__icon md-icon"></span> | |
370 | Form Builder | |
371 | </label> | |
372 | <ul class="md-nav__list" data-md-scrollfix> | |
373 | ||
374 | ||
375 | ||
376 | ||
377 | ||
378 | <li class="md-nav__item"> | |
379 | <a href="../../../php/api/form_builder/overview/" class="md-nav__link"> | |
380 | Overview | |
381 | </a> | |
382 | </li> | |
383 | ||
384 | ||
385 | ||
386 | ||
387 | ||
388 | ||
389 | ||
390 | <li class="md-nav__item"> | |
391 | <a href="../../../php/api/form_builder/structure/" class="md-nav__link"> | |
392 | Structure | |
393 | </a> | |
394 | </li> | |
395 | ||
396 | ||
397 | ||
398 | ||
399 | ||
400 | ||
401 | ||
402 | <li class="md-nav__item"> | |
403 | <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link"> | |
404 | Fields | |
405 | </a> | |
406 | </li> | |
407 | ||
408 | ||
409 | ||
410 | ||
411 | ||
412 | ||
413 | ||
414 | <li class="md-nav__item"> | |
415 | <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link"> | |
416 | Validation and Data | |
417 | </a> | |
418 | </li> | |
419 | ||
420 | ||
421 | ||
422 | ||
423 | ||
424 | ||
425 | ||
426 | <li class="md-nav__item"> | |
427 | <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link"> | |
428 | Dependencies | |
429 | </a> | |
430 | </li> | |
431 | ||
432 | ||
433 | ||
434 | </ul> | |
435 | </nav> | |
436 | </li> | |
437 | ||
438 | ||
439 | ||
440 | ||
441 | ||
442 | ||
443 | ||
444 | <li class="md-nav__item"> | |
445 | <a href="../../../php/api/package_installation_plugins/" class="md-nav__link"> | |
446 | Package Installation Plugins | |
447 | </a> | |
448 | </li> | |
449 | ||
450 | ||
451 | ||
452 | ||
453 | ||
454 | ||
455 | ||
456 | <li class="md-nav__item"> | |
457 | <a href="../../../php/api/user_activity_points/" class="md-nav__link"> | |
458 | User Activity Points | |
459 | </a> | |
460 | </li> | |
461 | ||
462 | ||
463 | ||
464 | ||
465 | ||
466 | ||
467 | ||
468 | <li class="md-nav__item"> | |
469 | <a href="../../../php/api/user_notifications/" class="md-nav__link"> | |
470 | User Notifications | |
471 | </a> | |
472 | </li> | |
473 | ||
474 | ||
475 | ||
476 | ||
477 | ||
478 | ||
479 | ||
480 | <li class="md-nav__item"> | |
481 | <a href="../../../php/api/sitemaps/" class="md-nav__link"> | |
482 | Sitemaps | |
483 | </a> | |
484 | </li> | |
485 | ||
486 | ||
487 | ||
488 | </ul> | |
489 | </nav> | |
490 | </li> | |
491 | ||
492 | ||
493 | ||
494 | ||
495 | ||
496 | ||
497 | ||
498 | <li class="md-nav__item"> | |
499 | <a href="../../../php/code-style/" class="md-nav__link"> | |
500 | Code Style | |
501 | </a> | |
502 | </li> | |
503 | ||
504 | ||
505 | ||
506 | ||
507 | ||
508 | ||
509 | ||
510 | <li class="md-nav__item"> | |
511 | <a href="../../../php/apps/" class="md-nav__link"> | |
512 | Apps | |
513 | </a> | |
514 | </li> | |
515 | ||
516 | ||
517 | ||
518 | ||
519 | ||
520 | ||
521 | ||
522 | <li class="md-nav__item"> | |
523 | <a href="../../../php/gdpr/" class="md-nav__link"> | |
524 | GDPR | |
525 | </a> | |
526 | </li> | |
527 | ||
528 | ||
529 | ||
530 | </ul> | |
531 | </nav> | |
532 | </li> | |
533 | ||
534 | ||
535 | ||
536 | ||
537 | ||
538 | ||
539 | ||
540 | ||
541 | ||
542 | ||
543 | ||
544 | <li class="md-nav__item md-nav__item--nested"> | |
545 | ||
546 | ||
547 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
548 | ||
549 | <label class="md-nav__link" for="__nav_3"> | |
550 | Languages, Templates & CSS | |
551 | <span class="md-nav__icon md-icon"></span> | |
552 | </label> | |
553 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
554 | <label class="md-nav__title" for="__nav_3"> | |
555 | <span class="md-nav__icon md-icon"></span> | |
556 | Languages, Templates & CSS | |
557 | </label> | |
558 | <ul class="md-nav__list" data-md-scrollfix> | |
559 | ||
560 | ||
561 | ||
562 | ||
563 | ||
564 | <li class="md-nav__item"> | |
565 | <a href="../../../view/languages/" class="md-nav__link"> | |
566 | Languages | |
567 | </a> | |
568 | </li> | |
569 | ||
570 | ||
571 | ||
572 | ||
573 | ||
574 | ||
575 | ||
576 | <li class="md-nav__item"> | |
577 | <a href="../../../view/templates/" class="md-nav__link"> | |
578 | Templates | |
579 | </a> | |
580 | </li> | |
581 | ||
582 | ||
583 | ||
584 | ||
585 | ||
586 | ||
587 | ||
588 | <li class="md-nav__item"> | |
589 | <a href="../../../view/css/" class="md-nav__link"> | |
590 | CSS | |
591 | </a> | |
592 | </li> | |
593 | ||
594 | ||
595 | ||
596 | </ul> | |
597 | </nav> | |
598 | </li> | |
599 | ||
600 | ||
601 | ||
602 | ||
603 | ||
604 | ||
605 | ||
606 | ||
607 | ||
608 | ||
609 | ||
610 | <li class="md-nav__item md-nav__item--nested"> | |
611 | ||
612 | ||
613 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
614 | ||
615 | <label class="md-nav__link" for="__nav_4"> | |
77efcd46 | 616 | TypeScript and JavaScript API |
45ca63d0 TD |
617 | <span class="md-nav__icon md-icon"></span> |
618 | </label> | |
77efcd46 | 619 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
45ca63d0 TD |
620 | <label class="md-nav__title" for="__nav_4"> |
621 | <span class="md-nav__icon md-icon"></span> | |
77efcd46 | 622 | TypeScript and JavaScript API |
45ca63d0 TD |
623 | </label> |
624 | <ul class="md-nav__list" data-md-scrollfix> | |
625 | ||
626 | ||
627 | ||
628 | ||
629 | ||
630 | <li class="md-nav__item"> | |
631 | <a href="../../../javascript/general-usage/" class="md-nav__link"> | |
632 | General Usage | |
633 | </a> | |
634 | </li> | |
635 | ||
636 | ||
637 | ||
638 | ||
639 | ||
640 | ||
641 | ||
77efcd46 WG |
642 | <li class="md-nav__item"> |
643 | <a href="../../../javascript/typescript/" class="md-nav__link"> | |
644 | TypeScript | |
645 | </a> | |
646 | </li> | |
647 | ||
648 | ||
649 | ||
650 | ||
651 | ||
652 | ||
653 | ||
45ca63d0 TD |
654 | |
655 | <li class="md-nav__item md-nav__item--nested"> | |
656 | ||
657 | ||
77efcd46 | 658 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
45ca63d0 | 659 | |
77efcd46 | 660 | <label class="md-nav__link" for="__nav_4_3"> |
45ca63d0 TD |
661 | New API |
662 | <span class="md-nav__icon md-icon"></span> | |
663 | </label> | |
664 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
77efcd46 | 665 | <label class="md-nav__title" for="__nav_4_3"> |
45ca63d0 TD |
666 | <span class="md-nav__icon md-icon"></span> |
667 | New API | |
668 | </label> | |
669 | <ul class="md-nav__list" data-md-scrollfix> | |
670 | ||
671 | ||
672 | ||
673 | ||
674 | ||
675 | <li class="md-nav__item"> | |
676 | <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
677 | Writing a module | |
678 | </a> | |
679 | </li> | |
680 | ||
681 | ||
682 | ||
683 | ||
684 | ||
685 | ||
686 | ||
687 | <li class="md-nav__item"> | |
688 | <a href="../../../javascript/new-api_data-structures/" class="md-nav__link"> | |
689 | Data Structures | |
690 | </a> | |
691 | </li> | |
692 | ||
693 | ||
694 | ||
695 | ||
696 | ||
697 | ||
698 | ||
699 | <li class="md-nav__item"> | |
700 | <a href="../../../javascript/new-api_core/" class="md-nav__link"> | |
701 | Core Functions | |
702 | </a> | |
703 | </li> | |
704 | ||
705 | ||
706 | ||
707 | ||
708 | ||
709 | ||
710 | ||
711 | <li class="md-nav__item"> | |
712 | <a href="../../../javascript/new-api_dom/" class="md-nav__link"> | |
713 | DOM | |
714 | </a> | |
715 | </li> | |
716 | ||
717 | ||
718 | ||
719 | ||
720 | ||
721 | ||
722 | ||
723 | <li class="md-nav__item"> | |
724 | <a href="../../../javascript/new-api_events/" class="md-nav__link"> | |
725 | Event Handling | |
726 | </a> | |
727 | </li> | |
728 | ||
729 | ||
730 | ||
731 | ||
732 | ||
733 | ||
734 | ||
735 | <li class="md-nav__item"> | |
736 | <a href="../../../javascript/new-api_ajax/" class="md-nav__link"> | |
737 | Ajax | |
738 | </a> | |
739 | </li> | |
740 | ||
741 | ||
742 | ||
743 | ||
744 | ||
745 | ||
746 | ||
747 | <li class="md-nav__item"> | |
748 | <a href="../../../javascript/new-api_dialogs/" class="md-nav__link"> | |
749 | Dialogs | |
750 | </a> | |
751 | </li> | |
752 | ||
753 | ||
754 | ||
755 | ||
756 | ||
757 | ||
758 | ||
759 | <li class="md-nav__item"> | |
760 | <a href="../../../javascript/new-api_browser/" class="md-nav__link"> | |
761 | Browser and Screen Sizes | |
762 | </a> | |
763 | </li> | |
764 | ||
765 | ||
766 | ||
767 | ||
768 | ||
769 | ||
770 | ||
771 | <li class="md-nav__item"> | |
772 | <a href="../../../javascript/new-api_ui/" class="md-nav__link"> | |
773 | User Interface | |
774 | </a> | |
775 | </li> | |
776 | ||
777 | ||
778 | ||
779 | </ul> | |
780 | </nav> | |
781 | </li> | |
782 | ||
783 | ||
784 | ||
785 | ||
786 | ||
787 | ||
788 | ||
789 | <li class="md-nav__item"> | |
790 | <a href="../../../javascript/legacy-api/" class="md-nav__link"> | |
791 | Legacy API | |
792 | </a> | |
793 | </li> | |
794 | ||
795 | ||
796 | ||
797 | ||
798 | ||
799 | ||
800 | ||
801 | <li class="md-nav__item"> | |
802 | <a href="../../../javascript/helper-functions/" class="md-nav__link"> | |
803 | Helper Functions | |
804 | </a> | |
805 | </li> | |
806 | ||
807 | ||
808 | ||
809 | ||
810 | ||
811 | ||
812 | ||
813 | <li class="md-nav__item"> | |
814 | <a href="../../../javascript/code-snippets/" class="md-nav__link"> | |
815 | Code Snippets | |
816 | </a> | |
817 | </li> | |
818 | ||
819 | ||
820 | ||
821 | </ul> | |
822 | </nav> | |
823 | </li> | |
824 | ||
825 | ||
826 | ||
827 | ||
828 | ||
829 | ||
830 | ||
831 | ||
832 | ||
833 | ||
834 | ||
835 | ||
836 | ||
837 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
838 | ||
839 | ||
840 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked> | |
841 | ||
842 | <label class="md-nav__link" for="__nav_5"> | |
843 | Package Components | |
844 | <span class="md-nav__icon md-icon"></span> | |
845 | </label> | |
846 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
847 | <label class="md-nav__title" for="__nav_5"> | |
848 | <span class="md-nav__icon md-icon"></span> | |
849 | Package Components | |
850 | </label> | |
851 | <ul class="md-nav__list" data-md-scrollfix> | |
852 | ||
853 | ||
854 | ||
855 | ||
856 | ||
857 | <li class="md-nav__item"> | |
858 | <a href="../../package-xml/" class="md-nav__link"> | |
859 | package.xml | |
860 | </a> | |
861 | </li> | |
862 | ||
863 | ||
864 | ||
865 | ||
866 | ||
867 | ||
868 | ||
869 | ||
870 | ||
871 | ||
872 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
873 | ||
874 | ||
875 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked> | |
876 | ||
877 | <label class="md-nav__link" for="__nav_5_2"> | |
878 | PIPs | |
879 | <span class="md-nav__icon md-icon"></span> | |
880 | </label> | |
881 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
882 | <label class="md-nav__title" for="__nav_5_2"> | |
883 | <span class="md-nav__icon md-icon"></span> | |
884 | PIPs | |
885 | </label> | |
886 | <ul class="md-nav__list" data-md-scrollfix> | |
887 | ||
888 | ||
889 | ||
890 | ||
891 | ||
892 | <li class="md-nav__item"> | |
893 | <a href="../" class="md-nav__link"> | |
894 | Overview | |
895 | </a> | |
896 | </li> | |
897 | ||
898 | ||
899 | ||
900 | ||
901 | ||
902 | ||
903 | ||
904 | <li class="md-nav__item"> | |
905 | <a href="../acl-option/" class="md-nav__link"> | |
906 | aclOption | |
907 | </a> | |
908 | </li> | |
909 | ||
910 | ||
911 | ||
912 | ||
913 | ||
914 | ||
915 | ||
916 | <li class="md-nav__item"> | |
917 | <a href="../acp-menu/" class="md-nav__link"> | |
918 | acpMenu | |
919 | </a> | |
920 | </li> | |
921 | ||
922 | ||
923 | ||
924 | ||
925 | ||
926 | ||
927 | ||
928 | ||
929 | ||
930 | <li class="md-nav__item md-nav__item--active"> | |
931 | ||
932 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
933 | ||
934 | ||
935 | ||
936 | ||
937 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
938 | acpSearchProvider | |
939 | <span class="md-nav__icon md-icon"></span> | |
940 | </label> | |
941 | ||
942 | <a href="./" class="md-nav__link md-nav__link--active"> | |
943 | acpSearchProvider | |
944 | </a> | |
945 | ||
946 | ||
947 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
948 | ||
949 | ||
950 | ||
951 | ||
952 | ||
953 | <label class="md-nav__title" for="__toc"> | |
954 | <span class="md-nav__icon md-icon"></span> | |
955 | Table of contents | |
956 | </label> | |
957 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
958 | ||
959 | <li class="md-nav__item"> | |
960 | <a href="#components" class="md-nav__link"> | |
961 | Components | |
962 | </a> | |
963 | ||
964 | <nav class="md-nav" aria-label="Components"> | |
965 | <ul class="md-nav__list"> | |
966 | ||
967 | <li class="md-nav__item"> | |
968 | <a href="#classname" class="md-nav__link"> | |
969 | <classname> | |
970 | </a> | |
971 | ||
972 | </li> | |
973 | ||
974 | <li class="md-nav__item"> | |
975 | <a href="#showorder" class="md-nav__link"> | |
976 | <showorder> | |
977 | </a> | |
978 | ||
979 | </li> | |
980 | ||
981 | </ul> | |
982 | </nav> | |
983 | ||
984 | </li> | |
985 | ||
986 | <li class="md-nav__item"> | |
987 | <a href="#example" class="md-nav__link"> | |
988 | Example | |
989 | </a> | |
990 | ||
991 | </li> | |
992 | ||
993 | </ul> | |
994 | ||
995 | </nav> | |
996 | ||
997 | </li> | |
998 | ||
999 | ||
1000 | ||
1001 | ||
1002 | ||
1003 | ||
1004 | ||
1005 | <li class="md-nav__item"> | |
1006 | <a href="../acp-template/" class="md-nav__link"> | |
1007 | acpTemplate | |
1008 | </a> | |
1009 | </li> | |
1010 | ||
1011 | ||
1012 | ||
1013 | ||
1014 | ||
1015 | ||
1016 | ||
1017 | <li class="md-nav__item"> | |
1018 | <a href="../bbcode/" class="md-nav__link"> | |
1019 | bbcode | |
1020 | </a> | |
1021 | </li> | |
1022 | ||
1023 | ||
1024 | ||
1025 | ||
1026 | ||
1027 | ||
1028 | ||
1029 | <li class="md-nav__item"> | |
1030 | <a href="../box/" class="md-nav__link"> | |
1031 | box | |
1032 | </a> | |
1033 | </li> | |
1034 | ||
1035 | ||
1036 | ||
1037 | ||
1038 | ||
1039 | ||
1040 | ||
1041 | <li class="md-nav__item"> | |
1042 | <a href="../clipboard-action/" class="md-nav__link"> | |
1043 | clipboardAction | |
1044 | </a> | |
1045 | </li> | |
1046 | ||
1047 | ||
1048 | ||
1049 | ||
1050 | ||
1051 | ||
1052 | ||
1053 | <li class="md-nav__item"> | |
1054 | <a href="../core-object/" class="md-nav__link"> | |
1055 | coreObject | |
1056 | </a> | |
1057 | </li> | |
1058 | ||
1059 | ||
1060 | ||
1061 | ||
1062 | ||
1063 | ||
1064 | ||
1065 | <li class="md-nav__item"> | |
1066 | <a href="../cronjob/" class="md-nav__link"> | |
1067 | cronjob | |
1068 | </a> | |
1069 | </li> | |
1070 | ||
1071 | ||
1072 | ||
1073 | ||
1074 | ||
1075 | ||
1076 | ||
1077 | <li class="md-nav__item"> | |
1078 | <a href="../event-listener/" class="md-nav__link"> | |
1079 | eventListener | |
1080 | </a> | |
1081 | </li> | |
1082 | ||
1083 | ||
1084 | ||
1085 | ||
1086 | ||
1087 | ||
1088 | ||
1089 | <li class="md-nav__item"> | |
1090 | <a href="../file/" class="md-nav__link"> | |
1091 | file | |
1092 | </a> | |
1093 | </li> | |
1094 | ||
1095 | ||
1096 | ||
1097 | ||
1098 | ||
1099 | ||
1100 | ||
1101 | <li class="md-nav__item"> | |
1102 | <a href="../language/" class="md-nav__link"> | |
1103 | language | |
1104 | </a> | |
1105 | </li> | |
1106 | ||
1107 | ||
1108 | ||
1109 | ||
1110 | ||
1111 | ||
1112 | ||
1113 | <li class="md-nav__item"> | |
1114 | <a href="../media-provider/" class="md-nav__link"> | |
1115 | mediaProvider | |
1116 | </a> | |
1117 | </li> | |
1118 | ||
1119 | ||
1120 | ||
1121 | ||
1122 | ||
1123 | ||
1124 | ||
1125 | <li class="md-nav__item"> | |
1126 | <a href="../menu/" class="md-nav__link"> | |
1127 | menu | |
1128 | </a> | |
1129 | </li> | |
1130 | ||
1131 | ||
1132 | ||
1133 | ||
1134 | ||
1135 | ||
1136 | ||
1137 | <li class="md-nav__item"> | |
1138 | <a href="../menu-item/" class="md-nav__link"> | |
1139 | menuItem | |
1140 | </a> | |
1141 | </li> | |
1142 | ||
1143 | ||
1144 | ||
1145 | ||
1146 | ||
1147 | ||
1148 | ||
1149 | <li class="md-nav__item"> | |
1150 | <a href="../object-type/" class="md-nav__link"> | |
1151 | objectType | |
1152 | </a> | |
1153 | </li> | |
1154 | ||
1155 | ||
1156 | ||
1157 | ||
1158 | ||
1159 | ||
1160 | ||
1161 | <li class="md-nav__item"> | |
1162 | <a href="../object-type-definition/" class="md-nav__link"> | |
1163 | objectTypeDefinition | |
1164 | </a> | |
1165 | </li> | |
1166 | ||
1167 | ||
1168 | ||
1169 | ||
1170 | ||
1171 | ||
1172 | ||
1173 | <li class="md-nav__item"> | |
1174 | <a href="../option/" class="md-nav__link"> | |
1175 | option | |
1176 | </a> | |
1177 | </li> | |
1178 | ||
1179 | ||
1180 | ||
1181 | ||
1182 | ||
1183 | ||
1184 | ||
1185 | <li class="md-nav__item"> | |
1186 | <a href="../page/" class="md-nav__link"> | |
1187 | page | |
1188 | </a> | |
1189 | </li> | |
1190 | ||
1191 | ||
1192 | ||
1193 | ||
1194 | ||
1195 | ||
1196 | ||
1197 | <li class="md-nav__item"> | |
1198 | <a href="../pip/" class="md-nav__link"> | |
1199 | pip | |
1200 | </a> | |
1201 | </li> | |
1202 | ||
1203 | ||
1204 | ||
1205 | ||
1206 | ||
1207 | ||
1208 | ||
1209 | <li class="md-nav__item"> | |
1210 | <a href="../script/" class="md-nav__link"> | |
1211 | script | |
1212 | </a> | |
1213 | </li> | |
1214 | ||
1215 | ||
1216 | ||
1217 | ||
1218 | ||
1219 | ||
1220 | ||
1221 | <li class="md-nav__item"> | |
1222 | <a href="../smiley/" class="md-nav__link"> | |
1223 | smiley | |
1224 | </a> | |
1225 | </li> | |
1226 | ||
1227 | ||
1228 | ||
1229 | ||
1230 | ||
1231 | ||
1232 | ||
1233 | <li class="md-nav__item"> | |
1234 | <a href="../sql/" class="md-nav__link"> | |
1235 | sql | |
1236 | </a> | |
1237 | </li> | |
1238 | ||
1239 | ||
1240 | ||
1241 | ||
1242 | ||
1243 | ||
1244 | ||
1245 | <li class="md-nav__item"> | |
1246 | <a href="../style/" class="md-nav__link"> | |
1247 | style | |
1248 | </a> | |
1249 | </li> | |
1250 | ||
1251 | ||
1252 | ||
1253 | ||
1254 | ||
1255 | ||
1256 | ||
1257 | <li class="md-nav__item"> | |
1258 | <a href="../template/" class="md-nav__link"> | |
1259 | template | |
1260 | </a> | |
1261 | </li> | |
1262 | ||
1263 | ||
1264 | ||
1265 | ||
1266 | ||
1267 | ||
1268 | ||
1269 | <li class="md-nav__item"> | |
1270 | <a href="../template-listener/" class="md-nav__link"> | |
1271 | templateListener | |
1272 | </a> | |
1273 | </li> | |
1274 | ||
1275 | ||
1276 | ||
1277 | ||
1278 | ||
1279 | ||
1280 | ||
1281 | <li class="md-nav__item"> | |
1282 | <a href="../user-group-option/" class="md-nav__link"> | |
1283 | userGroupOption | |
1284 | </a> | |
1285 | </li> | |
1286 | ||
1287 | ||
1288 | ||
1289 | ||
1290 | ||
1291 | ||
1292 | ||
1293 | <li class="md-nav__item"> | |
1294 | <a href="../user-menu/" class="md-nav__link"> | |
1295 | userMenu | |
1296 | </a> | |
1297 | </li> | |
1298 | ||
1299 | ||
1300 | ||
1301 | ||
1302 | ||
1303 | ||
1304 | ||
1305 | <li class="md-nav__item"> | |
1306 | <a href="../user-notification-event/" class="md-nav__link"> | |
1307 | userNotificationEvent | |
1308 | </a> | |
1309 | </li> | |
1310 | ||
1311 | ||
1312 | ||
1313 | ||
1314 | ||
1315 | ||
1316 | ||
1317 | <li class="md-nav__item"> | |
1318 | <a href="../user-option/" class="md-nav__link"> | |
1319 | userOption | |
1320 | </a> | |
1321 | </li> | |
1322 | ||
1323 | ||
1324 | ||
1325 | ||
1326 | ||
1327 | ||
1328 | ||
1329 | <li class="md-nav__item"> | |
1330 | <a href="../user-profile-menu/" class="md-nav__link"> | |
1331 | userProfileMenu | |
1332 | </a> | |
1333 | </li> | |
1334 | ||
1335 | ||
1336 | ||
1337 | </ul> | |
1338 | </nav> | |
1339 | </li> | |
1340 | ||
1341 | ||
1342 | ||
1343 | ||
1344 | ||
1345 | ||
1346 | ||
1347 | <li class="md-nav__item"> | |
1348 | <a href="../../database-php-api/" class="md-nav__link"> | |
1349 | Database PHP API | |
1350 | </a> | |
1351 | </li> | |
1352 | ||
1353 | ||
1354 | ||
1355 | </ul> | |
1356 | </nav> | |
1357 | </li> | |
1358 | ||
1359 | ||
1360 | ||
1361 | ||
1362 | ||
1363 | ||
1364 | ||
1365 | ||
1366 | ||
1367 | ||
1368 | ||
1369 | <li class="md-nav__item md-nav__item--nested"> | |
1370 | ||
1371 | ||
1372 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1373 | ||
1374 | <label class="md-nav__link" for="__nav_6"> | |
1375 | Migration | |
1376 | <span class="md-nav__icon md-icon"></span> | |
1377 | </label> | |
1378 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1379 | <label class="md-nav__title" for="__nav_6"> | |
1380 | <span class="md-nav__icon md-icon"></span> | |
1381 | Migration | |
1382 | </label> | |
1383 | <ul class="md-nav__list" data-md-scrollfix> | |
1384 | ||
1385 | ||
1386 | ||
1387 | ||
1388 | ||
1389 | ||
1390 | <li class="md-nav__item md-nav__item--nested"> | |
1391 | ||
1392 | ||
1393 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
1394 | ||
1395 | <label class="md-nav__link" for="__nav_6_1"> | |
1396 | Migrating from WSC 5.3 | |
1397 | <span class="md-nav__icon md-icon"></span> | |
1398 | </label> | |
1399 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1400 | <label class="md-nav__title" for="__nav_6_1"> | |
1401 | <span class="md-nav__icon md-icon"></span> | |
1402 | Migrating from WSC 5.3 | |
1403 | </label> | |
1404 | <ul class="md-nav__list" data-md-scrollfix> | |
1405 | ||
1406 | ||
1407 | ||
1408 | ||
1409 | ||
1410 | <li class="md-nav__item"> | |
1411 | <a href="../../../migration/wsc53/php/" class="md-nav__link"> | |
1412 | PHP API | |
1413 | </a> | |
1414 | </li> | |
1415 | ||
1416 | ||
1417 | ||
1418 | ||
1419 | ||
1420 | ||
1421 | ||
1422 | <li class="md-nav__item"> | |
1423 | <a href="../../../migration/wsc53/session/" class="md-nav__link"> | |
1424 | Session Handling and Authentication | |
1425 | </a> | |
1426 | </li> | |
1427 | ||
1428 | ||
1429 | ||
1430 | ||
1431 | ||
1432 | ||
1433 | ||
1434 | <li class="md-nav__item"> | |
1435 | <a href="../../../migration/wsc53/javascript/" class="md-nav__link"> | |
77efcd46 | 1436 | TypeScript and JavaScript |
45ca63d0 TD |
1437 | </a> |
1438 | </li> | |
1439 | ||
1440 | ||
1441 | ||
1442 | ||
1443 | ||
1444 | ||
1445 | ||
1446 | <li class="md-nav__item"> | |
1447 | <a href="../../../migration/wsc53/templates/" class="md-nav__link"> | |
1448 | Templates | |
1449 | </a> | |
1450 | </li> | |
1451 | ||
1452 | ||
1453 | ||
1454 | ||
1455 | ||
1456 | ||
1457 | ||
1458 | <li class="md-nav__item"> | |
1459 | <a href="../../../migration/wsc53/libraries/" class="md-nav__link"> | |
1460 | Third Party Libraries | |
1461 | </a> | |
1462 | </li> | |
1463 | ||
1464 | ||
1465 | ||
1466 | </ul> | |
1467 | </nav> | |
1468 | </li> | |
1469 | ||
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | ||
1475 | ||
1476 | ||
1477 | <li class="md-nav__item md-nav__item--nested"> | |
1478 | ||
1479 | ||
1480 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1481 | ||
1482 | <label class="md-nav__link" for="__nav_6_2"> | |
1483 | Migrating from WSC 5.2 | |
1484 | <span class="md-nav__icon md-icon"></span> | |
1485 | </label> | |
1486 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1487 | <label class="md-nav__title" for="__nav_6_2"> | |
1488 | <span class="md-nav__icon md-icon"></span> | |
1489 | Migrating from WSC 5.2 | |
1490 | </label> | |
1491 | <ul class="md-nav__list" data-md-scrollfix> | |
1492 | ||
1493 | ||
1494 | ||
1495 | ||
1496 | ||
1497 | <li class="md-nav__item"> | |
1498 | <a href="../../../migration/wsc52/php/" class="md-nav__link"> | |
1499 | PHP API | |
1500 | </a> | |
1501 | </li> | |
1502 | ||
1503 | ||
1504 | ||
1505 | ||
1506 | ||
1507 | ||
1508 | ||
1509 | <li class="md-nav__item"> | |
1510 | <a href="../../../migration/wsc52/templates/" class="md-nav__link"> | |
1511 | Templates and Languages | |
1512 | </a> | |
1513 | </li> | |
1514 | ||
1515 | ||
1516 | ||
1517 | ||
1518 | ||
1519 | ||
1520 | ||
1521 | <li class="md-nav__item"> | |
1522 | <a href="../../../migration/wsc52/libraries/" class="md-nav__link"> | |
1523 | Third Party Libraries | |
1524 | </a> | |
1525 | </li> | |
1526 | ||
1527 | ||
1528 | ||
1529 | </ul> | |
1530 | </nav> | |
1531 | </li> | |
1532 | ||
1533 | ||
1534 | ||
1535 | ||
1536 | ||
1537 | ||
1538 | ||
1539 | ||
1540 | <li class="md-nav__item md-nav__item--nested"> | |
1541 | ||
1542 | ||
1543 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1544 | ||
1545 | <label class="md-nav__link" for="__nav_6_3"> | |
1546 | Migrating from WSC 3.1 | |
1547 | <span class="md-nav__icon md-icon"></span> | |
1548 | </label> | |
1549 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1550 | <label class="md-nav__title" for="__nav_6_3"> | |
1551 | <span class="md-nav__icon md-icon"></span> | |
1552 | Migrating from WSC 3.1 | |
1553 | </label> | |
1554 | <ul class="md-nav__list" data-md-scrollfix> | |
1555 | ||
1556 | ||
1557 | ||
1558 | ||
1559 | ||
1560 | <li class="md-nav__item"> | |
1561 | <a href="../../../migration/wsc31/php/" class="md-nav__link"> | |
1562 | PHP API | |
1563 | </a> | |
1564 | </li> | |
1565 | ||
1566 | ||
1567 | ||
1568 | </ul> | |
1569 | </nav> | |
1570 | </li> | |
1571 | ||
1572 | ||
1573 | ||
1574 | ||
1575 | ||
1576 | ||
1577 | ||
1578 | ||
1579 | <li class="md-nav__item md-nav__item--nested"> | |
1580 | ||
1581 | ||
1582 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1583 | ||
1584 | <label class="md-nav__link" for="__nav_6_4"> | |
1585 | Migrating from WSC 3.0 | |
1586 | <span class="md-nav__icon md-icon"></span> | |
1587 | </label> | |
1588 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1589 | <label class="md-nav__title" for="__nav_6_4"> | |
1590 | <span class="md-nav__icon md-icon"></span> | |
1591 | Migrating from WSC 3.0 | |
1592 | </label> | |
1593 | <ul class="md-nav__list" data-md-scrollfix> | |
1594 | ||
1595 | ||
1596 | ||
1597 | ||
1598 | ||
1599 | <li class="md-nav__item"> | |
1600 | <a href="../../../migration/wsc30/php/" class="md-nav__link"> | |
1601 | PHP API | |
1602 | </a> | |
1603 | </li> | |
1604 | ||
1605 | ||
1606 | ||
1607 | ||
1608 | ||
1609 | ||
1610 | ||
1611 | <li class="md-nav__item"> | |
1612 | <a href="../../../migration/wsc30/javascript/" class="md-nav__link"> | |
1613 | JavaScript API | |
1614 | </a> | |
1615 | </li> | |
1616 | ||
1617 | ||
1618 | ||
1619 | ||
1620 | ||
1621 | ||
1622 | ||
1623 | <li class="md-nav__item"> | |
1624 | <a href="../../../migration/wsc30/templates/" class="md-nav__link"> | |
1625 | Templates | |
1626 | </a> | |
1627 | </li> | |
1628 | ||
1629 | ||
1630 | ||
1631 | ||
1632 | ||
1633 | ||
1634 | ||
1635 | <li class="md-nav__item"> | |
1636 | <a href="../../../migration/wsc30/css/" class="md-nav__link"> | |
1637 | CSS | |
1638 | </a> | |
1639 | </li> | |
1640 | ||
1641 | ||
1642 | ||
1643 | ||
1644 | ||
1645 | ||
1646 | ||
1647 | <li class="md-nav__item"> | |
1648 | <a href="../../../migration/wsc30/package/" class="md-nav__link"> | |
1649 | Package Components | |
1650 | </a> | |
1651 | </li> | |
1652 | ||
1653 | ||
1654 | ||
1655 | </ul> | |
1656 | </nav> | |
1657 | </li> | |
1658 | ||
1659 | ||
1660 | ||
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | <li class="md-nav__item md-nav__item--nested"> | |
1667 | ||
1668 | ||
1669 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1670 | ||
1671 | <label class="md-nav__link" for="__nav_6_5"> | |
1672 | Migrating from WCF 2.1 | |
1673 | <span class="md-nav__icon md-icon"></span> | |
1674 | </label> | |
1675 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1676 | <label class="md-nav__title" for="__nav_6_5"> | |
1677 | <span class="md-nav__icon md-icon"></span> | |
1678 | Migrating from WCF 2.1 | |
1679 | </label> | |
1680 | <ul class="md-nav__list" data-md-scrollfix> | |
1681 | ||
1682 | ||
1683 | ||
1684 | ||
1685 | ||
1686 | <li class="md-nav__item"> | |
1687 | <a href="../../../migration/wcf21/php/" class="md-nav__link"> | |
1688 | PHP API | |
1689 | </a> | |
1690 | </li> | |
1691 | ||
1692 | ||
1693 | ||
1694 | ||
1695 | ||
1696 | ||
1697 | ||
1698 | <li class="md-nav__item"> | |
1699 | <a href="../../../migration/wcf21/templates/" class="md-nav__link"> | |
1700 | Templates | |
1701 | </a> | |
1702 | </li> | |
1703 | ||
1704 | ||
1705 | ||
1706 | ||
1707 | ||
1708 | ||
1709 | ||
1710 | <li class="md-nav__item"> | |
1711 | <a href="../../../migration/wcf21/css/" class="md-nav__link"> | |
1712 | CSS | |
1713 | </a> | |
1714 | </li> | |
1715 | ||
1716 | ||
1717 | ||
1718 | ||
1719 | ||
1720 | ||
1721 | ||
1722 | <li class="md-nav__item"> | |
1723 | <a href="../../../migration/wcf21/package/" class="md-nav__link"> | |
1724 | Package Components | |
1725 | </a> | |
1726 | </li> | |
1727 | ||
1728 | ||
1729 | ||
1730 | </ul> | |
1731 | </nav> | |
1732 | </li> | |
1733 | ||
1734 | ||
1735 | ||
1736 | </ul> | |
1737 | </nav> | |
1738 | </li> | |
1739 | ||
1740 | ||
1741 | ||
1742 | ||
1743 | ||
1744 | ||
1745 | ||
1746 | ||
1747 | ||
1748 | ||
1749 | ||
1750 | <li class="md-nav__item md-nav__item--nested"> | |
1751 | ||
1752 | ||
1753 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
1754 | ||
1755 | <label class="md-nav__link" for="__nav_7"> | |
1756 | Tutorials | |
1757 | <span class="md-nav__icon md-icon"></span> | |
1758 | </label> | |
1759 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
1760 | <label class="md-nav__title" for="__nav_7"> | |
1761 | <span class="md-nav__icon md-icon"></span> | |
1762 | Tutorials | |
1763 | </label> | |
1764 | <ul class="md-nav__list" data-md-scrollfix> | |
1765 | ||
1766 | ||
1767 | ||
1768 | ||
1769 | ||
1770 | ||
1771 | <li class="md-nav__item md-nav__item--nested"> | |
1772 | ||
1773 | ||
1774 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
1775 | ||
1776 | <label class="md-nav__link" for="__nav_7_1"> | |
1777 | Tutorial Series | |
1778 | <span class="md-nav__icon md-icon"></span> | |
1779 | </label> | |
1780 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
1781 | <label class="md-nav__title" for="__nav_7_1"> | |
1782 | <span class="md-nav__icon md-icon"></span> | |
1783 | Tutorial Series | |
1784 | </label> | |
1785 | <ul class="md-nav__list" data-md-scrollfix> | |
1786 | ||
1787 | ||
1788 | ||
1789 | ||
1790 | ||
1791 | <li class="md-nav__item"> | |
1792 | <a href="../../../tutorial/series/overview/" class="md-nav__link"> | |
1793 | Overview | |
1794 | </a> | |
1795 | </li> | |
1796 | ||
1797 | ||
1798 | ||
1799 | ||
1800 | ||
1801 | ||
1802 | ||
1803 | <li class="md-nav__item"> | |
1804 | <a href="../../../tutorial/series/part_1/" class="md-nav__link"> | |
1805 | Part 1 | |
1806 | </a> | |
1807 | </li> | |
1808 | ||
1809 | ||
1810 | ||
1811 | ||
1812 | ||
1813 | ||
1814 | ||
1815 | <li class="md-nav__item"> | |
1816 | <a href="../../../tutorial/series/part_2/" class="md-nav__link"> | |
1817 | Part 2 | |
1818 | </a> | |
1819 | </li> | |
1820 | ||
1821 | ||
1822 | ||
1823 | ||
1824 | ||
1825 | ||
1826 | ||
1827 | <li class="md-nav__item"> | |
1828 | <a href="../../../tutorial/series/part_3/" class="md-nav__link"> | |
1829 | Part 3 | |
1830 | </a> | |
1831 | </li> | |
1832 | ||
1833 | ||
1834 | ||
1835 | </ul> | |
1836 | </nav> | |
1837 | </li> | |
1838 | ||
1839 | ||
1840 | ||
1841 | </ul> | |
1842 | </nav> | |
1843 | </li> | |
1844 | ||
1845 | ||
1846 | ||
1847 | </ul> | |
1848 | </nav> | |
1849 | </div> | |
1850 | </div> | |
1851 | </div> | |
1852 | ||
1853 | ||
1854 | ||
1855 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
1856 | <div class="md-sidebar__scrollwrap"> | |
1857 | <div class="md-sidebar__inner"> | |
1858 | ||
1859 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
1860 | ||
1861 | ||
1862 | ||
1863 | ||
1864 | ||
1865 | <label class="md-nav__title" for="__toc"> | |
1866 | <span class="md-nav__icon md-icon"></span> | |
1867 | Table of contents | |
1868 | </label> | |
1869 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
1870 | ||
1871 | <li class="md-nav__item"> | |
1872 | <a href="#components" class="md-nav__link"> | |
1873 | Components | |
1874 | </a> | |
1875 | ||
1876 | <nav class="md-nav" aria-label="Components"> | |
1877 | <ul class="md-nav__list"> | |
1878 | ||
1879 | <li class="md-nav__item"> | |
1880 | <a href="#classname" class="md-nav__link"> | |
1881 | <classname> | |
1882 | </a> | |
1883 | ||
1884 | </li> | |
1885 | ||
1886 | <li class="md-nav__item"> | |
1887 | <a href="#showorder" class="md-nav__link"> | |
1888 | <showorder> | |
1889 | </a> | |
1890 | ||
1891 | </li> | |
1892 | ||
1893 | </ul> | |
1894 | </nav> | |
1895 | ||
1896 | </li> | |
1897 | ||
1898 | <li class="md-nav__item"> | |
1899 | <a href="#example" class="md-nav__link"> | |
1900 | Example | |
1901 | </a> | |
1902 | ||
1903 | </li> | |
1904 | ||
1905 | </ul> | |
1906 | ||
1907 | </nav> | |
1908 | </div> | |
1909 | </div> | |
1910 | </div> | |
1911 | ||
1912 | ||
1913 | <div class="md-content" data-md-component="content"> | |
1914 | <article class="md-content__inner md-typeset"> | |
1915 | ||
1916 | ||
9b8bddda | 1917 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/acp-search-provider.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
1918 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> |
1919 | </a> | |
1920 | ||
45ca63d0 TD |
1921 | |
1922 | <h1 id="acp-search-provider-package-installation-plugin">ACP Search Provider Package Installation Plugin<a class="headerlink" href="#acp-search-provider-package-installation-plugin" title="Permanent link">#</a></h1> | |
1923 | <p>Registers data provider for the admin panel search.</p> | |
1924 | <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2> | |
1925 | <p>Each acp search result provider is described as an <code><acpsearchprovider></code> element with the mandatory attribute <code>name</code>.</p> | |
1926 | <h3 id="classname"><code><classname></code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3> | |
1927 | <p>The name of the class providing the search results, | |
1928 | the class has to implement the <code>wcf\system\search\acp\IACPSearchResultProvider</code> interface.</p> | |
1929 | <h3 id="showorder"><code><showorder></code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3> | |
1930 | <p><span class="label label-info">Optional</span></p> | |
1931 | <p>Determines at which position of the search result list the provided results are shown.</p> | |
1932 | <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2> | |
1933 | <div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> | |
1934 | <span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/2019/acpSearchProvider.xsd"</span><span class="nt">></span> | |
1935 | <span class="nt"><import></span> | |
1936 | <span class="nt"><acpsearchprovider</span> <span class="na">name=</span><span class="s">"com.woltlab.wcf.example"</span><span class="nt">></span> | |
1937 | <span class="nt"><classname></span>wcf\system\search\acp\ExampleACPSearchResultProvider<span class="nt"></classname></span> | |
1938 | <span class="nt"><showorder></span>1<span class="nt"></showorder></span> | |
1939 | <span class="nt"></acpsearchprovider></span> | |
1940 | <span class="nt"></import></span> | |
1941 | <span class="nt"></data></span> | |
1942 | </code></pre></div> | |
1943 | ||
4a5c32e1 WG |
1944 | |
1945 | ||
1946 | ||
1947 | <hr> | |
1948 | <div class="md-source-date"> | |
1949 | <small> | |
1950 | ||
1951 | Last update: 2021-01-08 | |
1952 | ||
1953 | </small> | |
1954 | </div> | |
1955 | ||
1956 | ||
45ca63d0 TD |
1957 | |
1958 | ||
1959 | ||
1960 | ||
1961 | ||
1962 | ||
1963 | </article> | |
1964 | </div> | |
1965 | </div> | |
fb962f09 | 1966 | |
45ca63d0 TD |
1967 | </main> |
1968 | ||
1969 | ||
1970 | <footer class="md-footer"> | |
1971 | ||
1972 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
1973 | ||
1974 | <a href="../acp-menu/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
1975 | <div class="md-footer__button md-icon"> | |
1976 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> | |
1977 | </div> | |
1978 | <div class="md-footer__title"> | |
1979 | <div class="md-ellipsis"> | |
1980 | <span class="md-footer__direction"> | |
1981 | Previous | |
1982 | </span> | |
1983 | acpMenu | |
1984 | </div> | |
1985 | </div> | |
1986 | </a> | |
1987 | ||
1988 | ||
1989 | <a href="../acp-template/" class="md-footer__link md-footer__link--next" rel="next"> | |
1990 | <div class="md-footer__title"> | |
1991 | <div class="md-ellipsis"> | |
1992 | <span class="md-footer__direction"> | |
1993 | Next | |
1994 | </span> | |
1995 | acpTemplate | |
1996 | </div> | |
1997 | </div> | |
1998 | <div class="md-footer__button md-icon"> | |
1999 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> | |
2000 | </div> | |
2001 | </a> | |
2002 | ||
2003 | </nav> | |
2004 | ||
2005 | <div class="md-footer-meta md-typeset"> | |
2006 | <div class="md-footer-meta__inner md-grid"> | |
2007 | <div class="md-footer-copyright"> | |
2008 | ||
2009 | <div class="md-footer-copyright__highlight"> | |
2010 | Copyright © 2020 WoltLab GmbH | |
2011 | </div> | |
2012 | ||
2013 | Made with | |
2014 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2015 | Material for MkDocs | |
2016 | </a> | |
fb88dc6e | 2017 | |
45ca63d0 TD |
2018 | </div> |
2019 | <div class="md-footer-copyright"> | |
2020 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2021 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2022 | </div> | |
2023 | </div> | |
2024 | </div> | |
2025 | </footer> | |
2026 | ||
2027 | </div> | |
2028 | <div class="md-dialog" data-md-component="dialog"> | |
2029 | <div class="md-dialog__inner md-typeset"></div> | |
2030 | </div> | |
fb962f09 | 2031 | <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script> |
45ca63d0 TD |
2032 | |
2033 | ||
fb962f09 | 2034 | <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script> |
45ca63d0 TD |
2035 | |
2036 | ||
2037 | </body> | |
2038 | </html> |