Deployed 33caa8a to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / javascript / new-api_data-structures / index.html
CommitLineData
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>Data Structures - 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="#data-structures-javascript-api" 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 Data Structures
102
103 </span>
104 </div>
105 </div>
106 </div>
107 <div class="md-header__options">
108
109 </div>
110
a3639e76
WG
111 <label class="md-header__button md-icon" for="__search">
112 <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>
113 </label>
114
115<div class="md-search" data-md-component="search" role="dialog">
116 <label class="md-search__overlay" for="__search"></label>
117 <div class="md-search__inner" role="search">
118 <form class="md-search__form" name="search">
119 <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>
120 <label class="md-search__icon md-icon" for="__search">
121 <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>
122 <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>
123 </label>
124 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
125 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 </button>
127 </form>
128 <div class="md-search__output">
129 <div class="md-search__scrollwrap" data-md-scrollfix>
130 <div class="md-search-result" data-md-component="search-result">
131 <div class="md-search-result__meta">
132 Initializing search
133 </div>
134 <ol class="md-search-result__list"></ol>
135 </div>
136 </div>
137 </div>
138 </div>
139</div>
140
45ca63d0 141
7124f4cb
WG
142 <div class="md-header__source">
143
144<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
145 <div class="md-source__icon md-icon">
146
147 <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>
148 </div>
149 <div class="md-source__repository">
150 GitHub
151 </div>
152</a>
153 </div>
154
45ca63d0
TD
155 </nav>
156</header>
157
158 <div class="md-container" data-md-component="container">
159
160
161
162
163 <main class="md-main" data-md-component="main">
164 <div class="md-main__inner md-grid">
165
166
167
168 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
169 <div class="md-sidebar__scrollwrap">
170 <div class="md-sidebar__inner">
171
172
173
174
175
176<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
177 <label class="md-nav__title" for="__drawer">
178 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
179
180 <img src="../../assets/logo.png" alt="logo">
181
182 </a>
183 WoltLab Suite Documentation
184 </label>
185
7124f4cb
WG
186 <div class="md-nav__source">
187
188<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
189 <div class="md-source__icon md-icon">
190
191 <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>
192 </div>
193 <div class="md-source__repository">
194 GitHub
195 </div>
196</a>
197 </div>
198
45ca63d0
TD
199 <ul class="md-nav__list" data-md-scrollfix>
200
201
202
203
204
205
206
207
208 <li class="md-nav__item">
209 <a href="../../getting-started/" class="md-nav__link">
210 Getting Started
211 </a>
212 </li>
213
214
215
216
217
218
219
220
221
222
223
224 <li class="md-nav__item md-nav__item--nested">
225
226
227 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
228
229 <label class="md-nav__link" for="__nav_2">
230 PHP API
231 <span class="md-nav__icon md-icon"></span>
232 </label>
233 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
234 <label class="md-nav__title" for="__nav_2">
235 <span class="md-nav__icon md-icon"></span>
236 PHP API
237 </label>
238 <ul class="md-nav__list" data-md-scrollfix>
239
240
241
242
243
244 <li class="md-nav__item">
245 <a href="../../php/pages/" class="md-nav__link">
246 Pages
247 </a>
248 </li>
249
250
251
252
253
254
255
256 <li class="md-nav__item">
257 <a href="../../php/database-objects/" class="md-nav__link">
258 Database Objects
259 </a>
260 </li>
261
262
263
264
265
266
267
268 <li class="md-nav__item">
269 <a href="../../php/database-access/" class="md-nav__link">
270 Database Access
271 </a>
272 </li>
273
274
275
276
277
278
279
280 <li class="md-nav__item">
281 <a href="../../php/exceptions/" class="md-nav__link">
282 Exceptions
283 </a>
284 </li>
285
286
287
288
289
290
291
292
293 <li class="md-nav__item md-nav__item--nested">
294
295
296 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
297
298 <label class="md-nav__link" for="__nav_2_5">
299 API
300 <span class="md-nav__icon md-icon"></span>
301 </label>
302 <nav class="md-nav" aria-label="API" data-md-level="2">
303 <label class="md-nav__title" for="__nav_2_5">
304 <span class="md-nav__icon md-icon"></span>
305 API
306 </label>
307 <ul class="md-nav__list" data-md-scrollfix>
308
309
310
311
312
313 <li class="md-nav__item">
314 <a href="../../php/api/caches/" class="md-nav__link">
315 Caches
316 </a>
317 </li>
318
319
320
321
322
323
324
325 <li class="md-nav__item">
326 <a href="../../php/api/comments/" class="md-nav__link">
327 Comments
328 </a>
329 </li>
330
331
332
333
334
335
336
337 <li class="md-nav__item">
338 <a href="../../php/api/cronjobs/" class="md-nav__link">
339 Cronjobs
340 </a>
341 </li>
342
343
344
345
346
347
348
349 <li class="md-nav__item">
350 <a href="../../php/api/events/" class="md-nav__link">
351 Events
352 </a>
353 </li>
354
355
356
357
358
359
360
361
362 <li class="md-nav__item md-nav__item--nested">
363
364
365 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
366
367 <label class="md-nav__link" for="__nav_2_5_5">
368 Form Builder
369 <span class="md-nav__icon md-icon"></span>
370 </label>
371 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
372 <label class="md-nav__title" for="__nav_2_5_5">
373 <span class="md-nav__icon md-icon"></span>
374 Form Builder
375 </label>
376 <ul class="md-nav__list" data-md-scrollfix>
377
378
379
380
381
382 <li class="md-nav__item">
383 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
384 Overview
385 </a>
386 </li>
387
388
389
390
391
392
393
394 <li class="md-nav__item">
395 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
396 Structure
397 </a>
398 </li>
399
400
401
402
403
404
405
406 <li class="md-nav__item">
407 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
408 Fields
409 </a>
410 </li>
411
412
413
414
415
416
417
418 <li class="md-nav__item">
419 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
420 Validation and Data
421 </a>
422 </li>
423
424
425
426
427
428
429
430 <li class="md-nav__item">
431 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
432 Dependencies
433 </a>
434 </li>
435
436
437
438 </ul>
439 </nav>
440 </li>
441
442
443
444
445
446
447
448 <li class="md-nav__item">
449 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
450 Package Installation Plugins
451 </a>
452 </li>
453
454
455
456
457
458
459
460 <li class="md-nav__item">
461 <a href="../../php/api/user_activity_points/" class="md-nav__link">
462 User Activity Points
463 </a>
464 </li>
465
466
467
468
469
470
471
472 <li class="md-nav__item">
473 <a href="../../php/api/user_notifications/" class="md-nav__link">
474 User Notifications
475 </a>
476 </li>
477
478
479
480
481
482
483
484 <li class="md-nav__item">
485 <a href="../../php/api/sitemaps/" class="md-nav__link">
486 Sitemaps
487 </a>
488 </li>
489
490
491
492 </ul>
493 </nav>
494 </li>
495
496
497
498
499
500
501
502 <li class="md-nav__item">
503 <a href="../../php/code-style/" class="md-nav__link">
504 Code Style
505 </a>
506 </li>
507
508
509
510
511
512
513
514 <li class="md-nav__item">
515 <a href="../../php/apps/" class="md-nav__link">
516 Apps
517 </a>
518 </li>
519
520
521
522
523
524
525
526 <li class="md-nav__item">
527 <a href="../../php/gdpr/" class="md-nav__link">
528 GDPR
529 </a>
530 </li>
531
532
533
534 </ul>
535 </nav>
536 </li>
537
538
539
540
541
542
543
544
545
546
547
548 <li class="md-nav__item md-nav__item--nested">
549
550
551 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
552
553 <label class="md-nav__link" for="__nav_3">
554 Languages, Templates & CSS
555 <span class="md-nav__icon md-icon"></span>
556 </label>
557 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
558 <label class="md-nav__title" for="__nav_3">
559 <span class="md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
561 </label>
562 <ul class="md-nav__list" data-md-scrollfix>
563
564
565
566
567
568 <li class="md-nav__item">
569 <a href="../../view/languages/" class="md-nav__link">
570 Languages
571 </a>
572 </li>
573
574
575
576
577
578
579
580 <li class="md-nav__item">
581 <a href="../../view/templates/" class="md-nav__link">
582 Templates
583 </a>
584 </li>
585
586
587
588
589
590
591
592 <li class="md-nav__item">
593 <a href="../../view/css/" class="md-nav__link">
594 CSS
595 </a>
596 </li>
597
598
599
600 </ul>
601 </nav>
602 </li>
603
604
605
606
607
608
609
610
611
612
613
614
615
616 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
617
618
619 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
620
621 <label class="md-nav__link" for="__nav_4">
622 JavaScript API
623 <span class="md-nav__icon md-icon"></span>
624 </label>
625 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
626 <label class="md-nav__title" for="__nav_4">
627 <span class="md-nav__icon md-icon"></span>
628 JavaScript API
629 </label>
630 <ul class="md-nav__list" data-md-scrollfix>
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../general-usage/" class="md-nav__link">
638 General Usage
639 </a>
640 </li>
641
642
643
644
645
646
647
648
649
650
651 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
652
653
654 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" checked>
655
656 <label class="md-nav__link" for="__nav_4_2">
657 New API
658 <span class="md-nav__icon md-icon"></span>
659 </label>
660 <nav class="md-nav" aria-label="New API" data-md-level="2">
661 <label class="md-nav__title" for="__nav_4_2">
662 <span class="md-nav__icon md-icon"></span>
663 New API
664 </label>
665 <ul class="md-nav__list" data-md-scrollfix>
666
667
668
669
670
671 <li class="md-nav__item">
672 <a href="../new-api_writing-a-module/" class="md-nav__link">
673 Writing a module
674 </a>
675 </li>
676
677
678
679
680
681
682
683
684
685 <li class="md-nav__item md-nav__item--active">
686
687 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
688
689
690
691
692 <label class="md-nav__link md-nav__link--active" for="__toc">
693 Data Structures
694 <span class="md-nav__icon md-icon"></span>
695 </label>
696
697 <a href="./" class="md-nav__link md-nav__link--active">
698 Data Structures
699 </a>
700
701
702<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
703
704
705
706
707
708 <label class="md-nav__title" for="__toc">
709 <span class="md-nav__icon md-icon"></span>
710 Table of contents
711 </label>
712 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
713
714 <li class="md-nav__item">
715 <a href="#introduction" class="md-nav__link">
716 Introduction
717 </a>
718
719</li>
720
721 <li class="md-nav__item">
722 <a href="#dictionary" class="md-nav__link">
723 Dictionary
724 </a>
725
726 <nav class="md-nav" aria-label="Dictionary">
727 <ul class="md-nav__list">
728
729 <li class="md-nav__item">
730 <a href="#setkey-string-value-any" class="md-nav__link">
731 set(key: string, value: any)
732 </a>
733
734</li>
735
736 <li class="md-nav__item">
737 <a href="#deletekey-string" class="md-nav__link">
738 delete(key: string)
739 </a>
740
741</li>
742
743 <li class="md-nav__item">
744 <a href="#haskey-string-boolean" class="md-nav__link">
745 has(key: string): boolean
746 </a>
747
748</li>
749
750 <li class="md-nav__item">
751 <a href="#getkey-string-any" class="md-nav__link">
752 get(key: string): any
753 </a>
754
755</li>
756
757 <li class="md-nav__item">
758 <a href="#foreachcallback-value-any-key-string-void" class="md-nav__link">
759 forEach(callback: (value: any, key: string) =&gt; void)
760 </a>
761
762</li>
763
764 <li class="md-nav__item">
765 <a href="#size-number" class="md-nav__link">
766 size: number
767 </a>
768
769</li>
770
771 </ul>
772 </nav>
773
774</li>
775
776 <li class="md-nav__item">
777 <a href="#list" class="md-nav__link">
778 List
779 </a>
780
781 <nav class="md-nav" aria-label="List">
782 <ul class="md-nav__list">
783
784 <li class="md-nav__item">
785 <a href="#addvalue-any" class="md-nav__link">
786 add(value: any)
787 </a>
788
789</li>
790
791 <li class="md-nav__item">
792 <a href="#clear" class="md-nav__link">
793 clear()
794 </a>
795
796</li>
797
798 <li class="md-nav__item">
799 <a href="#deletevalue-any-boolean" class="md-nav__link">
800 delete(value: any): boolean
801 </a>
802
803</li>
804
805 <li class="md-nav__item">
806 <a href="#foreachcallback-value-any-void" class="md-nav__link">
807 forEach(callback: (value: any) =&gt; void)
808 </a>
809
810</li>
811
812 <li class="md-nav__item">
813 <a href="#hasvalue-any-boolean" class="md-nav__link">
814 has(value: any): boolean
815 </a>
816
817</li>
818
819 <li class="md-nav__item">
820 <a href="#size-number_1" class="md-nav__link">
821 size: number
822 </a>
823
824</li>
825
826 </ul>
827 </nav>
828
829</li>
830
831 <li class="md-nav__item">
832 <a href="#objectmap" class="md-nav__link">
833 ObjectMap
834 </a>
835
836 <nav class="md-nav" aria-label="ObjectMap">
837 <ul class="md-nav__list">
838
839 <li class="md-nav__item">
840 <a href="#setkey-object-value-object" class="md-nav__link">
841 set(key: Object, value: Object)
842 </a>
843
844</li>
845
846 <li class="md-nav__item">
847 <a href="#deletekey-object" class="md-nav__link">
848 delete(key: Object)
849 </a>
850
851</li>
852
853 <li class="md-nav__item">
854 <a href="#haskey-object-boolean" class="md-nav__link">
855 has(key: Object): boolean
856 </a>
857
858</li>
859
860 <li class="md-nav__item">
861 <a href="#getkey-object-object-undefined" class="md-nav__link">
862 get(key: Object): Object | undefined
863 </a>
864
865</li>
866
867 </ul>
868 </nav>
869
870</li>
871
872 </ul>
873
874</nav>
875
876 </li>
877
878
879
880
881
882
883
884 <li class="md-nav__item">
885 <a href="../new-api_core/" class="md-nav__link">
886 Core Functions
887 </a>
888 </li>
889
890
891
892
893
894
895
896 <li class="md-nav__item">
897 <a href="../new-api_dom/" class="md-nav__link">
898 DOM
899 </a>
900 </li>
901
902
903
904
905
906
907
908 <li class="md-nav__item">
909 <a href="../new-api_events/" class="md-nav__link">
910 Event Handling
911 </a>
912 </li>
913
914
915
916
917
918
919
920 <li class="md-nav__item">
921 <a href="../new-api_ajax/" class="md-nav__link">
922 Ajax
923 </a>
924 </li>
925
926
927
928
929
930
931
932 <li class="md-nav__item">
933 <a href="../new-api_dialogs/" class="md-nav__link">
934 Dialogs
935 </a>
936 </li>
937
938
939
940
941
942
943
944 <li class="md-nav__item">
945 <a href="../new-api_browser/" class="md-nav__link">
946 Browser and Screen Sizes
947 </a>
948 </li>
949
950
951
952
953
954
955
956 <li class="md-nav__item">
957 <a href="../new-api_ui/" class="md-nav__link">
958 User Interface
959 </a>
960 </li>
961
962
963
964 </ul>
965 </nav>
966 </li>
967
968
969
970
971
972
973
974 <li class="md-nav__item">
975 <a href="../legacy-api/" class="md-nav__link">
976 Legacy API
977 </a>
978 </li>
979
980
981
982
983
984
985
986 <li class="md-nav__item">
987 <a href="../helper-functions/" class="md-nav__link">
988 Helper Functions
989 </a>
990 </li>
991
992
993
994
995
996
997
998 <li class="md-nav__item">
999 <a href="../code-snippets/" class="md-nav__link">
1000 Code Snippets
1001 </a>
1002 </li>
1003
1004
1005
1006 </ul>
1007 </nav>
1008 </li>
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020 <li class="md-nav__item md-nav__item--nested">
1021
1022
1023 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1024
1025 <label class="md-nav__link" for="__nav_5">
1026 Package Components
1027 <span class="md-nav__icon md-icon"></span>
1028 </label>
1029 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1030 <label class="md-nav__title" for="__nav_5">
1031 <span class="md-nav__icon md-icon"></span>
1032 Package Components
1033 </label>
1034 <ul class="md-nav__list" data-md-scrollfix>
1035
1036
1037
1038
1039
1040 <li class="md-nav__item">
1041 <a href="../../package/package-xml/" class="md-nav__link">
1042 package.xml
1043 </a>
1044 </li>
1045
1046
1047
1048
1049
1050
1051
1052
1053 <li class="md-nav__item md-nav__item--nested">
1054
1055
1056 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1057
1058 <label class="md-nav__link" for="__nav_5_2">
1059 PIPs
1060 <span class="md-nav__icon md-icon"></span>
1061 </label>
1062 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1063 <label class="md-nav__title" for="__nav_5_2">
1064 <span class="md-nav__icon md-icon"></span>
1065 PIPs
1066 </label>
1067 <ul class="md-nav__list" data-md-scrollfix>
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../../package/pip/" class="md-nav__link">
1075 Overview
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085 <li class="md-nav__item">
1086 <a href="../../package/pip/acl-option/" class="md-nav__link">
1087 aclOption
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1099 acpMenu
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1111 acpSearchProvider
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121 <li class="md-nav__item">
1122 <a href="../../package/pip/acp-template/" class="md-nav__link">
1123 acpTemplate
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../../package/pip/bbcode/" class="md-nav__link">
1135 bbcode
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../../package/pip/box/" class="md-nav__link">
1147 box
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157 <li class="md-nav__item">
1158 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1159 clipboardAction
1160 </a>
1161 </li>
1162
1163
1164
1165
1166
1167
1168
1169 <li class="md-nav__item">
1170 <a href="../../package/pip/core-object/" class="md-nav__link">
1171 coreObject
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181 <li class="md-nav__item">
1182 <a href="../../package/pip/cronjob/" class="md-nav__link">
1183 cronjob
1184 </a>
1185 </li>
1186
1187
1188
1189
1190
1191
1192
1193 <li class="md-nav__item">
1194 <a href="../../package/pip/event-listener/" class="md-nav__link">
1195 eventListener
1196 </a>
1197 </li>
1198
1199
1200
1201
1202
1203
1204
1205 <li class="md-nav__item">
1206 <a href="../../package/pip/file/" class="md-nav__link">
1207 file
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217 <li class="md-nav__item">
1218 <a href="../../package/pip/language/" class="md-nav__link">
1219 language
1220 </a>
1221 </li>
1222
1223
1224
1225
1226
1227
1228
1229 <li class="md-nav__item">
1230 <a href="../../package/pip/media-provider/" class="md-nav__link">
1231 mediaProvider
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241 <li class="md-nav__item">
1242 <a href="../../package/pip/menu/" class="md-nav__link">
1243 menu
1244 </a>
1245 </li>
1246
1247
1248
1249
1250
1251
1252
1253 <li class="md-nav__item">
1254 <a href="../../package/pip/menu-item/" class="md-nav__link">
1255 menuItem
1256 </a>
1257 </li>
1258
1259
1260
1261
1262
1263
1264
1265 <li class="md-nav__item">
1266 <a href="../../package/pip/object-type/" class="md-nav__link">
1267 objectType
1268 </a>
1269 </li>
1270
1271
1272
1273
1274
1275
1276
1277 <li class="md-nav__item">
1278 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1279 objectTypeDefinition
1280 </a>
1281 </li>
1282
1283
1284
1285
1286
1287
1288
1289 <li class="md-nav__item">
1290 <a href="../../package/pip/option/" class="md-nav__link">
1291 option
1292 </a>
1293 </li>
1294
1295
1296
1297
1298
1299
1300
1301 <li class="md-nav__item">
1302 <a href="../../package/pip/page/" class="md-nav__link">
1303 page
1304 </a>
1305 </li>
1306
1307
1308
1309
1310
1311
1312
1313 <li class="md-nav__item">
1314 <a href="../../package/pip/pip/" class="md-nav__link">
1315 pip
1316 </a>
1317 </li>
1318
1319
1320
1321
1322
1323
1324
1325 <li class="md-nav__item">
1326 <a href="../../package/pip/script/" class="md-nav__link">
1327 script
1328 </a>
1329 </li>
1330
1331
1332
1333
1334
1335
1336
1337 <li class="md-nav__item">
1338 <a href="../../package/pip/smiley/" class="md-nav__link">
1339 smiley
1340 </a>
1341 </li>
1342
1343
1344
1345
1346
1347
1348
1349 <li class="md-nav__item">
1350 <a href="../../package/pip/sql/" class="md-nav__link">
1351 sql
1352 </a>
1353 </li>
1354
1355
1356
1357
1358
1359
1360
1361 <li class="md-nav__item">
1362 <a href="../../package/pip/style/" class="md-nav__link">
1363 style
1364 </a>
1365 </li>
1366
1367
1368
1369
1370
1371
1372
1373 <li class="md-nav__item">
1374 <a href="../../package/pip/template/" class="md-nav__link">
1375 template
1376 </a>
1377 </li>
1378
1379
1380
1381
1382
1383
1384
1385 <li class="md-nav__item">
1386 <a href="../../package/pip/template-listener/" class="md-nav__link">
1387 templateListener
1388 </a>
1389 </li>
1390
1391
1392
1393
1394
1395
1396
1397 <li class="md-nav__item">
1398 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1399 userGroupOption
1400 </a>
1401 </li>
1402
1403
1404
1405
1406
1407
1408
1409 <li class="md-nav__item">
1410 <a href="../../package/pip/user-menu/" class="md-nav__link">
1411 userMenu
1412 </a>
1413 </li>
1414
1415
1416
1417
1418
1419
1420
1421 <li class="md-nav__item">
1422 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1423 userNotificationEvent
1424 </a>
1425 </li>
1426
1427
1428
1429
1430
1431
1432
1433 <li class="md-nav__item">
1434 <a href="../../package/pip/user-option/" class="md-nav__link">
1435 userOption
1436 </a>
1437 </li>
1438
1439
1440
1441
1442
1443
1444
1445 <li class="md-nav__item">
1446 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1447 userProfileMenu
1448 </a>
1449 </li>
1450
1451
1452
1453 </ul>
1454 </nav>
1455 </li>
1456
1457
1458
1459
1460
1461
1462
1463 <li class="md-nav__item">
1464 <a href="../../package/database-php-api/" class="md-nav__link">
1465 Database PHP API
1466 </a>
1467 </li>
1468
1469
1470
1471 </ul>
1472 </nav>
1473 </li>
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485 <li class="md-nav__item md-nav__item--nested">
1486
1487
1488 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1489
1490 <label class="md-nav__link" for="__nav_6">
1491 Migration
1492 <span class="md-nav__icon md-icon"></span>
1493 </label>
1494 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1495 <label class="md-nav__title" for="__nav_6">
1496 <span class="md-nav__icon md-icon"></span>
1497 Migration
1498 </label>
1499 <ul class="md-nav__list" data-md-scrollfix>
1500
1501
1502
1503
1504
1505
1506 <li class="md-nav__item md-nav__item--nested">
1507
1508
1509 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1510
1511 <label class="md-nav__link" for="__nav_6_1">
1512 Migrating from WSC 5.3
1513 <span class="md-nav__icon md-icon"></span>
1514 </label>
1515 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1516 <label class="md-nav__title" for="__nav_6_1">
1517 <span class="md-nav__icon md-icon"></span>
1518 Migrating from WSC 5.3
1519 </label>
1520 <ul class="md-nav__list" data-md-scrollfix>
1521
1522
1523
1524
1525
1526 <li class="md-nav__item">
1527 <a href="../../migration/wsc53/php/" class="md-nav__link">
1528 PHP API
1529 </a>
1530 </li>
1531
1532
1533
1534
1535
1536
1537
1538 <li class="md-nav__item">
1539 <a href="../../migration/wsc53/session/" class="md-nav__link">
1540 Session Handling and Authentication
1541 </a>
1542 </li>
1543
1544
1545
1546
1547
1548
1549
1550 <li class="md-nav__item">
1551 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1552 JavaScript
1553 </a>
1554 </li>
1555
1556
1557
1558
1559
1560
1561
1562 <li class="md-nav__item">
1563 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1564 Templates
1565 </a>
1566 </li>
1567
1568
1569
1570
1571
1572
1573
1574 <li class="md-nav__item">
1575 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1576 Third Party Libraries
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_2" type="checkbox" id="__nav_6_2" >
1597
1598 <label class="md-nav__link" for="__nav_6_2">
1599 Migrating from WSC 5.2
1600 <span class="md-nav__icon md-icon"></span>
1601 </label>
1602 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1603 <label class="md-nav__title" for="__nav_6_2">
1604 <span class="md-nav__icon md-icon"></span>
1605 Migrating from WSC 5.2
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/wsc52/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/wsc52/templates/" class="md-nav__link">
1627 Templates and Languages
1628 </a>
1629 </li>
1630
1631
1632
1633
1634
1635
1636
1637 <li class="md-nav__item">
1638 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1639 Third Party Libraries
1640 </a>
1641 </li>
1642
1643
1644
1645 </ul>
1646 </nav>
1647 </li>
1648
1649
1650
1651
1652
1653
1654
1655
1656 <li class="md-nav__item md-nav__item--nested">
1657
1658
1659 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1660
1661 <label class="md-nav__link" for="__nav_6_3">
1662 Migrating from WSC 3.1
1663 <span class="md-nav__icon md-icon"></span>
1664 </label>
1665 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1666 <label class="md-nav__title" for="__nav_6_3">
1667 <span class="md-nav__icon md-icon"></span>
1668 Migrating from WSC 3.1
1669 </label>
1670 <ul class="md-nav__list" data-md-scrollfix>
1671
1672
1673
1674
1675
1676 <li class="md-nav__item">
1677 <a href="../../migration/wsc31/php/" class="md-nav__link">
1678 PHP API
1679 </a>
1680 </li>
1681
1682
1683
1684 </ul>
1685 </nav>
1686 </li>
1687
1688
1689
1690
1691
1692
1693
1694
1695 <li class="md-nav__item md-nav__item--nested">
1696
1697
1698 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1699
1700 <label class="md-nav__link" for="__nav_6_4">
1701 Migrating from WSC 3.0
1702 <span class="md-nav__icon md-icon"></span>
1703 </label>
1704 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1705 <label class="md-nav__title" for="__nav_6_4">
1706 <span class="md-nav__icon md-icon"></span>
1707 Migrating from WSC 3.0
1708 </label>
1709 <ul class="md-nav__list" data-md-scrollfix>
1710
1711
1712
1713
1714
1715 <li class="md-nav__item">
1716 <a href="../../migration/wsc30/php/" class="md-nav__link">
1717 PHP API
1718 </a>
1719 </li>
1720
1721
1722
1723
1724
1725
1726
1727 <li class="md-nav__item">
1728 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1729 JavaScript API
1730 </a>
1731 </li>
1732
1733
1734
1735
1736
1737
1738
1739 <li class="md-nav__item">
1740 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1741 Templates
1742 </a>
1743 </li>
1744
1745
1746
1747
1748
1749
1750
1751 <li class="md-nav__item">
1752 <a href="../../migration/wsc30/css/" class="md-nav__link">
1753 CSS
1754 </a>
1755 </li>
1756
1757
1758
1759
1760
1761
1762
1763 <li class="md-nav__item">
1764 <a href="../../migration/wsc30/package/" class="md-nav__link">
1765 Package Components
1766 </a>
1767 </li>
1768
1769
1770
1771 </ul>
1772 </nav>
1773 </li>
1774
1775
1776
1777
1778
1779
1780
1781
1782 <li class="md-nav__item md-nav__item--nested">
1783
1784
1785 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1786
1787 <label class="md-nav__link" for="__nav_6_5">
1788 Migrating from WCF 2.1
1789 <span class="md-nav__icon md-icon"></span>
1790 </label>
1791 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1792 <label class="md-nav__title" for="__nav_6_5">
1793 <span class="md-nav__icon md-icon"></span>
1794 Migrating from WCF 2.1
1795 </label>
1796 <ul class="md-nav__list" data-md-scrollfix>
1797
1798
1799
1800
1801
1802 <li class="md-nav__item">
1803 <a href="../../migration/wcf21/php/" class="md-nav__link">
1804 PHP API
1805 </a>
1806 </li>
1807
1808
1809
1810
1811
1812
1813
1814 <li class="md-nav__item">
1815 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1816 Templates
1817 </a>
1818 </li>
1819
1820
1821
1822
1823
1824
1825
1826 <li class="md-nav__item">
1827 <a href="../../migration/wcf21/css/" class="md-nav__link">
1828 CSS
1829 </a>
1830 </li>
1831
1832
1833
1834
1835
1836
1837
1838 <li class="md-nav__item">
1839 <a href="../../migration/wcf21/package/" class="md-nav__link">
1840 Package Components
1841 </a>
1842 </li>
1843
1844
1845
1846 </ul>
1847 </nav>
1848 </li>
1849
1850
1851
1852 </ul>
1853 </nav>
1854 </li>
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866 <li class="md-nav__item md-nav__item--nested">
1867
1868
1869 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1870
1871 <label class="md-nav__link" for="__nav_7">
1872 Tutorials
1873 <span class="md-nav__icon md-icon"></span>
1874 </label>
1875 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1876 <label class="md-nav__title" for="__nav_7">
1877 <span class="md-nav__icon md-icon"></span>
1878 Tutorials
1879 </label>
1880 <ul class="md-nav__list" data-md-scrollfix>
1881
1882
1883
1884
1885
1886
1887 <li class="md-nav__item md-nav__item--nested">
1888
1889
1890 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1891
1892 <label class="md-nav__link" for="__nav_7_1">
1893 Tutorial Series
1894 <span class="md-nav__icon md-icon"></span>
1895 </label>
1896 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1897 <label class="md-nav__title" for="__nav_7_1">
1898 <span class="md-nav__icon md-icon"></span>
1899 Tutorial Series
1900 </label>
1901 <ul class="md-nav__list" data-md-scrollfix>
1902
1903
1904
1905
1906
1907 <li class="md-nav__item">
1908 <a href="../../tutorial/series/overview/" class="md-nav__link">
1909 Overview
1910 </a>
1911 </li>
1912
1913
1914
1915
1916
1917
1918
1919 <li class="md-nav__item">
1920 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1921 Part 1
1922 </a>
1923 </li>
1924
1925
1926
1927
1928
1929
1930
1931 <li class="md-nav__item">
1932 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1933 Part 2
1934 </a>
1935 </li>
1936
1937
1938
1939
1940
1941
1942
1943 <li class="md-nav__item">
1944 <a href="../../tutorial/series/part_3/" class="md-nav__link">
1945 Part 3
1946 </a>
1947 </li>
1948
1949
1950
1951 </ul>
1952 </nav>
1953 </li>
1954
1955
1956
1957 </ul>
1958 </nav>
1959 </li>
1960
1961
1962
1963 </ul>
1964</nav>
1965 </div>
1966 </div>
1967 </div>
1968
1969
1970
1971 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1972 <div class="md-sidebar__scrollwrap">
1973 <div class="md-sidebar__inner">
1974
1975<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1976
1977
1978
1979
1980
1981 <label class="md-nav__title" for="__toc">
1982 <span class="md-nav__icon md-icon"></span>
1983 Table of contents
1984 </label>
1985 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1986
1987 <li class="md-nav__item">
1988 <a href="#introduction" class="md-nav__link">
1989 Introduction
1990 </a>
1991
1992</li>
1993
1994 <li class="md-nav__item">
1995 <a href="#dictionary" class="md-nav__link">
1996 Dictionary
1997 </a>
1998
1999 <nav class="md-nav" aria-label="Dictionary">
2000 <ul class="md-nav__list">
2001
2002 <li class="md-nav__item">
2003 <a href="#setkey-string-value-any" class="md-nav__link">
2004 set(key: string, value: any)
2005 </a>
2006
2007</li>
2008
2009 <li class="md-nav__item">
2010 <a href="#deletekey-string" class="md-nav__link">
2011 delete(key: string)
2012 </a>
2013
2014</li>
2015
2016 <li class="md-nav__item">
2017 <a href="#haskey-string-boolean" class="md-nav__link">
2018 has(key: string): boolean
2019 </a>
2020
2021</li>
2022
2023 <li class="md-nav__item">
2024 <a href="#getkey-string-any" class="md-nav__link">
2025 get(key: string): any
2026 </a>
2027
2028</li>
2029
2030 <li class="md-nav__item">
2031 <a href="#foreachcallback-value-any-key-string-void" class="md-nav__link">
2032 forEach(callback: (value: any, key: string) =&gt; void)
2033 </a>
2034
2035</li>
2036
2037 <li class="md-nav__item">
2038 <a href="#size-number" class="md-nav__link">
2039 size: number
2040 </a>
2041
2042</li>
2043
2044 </ul>
2045 </nav>
2046
2047</li>
2048
2049 <li class="md-nav__item">
2050 <a href="#list" class="md-nav__link">
2051 List
2052 </a>
2053
2054 <nav class="md-nav" aria-label="List">
2055 <ul class="md-nav__list">
2056
2057 <li class="md-nav__item">
2058 <a href="#addvalue-any" class="md-nav__link">
2059 add(value: any)
2060 </a>
2061
2062</li>
2063
2064 <li class="md-nav__item">
2065 <a href="#clear" class="md-nav__link">
2066 clear()
2067 </a>
2068
2069</li>
2070
2071 <li class="md-nav__item">
2072 <a href="#deletevalue-any-boolean" class="md-nav__link">
2073 delete(value: any): boolean
2074 </a>
2075
2076</li>
2077
2078 <li class="md-nav__item">
2079 <a href="#foreachcallback-value-any-void" class="md-nav__link">
2080 forEach(callback: (value: any) =&gt; void)
2081 </a>
2082
2083</li>
2084
2085 <li class="md-nav__item">
2086 <a href="#hasvalue-any-boolean" class="md-nav__link">
2087 has(value: any): boolean
2088 </a>
2089
2090</li>
2091
2092 <li class="md-nav__item">
2093 <a href="#size-number_1" class="md-nav__link">
2094 size: number
2095 </a>
2096
2097</li>
2098
2099 </ul>
2100 </nav>
2101
2102</li>
2103
2104 <li class="md-nav__item">
2105 <a href="#objectmap" class="md-nav__link">
2106 ObjectMap
2107 </a>
2108
2109 <nav class="md-nav" aria-label="ObjectMap">
2110 <ul class="md-nav__list">
2111
2112 <li class="md-nav__item">
2113 <a href="#setkey-object-value-object" class="md-nav__link">
2114 set(key: Object, value: Object)
2115 </a>
2116
2117</li>
2118
2119 <li class="md-nav__item">
2120 <a href="#deletekey-object" class="md-nav__link">
2121 delete(key: Object)
2122 </a>
2123
2124</li>
2125
2126 <li class="md-nav__item">
2127 <a href="#haskey-object-boolean" class="md-nav__link">
2128 has(key: Object): boolean
2129 </a>
2130
2131</li>
2132
2133 <li class="md-nav__item">
2134 <a href="#getkey-object-object-undefined" class="md-nav__link">
2135 get(key: Object): Object | undefined
2136 </a>
2137
2138</li>
2139
2140 </ul>
2141 </nav>
2142
2143</li>
2144
2145 </ul>
2146
2147</nav>
2148 </div>
2149 </div>
2150 </div>
2151
2152
2153 <div class="md-content" data-md-component="content">
2154 <article class="md-content__inner md-typeset">
2155
2156
9b8bddda 2157 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_data-structures.md" title="Edit this page" class="md-content__button md-icon">
7124f4cb
WG
2158 <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>
2159 </a>
2160
45ca63d0
TD
2161
2162 <h1 id="data-structures-javascript-api">Data Structures - JavaScript API<a class="headerlink" href="#data-structures-javascript-api" title="Permanent link">#</a></h1>
2163<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2>
2164<p>JavaScript offers only limited types of collections to hold and iterate over
2165data. Despite the ongoing efforts in ES6 and newer, these new data structures
2166and access methods, such as <code>for … of</code>, are not available in the still supported
2167Internet Explorer 11.</p>
2168<h2 id="dictionary"><code>Dictionary</code><a class="headerlink" href="#dictionary" title="Permanent link">#</a></h2>
2169<p>Represents a simple key-value map, but unlike the use of plain objects, will
2170always to guarantee to iterate over directly set values only.</p>
2171<p><em>In supported browsers this will use a native <code>Map</code> internally, otherwise a plain object.</em></p>
2172<h3 id="setkey-string-value-any"><code>set(key: string, value: any)</code><a class="headerlink" href="#setkey-string-value-any" title="Permanent link">#</a></h3>
2173<p>Adds or updates an item using the provided key. Numeric keys will be converted
2174into strings.</p>
2175<h3 id="deletekey-string"><code>delete(key: string)</code><a class="headerlink" href="#deletekey-string" title="Permanent link">#</a></h3>
2176<p>Removes an item from the collection.</p>
2177<h3 id="haskey-string-boolean"><code>has(key: string): boolean</code><a class="headerlink" href="#haskey-string-boolean" title="Permanent link">#</a></h3>
2178<p>Returns true if the key is contained in the collection.</p>
2179<h3 id="getkey-string-any"><code>get(key: string): any</code><a class="headerlink" href="#getkey-string-any" title="Permanent link">#</a></h3>
2180<p>Returns the value for the provided key, or <code>undefined</code> if the key was not found.
2181Use <code>.has()</code> to check for key existence.</p>
2182<h3 id="foreachcallback-value-any-key-string-void"><code>forEach(callback: (value: any, key: string) =&gt; void)</code><a class="headerlink" href="#foreachcallback-value-any-key-string-void" title="Permanent link">#</a></h3>
2183<p>Iterates over all items in the collection in an arbitrary order and invokes the
2184supplied callback with the value and the key.</p>
2185<h3 id="size-number"><code>size: number</code><a class="headerlink" href="#size-number" title="Permanent link">#</a></h3>
2186<p>This read-only property counts the number of items in the collection.</p>
2187<h2 id="list"><code>List</code><a class="headerlink" href="#list" title="Permanent link">#</a></h2>
2188<p>Represents a list of unique values.</p>
2189<p><em>In supported browsers this will use a native <code>Set</code> internally, otherwise an array.</em></p>
2190<h3 id="addvalue-any"><code>add(value: any)</code><a class="headerlink" href="#addvalue-any" title="Permanent link">#</a></h3>
2191<p>Adds a value to the list. If the value is already part of the list, this method
2192will silently abort.</p>
2193<h3 id="clear"><code>clear()</code><a class="headerlink" href="#clear" title="Permanent link">#</a></h3>
2194<p>Resets the collection.</p>
2195<h3 id="deletevalue-any-boolean"><code>delete(value: any): boolean</code><a class="headerlink" href="#deletevalue-any-boolean" title="Permanent link">#</a></h3>
2196<p>Attempts to remove a value from the list, it returns true if the value has been
2197part of the list.</p>
2198<h3 id="foreachcallback-value-any-void"><code>forEach(callback: (value: any) =&gt; void)</code><a class="headerlink" href="#foreachcallback-value-any-void" title="Permanent link">#</a></h3>
2199<p>Iterates over all values in the list in an arbitrary order and invokes the
2200supplied callback for each value.</p>
2201<h3 id="hasvalue-any-boolean"><code>has(value: any): boolean</code><a class="headerlink" href="#hasvalue-any-boolean" title="Permanent link">#</a></h3>
2202<p>Returns true if the provided value is part of this list.</p>
2203<h3 id="size-number_1"><code>size: number</code><a class="headerlink" href="#size-number_1" title="Permanent link">#</a></h3>
2204<p>This read-only property counts the number of items in the list.</p>
2205<h2 id="objectmap"><code>ObjectMap</code><a class="headerlink" href="#objectmap" title="Permanent link">#</a></h2>
2206<div class="admonition info">
2207<p class="admonition-title">This class uses a <code>WeakMap</code> internally, the keys are only weakly referenced and do not prevent garbage collection.</p>
2208</div>
2209<p>Represents a collection where any kind of objects, such as class instances or
2210DOM elements, can be used as key. These keys are weakly referenced and will not
2211prevent garbage collection from happening, but this also means that it is not
2212possible to enumerate or iterate over the stored keys and values.</p>
2213<p>This class is especially useful when you want to store additional data for
2214objects that may get disposed on runtime, such as DOM elements. Using any regular
2215data collections will cause the object to be referenced indefinitely, preventing
2216the garbage collection from removing orphaned objects.</p>
2217<h3 id="setkey-object-value-object"><code>set(key: Object, value: Object)</code><a class="headerlink" href="#setkey-object-value-object" title="Permanent link">#</a></h3>
2218<p>Adds the key with the provided value to the map, if the key was already part
2219of the collection, its value is overwritten.</p>
2220<h3 id="deletekey-object"><code>delete(key: Object)</code><a class="headerlink" href="#deletekey-object" title="Permanent link">#</a></h3>
2221<p>Attempts to remove a key from the collection. The method will abort silently if
2222the key is not part of the collection.</p>
2223<h3 id="haskey-object-boolean"><code>has(key: Object): boolean</code><a class="headerlink" href="#haskey-object-boolean" title="Permanent link">#</a></h3>
2224<p>Returns true if there is a value for the provided key in this collection.</p>
2225<h3 id="getkey-object-object-undefined"><code>get(key: Object): Object | undefined</code><a class="headerlink" href="#getkey-object-object-undefined" title="Permanent link">#</a></h3>
2226<p>Retrieves the value of the provided key, or <code>undefined</code> if the key was not found.</p>
2227
4a5c32e1
WG
2228
2229
2230
2231<hr>
2232<div class="md-source-date">
2233 <small>
2234
2235 Last update: 2021-01-08
2236
2237 </small>
2238</div>
2239
2240
45ca63d0
TD
2241
2242
2243
2244
2245
2246
2247 </article>
2248 </div>
2249 </div>
2250 </main>
2251
2252
2253<footer class="md-footer">
2254
2255 <nav class="md-footer__inner md-grid" aria-label="Footer">
2256
2257 <a href="../new-api_writing-a-module/" class="md-footer__link md-footer__link--prev" rel="prev">
2258 <div class="md-footer__button md-icon">
2259 <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>
2260 </div>
2261 <div class="md-footer__title">
2262 <div class="md-ellipsis">
2263 <span class="md-footer__direction">
2264 Previous
2265 </span>
2266 Writing a module
2267 </div>
2268 </div>
2269 </a>
2270
2271
2272 <a href="../new-api_core/" class="md-footer__link md-footer__link--next" rel="next">
2273 <div class="md-footer__title">
2274 <div class="md-ellipsis">
2275 <span class="md-footer__direction">
2276 Next
2277 </span>
2278 Core Functions
2279 </div>
2280 </div>
2281 <div class="md-footer__button md-icon">
2282 <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>
2283 </div>
2284 </a>
2285
2286 </nav>
2287
2288 <div class="md-footer-meta md-typeset">
2289 <div class="md-footer-meta__inner md-grid">
2290 <div class="md-footer-copyright">
2291
2292 <div class="md-footer-copyright__highlight">
2293 Copyright © 2020 WoltLab GmbH
2294 </div>
2295
2296 Made with
2297 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2298 Material for MkDocs
2299 </a>
fb88dc6e 2300
45ca63d0
TD
2301 </div>
2302 <div class="md-footer-copyright">
2303 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2304 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2305</div>
2306 </div>
2307 </div>
2308</footer>
2309
2310 </div>
2311 <div class="md-dialog" data-md-component="dialog">
2312 <div class="md-dialog__inner md-typeset"></div>
2313 </div>
2314 <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>
2315
2316
fb88dc6e 2317 <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
45ca63d0
TD
2318
2319
2320 </body>
2321</html>