3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Data Structures - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#data-structures-javascript-api" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
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>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
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>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
684 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
685 <label class=
"md-nav__title" for=
"__nav_4">
686 <span class=
"md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../typescript/" class=
"md-nav__link">
722 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
725 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" checked
>
727 <label class=
"md-nav__link" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
731 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
732 <label class=
"md-nav__title" for=
"__nav_4_3">
733 <span class=
"md-nav__icon md-icon"></span>
736 <ul class=
"md-nav__list" data-md-scrollfix
>
742 <li class=
"md-nav__item">
743 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
756 <li class=
"md-nav__item md-nav__item--active">
758 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
763 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
765 <span class=
"md-nav__icon md-icon"></span>
768 <a href=
"./" class=
"md-nav__link md-nav__link--active">
773 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
779 <label class=
"md-nav__title" for=
"__toc">
780 <span class=
"md-nav__icon md-icon"></span>
783 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
785 <li class=
"md-nav__item">
786 <a href=
"#introduction" class=
"md-nav__link">
792 <li class=
"md-nav__item">
793 <a href=
"#dictionary" class=
"md-nav__link">
797 <nav class=
"md-nav" aria-label=
"Dictionary">
798 <ul class=
"md-nav__list">
800 <li class=
"md-nav__item">
801 <a href=
"#setkey-string-value-any" class=
"md-nav__link">
802 set(key: string, value: any)
807 <li class=
"md-nav__item">
808 <a href=
"#deletekey-string" class=
"md-nav__link">
814 <li class=
"md-nav__item">
815 <a href=
"#haskey-string-boolean" class=
"md-nav__link">
816 has(key: string): boolean
821 <li class=
"md-nav__item">
822 <a href=
"#getkey-string-any" class=
"md-nav__link">
823 get(key: string): any
828 <li class=
"md-nav__item">
829 <a href=
"#foreachcallback-value-any-key-string-void" class=
"md-nav__link">
830 forEach(callback: (value: any, key: string) =
> void)
835 <li class=
"md-nav__item">
836 <a href=
"#size-number" class=
"md-nav__link">
847 <li class=
"md-nav__item">
848 <a href=
"#list" class=
"md-nav__link">
852 <nav class=
"md-nav" aria-label=
"List">
853 <ul class=
"md-nav__list">
855 <li class=
"md-nav__item">
856 <a href=
"#addvalue-any" class=
"md-nav__link">
862 <li class=
"md-nav__item">
863 <a href=
"#clear" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"#deletevalue-any-boolean" class=
"md-nav__link">
871 delete(value: any): boolean
876 <li class=
"md-nav__item">
877 <a href=
"#foreachcallback-value-any-void" class=
"md-nav__link">
878 forEach(callback: (value: any) =
> void)
883 <li class=
"md-nav__item">
884 <a href=
"#hasvalue-any-boolean" class=
"md-nav__link">
885 has(value: any): boolean
890 <li class=
"md-nav__item">
891 <a href=
"#size-number_1" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"#objectmap" class=
"md-nav__link">
907 <nav class=
"md-nav" aria-label=
"ObjectMap">
908 <ul class=
"md-nav__list">
910 <li class=
"md-nav__item">
911 <a href=
"#setkey-object-value-object" class=
"md-nav__link">
912 set(key: Object, value: Object)
917 <li class=
"md-nav__item">
918 <a href=
"#deletekey-object" class=
"md-nav__link">
924 <li class=
"md-nav__item">
925 <a href=
"#haskey-object-boolean" class=
"md-nav__link">
926 has(key: Object): boolean
931 <li class=
"md-nav__item">
932 <a href=
"#getkey-object-object-undefined" class=
"md-nav__link">
933 get(key: Object): Object | undefined
955 <li class=
"md-nav__item">
956 <a href=
"../new-api_core/" class=
"md-nav__link">
967 <li class=
"md-nav__item">
968 <a href=
"../new-api_dom/" class=
"md-nav__link">
979 <li class=
"md-nav__item">
980 <a href=
"../new-api_events/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../new-api_ajax/" class=
"md-nav__link">
1003 <li class=
"md-nav__item">
1004 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
1015 <li class=
"md-nav__item">
1016 <a href=
"../new-api_browser/" class=
"md-nav__link">
1017 Browser and Screen Sizes
1027 <li class=
"md-nav__item">
1028 <a href=
"../new-api_ui/" class=
"md-nav__link">
1045 <li class=
"md-nav__item">
1046 <a href=
"../legacy-api/" class=
"md-nav__link">
1057 <li class=
"md-nav__item">
1058 <a href=
"../helper-functions/" class=
"md-nav__link">
1069 <li class=
"md-nav__item">
1070 <a href=
"../code-snippets/" class=
"md-nav__link">
1091 <li class=
"md-nav__item md-nav__item--nested">
1094 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1096 <label class=
"md-nav__link" for=
"__nav_5">
1098 <span class=
"md-nav__icon md-icon"></span>
1100 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1101 <label class=
"md-nav__title" for=
"__nav_5">
1102 <span class=
"md-nav__icon md-icon"></span>
1105 <ul class=
"md-nav__list" data-md-scrollfix
>
1111 <li class=
"md-nav__item">
1112 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1124 <li class=
"md-nav__item md-nav__item--nested">
1127 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1129 <label class=
"md-nav__link" for=
"__nav_5_2">
1131 <span class=
"md-nav__icon md-icon"></span>
1133 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1134 <label class=
"md-nav__title" for=
"__nav_5_2">
1135 <span class=
"md-nav__icon md-icon"></span>
1138 <ul class=
"md-nav__list" data-md-scrollfix
>
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1362 objectTypeDefinition
1372 <li class=
"md-nav__item">
1373 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1396 <li class=
"md-nav__item">
1397 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1408 <li class=
"md-nav__item">
1409 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1420 <li class=
"md-nav__item">
1421 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1432 <li class=
"md-nav__item">
1433 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1444 <li class=
"md-nav__item">
1445 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1468 <li class=
"md-nav__item">
1469 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1480 <li class=
"md-nav__item">
1481 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1492 <li class=
"md-nav__item">
1493 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1504 <li class=
"md-nav__item">
1505 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1506 userNotificationEvent
1516 <li class=
"md-nav__item">
1517 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1546 <li class=
"md-nav__item">
1547 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1568 <li class=
"md-nav__item md-nav__item--nested">
1571 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1573 <label class=
"md-nav__link" for=
"__nav_6">
1575 <span class=
"md-nav__icon md-icon"></span>
1577 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1578 <label class=
"md-nav__title" for=
"__nav_6">
1579 <span class=
"md-nav__icon md-icon"></span>
1582 <ul class=
"md-nav__list" data-md-scrollfix
>
1589 <li class=
"md-nav__item md-nav__item--nested">
1592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1594 <label class=
"md-nav__link" for=
"__nav_6_1">
1595 Migrating from WSC
5.3
1596 <span class=
"md-nav__icon md-icon"></span>
1598 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1599 <label class=
"md-nav__title" for=
"__nav_6_1">
1600 <span class=
"md-nav__icon md-icon"></span>
1601 Migrating from WSC
5.3
1603 <ul class=
"md-nav__list" data-md-scrollfix
>
1609 <li class=
"md-nav__item">
1610 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1621 <li class=
"md-nav__item">
1622 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1623 Session Handling and Authentication
1633 <li class=
"md-nav__item">
1634 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1635 TypeScript and JavaScript
1645 <li class=
"md-nav__item">
1646 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1657 <li class=
"md-nav__item">
1658 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1659 Third Party Libraries
1676 <li class=
"md-nav__item md-nav__item--nested">
1679 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1681 <label class=
"md-nav__link" for=
"__nav_6_2">
1682 Migrating from WSC
5.2
1683 <span class=
"md-nav__icon md-icon"></span>
1685 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1686 <label class=
"md-nav__title" for=
"__nav_6_2">
1687 <span class=
"md-nav__icon md-icon"></span>
1688 Migrating from WSC
5.2
1690 <ul class=
"md-nav__list" data-md-scrollfix
>
1696 <li class=
"md-nav__item">
1697 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1710 Templates and Languages
1720 <li class=
"md-nav__item">
1721 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1722 Third Party Libraries
1739 <li class=
"md-nav__item md-nav__item--nested">
1742 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1744 <label class=
"md-nav__link" for=
"__nav_6_3">
1745 Migrating from WSC
3.1
1746 <span class=
"md-nav__icon md-icon"></span>
1748 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1749 <label class=
"md-nav__title" for=
"__nav_6_3">
1750 <span class=
"md-nav__icon md-icon"></span>
1751 Migrating from WSC
3.1
1753 <ul class=
"md-nav__list" data-md-scrollfix
>
1759 <li class=
"md-nav__item">
1760 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1778 <li class=
"md-nav__item md-nav__item--nested">
1781 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1783 <label class=
"md-nav__link" for=
"__nav_6_4">
1784 Migrating from WSC
3.0
1785 <span class=
"md-nav__icon md-icon"></span>
1787 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1788 <label class=
"md-nav__title" for=
"__nav_6_4">
1789 <span class=
"md-nav__icon md-icon"></span>
1790 Migrating from WSC
3.0
1792 <ul class=
"md-nav__list" data-md-scrollfix
>
1798 <li class=
"md-nav__item">
1799 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1810 <li class=
"md-nav__item">
1811 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1822 <li class=
"md-nav__item">
1823 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1834 <li class=
"md-nav__item">
1835 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1846 <li class=
"md-nav__item">
1847 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1865 <li class=
"md-nav__item md-nav__item--nested">
1868 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1870 <label class=
"md-nav__link" for=
"__nav_6_5">
1871 Migrating from WCF
2.1
1872 <span class=
"md-nav__icon md-icon"></span>
1874 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1875 <label class=
"md-nav__title" for=
"__nav_6_5">
1876 <span class=
"md-nav__icon md-icon"></span>
1877 Migrating from WCF
2.1
1879 <ul class=
"md-nav__list" data-md-scrollfix
>
1885 <li class=
"md-nav__item">
1886 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1897 <li class=
"md-nav__item">
1898 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1909 <li class=
"md-nav__item">
1910 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1921 <li class=
"md-nav__item">
1922 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1949 <li class=
"md-nav__item md-nav__item--nested">
1952 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1954 <label class=
"md-nav__link" for=
"__nav_7">
1956 <span class=
"md-nav__icon md-icon"></span>
1958 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1959 <label class=
"md-nav__title" for=
"__nav_7">
1960 <span class=
"md-nav__icon md-icon"></span>
1963 <ul class=
"md-nav__list" data-md-scrollfix
>
1970 <li class=
"md-nav__item md-nav__item--nested">
1973 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1975 <label class=
"md-nav__link" for=
"__nav_7_1">
1977 <span class=
"md-nav__icon md-icon"></span>
1979 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1980 <label class=
"md-nav__title" for=
"__nav_7_1">
1981 <span class=
"md-nav__icon md-icon"></span>
1984 <ul class=
"md-nav__list" data-md-scrollfix
>
1990 <li class=
"md-nav__item">
1991 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2002 <li class=
"md-nav__item">
2003 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2014 <li class=
"md-nav__item">
2015 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2026 <li class=
"md-nav__item">
2027 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2054 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2055 <div class=
"md-sidebar__scrollwrap">
2056 <div class=
"md-sidebar__inner">
2058 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2064 <label class=
"md-nav__title" for=
"__toc">
2065 <span class=
"md-nav__icon md-icon"></span>
2068 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2070 <li class=
"md-nav__item">
2071 <a href=
"#introduction" class=
"md-nav__link">
2077 <li class=
"md-nav__item">
2078 <a href=
"#dictionary" class=
"md-nav__link">
2082 <nav class=
"md-nav" aria-label=
"Dictionary">
2083 <ul class=
"md-nav__list">
2085 <li class=
"md-nav__item">
2086 <a href=
"#setkey-string-value-any" class=
"md-nav__link">
2087 set(key: string, value: any)
2092 <li class=
"md-nav__item">
2093 <a href=
"#deletekey-string" class=
"md-nav__link">
2099 <li class=
"md-nav__item">
2100 <a href=
"#haskey-string-boolean" class=
"md-nav__link">
2101 has(key: string): boolean
2106 <li class=
"md-nav__item">
2107 <a href=
"#getkey-string-any" class=
"md-nav__link">
2108 get(key: string): any
2113 <li class=
"md-nav__item">
2114 <a href=
"#foreachcallback-value-any-key-string-void" class=
"md-nav__link">
2115 forEach(callback: (value: any, key: string) =
> void)
2120 <li class=
"md-nav__item">
2121 <a href=
"#size-number" class=
"md-nav__link">
2132 <li class=
"md-nav__item">
2133 <a href=
"#list" class=
"md-nav__link">
2137 <nav class=
"md-nav" aria-label=
"List">
2138 <ul class=
"md-nav__list">
2140 <li class=
"md-nav__item">
2141 <a href=
"#addvalue-any" class=
"md-nav__link">
2147 <li class=
"md-nav__item">
2148 <a href=
"#clear" class=
"md-nav__link">
2154 <li class=
"md-nav__item">
2155 <a href=
"#deletevalue-any-boolean" class=
"md-nav__link">
2156 delete(value: any): boolean
2161 <li class=
"md-nav__item">
2162 <a href=
"#foreachcallback-value-any-void" class=
"md-nav__link">
2163 forEach(callback: (value: any) =
> void)
2168 <li class=
"md-nav__item">
2169 <a href=
"#hasvalue-any-boolean" class=
"md-nav__link">
2170 has(value: any): boolean
2175 <li class=
"md-nav__item">
2176 <a href=
"#size-number_1" class=
"md-nav__link">
2187 <li class=
"md-nav__item">
2188 <a href=
"#objectmap" class=
"md-nav__link">
2192 <nav class=
"md-nav" aria-label=
"ObjectMap">
2193 <ul class=
"md-nav__list">
2195 <li class=
"md-nav__item">
2196 <a href=
"#setkey-object-value-object" class=
"md-nav__link">
2197 set(key: Object, value: Object)
2202 <li class=
"md-nav__item">
2203 <a href=
"#deletekey-object" class=
"md-nav__link">
2209 <li class=
"md-nav__item">
2210 <a href=
"#haskey-object-boolean" class=
"md-nav__link">
2211 has(key: Object): boolean
2216 <li class=
"md-nav__item">
2217 <a href=
"#getkey-object-object-undefined" class=
"md-nav__link">
2218 get(key: Object): Object | undefined
2236 <div class=
"md-content" data-md-component=
"content">
2237 <article class=
"md-content__inner md-typeset">
2240 <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">
2241 <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>
2245 <h1 id=
"data-structures-javascript-api">Data Structures - JavaScript API
<a class=
"headerlink" href=
"#data-structures-javascript-api" title=
"Permanent link">#
</a></h1>
2246 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
2247 <p>JavaScript offers only limited types of collections to hold and iterate over
2248 data. Despite the ongoing efforts in ES6 and newer, these new data structures
2249 and access methods, such as
<code>for … of
</code>, are not available in the still supported
2250 Internet Explorer
11.
</p>
2251 <h2 id=
"dictionary"><code>Dictionary
</code><a class=
"headerlink" href=
"#dictionary" title=
"Permanent link">#
</a></h2>
2252 <p>Represents a simple key-value map, but unlike the use of plain objects, will
2253 always to guarantee to iterate over directly set values only.
</p>
2254 <p><em>In supported browsers this will use a native
<code>Map
</code> internally, otherwise a plain object.
</em></p>
2255 <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>
2256 <p>Adds or updates an item using the provided key. Numeric keys will be converted
2258 <h3 id=
"deletekey-string"><code>delete(key: string)
</code><a class=
"headerlink" href=
"#deletekey-string" title=
"Permanent link">#
</a></h3>
2259 <p>Removes an item from the collection.
</p>
2260 <h3 id=
"haskey-string-boolean"><code>has(key: string): boolean
</code><a class=
"headerlink" href=
"#haskey-string-boolean" title=
"Permanent link">#
</a></h3>
2261 <p>Returns true if the key is contained in the collection.
</p>
2262 <h3 id=
"getkey-string-any"><code>get(key: string): any
</code><a class=
"headerlink" href=
"#getkey-string-any" title=
"Permanent link">#
</a></h3>
2263 <p>Returns the value for the provided key, or
<code>undefined
</code> if the key was not found.
2264 Use
<code>.has()
</code> to check for key existence.
</p>
2265 <h3 id=
"foreachcallback-value-any-key-string-void"><code>forEach(callback: (value: any, key: string) =
> void)
</code><a class=
"headerlink" href=
"#foreachcallback-value-any-key-string-void" title=
"Permanent link">#
</a></h3>
2266 <p>Iterates over all items in the collection in an arbitrary order and invokes the
2267 supplied callback with the value and the key.
</p>
2268 <h3 id=
"size-number"><code>size: number
</code><a class=
"headerlink" href=
"#size-number" title=
"Permanent link">#
</a></h3>
2269 <p>This read-only property counts the number of items in the collection.
</p>
2270 <h2 id=
"list"><code>List
</code><a class=
"headerlink" href=
"#list" title=
"Permanent link">#
</a></h2>
2271 <p>Represents a list of unique values.
</p>
2272 <p><em>In supported browsers this will use a native
<code>Set
</code> internally, otherwise an array.
</em></p>
2273 <h3 id=
"addvalue-any"><code>add(value: any)
</code><a class=
"headerlink" href=
"#addvalue-any" title=
"Permanent link">#
</a></h3>
2274 <p>Adds a value to the list. If the value is already part of the list, this method
2275 will silently abort.
</p>
2276 <h3 id=
"clear"><code>clear()
</code><a class=
"headerlink" href=
"#clear" title=
"Permanent link">#
</a></h3>
2277 <p>Resets the collection.
</p>
2278 <h3 id=
"deletevalue-any-boolean"><code>delete(value: any): boolean
</code><a class=
"headerlink" href=
"#deletevalue-any-boolean" title=
"Permanent link">#
</a></h3>
2279 <p>Attempts to remove a value from the list, it returns true if the value has been
2280 part of the list.
</p>
2281 <h3 id=
"foreachcallback-value-any-void"><code>forEach(callback: (value: any) =
> void)
</code><a class=
"headerlink" href=
"#foreachcallback-value-any-void" title=
"Permanent link">#
</a></h3>
2282 <p>Iterates over all values in the list in an arbitrary order and invokes the
2283 supplied callback for each value.
</p>
2284 <h3 id=
"hasvalue-any-boolean"><code>has(value: any): boolean
</code><a class=
"headerlink" href=
"#hasvalue-any-boolean" title=
"Permanent link">#
</a></h3>
2285 <p>Returns true if the provided value is part of this list.
</p>
2286 <h3 id=
"size-number_1"><code>size: number
</code><a class=
"headerlink" href=
"#size-number_1" title=
"Permanent link">#
</a></h3>
2287 <p>This read-only property counts the number of items in the list.
</p>
2288 <h2 id=
"objectmap"><code>ObjectMap
</code><a class=
"headerlink" href=
"#objectmap" title=
"Permanent link">#
</a></h2>
2289 <div class=
"admonition info">
2290 <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>
2292 <p>Represents a collection where any kind of objects, such as class instances or
2293 DOM elements, can be used as key. These keys are weakly referenced and will not
2294 prevent garbage collection from happening, but this also means that it is not
2295 possible to enumerate or iterate over the stored keys and values.
</p>
2296 <p>This class is especially useful when you want to store additional data for
2297 objects that may get disposed on runtime, such as DOM elements. Using any regular
2298 data collections will cause the object to be referenced indefinitely, preventing
2299 the garbage collection from removing orphaned objects.
</p>
2300 <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>
2301 <p>Adds the key with the provided value to the map, if the key was already part
2302 of the collection, its value is overwritten.
</p>
2303 <h3 id=
"deletekey-object"><code>delete(key: Object)
</code><a class=
"headerlink" href=
"#deletekey-object" title=
"Permanent link">#
</a></h3>
2304 <p>Attempts to remove a key from the collection. The method will abort silently if
2305 the key is not part of the collection.
</p>
2306 <h3 id=
"haskey-object-boolean"><code>has(key: Object): boolean
</code><a class=
"headerlink" href=
"#haskey-object-boolean" title=
"Permanent link">#
</a></h3>
2307 <p>Returns true if there is a value for the provided key in this collection.
</p>
2308 <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>
2309 <p>Retrieves the value of the provided key, or
<code>undefined
</code> if the key was not found.
</p>
2315 <div class=
"md-source-date">
2318 Last update:
2021-
01-
08
2337 <footer class=
"md-footer">
2339 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2341 <a href=
"../new-api_writing-a-module/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2342 <div class=
"md-footer__button md-icon">
2343 <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>
2345 <div class=
"md-footer__title">
2346 <div class=
"md-ellipsis">
2347 <span class=
"md-footer__direction">
2356 <a href=
"../new-api_core/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2357 <div class=
"md-footer__title">
2358 <div class=
"md-ellipsis">
2359 <span class=
"md-footer__direction">
2365 <div class=
"md-footer__button md-icon">
2366 <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>
2372 <div class=
"md-footer-meta md-typeset">
2373 <div class=
"md-footer-meta__inner md-grid">
2374 <div class=
"md-footer-copyright">
2376 <div class=
"md-footer-copyright__highlight">
2377 Copyright ©
2020 WoltLab GmbH
2381 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2386 <div class=
"md-footer-copyright">
2387 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2388 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2395 <div class=
"md-dialog" data-md-component=
"dialog">
2396 <div class=
"md-dialog__inner md-typeset"></div>
2398 <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>
2401 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>