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