3bed23eaee9d23732afa6bcf27b353ad8deb45ac
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / javascript / new-api_core / index.html
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="icon" href="../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
14
15
16
17 <title>Core Functions - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
22
23
24 <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
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 <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
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="#core-modules-and-functions-javascript-api" 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
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">
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 Core Functions
101
102 </span>
103 </div>
104 </div>
105 </div>
106
107
108
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">
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>
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
139
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
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>
146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150 </a>
151 </div>
152
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
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">
175
176 <img src="../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
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
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>
188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192 </a>
193 </div>
194
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
310 <li class="md-nav__item md-nav__item--nested">
311
312
313 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
314
315 <label class="md-nav__link" for="__nav_2_5_1">
316 Caches
317 <span class="md-nav__icon md-icon"></span>
318 </label>
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>
322 Caches
323 </label>
324 <ul class="md-nav__list" data-md-scrollfix>
325
326
327
328
329
330 <li class="md-nav__item">
331 <a href="../../php/api/caches/" class="md-nav__link">
332 Overview
333 </a>
334 </li>
335
336
337
338
339
340
341
342 <li class="md-nav__item">
343 <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
344 Persistent Caches
345 </a>
346 </li>
347
348
349
350
351
352
353
354 <li class="md-nav__item">
355 <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
356 Runtime Caches
357 </a>
358 </li>
359
360
361
362 </ul>
363 </nav>
364 </li>
365
366
367
368
369
370
371
372 <li class="md-nav__item">
373 <a href="../../php/api/comments/" class="md-nav__link">
374 Comments
375 </a>
376 </li>
377
378
379
380
381
382
383
384 <li class="md-nav__item">
385 <a href="../../php/api/cronjobs/" class="md-nav__link">
386 Cronjobs
387 </a>
388 </li>
389
390
391
392
393
394
395
396 <li class="md-nav__item">
397 <a href="../../php/api/events/" class="md-nav__link">
398 Events
399 </a>
400 </li>
401
402
403
404
405
406
407
408
409 <li class="md-nav__item md-nav__item--nested">
410
411
412 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
413
414 <label class="md-nav__link" for="__nav_2_5_5">
415 Form Builder
416 <span class="md-nav__icon md-icon"></span>
417 </label>
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>
421 Form Builder
422 </label>
423 <ul class="md-nav__list" data-md-scrollfix>
424
425
426
427
428
429 <li class="md-nav__item">
430 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
431 Overview
432 </a>
433 </li>
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
443 Structure
444 </a>
445 </li>
446
447
448
449
450
451
452
453 <li class="md-nav__item">
454 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
455 Fields
456 </a>
457 </li>
458
459
460
461
462
463
464
465 <li class="md-nav__item">
466 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
467 Validation and Data
468 </a>
469 </li>
470
471
472
473
474
475
476
477 <li class="md-nav__item">
478 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
479 Dependencies
480 </a>
481 </li>
482
483
484
485 </ul>
486 </nav>
487 </li>
488
489
490
491
492
493
494
495 <li class="md-nav__item">
496 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
497 Package Installation Plugins
498 </a>
499 </li>
500
501
502
503
504
505
506
507 <li class="md-nav__item">
508 <a href="../../php/api/user_activity_points/" class="md-nav__link">
509 User Activity Points
510 </a>
511 </li>
512
513
514
515
516
517
518
519 <li class="md-nav__item">
520 <a href="../../php/api/user_notifications/" class="md-nav__link">
521 User Notifications
522 </a>
523 </li>
524
525
526
527
528
529
530
531 <li class="md-nav__item">
532 <a href="../../php/api/sitemaps/" class="md-nav__link">
533 Sitemaps
534 </a>
535 </li>
536
537
538
539 </ul>
540 </nav>
541 </li>
542
543
544
545
546
547
548
549 <li class="md-nav__item">
550 <a href="../../php/code-style/" class="md-nav__link">
551 Code Style
552 </a>
553 </li>
554
555
556
557
558
559
560
561 <li class="md-nav__item">
562 <a href="../../php/apps/" class="md-nav__link">
563 Apps
564 </a>
565 </li>
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../php/gdpr/" class="md-nav__link">
575 GDPR
576 </a>
577 </li>
578
579
580
581 </ul>
582 </nav>
583 </li>
584
585
586
587
588
589
590
591
592
593
594
595 <li class="md-nav__item md-nav__item--nested">
596
597
598 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
599
600 <label class="md-nav__link" for="__nav_3">
601 Languages, Templates & CSS
602 <span class="md-nav__icon md-icon"></span>
603 </label>
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
608 </label>
609 <ul class="md-nav__list" data-md-scrollfix>
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../view/languages/" class="md-nav__link">
617 Languages
618 </a>
619 </li>
620
621
622
623
624
625
626
627 <li class="md-nav__item">
628 <a href="../../view/templates/" class="md-nav__link">
629 Templates
630 </a>
631 </li>
632
633
634
635
636
637
638
639 <li class="md-nav__item">
640 <a href="../../view/template-plugins/" class="md-nav__link">
641 Template Plugins
642 </a>
643 </li>
644
645
646
647
648
649
650
651 <li class="md-nav__item">
652 <a href="../../view/css/" class="md-nav__link">
653 CSS
654 </a>
655 </li>
656
657
658
659 </ul>
660 </nav>
661 </li>
662
663
664
665
666
667
668
669
670
671
672
673
674
675 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
676
677
678 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
679
680 <label class="md-nav__link" for="__nav_4">
681 TypeScript and JavaScript API
682 <span class="md-nav__icon md-icon"></span>
683 </label>
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
688 </label>
689 <ul class="md-nav__list" data-md-scrollfix>
690
691
692
693
694
695 <li class="md-nav__item">
696 <a href="../general-usage/" class="md-nav__link">
697 General Usage
698 </a>
699 </li>
700
701
702
703
704
705
706
707 <li class="md-nav__item">
708 <a href="../typescript/" class="md-nav__link">
709 TypeScript
710 </a>
711 </li>
712
713
714
715
716
717
718
719
720
721
722 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
723
724
725 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" checked>
726
727 <label class="md-nav__link" for="__nav_4_3">
728 New API
729 <span class="md-nav__icon md-icon"></span>
730 </label>
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>
734 New API
735 </label>
736 <ul class="md-nav__list" data-md-scrollfix>
737
738
739
740
741
742 <li class="md-nav__item">
743 <a href="../new-api_writing-a-module/" class="md-nav__link">
744 Writing a module
745 </a>
746 </li>
747
748
749
750
751
752
753
754 <li class="md-nav__item">
755 <a href="../new-api_data-structures/" class="md-nav__link">
756 Data Structures
757 </a>
758 </li>
759
760
761
762
763
764
765
766
767
768 <li class="md-nav__item md-nav__item--active">
769
770 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
771
772
773
774
775 <label class="md-nav__link md-nav__link--active" for="__toc">
776 Core Functions
777 <span class="md-nav__icon md-icon"></span>
778 </label>
779
780 <a href="./" class="md-nav__link md-nav__link--active">
781 Core Functions
782 </a>
783
784
785 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
786
787
788
789
790
791 <label class="md-nav__title" for="__toc">
792 <span class="md-nav__icon md-icon"></span>
793 Table of contents
794 </label>
795 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
796
797 <li class="md-nav__item">
798 <a href="#core" class="md-nav__link">
799 Core
800 </a>
801
802 <nav class="md-nav" aria-label="Core">
803 <ul class="md-nav__list">
804
805 <li class="md-nav__item">
806 <a href="#cloneobject-object-object" class="md-nav__link">
807 clone(object: Object): Object
808 </a>
809
810 </li>
811
812 <li class="md-nav__item">
813 <a href="#extendbase-object-merge-object-object" class="md-nav__link">
814 extend(base: Object, ...merge: Object[]): Object
815 </a>
816
817 </li>
818
819 <li class="md-nav__item">
820 <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
821 inherit(base: Object, target: Object, merge?: Object)
822 </a>
823
824 </li>
825
826 <li class="md-nav__item">
827 <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
828 isPlainObject(object: Object): boolean
829 </a>
830
831 </li>
832
833 <li class="md-nav__item">
834 <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
835 triggerEvent(element: Element, eventName: string)
836 </a>
837
838 </li>
839
840 </ul>
841 </nav>
842
843 </li>
844
845 <li class="md-nav__item">
846 <a href="#language" class="md-nav__link">
847 Language
848 </a>
849
850 <nav class="md-nav" aria-label="Language">
851 <ul class="md-nav__list">
852
853 <li class="md-nav__item">
854 <a href="#addkey-string-value-string" class="md-nav__link">
855 add(key: string, value: string)
856 </a>
857
858 </li>
859
860 <li class="md-nav__item">
861 <a href="#addobjectobject-object" class="md-nav__link">
862 addObject(object: Object)
863 </a>
864
865 </li>
866
867 <li class="md-nav__item">
868 <a href="#getkey-string-parameters-object-string" class="md-nav__link">
869 get(key: string, parameters?: Object): string
870 </a>
871
872 </li>
873
874 </ul>
875 </nav>
876
877 </li>
878
879 <li class="md-nav__item">
880 <a href="#stringutil" class="md-nav__link">
881 StringUtil
882 </a>
883
884 <nav class="md-nav" aria-label="StringUtil">
885 <ul class="md-nav__list">
886
887 <li class="md-nav__item">
888 <a href="#escapehtmlstr-string-string" class="md-nav__link">
889 escapeHTML(str: string): string
890 </a>
891
892 </li>
893
894 <li class="md-nav__item">
895 <a href="#escaperegexpstr-string-string" class="md-nav__link">
896 escapeRegExp(str: string): string
897 </a>
898
899 </li>
900
901 <li class="md-nav__item">
902 <a href="#lcfirststr-string-string" class="md-nav__link">
903 lcfirst(str: string): string
904 </a>
905
906 </li>
907
908 <li class="md-nav__item">
909 <a href="#ucfirststr-string-string" class="md-nav__link">
910 ucfirst(str: string): string
911 </a>
912
913 </li>
914
915 <li class="md-nav__item">
916 <a href="#unescapehtmlstr-string-string" class="md-nav__link">
917 unescapeHTML(str: string): string
918 </a>
919
920 </li>
921
922 </ul>
923 </nav>
924
925 </li>
926
927 </ul>
928
929 </nav>
930
931 </li>
932
933
934
935
936
937
938
939 <li class="md-nav__item">
940 <a href="../new-api_dom/" class="md-nav__link">
941 DOM
942 </a>
943 </li>
944
945
946
947
948
949
950
951 <li class="md-nav__item">
952 <a href="../new-api_events/" class="md-nav__link">
953 Event Handling
954 </a>
955 </li>
956
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../new-api_ajax/" class="md-nav__link">
965 Ajax
966 </a>
967 </li>
968
969
970
971
972
973
974
975 <li class="md-nav__item">
976 <a href="../new-api_dialogs/" class="md-nav__link">
977 Dialogs
978 </a>
979 </li>
980
981
982
983
984
985
986
987 <li class="md-nav__item">
988 <a href="../new-api_browser/" class="md-nav__link">
989 Browser and Screen Sizes
990 </a>
991 </li>
992
993
994
995
996
997
998
999 <li class="md-nav__item">
1000 <a href="../new-api_ui/" class="md-nav__link">
1001 User Interface
1002 </a>
1003 </li>
1004
1005
1006
1007 </ul>
1008 </nav>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017 <li class="md-nav__item">
1018 <a href="../legacy-api/" class="md-nav__link">
1019 Legacy API
1020 </a>
1021 </li>
1022
1023
1024
1025
1026
1027
1028
1029 <li class="md-nav__item">
1030 <a href="../helper-functions/" class="md-nav__link">
1031 Helper Functions
1032 </a>
1033 </li>
1034
1035
1036
1037
1038
1039
1040
1041 <li class="md-nav__item">
1042 <a href="../code-snippets/" class="md-nav__link">
1043 Code Snippets
1044 </a>
1045 </li>
1046
1047
1048
1049 </ul>
1050 </nav>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063 <li class="md-nav__item md-nav__item--nested">
1064
1065
1066 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1067
1068 <label class="md-nav__link" for="__nav_5">
1069 Package Components
1070 <span class="md-nav__icon md-icon"></span>
1071 </label>
1072 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1073 <label class="md-nav__title" for="__nav_5">
1074 <span class="md-nav__icon md-icon"></span>
1075 Package Components
1076 </label>
1077 <ul class="md-nav__list" data-md-scrollfix>
1078
1079
1080
1081
1082
1083 <li class="md-nav__item">
1084 <a href="../../package/package-xml/" class="md-nav__link">
1085 package.xml
1086 </a>
1087 </li>
1088
1089
1090
1091
1092
1093
1094
1095
1096 <li class="md-nav__item md-nav__item--nested">
1097
1098
1099 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1100
1101 <label class="md-nav__link" for="__nav_5_2">
1102 PIPs
1103 <span class="md-nav__icon md-icon"></span>
1104 </label>
1105 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1106 <label class="md-nav__title" for="__nav_5_2">
1107 <span class="md-nav__icon md-icon"></span>
1108 PIPs
1109 </label>
1110 <ul class="md-nav__list" data-md-scrollfix>
1111
1112
1113
1114
1115
1116 <li class="md-nav__item">
1117 <a href="../../package/pip/" class="md-nav__link">
1118 Overview
1119 </a>
1120 </li>
1121
1122
1123
1124
1125
1126
1127
1128 <li class="md-nav__item">
1129 <a href="../../package/pip/acl-option/" class="md-nav__link">
1130 aclOption
1131 </a>
1132 </li>
1133
1134
1135
1136
1137
1138
1139
1140 <li class="md-nav__item">
1141 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1142 acpMenu
1143 </a>
1144 </li>
1145
1146
1147
1148
1149
1150
1151
1152 <li class="md-nav__item">
1153 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1154 acpSearchProvider
1155 </a>
1156 </li>
1157
1158
1159
1160
1161
1162
1163
1164 <li class="md-nav__item">
1165 <a href="../../package/pip/acp-template/" class="md-nav__link">
1166 acpTemplate
1167 </a>
1168 </li>
1169
1170
1171
1172
1173
1174
1175
1176 <li class="md-nav__item">
1177 <a href="../../package/pip/bbcode/" class="md-nav__link">
1178 bbcode
1179 </a>
1180 </li>
1181
1182
1183
1184
1185
1186
1187
1188 <li class="md-nav__item">
1189 <a href="../../package/pip/box/" class="md-nav__link">
1190 box
1191 </a>
1192 </li>
1193
1194
1195
1196
1197
1198
1199
1200 <li class="md-nav__item">
1201 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1202 clipboardAction
1203 </a>
1204 </li>
1205
1206
1207
1208
1209
1210
1211
1212 <li class="md-nav__item">
1213 <a href="../../package/pip/core-object/" class="md-nav__link">
1214 coreObject
1215 </a>
1216 </li>
1217
1218
1219
1220
1221
1222
1223
1224 <li class="md-nav__item">
1225 <a href="../../package/pip/cronjob/" class="md-nav__link">
1226 cronjob
1227 </a>
1228 </li>
1229
1230
1231
1232
1233
1234
1235
1236 <li class="md-nav__item">
1237 <a href="../../package/pip/database/" class="md-nav__link">
1238 database
1239 </a>
1240 </li>
1241
1242
1243
1244
1245
1246
1247
1248 <li class="md-nav__item">
1249 <a href="../../package/pip/event-listener/" class="md-nav__link">
1250 eventListener
1251 </a>
1252 </li>
1253
1254
1255
1256
1257
1258
1259
1260 <li class="md-nav__item">
1261 <a href="../../package/pip/file/" class="md-nav__link">
1262 file
1263 </a>
1264 </li>
1265
1266
1267
1268
1269
1270
1271
1272 <li class="md-nav__item">
1273 <a href="../../package/pip/language/" class="md-nav__link">
1274 language
1275 </a>
1276 </li>
1277
1278
1279
1280
1281
1282
1283
1284 <li class="md-nav__item">
1285 <a href="../../package/pip/media-provider/" class="md-nav__link">
1286 mediaProvider
1287 </a>
1288 </li>
1289
1290
1291
1292
1293
1294
1295
1296 <li class="md-nav__item">
1297 <a href="../../package/pip/menu/" class="md-nav__link">
1298 menu
1299 </a>
1300 </li>
1301
1302
1303
1304
1305
1306
1307
1308 <li class="md-nav__item">
1309 <a href="../../package/pip/menu-item/" class="md-nav__link">
1310 menuItem
1311 </a>
1312 </li>
1313
1314
1315
1316
1317
1318
1319
1320 <li class="md-nav__item">
1321 <a href="../../package/pip/object-type/" class="md-nav__link">
1322 objectType
1323 </a>
1324 </li>
1325
1326
1327
1328
1329
1330
1331
1332 <li class="md-nav__item">
1333 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1334 objectTypeDefinition
1335 </a>
1336 </li>
1337
1338
1339
1340
1341
1342
1343
1344 <li class="md-nav__item">
1345 <a href="../../package/pip/option/" class="md-nav__link">
1346 option
1347 </a>
1348 </li>
1349
1350
1351
1352
1353
1354
1355
1356 <li class="md-nav__item">
1357 <a href="../../package/pip/page/" class="md-nav__link">
1358 page
1359 </a>
1360 </li>
1361
1362
1363
1364
1365
1366
1367
1368 <li class="md-nav__item">
1369 <a href="../../package/pip/pip/" class="md-nav__link">
1370 pip
1371 </a>
1372 </li>
1373
1374
1375
1376
1377
1378
1379
1380 <li class="md-nav__item">
1381 <a href="../../package/pip/script/" class="md-nav__link">
1382 script
1383 </a>
1384 </li>
1385
1386
1387
1388
1389
1390
1391
1392 <li class="md-nav__item">
1393 <a href="../../package/pip/smiley/" class="md-nav__link">
1394 smiley
1395 </a>
1396 </li>
1397
1398
1399
1400
1401
1402
1403
1404 <li class="md-nav__item">
1405 <a href="../../package/pip/sql/" class="md-nav__link">
1406 sql
1407 </a>
1408 </li>
1409
1410
1411
1412
1413
1414
1415
1416 <li class="md-nav__item">
1417 <a href="../../package/pip/style/" class="md-nav__link">
1418 style
1419 </a>
1420 </li>
1421
1422
1423
1424
1425
1426
1427
1428 <li class="md-nav__item">
1429 <a href="../../package/pip/template/" class="md-nav__link">
1430 template
1431 </a>
1432 </li>
1433
1434
1435
1436
1437
1438
1439
1440 <li class="md-nav__item">
1441 <a href="../../package/pip/template-listener/" class="md-nav__link">
1442 templateListener
1443 </a>
1444 </li>
1445
1446
1447
1448
1449
1450
1451
1452 <li class="md-nav__item">
1453 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1454 userGroupOption
1455 </a>
1456 </li>
1457
1458
1459
1460
1461
1462
1463
1464 <li class="md-nav__item">
1465 <a href="../../package/pip/user-menu/" class="md-nav__link">
1466 userMenu
1467 </a>
1468 </li>
1469
1470
1471
1472
1473
1474
1475
1476 <li class="md-nav__item">
1477 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1478 userNotificationEvent
1479 </a>
1480 </li>
1481
1482
1483
1484
1485
1486
1487
1488 <li class="md-nav__item">
1489 <a href="../../package/pip/user-option/" class="md-nav__link">
1490 userOption
1491 </a>
1492 </li>
1493
1494
1495
1496
1497
1498
1499
1500 <li class="md-nav__item">
1501 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1502 userProfileMenu
1503 </a>
1504 </li>
1505
1506
1507
1508 </ul>
1509 </nav>
1510 </li>
1511
1512
1513
1514
1515
1516
1517
1518 <li class="md-nav__item">
1519 <a href="../../package/database-php-api/" class="md-nav__link">
1520 Database PHP API
1521 </a>
1522 </li>
1523
1524
1525
1526 </ul>
1527 </nav>
1528 </li>
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540 <li class="md-nav__item md-nav__item--nested">
1541
1542
1543 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1544
1545 <label class="md-nav__link" for="__nav_6">
1546 Migration
1547 <span class="md-nav__icon md-icon"></span>
1548 </label>
1549 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1550 <label class="md-nav__title" for="__nav_6">
1551 <span class="md-nav__icon md-icon"></span>
1552 Migration
1553 </label>
1554 <ul class="md-nav__list" data-md-scrollfix>
1555
1556
1557
1558
1559
1560
1561 <li class="md-nav__item md-nav__item--nested">
1562
1563
1564 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1565
1566 <label class="md-nav__link" for="__nav_6_1">
1567 Migrating from WSC 5.3
1568 <span class="md-nav__icon md-icon"></span>
1569 </label>
1570 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1571 <label class="md-nav__title" for="__nav_6_1">
1572 <span class="md-nav__icon md-icon"></span>
1573 Migrating from WSC 5.3
1574 </label>
1575 <ul class="md-nav__list" data-md-scrollfix>
1576
1577
1578
1579
1580
1581 <li class="md-nav__item">
1582 <a href="../../migration/wsc53/php/" class="md-nav__link">
1583 PHP API
1584 </a>
1585 </li>
1586
1587
1588
1589
1590
1591
1592
1593 <li class="md-nav__item">
1594 <a href="../../migration/wsc53/session/" class="md-nav__link">
1595 Session Handling and Authentication
1596 </a>
1597 </li>
1598
1599
1600
1601
1602
1603
1604
1605 <li class="md-nav__item">
1606 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1607 TypeScript and JavaScript
1608 </a>
1609 </li>
1610
1611
1612
1613
1614
1615
1616
1617 <li class="md-nav__item">
1618 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1619 Templates
1620 </a>
1621 </li>
1622
1623
1624
1625
1626
1627
1628
1629 <li class="md-nav__item">
1630 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1631 Third Party Libraries
1632 </a>
1633 </li>
1634
1635
1636
1637 </ul>
1638 </nav>
1639 </li>
1640
1641
1642
1643
1644
1645
1646
1647
1648 <li class="md-nav__item md-nav__item--nested">
1649
1650
1651 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1652
1653 <label class="md-nav__link" for="__nav_6_2">
1654 Migrating from WSC 5.2
1655 <span class="md-nav__icon md-icon"></span>
1656 </label>
1657 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1658 <label class="md-nav__title" for="__nav_6_2">
1659 <span class="md-nav__icon md-icon"></span>
1660 Migrating from WSC 5.2
1661 </label>
1662 <ul class="md-nav__list" data-md-scrollfix>
1663
1664
1665
1666
1667
1668 <li class="md-nav__item">
1669 <a href="../../migration/wsc52/php/" class="md-nav__link">
1670 PHP API
1671 </a>
1672 </li>
1673
1674
1675
1676
1677
1678
1679
1680 <li class="md-nav__item">
1681 <a href="../../migration/wsc52/templates/" class="md-nav__link">
1682 Templates and Languages
1683 </a>
1684 </li>
1685
1686
1687
1688
1689
1690
1691
1692 <li class="md-nav__item">
1693 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1694 Third Party Libraries
1695 </a>
1696 </li>
1697
1698
1699
1700 </ul>
1701 </nav>
1702 </li>
1703
1704
1705
1706
1707
1708
1709
1710
1711 <li class="md-nav__item md-nav__item--nested">
1712
1713
1714 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1715
1716 <label class="md-nav__link" for="__nav_6_3">
1717 Migrating from WSC 3.1
1718 <span class="md-nav__icon md-icon"></span>
1719 </label>
1720 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1721 <label class="md-nav__title" for="__nav_6_3">
1722 <span class="md-nav__icon md-icon"></span>
1723 Migrating from WSC 3.1
1724 </label>
1725 <ul class="md-nav__list" data-md-scrollfix>
1726
1727
1728
1729
1730
1731 <li class="md-nav__item">
1732 <a href="../../migration/wsc31/php/" class="md-nav__link">
1733 PHP API
1734 </a>
1735 </li>
1736
1737
1738
1739 </ul>
1740 </nav>
1741 </li>
1742
1743
1744
1745
1746
1747
1748
1749
1750 <li class="md-nav__item md-nav__item--nested">
1751
1752
1753 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1754
1755 <label class="md-nav__link" for="__nav_6_4">
1756 Migrating from WSC 3.0
1757 <span class="md-nav__icon md-icon"></span>
1758 </label>
1759 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1760 <label class="md-nav__title" for="__nav_6_4">
1761 <span class="md-nav__icon md-icon"></span>
1762 Migrating from WSC 3.0
1763 </label>
1764 <ul class="md-nav__list" data-md-scrollfix>
1765
1766
1767
1768
1769
1770 <li class="md-nav__item">
1771 <a href="../../migration/wsc30/php/" class="md-nav__link">
1772 PHP API
1773 </a>
1774 </li>
1775
1776
1777
1778
1779
1780
1781
1782 <li class="md-nav__item">
1783 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1784 JavaScript API
1785 </a>
1786 </li>
1787
1788
1789
1790
1791
1792
1793
1794 <li class="md-nav__item">
1795 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1796 Templates
1797 </a>
1798 </li>
1799
1800
1801
1802
1803
1804
1805
1806 <li class="md-nav__item">
1807 <a href="../../migration/wsc30/css/" class="md-nav__link">
1808 CSS
1809 </a>
1810 </li>
1811
1812
1813
1814
1815
1816
1817
1818 <li class="md-nav__item">
1819 <a href="../../migration/wsc30/package/" class="md-nav__link">
1820 Package Components
1821 </a>
1822 </li>
1823
1824
1825
1826 </ul>
1827 </nav>
1828 </li>
1829
1830
1831
1832
1833
1834
1835
1836
1837 <li class="md-nav__item md-nav__item--nested">
1838
1839
1840 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1841
1842 <label class="md-nav__link" for="__nav_6_5">
1843 Migrating from WCF 2.1
1844 <span class="md-nav__icon md-icon"></span>
1845 </label>
1846 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1847 <label class="md-nav__title" for="__nav_6_5">
1848 <span class="md-nav__icon md-icon"></span>
1849 Migrating from WCF 2.1
1850 </label>
1851 <ul class="md-nav__list" data-md-scrollfix>
1852
1853
1854
1855
1856
1857 <li class="md-nav__item">
1858 <a href="../../migration/wcf21/php/" class="md-nav__link">
1859 PHP API
1860 </a>
1861 </li>
1862
1863
1864
1865
1866
1867
1868
1869 <li class="md-nav__item">
1870 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1871 Templates
1872 </a>
1873 </li>
1874
1875
1876
1877
1878
1879
1880
1881 <li class="md-nav__item">
1882 <a href="../../migration/wcf21/css/" class="md-nav__link">
1883 CSS
1884 </a>
1885 </li>
1886
1887
1888
1889
1890
1891
1892
1893 <li class="md-nav__item">
1894 <a href="../../migration/wcf21/package/" class="md-nav__link">
1895 Package Components
1896 </a>
1897 </li>
1898
1899
1900
1901 </ul>
1902 </nav>
1903 </li>
1904
1905
1906
1907 </ul>
1908 </nav>
1909 </li>
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921 <li class="md-nav__item md-nav__item--nested">
1922
1923
1924 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1925
1926 <label class="md-nav__link" for="__nav_7">
1927 Tutorials
1928 <span class="md-nav__icon md-icon"></span>
1929 </label>
1930 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1931 <label class="md-nav__title" for="__nav_7">
1932 <span class="md-nav__icon md-icon"></span>
1933 Tutorials
1934 </label>
1935 <ul class="md-nav__list" data-md-scrollfix>
1936
1937
1938
1939
1940
1941
1942 <li class="md-nav__item md-nav__item--nested">
1943
1944
1945 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1946
1947 <label class="md-nav__link" for="__nav_7_1">
1948 Tutorial Series
1949 <span class="md-nav__icon md-icon"></span>
1950 </label>
1951 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1952 <label class="md-nav__title" for="__nav_7_1">
1953 <span class="md-nav__icon md-icon"></span>
1954 Tutorial Series
1955 </label>
1956 <ul class="md-nav__list" data-md-scrollfix>
1957
1958
1959
1960
1961
1962 <li class="md-nav__item">
1963 <a href="../../tutorial/series/overview/" class="md-nav__link">
1964 Overview
1965 </a>
1966 </li>
1967
1968
1969
1970
1971
1972
1973
1974 <li class="md-nav__item">
1975 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1976 Part 1
1977 </a>
1978 </li>
1979
1980
1981
1982
1983
1984
1985
1986 <li class="md-nav__item">
1987 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1988 Part 2
1989 </a>
1990 </li>
1991
1992
1993
1994
1995
1996
1997
1998 <li class="md-nav__item">
1999 <a href="../../tutorial/series/part_3/" class="md-nav__link">
2000 Part 3
2001 </a>
2002 </li>
2003
2004
2005
2006 </ul>
2007 </nav>
2008 </li>
2009
2010
2011
2012 </ul>
2013 </nav>
2014 </li>
2015
2016
2017
2018 </ul>
2019 </nav>
2020 </div>
2021 </div>
2022 </div>
2023
2024
2025
2026 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2027 <div class="md-sidebar__scrollwrap">
2028 <div class="md-sidebar__inner">
2029
2030 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2031
2032
2033
2034
2035
2036 <label class="md-nav__title" for="__toc">
2037 <span class="md-nav__icon md-icon"></span>
2038 Table of contents
2039 </label>
2040 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2041
2042 <li class="md-nav__item">
2043 <a href="#core" class="md-nav__link">
2044 Core
2045 </a>
2046
2047 <nav class="md-nav" aria-label="Core">
2048 <ul class="md-nav__list">
2049
2050 <li class="md-nav__item">
2051 <a href="#cloneobject-object-object" class="md-nav__link">
2052 clone(object: Object): Object
2053 </a>
2054
2055 </li>
2056
2057 <li class="md-nav__item">
2058 <a href="#extendbase-object-merge-object-object" class="md-nav__link">
2059 extend(base: Object, ...merge: Object[]): Object
2060 </a>
2061
2062 </li>
2063
2064 <li class="md-nav__item">
2065 <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
2066 inherit(base: Object, target: Object, merge?: Object)
2067 </a>
2068
2069 </li>
2070
2071 <li class="md-nav__item">
2072 <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
2073 isPlainObject(object: Object): boolean
2074 </a>
2075
2076 </li>
2077
2078 <li class="md-nav__item">
2079 <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
2080 triggerEvent(element: Element, eventName: string)
2081 </a>
2082
2083 </li>
2084
2085 </ul>
2086 </nav>
2087
2088 </li>
2089
2090 <li class="md-nav__item">
2091 <a href="#language" class="md-nav__link">
2092 Language
2093 </a>
2094
2095 <nav class="md-nav" aria-label="Language">
2096 <ul class="md-nav__list">
2097
2098 <li class="md-nav__item">
2099 <a href="#addkey-string-value-string" class="md-nav__link">
2100 add(key: string, value: string)
2101 </a>
2102
2103 </li>
2104
2105 <li class="md-nav__item">
2106 <a href="#addobjectobject-object" class="md-nav__link">
2107 addObject(object: Object)
2108 </a>
2109
2110 </li>
2111
2112 <li class="md-nav__item">
2113 <a href="#getkey-string-parameters-object-string" class="md-nav__link">
2114 get(key: string, parameters?: Object): string
2115 </a>
2116
2117 </li>
2118
2119 </ul>
2120 </nav>
2121
2122 </li>
2123
2124 <li class="md-nav__item">
2125 <a href="#stringutil" class="md-nav__link">
2126 StringUtil
2127 </a>
2128
2129 <nav class="md-nav" aria-label="StringUtil">
2130 <ul class="md-nav__list">
2131
2132 <li class="md-nav__item">
2133 <a href="#escapehtmlstr-string-string" class="md-nav__link">
2134 escapeHTML(str: string): string
2135 </a>
2136
2137 </li>
2138
2139 <li class="md-nav__item">
2140 <a href="#escaperegexpstr-string-string" class="md-nav__link">
2141 escapeRegExp(str: string): string
2142 </a>
2143
2144 </li>
2145
2146 <li class="md-nav__item">
2147 <a href="#lcfirststr-string-string" class="md-nav__link">
2148 lcfirst(str: string): string
2149 </a>
2150
2151 </li>
2152
2153 <li class="md-nav__item">
2154 <a href="#ucfirststr-string-string" class="md-nav__link">
2155 ucfirst(str: string): string
2156 </a>
2157
2158 </li>
2159
2160 <li class="md-nav__item">
2161 <a href="#unescapehtmlstr-string-string" class="md-nav__link">
2162 unescapeHTML(str: string): string
2163 </a>
2164
2165 </li>
2166
2167 </ul>
2168 </nav>
2169
2170 </li>
2171
2172 </ul>
2173
2174 </nav>
2175 </div>
2176 </div>
2177 </div>
2178
2179
2180 <div class="md-content" data-md-component="content">
2181 <article class="md-content__inner md-typeset">
2182
2183
2184 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_core.md" title="Edit this page" class="md-content__button md-icon">
2185 <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>
2186 </a>
2187
2188
2189 <h1 id="core-modules-and-functions-javascript-api">Core Modules and Functions - JavaScript API<a class="headerlink" href="#core-modules-and-functions-javascript-api" title="Permanent link">#</a></h1>
2190 <p>A brief overview of common methods that may be useful when writing any module.</p>
2191 <h2 id="core"><code>Core</code><a class="headerlink" href="#core" title="Permanent link">#</a></h2>
2192 <h3 id="cloneobject-object-object"><code>clone(object: Object): Object</code><a class="headerlink" href="#cloneobject-object-object" title="Permanent link">#</a></h3>
2193 <p>Creates a deep-clone of the provided object by value, removing any references on
2194 the original element, including arrays. However, this does not clone references
2195 to non-plain objects, these instances will be copied by reference.</p>
2196 <div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span> <span class="p">{</span>
2197 <span class="kd">var</span> <span class="nx">obj1</span> <span class="o">=</span> <span class="p">{</span> <span class="nx">a</span><span class="o">:</span> <span class="mf">1</span> <span class="p">};</span>
2198 <span class="kd">var</span> <span class="nx">obj2</span> <span class="o">=</span> <span class="nx">Core</span><span class="p">.</span><span class="nx">clone</span><span class="p">(</span><span class="nx">obj1</span><span class="p">);</span>
2199
2200 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">obj1</span> <span class="o">===</span> <span class="nx">obj2</span><span class="p">);</span> <span class="c1">// output: false</span>
2201 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">obj2</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">&amp;&amp;</span> <span class="nx">obj2</span><span class="p">.</span><span class="nx">a</span> <span class="o">===</span> <span class="mf">1</span><span class="p">);</span> <span class="c1">// output: true</span>
2202 <span class="p">});</span>
2203 </code></pre></div>
2204 <h3 id="extendbase-object-merge-object-object"><code>extend(base: Object, ...merge: Object[]): Object</code><a class="headerlink" href="#extendbase-object-merge-object-object" title="Permanent link">#</a></h3>
2205 <p>Accepts an infinite amount of plain objects as parameters, values will be copied
2206 from the 2nd...nth object into the first object. The first parameter will be
2207 cloned and the resulting object is returned.</p>
2208 <div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span> <span class="p">{</span>
2209 <span class="kd">var</span> <span class="nx">obj1</span> <span class="o">=</span> <span class="p">{</span> <span class="nx">a</span><span class="o">:</span> <span class="mf">2</span> <span class="p">};</span>
2210 <span class="kd">var</span> <span class="nx">obj2</span> <span class="o">=</span> <span class="p">{</span> <span class="nx">a</span><span class="o">:</span> <span class="mf">1</span><span class="p">,</span> <span class="nx">b</span><span class="o">:</span> <span class="mf">2</span> <span class="p">};</span>
2211 <span class="kd">var</span> <span class="nx">obj</span> <span class="o">=</span> <span class="nx">Core</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
2212 <span class="nx">b</span><span class="o">:</span> <span class="mf">1</span>
2213 <span class="p">},</span> <span class="nx">obj1</span><span class="p">,</span> <span class="nx">obj2</span><span class="p">);</span>
2214
2215 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">obj</span><span class="p">.</span><span class="nx">b</span> <span class="o">===</span> <span class="mf">2</span><span class="p">);</span> <span class="c1">// output: true</span>
2216 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">obj</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">&amp;&amp;</span> <span class="nx">obj</span><span class="p">.</span><span class="nx">a</span> <span class="o">===</span> <span class="mf">2</span><span class="p">);</span> <span class="c1">// output: false</span>
2217 <span class="p">});</span>
2218 </code></pre></div>
2219 <h3 id="inheritbase-object-target-object-merge-object"><code>inherit(base: Object, target: Object, merge?: Object)</code><a class="headerlink" href="#inheritbase-object-target-object-merge-object" title="Permanent link">#</a></h3>
2220 <p>Derives the second object's prototype from the first object, afterwards the
2221 derived class will pass the <code>instanceof</code> check against the original class.</p>
2222 <div class="highlight"><pre><span></span><code><span class="c1">// App.js</span>
2223 <span class="nb">window</span><span class="p">.</span><span class="nx">App</span> <span class="o">=</span> <span class="p">{};</span>
2224 <span class="nx">App</span><span class="p">.</span><span class="nx">Foo</span> <span class="o">=</span> <span class="nx">Class</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
2225 <span class="nx">bar</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{}</span>
2226 <span class="p">});</span>
2227 <span class="nx">App</span><span class="p">.</span><span class="nx">Baz</span> <span class="o">=</span> <span class="nx">App</span><span class="p">.</span><span class="nx">Foo</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
2228 <span class="nx">makeSnafucated</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{}</span>
2229 <span class="p">});</span>
2230
2231 <span class="c1">// --- NEW API ---</span>
2232
2233 <span class="c1">// App/Foo.js</span>
2234 <span class="nx">define</span><span class="p">([],</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2235 <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2236
2237 <span class="kd">function</span> <span class="nx">Foo</span><span class="p">()</span> <span class="p">{};</span>
2238 <span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="p">{</span>
2239 <span class="nx">bar</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{}</span>
2240 <span class="p">};</span>
2241
2242 <span class="k">return</span> <span class="nx">Foo</span><span class="p">;</span>
2243 <span class="p">});</span>
2244
2245 <span class="c1">// App/Baz.js</span>
2246 <span class="nx">define</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">,</span> <span class="s2">&quot;./Foo&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">,</span> <span class="nx">Foo</span><span class="p">)</span> <span class="p">{</span>
2247 <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2248
2249 <span class="kd">function</span> <span class="nx">Baz</span><span class="p">()</span> <span class="p">{};</span>
2250 <span class="nx">Core</span><span class="p">.</span><span class="nx">inherit</span><span class="p">(</span><span class="nx">Baz</span><span class="p">,</span> <span class="nx">Foo</span><span class="p">,</span> <span class="p">{</span>
2251 <span class="nx">makeSnafucated</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{}</span>
2252 <span class="p">});</span>
2253
2254 <span class="k">return</span> <span class="nx">Baz</span><span class="p">;</span>
2255 <span class="p">});</span>
2256 </code></pre></div>
2257 <h3 id="isplainobjectobject-object-boolean"><code>isPlainObject(object: Object): boolean</code><a class="headerlink" href="#isplainobjectobject-object-boolean" title="Permanent link">#</a></h3>
2258 <p>Verifies if an object is a plain JavaScript object and not an object instance.</p>
2259 <div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span> <span class="p">{</span>
2260 <span class="kd">function</span> <span class="nx">Foo</span><span class="p">()</span> <span class="p">{}</span>
2261 <span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="p">{</span>
2262 <span class="nx">hello</span><span class="o">:</span> <span class="s2">&quot;world&quot;</span><span class="p">;</span>
2263 <span class="p">};</span>
2264
2265 <span class="kd">var</span> <span class="nx">obj1</span> <span class="o">=</span> <span class="p">{</span> <span class="nx">hello</span><span class="o">:</span> <span class="s2">&quot;world&quot;</span> <span class="p">};</span>
2266 <span class="kd">var</span> <span class="nx">obj2</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Foo</span><span class="p">();</span>
2267
2268 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">Core</span><span class="p">.</span><span class="nx">isPlainObject</span><span class="p">(</span><span class="nx">obj1</span><span class="p">));</span> <span class="c1">// output: true</span>
2269 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">obj1</span><span class="p">.</span><span class="nx">hello</span> <span class="o">===</span> <span class="nx">obj2</span><span class="p">.</span><span class="nx">hello</span><span class="p">);</span> <span class="c1">// output: true</span>
2270 <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">Core</span><span class="p">.</span><span class="nx">isPlainObject</span><span class="p">(</span><span class="nx">obj2</span><span class="p">));</span> <span class="c1">// output: false</span>
2271 <span class="p">});</span>
2272 </code></pre></div>
2273 <h3 id="triggereventelement-element-eventname-string"><code>triggerEvent(element: Element, eventName: string)</code><a class="headerlink" href="#triggereventelement-element-eventname-string" title="Permanent link">#</a></h3>
2274 <p>Creates and dispatches a synthetic JavaScript event on an element.</p>
2275 <div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span> <span class="p">{</span>
2276 <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elBySel</span><span class="p">(</span><span class="s2">&quot;.some-element&quot;</span><span class="p">);</span>
2277 <span class="nx">Core</span><span class="p">.</span><span class="nx">triggerEvent</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">&quot;click&quot;</span><span class="p">);</span>
2278 <span class="p">});</span>
2279 </code></pre></div>
2280 <h2 id="language"><code>Language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2>
2281 <h3 id="addkey-string-value-string"><code>add(key: string, value: string)</code><a class="headerlink" href="#addkey-string-value-string" title="Permanent link">#</a></h3>
2282 <p>Registers a new phrase.</p>
2283 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">script</span> <span class="na">data-relocate</span><span class="o">=</span><span class="s">&quot;true&quot;</span><span class="p">&gt;</span>
2284 <span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Language&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span> <span class="p">{</span>
2285 <span class="nx">Language</span><span class="p">.</span><span class="nx">add</span><span class="p">(</span><span class="s1">&#39;app.foo.bar&#39;</span><span class="p">,</span> <span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span><span class="p">);</span>
2286 <span class="p">});</span>
2287 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2288 </code></pre></div>
2289 <h3 id="addobjectobject-object"><code>addObject(object: Object)</code><a class="headerlink" href="#addobjectobject-object" title="Permanent link">#</a></h3>
2290 <p>Registers a list of phrases using a plain object.</p>
2291 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">script</span> <span class="na">data-relocate</span><span class="o">=</span><span class="s">&quot;true&quot;</span><span class="p">&gt;</span>
2292 <span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Language&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span> <span class="p">{</span>
2293 <span class="nx">Language</span><span class="p">.</span><span class="nx">addObject</span><span class="p">({</span>
2294 <span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span>
2295 <span class="p">});</span>
2296 <span class="p">});</span>
2297 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2298 </code></pre></div>
2299 <h3 id="getkey-string-parameters-object-string"><code>get(key: string, parameters?: Object): string</code><a class="headerlink" href="#getkey-string-parameters-object-string" title="Permanent link">#</a></h3>
2300 <p>Retrieves a phrase by its key, optionally supporting basic template scripting
2301 with dynamic variables passed using the <code>parameters</code> object.</p>
2302 <div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Language&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span> <span class="p">{</span>
2303 <span class="kd">var</span> <span class="nx">title</span> <span class="o">=</span> <span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;app.foo.title&quot;</span><span class="p">);</span>
2304 <span class="kd">var</span> <span class="nx">content</span> <span class="o">=</span> <span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;app.foo.content&quot;</span><span class="p">,</span> <span class="p">{</span>
2305 <span class="nx">some</span><span class="o">:</span> <span class="s2">&quot;value&quot;</span>
2306 <span class="p">});</span>
2307 <span class="p">});</span>
2308 </code></pre></div>
2309 <h2 id="stringutil"><code>StringUtil</code><a class="headerlink" href="#stringutil" title="Permanent link">#</a></h2>
2310 <h3 id="escapehtmlstr-string-string"><code>escapeHTML(str: string): string</code><a class="headerlink" href="#escapehtmlstr-string-string" title="Permanent link">#</a></h3>
2311 <p>Escapes special HTML characters by converting them into an HTML entity.</p>
2312 <table>
2313 <thead>
2314 <tr>
2315 <th>Character</th>
2316 <th>Replacement</th>
2317 </tr>
2318 </thead>
2319 <tbody>
2320 <tr>
2321 <td><code>&amp;</code></td>
2322 <td><code>&amp;amp;</code></td>
2323 </tr>
2324 <tr>
2325 <td><code>"</code></td>
2326 <td><code>&amp;quot;</code></td>
2327 </tr>
2328 <tr>
2329 <td><code>&lt;</code></td>
2330 <td><code>&amp;lt;</code></td>
2331 </tr>
2332 <tr>
2333 <td><code>&gt;</code></td>
2334 <td><code>&amp;gt;</code></td>
2335 </tr>
2336 </tbody>
2337 </table>
2338 <h3 id="escaperegexpstr-string-string"><code>escapeRegExp(str: string): string</code><a class="headerlink" href="#escaperegexpstr-string-string" title="Permanent link">#</a></h3>
2339 <p>Escapes a list of characters that have a special meaning in regular expressions
2340 and could alter the behavior when embedded into regular expressions.</p>
2341 <h3 id="lcfirststr-string-string"><code>lcfirst(str: string): string</code><a class="headerlink" href="#lcfirststr-string-string" title="Permanent link">#</a></h3>
2342 <p>Makes a string's first character lowercase.</p>
2343 <h3 id="ucfirststr-string-string"><code>ucfirst(str: string): string</code><a class="headerlink" href="#ucfirststr-string-string" title="Permanent link">#</a></h3>
2344 <p>Makes a string's first character uppercase.</p>
2345 <h3 id="unescapehtmlstr-string-string"><code>unescapeHTML(str: string): string</code><a class="headerlink" href="#unescapehtmlstr-string-string" title="Permanent link">#</a></h3>
2346 <p>Converts some HTML entities into their original character. This is the reverse
2347 function of <code>escapeHTML()</code>.</p>
2348
2349
2350
2351
2352 <hr>
2353 <div class="md-source-date">
2354 <small>
2355
2356 Last update: 2021-01-08
2357
2358 </small>
2359 </div>
2360
2361
2362
2363
2364
2365
2366
2367
2368 </article>
2369 </div>
2370 </div>
2371
2372 </main>
2373
2374
2375 <footer class="md-footer">
2376
2377 <nav class="md-footer__inner md-grid" aria-label="Footer">
2378
2379 <a href="../new-api_data-structures/" class="md-footer__link md-footer__link--prev" rel="prev">
2380 <div class="md-footer__button md-icon">
2381 <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>
2382 </div>
2383 <div class="md-footer__title">
2384 <div class="md-ellipsis">
2385 <span class="md-footer__direction">
2386 Previous
2387 </span>
2388 Data Structures
2389 </div>
2390 </div>
2391 </a>
2392
2393
2394 <a href="../new-api_dom/" class="md-footer__link md-footer__link--next" rel="next">
2395 <div class="md-footer__title">
2396 <div class="md-ellipsis">
2397 <span class="md-footer__direction">
2398 Next
2399 </span>
2400 DOM
2401 </div>
2402 </div>
2403 <div class="md-footer__button md-icon">
2404 <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>
2405 </div>
2406 </a>
2407
2408 </nav>
2409
2410 <div class="md-footer-meta md-typeset">
2411 <div class="md-footer-meta__inner md-grid">
2412 <div class="md-footer-copyright">
2413
2414 <div class="md-footer-copyright__highlight">
2415 Copyright © 2020 WoltLab GmbH
2416 </div>
2417
2418 Made with
2419 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2420 Material for MkDocs
2421 </a>
2422
2423 </div>
2424 <div class="md-footer-copyright">
2425 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2426 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2427 </div>
2428 </div>
2429 </div>
2430 </footer>
2431
2432 </div>
2433 <div class="md-dialog" data-md-component="dialog">
2434 <div class="md-dialog__inner md-typeset"></div>
2435 </div>
2436 <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>
2437
2438
2439 <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2440
2441
2442 </body>
2443 </html>