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