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