Deployed 10e50fd9 to 6.0 with MkDocs 1.5.2 and mike 1.1.2
[GitHub/WoltLab/woltlab.github.io.git] / 6.0 / javascript / new-api_core / index.html
CommitLineData
9aa5da67
WG
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 <link rel="canonical" href="https://docs.woltlab.com/6.0/javascript/new-api_core/">
12
e02609d6
WG
13
14 <link rel="prev" href="../new-api_writing-a-module/">
15
16
17 <link rel="next" href="../new-api_dom/">
18
9aa5da67 19 <link rel="icon" href="../../assets/default.favicon.ico">
9f07cf57 20 <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
9aa5da67
WG
21
22
23
24 <title>Core Functions - WoltLab Suite Documentation</title>
25
26
27
e06c8b5f 28 <link rel="stylesheet" href="../../assets/stylesheets/main.eebd395e.min.css">
9aa5da67
WG
29
30
9d185e89 31 <link rel="stylesheet" href="../../assets/stylesheets/palette.ecc896b0.min.css">
9aa5da67
WG
32
33
7f9945cf 34
9aa5da67
WG
35
36
37
38
39
40
41 <link rel="stylesheet" href="../../stylesheets/extra.css">
42
a06fd3b1 43 <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
9aa5da67
WG
44
45
46
47
48
7f9945cf 49
9aa5da67
WG
50 </head>
51
52
53
54
55
56
57
94fa7b1e 58 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
9aa5da67
WG
59
60
61
62 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
63 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
64 <label class="md-overlay" for="__drawer"></label>
65 <div data-md-component="skip">
66
67
68 <a href="#core-modules-and-functions-javascript-api" class="md-skip">
69 Skip to content
70 </a>
71
72 </div>
73 <div data-md-component="announce">
74
75 <aside class="md-banner">
76 <div class="md-banner__inner md-grid md-typeset">
77
a06fd3b1 78
9aa5da67
WG
79 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
80
81 </div>
a06fd3b1 82
9aa5da67
WG
83 </aside>
84
85 </div>
86
6f2e8f13 87 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
a06fd3b1 88
9aa5da67
WG
89 </div>
90
91
92
93
781975eb
WG
94
95
96<header class="md-header md-header--shadow" data-md-component="header">
9aa5da67
WG
97 <nav class="md-header__inner md-grid" aria-label="Header">
98 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
99
100 <img src="../../assets/logo.png" alt="logo">
101
102 </a>
103 <label class="md-header__button md-icon" for="__drawer">
104 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
105 </label>
106 <div class="md-header__title" data-md-component="header-title">
107 <div class="md-header__ellipsis">
108 <div class="md-header__topic">
109 <span class="md-ellipsis">
110 WoltLab Suite Documentation
111 </span>
112 </div>
113 <div class="md-header__topic" data-md-component="header-topic">
114 <span class="md-ellipsis">
115
116 Core Functions
117
118 </span>
119 </div>
120 </div>
121 </div>
122
94fa7b1e
WG
123
124
9aa5da67
WG
125
126
127 <label class="md-header__button md-icon" for="__search">
128 <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>
129 </label>
130 <div class="md-search" data-md-component="search" role="dialog">
131 <label class="md-search__overlay" for="__search"></label>
132 <div class="md-search__inner" role="search">
133 <form class="md-search__form" name="search">
134 <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" required>
135 <label class="md-search__icon md-icon" for="__search">
136 <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>
137 <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>
138 </label>
139 <nav class="md-search__options" aria-label="Search">
140
7f9945cf 141 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
9aa5da67
WG
142 <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>
143 </button>
144 </nav>
145
146 </form>
147 <div class="md-search__output">
148 <div class="md-search__scrollwrap" data-md-scrollfix>
149 <div class="md-search-result" data-md-component="search-result">
150 <div class="md-search-result__meta">
151 Initializing search
152 </div>
7b2c751c 153 <ol class="md-search-result__list" role="presentation"></ol>
9aa5da67
WG
154 </div>
155 </div>
156 </div>
157 </div>
158</div>
159
160
161 <div class="md-header__source">
162 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
163 <div class="md-source__icon md-icon">
164
94fa7b1e 165 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
166 </div>
167 <div class="md-source__repository">
168 GitHub
169 </div>
170</a>
171 </div>
172
173 </nav>
174
175</header>
176
177 <div class="md-container" data-md-component="container">
178
179
180
181
182
183
184 <main class="md-main" data-md-component="main">
185 <div class="md-main__inner md-grid">
186
187
188
189 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
190 <div class="md-sidebar__scrollwrap">
191 <div class="md-sidebar__inner">
192
193
194
195<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
196 <label class="md-nav__title" for="__drawer">
197 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
198
199 <img src="../../assets/logo.png" alt="logo">
200
201 </a>
202 WoltLab Suite Documentation
203 </label>
204
205 <div class="md-nav__source">
206 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
207 <div class="md-source__icon md-icon">
208
94fa7b1e 209 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
210 </div>
211 <div class="md-source__repository">
212 GitHub
213 </div>
214</a>
215 </div>
216
217 <ul class="md-nav__list" data-md-scrollfix>
218
219
220
221
222
223
224
225
226 <li class="md-nav__item">
227 <a href="../../getting-started/" class="md-nav__link">
228 Getting Started
229 </a>
230 </li>
231
232
233
234
235
236
237
238
239
240
241
242 <li class="md-nav__item md-nav__item--nested">
243
244
9aa5da67
WG
245
246
51b70eee 247 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
e02609d6 248
9aa5da67
WG
249
250
51b70eee 251 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
9aa5da67
WG
252 PHP API
253 <span class="md-nav__icon md-icon"></span>
254 </label>
255
51b70eee 256 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
9aa5da67
WG
257 <label class="md-nav__title" for="__nav_2">
258 <span class="md-nav__icon md-icon"></span>
259 PHP API
260 </label>
261 <ul class="md-nav__list" data-md-scrollfix>
262
263
264
265
266
267
268 <li class="md-nav__item">
269 <a href="../../php/pages/" class="md-nav__link">
270 Pages
271 </a>
272 </li>
273
274
275
276
277
278
279
280
281
282 <li class="md-nav__item">
283 <a href="../../php/database-objects/" class="md-nav__link">
284 Database Objects
285 </a>
286 </li>
287
288
289
290
291
292
293
294
295
296 <li class="md-nav__item">
297 <a href="../../php/database-access/" class="md-nav__link">
298 Database Access
299 </a>
300 </li>
301
302
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../php/exceptions/" class="md-nav__link">
312 Exceptions
313 </a>
314 </li>
315
316
317
318
319
320
321
322
323
324
325 <li class="md-nav__item md-nav__item--nested">
326
327
9aa5da67
WG
328
329
51b70eee 330 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
e02609d6 331
9aa5da67
WG
332
333
51b70eee 334 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
9aa5da67
WG
335 API
336 <span class="md-nav__icon md-icon"></span>
337 </label>
338
51b70eee 339 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
9aa5da67
WG
340 <label class="md-nav__title" for="__nav_2_5">
341 <span class="md-nav__icon md-icon"></span>
342 API
343 </label>
344 <ul class="md-nav__list" data-md-scrollfix>
345
346
347
348
349
350
351
352 <li class="md-nav__item md-nav__item--nested">
353
354
9aa5da67
WG
355
356
51b70eee 357 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
9aa5da67
WG
358
359
e02609d6 360
51b70eee 361 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
9aa5da67
WG
362 Caches
363 <span class="md-nav__icon md-icon"></span>
364 </label>
365
51b70eee 366 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
9aa5da67
WG
367 <label class="md-nav__title" for="__nav_2_5_1">
368 <span class="md-nav__icon md-icon"></span>
369 Caches
370 </label>
371 <ul class="md-nav__list" data-md-scrollfix>
372
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../php/api/caches/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390
391
392 <li class="md-nav__item">
393 <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
394 Persistent Caches
395 </a>
396 </li>
397
398
399
400
401
402
403
404
405
406 <li class="md-nav__item">
407 <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
408 Runtime Caches
409 </a>
410 </li>
411
412
413
414
415 </ul>
416 </nav>
417 </li>
418
419
420
421
422
423
424
425
426
427 <li class="md-nav__item">
428 <a href="../../php/api/comments/" class="md-nav__link">
429 Comments
430 </a>
431 </li>
432
433
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../php/api/cronjobs/" class="md-nav__link">
443 Cronjobs
444 </a>
445 </li>
446
447
448
449
450
451
452
453
454
455 <li class="md-nav__item">
456 <a href="../../php/api/events/" class="md-nav__link">
457 Events
458 </a>
459 </li>
460
461
462
463
464
465
466
467
468
469
470 <li class="md-nav__item md-nav__item--nested">
471
472
9aa5da67
WG
473
474
51b70eee 475 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
e02609d6 476
9aa5da67
WG
477
478
51b70eee 479 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
9aa5da67
WG
480 Form Builder
481 <span class="md-nav__icon md-icon"></span>
482 </label>
483
51b70eee 484 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
9aa5da67
WG
485 <label class="md-nav__title" for="__nav_2_5_5">
486 <span class="md-nav__icon md-icon"></span>
487 Form Builder
488 </label>
489 <ul class="md-nav__list" data-md-scrollfix>
490
491
492
493
494
495
496 <li class="md-nav__item">
497 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
498 Overview
499 </a>
500 </li>
501
502
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
512 Structure
513 </a>
514 </li>
515
516
517
518
519
520
521
522
523
524 <li class="md-nav__item">
525 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
526 Fields
527 </a>
528 </li>
529
530
531
532
533
534
535
536
537
538 <li class="md-nav__item">
539 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
540 Validation and Data
541 </a>
542 </li>
543
544
545
546
547
548
549
550
551
552 <li class="md-nav__item">
553 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
554 Dependencies
555 </a>
556 </li>
557
558
559
560
561 </ul>
562 </nav>
563 </li>
564
565
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
575 Package Installation Plugins
576 </a>
577 </li>
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item">
588 <a href="../../php/api/user_activity_points/" class="md-nav__link">
589 User Activity Points
590 </a>
591 </li>
592
593
594
595
596
597
598
599
600
601 <li class="md-nav__item">
602 <a href="../../php/api/user_notifications/" class="md-nav__link">
603 User Notifications
604 </a>
605 </li>
606
607
608
609
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../php/api/sitemaps/" class="md-nav__link">
617 Sitemaps
618 </a>
619 </li>
620
621
622
623
624 </ul>
625 </nav>
626 </li>
627
628
629
630
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../../php/code-style/" class="md-nav__link">
638 Code Style
639 </a>
640 </li>
641
642
643
644
645
646
647
648
649
650 <li class="md-nav__item">
651 <a href="../../php/apps/" class="md-nav__link">
652 Apps
653 </a>
654 </li>
655
656
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../php/gdpr/" class="md-nav__link">
666 GDPR
667 </a>
668 </li>
669
670
671
672
673 </ul>
674 </nav>
675 </li>
676
677
678
679
680
681
682
683
684
685
686
687 <li class="md-nav__item md-nav__item--nested">
688
689
9aa5da67
WG
690
691
51b70eee 692 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
e02609d6 693
9aa5da67
WG
694
695
51b70eee 696 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
9aa5da67
WG
697 Languages, Templates & CSS
698 <span class="md-nav__icon md-icon"></span>
699 </label>
700
51b70eee 701 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
9aa5da67
WG
702 <label class="md-nav__title" for="__nav_3">
703 <span class="md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
705 </label>
706 <ul class="md-nav__list" data-md-scrollfix>
707
708
709
710
711
712
713 <li class="md-nav__item">
714 <a href="../../view/languages/" class="md-nav__link">
715 Languages
716 </a>
717 </li>
718
719
720
721
722
723
724
725
726
727 <li class="md-nav__item">
728 <a href="../../view/templates/" class="md-nav__link">
729 Templates
730 </a>
731 </li>
732
733
734
735
736
737
738
739
740
3c22ac76
WG
741 <li class="md-nav__item">
742 <a href="../../view/template-modifiers/" class="md-nav__link">
743 Template Modifiers
744 </a>
745 </li>
746
747
748
749
750
751
752
753
754
9aa5da67
WG
755 <li class="md-nav__item">
756 <a href="../../view/template-plugins/" class="md-nav__link">
757 Template Plugins
758 </a>
759 </li>
760
761
762
763
764
765
766
767
768
769 <li class="md-nav__item">
770 <a href="../../view/css/" class="md-nav__link">
771 CSS
772 </a>
773 </li>
774
775
776
777
778 </ul>
779 </nav>
780 </li>
781
782
783
784
785
786
787
788
789
790
791
792
793
794 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
795
796
9aa5da67
WG
797
798
51b70eee 799 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
9aa5da67
WG
800
801
e02609d6 802
51b70eee 803 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
9aa5da67
WG
804 TypeScript and JavaScript API
805 <span class="md-nav__icon md-icon"></span>
806 </label>
807
51b70eee 808 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
9aa5da67
WG
809 <label class="md-nav__title" for="__nav_4">
810 <span class="md-nav__icon md-icon"></span>
811 TypeScript and JavaScript API
812 </label>
813 <ul class="md-nav__list" data-md-scrollfix>
814
815
816
817
818
819
820 <li class="md-nav__item">
821 <a href="../general-usage/" class="md-nav__link">
822 General Usage
823 </a>
824 </li>
825
826
827
828
829
830
831
832
833
834 <li class="md-nav__item">
835 <a href="../typescript/" class="md-nav__link">
836 TypeScript
837 </a>
838 </li>
839
840
841
842
843
844
845
846
9f399714
WG
847
848
849 <li class="md-nav__item md-nav__item--nested">
850
851
9f399714
WG
852
853
51b70eee 854 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
e02609d6 855
9f399714
WG
856
857
51b70eee 858 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
9f399714
WG
859 Components
860 <span class="md-nav__icon md-icon"></span>
861 </label>
862
51b70eee 863 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
9f399714
WG
864 <label class="md-nav__title" for="__nav_4_3">
865 <span class="md-nav__icon md-icon"></span>
866 Components
867 </label>
868 <ul class="md-nav__list" data-md-scrollfix>
869
870
871
872
873
874
8c5b3015
WG
875 <li class="md-nav__item">
876 <a href="../components_ckeditor5/" class="md-nav__link">
877 CKEditor 5
878 </a>
879 </li>
880
881
882
883
884
885
886
887
888
9f399714
WG
889 <li class="md-nav__item">
890 <a href="../components_confirmation/" class="md-nav__link">
891 Confirmation
892 </a>
893 </li>
894
895
896
897
898
899
900
901
902
903 <li class="md-nav__item">
904 <a href="../components_dialog/" class="md-nav__link">
905 Dialog
906 </a>
907 </li>
908
909
910
911
f2d0508c
WG
912
913
914
915
916
816a45a9
WG
917 <li class="md-nav__item">
918 <a href="../components_google_maps/" class="md-nav__link">
919 Google Maps
920 </a>
921 </li>
922
923
924
925
926
927
928
929
930
f2d0508c
WG
931 <li class="md-nav__item">
932 <a href="../components_pagination/" class="md-nav__link">
933 Pagination
934 </a>
935 </li>
936
937
938
939
9f399714
WG
940 </ul>
941 </nav>
942 </li>
943
944
945
946
947
948
949
950
9aa5da67
WG
951
952
953
954
955 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
956
957
9aa5da67
WG
958
959
51b70eee 960 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
9aa5da67
WG
961
962
e02609d6 963
51b70eee 964 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
9aa5da67
WG
965 New API
966 <span class="md-nav__icon md-icon"></span>
967 </label>
968
51b70eee 969 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
9f399714 970 <label class="md-nav__title" for="__nav_4_4">
9aa5da67
WG
971 <span class="md-nav__icon md-icon"></span>
972 New API
973 </label>
974 <ul class="md-nav__list" data-md-scrollfix>
975
976
977
978
979
980
981 <li class="md-nav__item">
982 <a href="../new-api_writing-a-module/" class="md-nav__link">
983 Writing a module
984 </a>
985 </li>
986
987
988
989
990
991
992
993
9aa5da67
WG
994
995
996
997 <li class="md-nav__item md-nav__item--active">
998
51b70eee 999 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
9aa5da67
WG
1000
1001
1002
1003
1004
1005 <label class="md-nav__link md-nav__link--active" for="__toc">
1006 Core Functions
1007 <span class="md-nav__icon md-icon"></span>
1008 </label>
1009
1010 <a href="./" class="md-nav__link md-nav__link--active">
1011 Core Functions
1012 </a>
1013
1014
1015
1016<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1017
1018
1019
1020
1021
1022
1023 <label class="md-nav__title" for="__toc">
1024 <span class="md-nav__icon md-icon"></span>
1025 Table of contents
1026 </label>
1027 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1028
1029 <li class="md-nav__item">
1030 <a href="#core" class="md-nav__link">
1031 Core
1032 </a>
1033
1034 <nav class="md-nav" aria-label="Core">
1035 <ul class="md-nav__list">
1036
1037 <li class="md-nav__item">
1038 <a href="#cloneobject-object-object" class="md-nav__link">
1039 clone(object: Object): Object
1040 </a>
1041
1042</li>
1043
1044 <li class="md-nav__item">
1045 <a href="#extendbase-object-merge-object-object" class="md-nav__link">
1046 extend(base: Object, ...merge: Object[]): Object
1047 </a>
1048
1049</li>
1050
1051 <li class="md-nav__item">
1052 <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
1053 inherit(base: Object, target: Object, merge?: Object)
1054 </a>
1055
1056</li>
1057
1058 <li class="md-nav__item">
1059 <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
1060 isPlainObject(object: Object): boolean
1061 </a>
1062
1063</li>
1064
1065 <li class="md-nav__item">
1066 <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
1067 triggerEvent(element: Element, eventName: string)
1068 </a>
1069
1070</li>
1071
1072 </ul>
1073 </nav>
1074
1075</li>
1076
1077 <li class="md-nav__item">
1078 <a href="#language" class="md-nav__link">
1079 Language
1080 </a>
1081
1082 <nav class="md-nav" aria-label="Language">
1083 <ul class="md-nav__list">
1084
1085 <li class="md-nav__item">
1086 <a href="#addkey-string-value-string" class="md-nav__link">
1087 add(key: string, value: string)
1088 </a>
1089
1090</li>
1091
1092 <li class="md-nav__item">
1093 <a href="#addobjectobject-object" class="md-nav__link">
1094 addObject(object: Object)
1095 </a>
1096
1097</li>
1098
1099 <li class="md-nav__item">
1100 <a href="#getkey-string-parameters-object-string" class="md-nav__link">
1101 get(key: string, parameters?: Object): string
1102 </a>
1103
1104</li>
1105
1106 </ul>
1107 </nav>
1108
1109</li>
1110
1111 <li class="md-nav__item">
1112 <a href="#stringutil" class="md-nav__link">
1113 StringUtil
1114 </a>
1115
1116 <nav class="md-nav" aria-label="StringUtil">
1117 <ul class="md-nav__list">
1118
1119 <li class="md-nav__item">
1120 <a href="#escapehtmlstr-string-string" class="md-nav__link">
1121 escapeHTML(str: string): string
1122 </a>
1123
1124</li>
1125
1126 <li class="md-nav__item">
1127 <a href="#escaperegexpstr-string-string" class="md-nav__link">
1128 escapeRegExp(str: string): string
1129 </a>
1130
1131</li>
1132
1133 <li class="md-nav__item">
1134 <a href="#lcfirststr-string-string" class="md-nav__link">
1135 lcfirst(str: string): string
1136 </a>
1137
1138</li>
1139
1140 <li class="md-nav__item">
1141 <a href="#ucfirststr-string-string" class="md-nav__link">
1142 ucfirst(str: string): string
1143 </a>
1144
1145</li>
1146
1147 <li class="md-nav__item">
1148 <a href="#unescapehtmlstr-string-string" class="md-nav__link">
1149 unescapeHTML(str: string): string
1150 </a>
1151
1152</li>
1153
1154 </ul>
1155 </nav>
1156
1157</li>
1158
1159 </ul>
1160
1161</nav>
1162
1163 </li>
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173 <li class="md-nav__item">
1174 <a href="../new-api_dom/" class="md-nav__link">
1175 DOM
1176 </a>
1177 </li>
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187 <li class="md-nav__item">
1188 <a href="../new-api_events/" class="md-nav__link">
1189 Event Handling
1190 </a>
1191 </li>
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201 <li class="md-nav__item">
1202 <a href="../new-api_ajax/" class="md-nav__link">
1203 Ajax
1204 </a>
1205 </li>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215 <li class="md-nav__item">
1216 <a href="../new-api_dialogs/" class="md-nav__link">
1217 Dialogs
1218 </a>
1219 </li>
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229 <li class="md-nav__item">
1230 <a href="../new-api_browser/" class="md-nav__link">
1231 Browser and Screen Sizes
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243 <li class="md-nav__item">
1244 <a href="../new-api_ui/" class="md-nav__link">
1245 User Interface
1246 </a>
1247 </li>
1248
1249
1250
1251
1252 </ul>
1253 </nav>
1254 </li>
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264 <li class="md-nav__item">
1265 <a href="../legacy-api/" class="md-nav__link">
1266 Legacy API
1267 </a>
1268 </li>
1269
1270
1271
1272
1273
1274
1275
1276
1277
9aa5da67
WG
1278 <li class="md-nav__item">
1279 <a href="../code-snippets/" class="md-nav__link">
1280 Code Snippets
1281 </a>
1282 </li>
1283
1284
1285
1286
1287 </ul>
1288 </nav>
1289 </li>
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301 <li class="md-nav__item md-nav__item--nested">
1302
1303
9aa5da67
WG
1304
1305
51b70eee 1306 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
e02609d6 1307
9aa5da67
WG
1308
1309
51b70eee 1310 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
9aa5da67
WG
1311 Package Components
1312 <span class="md-nav__icon md-icon"></span>
1313 </label>
1314
51b70eee 1315 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
9aa5da67
WG
1316 <label class="md-nav__title" for="__nav_5">
1317 <span class="md-nav__icon md-icon"></span>
1318 Package Components
1319 </label>
1320 <ul class="md-nav__list" data-md-scrollfix>
1321
1322
1323
1324
1325
1326
1327 <li class="md-nav__item">
1328 <a href="../../package/package-xml/" class="md-nav__link">
1329 package.xml
1330 </a>
1331 </li>
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342 <li class="md-nav__item md-nav__item--nested">
1343
1344
9aa5da67
WG
1345
1346
51b70eee 1347 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
9aa5da67
WG
1348
1349
e02609d6 1350
51b70eee 1351 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
9aa5da67
WG
1352 PIPs
1353 <span class="md-nav__icon md-icon"></span>
1354 </label>
1355
51b70eee 1356 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
9aa5da67
WG
1357 <label class="md-nav__title" for="__nav_5_2">
1358 <span class="md-nav__icon md-icon"></span>
1359 PIPs
1360 </label>
1361 <ul class="md-nav__list" data-md-scrollfix>
1362
1363
1364
1365
1366
1367
1368 <li class="md-nav__item">
1369 <a href="../../package/pip/" class="md-nav__link">
1370 Overview
1371 </a>
1372 </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382 <li class="md-nav__item">
1383 <a href="../../package/pip/acl-option/" class="md-nav__link">
1384 aclOption
1385 </a>
1386 </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 <li class="md-nav__item">
1397 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1398 acpMenu
1399 </a>
1400 </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410 <li class="md-nav__item">
1411 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1412 acpSearchProvider
1413 </a>
1414 </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424 <li class="md-nav__item">
1425 <a href="../../package/pip/acp-template/" class="md-nav__link">
1426 acpTemplate
1427 </a>
1428 </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item">
1439 <a href="../../package/pip/acp-template-delete/" class="md-nav__link">
1440 acpTemplateDelete
1441 </a>
1442 </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <li class="md-nav__item">
1453 <a href="../../package/pip/bbcode/" class="md-nav__link">
1454 bbcode
1455 </a>
1456 </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466 <li class="md-nav__item">
1467 <a href="../../package/pip/box/" class="md-nav__link">
1468 box
1469 </a>
1470 </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480 <li class="md-nav__item">
1481 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1482 clipboardAction
1483 </a>
1484 </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494 <li class="md-nav__item">
1495 <a href="../../package/pip/core-object/" class="md-nav__link">
1496 coreObject
1497 </a>
1498 </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508 <li class="md-nav__item">
1509 <a href="../../package/pip/cronjob/" class="md-nav__link">
1510 cronjob
1511 </a>
1512 </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522 <li class="md-nav__item">
1523 <a href="../../package/pip/database/" class="md-nav__link">
1524 database
1525 </a>
1526 </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536 <li class="md-nav__item">
1537 <a href="../../package/pip/event-listener/" class="md-nav__link">
1538 eventListener
1539 </a>
1540 </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550 <li class="md-nav__item">
1551 <a href="../../package/pip/file/" class="md-nav__link">
1552 file
1553 </a>
1554 </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564 <li class="md-nav__item">
1565 <a href="../../package/pip/file-delete/" class="md-nav__link">
1566 fileDelete
1567 </a>
1568 </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578 <li class="md-nav__item">
1579 <a href="../../package/pip/language/" class="md-nav__link">
1580 language
1581 </a>
1582 </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../package/pip/media-provider/" class="md-nav__link">
1594 mediaProvider
1595 </a>
1596 </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606 <li class="md-nav__item">
1607 <a href="../../package/pip/menu/" class="md-nav__link">
1608 menu
1609 </a>
1610 </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620 <li class="md-nav__item">
1621 <a href="../../package/pip/menu-item/" class="md-nav__link">
1622 menuItem
1623 </a>
1624 </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634 <li class="md-nav__item">
1635 <a href="../../package/pip/object-type/" class="md-nav__link">
1636 objectType
1637 </a>
1638 </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648 <li class="md-nav__item">
1649 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1650 objectTypeDefinition
1651 </a>
1652 </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662 <li class="md-nav__item">
1663 <a href="../../package/pip/option/" class="md-nav__link">
1664 option
1665 </a>
1666 </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <li class="md-nav__item">
1677 <a href="../../package/pip/page/" class="md-nav__link">
1678 page
1679 </a>
1680 </li>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690 <li class="md-nav__item">
1691 <a href="../../package/pip/pip/" class="md-nav__link">
1692 pip
1693 </a>
1694 </li>
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704 <li class="md-nav__item">
1705 <a href="../../package/pip/script/" class="md-nav__link">
1706 script
1707 </a>
1708 </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718 <li class="md-nav__item">
1719 <a href="../../package/pip/smiley/" class="md-nav__link">
1720 smiley
1721 </a>
1722 </li>
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732 <li class="md-nav__item">
1733 <a href="../../package/pip/sql/" class="md-nav__link">
1734 sql
1735 </a>
1736 </li>
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746 <li class="md-nav__item">
1747 <a href="../../package/pip/style/" class="md-nav__link">
1748 style
1749 </a>
1750 </li>
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760 <li class="md-nav__item">
1761 <a href="../../package/pip/template/" class="md-nav__link">
1762 template
1763 </a>
1764 </li>
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774 <li class="md-nav__item">
1775 <a href="../../package/pip/template-delete/" class="md-nav__link">
1776 templateDelete
1777 </a>
1778 </li>
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788 <li class="md-nav__item">
1789 <a href="../../package/pip/template-listener/" class="md-nav__link">
1790 templateListener
1791 </a>
1792 </li>
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802 <li class="md-nav__item">
1803 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1804 userGroupOption
1805 </a>
1806 </li>
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816 <li class="md-nav__item">
1817 <a href="../../package/pip/user-menu/" class="md-nav__link">
1818 userMenu
1819 </a>
1820 </li>
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830 <li class="md-nav__item">
1831 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1832 userNotificationEvent
1833 </a>
1834 </li>
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844 <li class="md-nav__item">
1845 <a href="../../package/pip/user-option/" class="md-nav__link">
1846 userOption
1847 </a>
1848 </li>
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858 <li class="md-nav__item">
1859 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1860 userProfileMenu
1861 </a>
1862 </li>
1863
1864
1865
1866
1867 </ul>
1868 </nav>
1869 </li>
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879 <li class="md-nav__item">
1880 <a href="../../package/database-php-api/" class="md-nav__link">
1881 Database PHP API
1882 </a>
1883 </li>
1884
1885
1886
1887
1888 </ul>
1889 </nav>
1890 </li>
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902 <li class="md-nav__item md-nav__item--nested">
1903
1904
9aa5da67
WG
1905
1906
51b70eee 1907 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
e02609d6 1908
9aa5da67
WG
1909
1910
51b70eee 1911 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
9aa5da67
WG
1912 Migration
1913 <span class="md-nav__icon md-icon"></span>
1914 </label>
1915
51b70eee 1916 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
9aa5da67
WG
1917 <label class="md-nav__title" for="__nav_6">
1918 <span class="md-nav__icon md-icon"></span>
1919 Migration
1920 </label>
1921 <ul class="md-nav__list" data-md-scrollfix>
1922
1923
1924
1925
1926
1927
1928
1929 <li class="md-nav__item md-nav__item--nested">
1930
1931
9aa5da67
WG
1932
1933
51b70eee 1934 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
e02609d6 1935
9aa5da67
WG
1936
1937
51b70eee 1938 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
9aa5da67
WG
1939 From WoltLab Suite 5.5
1940 <span class="md-nav__icon md-icon"></span>
1941 </label>
1942
51b70eee 1943 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
9aa5da67
WG
1944 <label class="md-nav__title" for="__nav_6_1">
1945 <span class="md-nav__icon md-icon"></span>
1946 From WoltLab Suite 5.5
1947 </label>
1948 <ul class="md-nav__list" data-md-scrollfix>
1949
1950
1951
1952
1953
1954
1955 <li class="md-nav__item">
1956 <a href="../../migration/wsc55/php/" class="md-nav__link">
1957 PHP API
1958 </a>
1959 </li>
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969 <li class="md-nav__item">
1970 <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1971 TypeScript and JavaScript
1972 </a>
1973 </li>
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983 <li class="md-nav__item">
1984 <a href="../../migration/wsc55/templates/" class="md-nav__link">
1985 Templates
1986 </a>
1987 </li>
1988
1989
1990
1991
1992
1993
1994
1995
1996
024038ef
WG
1997 <li class="md-nav__item">
1998 <a href="../../migration/wsc55/icons/" class="md-nav__link">
1999 Icons
2000 </a>
2001 </li>
2002
2003
2004
2005
2006
2007
2008
2009
2010
6d611e8a
WG
2011 <li class="md-nav__item">
2012 <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
2013 Dialogs
2014 </a>
2015 </li>
bf252c67
WG
2016
2017
2018
2019
2020
6d611e8a
WG
2021
2022
2023
2024
9aa5da67
WG
2025 <li class="md-nav__item">
2026 <a href="../../migration/wsc55/libraries/" class="md-nav__link">
2027 Third Party Libraries
2028 </a>
2029 </li>
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039 <li class="md-nav__item">
2040 <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2041 Deprecations and Removals
2042 </a>
2043 </li>
2044
2045
2046
2047
2048 </ul>
2049 </nav>
2050 </li>
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061 <li class="md-nav__item md-nav__item--nested">
2062
2063
9aa5da67
WG
2064
2065
51b70eee 2066 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
9aa5da67
WG
2067
2068
e02609d6 2069
51b70eee 2070 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
9aa5da67
WG
2071 From WoltLab Suite 5.4
2072 <span class="md-nav__icon md-icon"></span>
2073 </label>
2074
51b70eee 2075 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
9aa5da67
WG
2076 <label class="md-nav__title" for="__nav_6_2">
2077 <span class="md-nav__icon md-icon"></span>
2078 From WoltLab Suite 5.4
2079 </label>
2080 <ul class="md-nav__list" data-md-scrollfix>
2081
2082
2083
2084
2085
2086
2087 <li class="md-nav__item">
2088 <a href="../../migration/wsc54/php/" class="md-nav__link">
2089 PHP API
2090 </a>
2091 </li>
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101 <li class="md-nav__item">
2102 <a href="../../migration/wsc54/javascript/" class="md-nav__link">
2103 TypeScript and JavaScript
2104 </a>
2105 </li>
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115 <li class="md-nav__item">
2116 <a href="../../migration/wsc54/templates/" class="md-nav__link">
2117 Templates
2118 </a>
2119 </li>
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129 <li class="md-nav__item">
2130 <a href="../../migration/wsc54/libraries/" class="md-nav__link">
2131 Third Party Libraries
2132 </a>
2133 </li>
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143 <li class="md-nav__item">
2144 <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2145 Deprecations and Removals
2146 </a>
2147 </li>
2148
2149
2150
2151
2152 </ul>
2153 </nav>
2154 </li>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165 <li class="md-nav__item md-nav__item--nested">
2166
2167
9aa5da67
WG
2168
2169
51b70eee 2170 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
e02609d6 2171
9aa5da67
WG
2172
2173
51b70eee 2174 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
9aa5da67
WG
2175 From WoltLab Suite 5.3
2176 <span class="md-nav__icon md-icon"></span>
2177 </label>
2178
51b70eee 2179 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
9aa5da67
WG
2180 <label class="md-nav__title" for="__nav_6_3">
2181 <span class="md-nav__icon md-icon"></span>
2182 From WoltLab Suite 5.3
2183 </label>
2184 <ul class="md-nav__list" data-md-scrollfix>
2185
2186
2187
2188
2189
2190
2191 <li class="md-nav__item">
2192 <a href="../../migration/wsc53/php/" class="md-nav__link">
2193 PHP API
2194 </a>
2195 </li>
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205 <li class="md-nav__item">
2206 <a href="../../migration/wsc53/session/" class="md-nav__link">
2207 Session Handling and Authentication
2208 </a>
2209 </li>
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219 <li class="md-nav__item">
2220 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2221 TypeScript and JavaScript
2222 </a>
2223 </li>
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233 <li class="md-nav__item">
2234 <a href="../../migration/wsc53/templates/" class="md-nav__link">
2235 Templates
2236 </a>
2237 </li>
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247 <li class="md-nav__item">
2248 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2249 Third Party Libraries
2250 </a>
2251 </li>
2252
2253
2254
2255
2256 </ul>
2257 </nav>
2258 </li>
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269 <li class="md-nav__item md-nav__item--nested">
2270
2271
9aa5da67
WG
2272
2273
51b70eee 2274 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
e02609d6 2275
9aa5da67
WG
2276
2277
51b70eee 2278 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
9aa5da67
WG
2279 From WoltLab Suite 5.2
2280 <span class="md-nav__icon md-icon"></span>
2281 </label>
2282
51b70eee 2283 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
9aa5da67
WG
2284 <label class="md-nav__title" for="__nav_6_4">
2285 <span class="md-nav__icon md-icon"></span>
2286 From WoltLab Suite 5.2
2287 </label>
2288 <ul class="md-nav__list" data-md-scrollfix>
2289
2290
2291
2292
2293
2294
2295 <li class="md-nav__item">
2296 <a href="../../migration/wsc52/php/" class="md-nav__link">
2297 PHP API
2298 </a>
2299 </li>
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309 <li class="md-nav__item">
2310 <a href="../../migration/wsc52/templates/" class="md-nav__link">
2311 Templates and Languages
2312 </a>
2313 </li>
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323 <li class="md-nav__item">
2324 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2325 Third Party Libraries
2326 </a>
2327 </li>
2328
2329
2330
2331
2332 </ul>
2333 </nav>
2334 </li>
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345 <li class="md-nav__item md-nav__item--nested">
2346
2347
9aa5da67
WG
2348
2349
51b70eee 2350 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
9aa5da67
WG
2351
2352
e02609d6 2353
51b70eee 2354 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
9aa5da67
WG
2355 From WoltLab Suite 3.1
2356 <span class="md-nav__icon md-icon"></span>
2357 </label>
2358
51b70eee 2359 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
9aa5da67
WG
2360 <label class="md-nav__title" for="__nav_6_5">
2361 <span class="md-nav__icon md-icon"></span>
2362 From WoltLab Suite 3.1
2363 </label>
2364 <ul class="md-nav__list" data-md-scrollfix>
2365
2366
2367
2368
2369
2370
2371 <li class="md-nav__item">
2372 <a href="../../migration/wsc31/php/" class="md-nav__link">
2373 PHP API
2374 </a>
2375 </li>
2376
2377
2378
2379
2380 </ul>
2381 </nav>
2382 </li>
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393 <li class="md-nav__item md-nav__item--nested">
2394
2395
9aa5da67
WG
2396
2397
51b70eee 2398 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
e02609d6 2399
9aa5da67
WG
2400
2401
51b70eee 2402 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
9aa5da67
WG
2403 From WoltLab Suite 3.0
2404 <span class="md-nav__icon md-icon"></span>
2405 </label>
2406
51b70eee 2407 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
9aa5da67
WG
2408 <label class="md-nav__title" for="__nav_6_6">
2409 <span class="md-nav__icon md-icon"></span>
2410 From WoltLab Suite 3.0
2411 </label>
2412 <ul class="md-nav__list" data-md-scrollfix>
2413
2414
2415
2416
2417
2418
2419 <li class="md-nav__item">
2420 <a href="../../migration/wsc30/php/" class="md-nav__link">
2421 PHP API
2422 </a>
2423 </li>
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433 <li class="md-nav__item">
2434 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2435 JavaScript API
2436 </a>
2437 </li>
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447 <li class="md-nav__item">
2448 <a href="../../migration/wsc30/templates/" class="md-nav__link">
2449 Templates
2450 </a>
2451 </li>
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461 <li class="md-nav__item">
2462 <a href="../../migration/wsc30/css/" class="md-nav__link">
2463 CSS
2464 </a>
2465 </li>
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475 <li class="md-nav__item">
2476 <a href="../../migration/wsc30/package/" class="md-nav__link">
2477 Package Components
2478 </a>
2479 </li>
2480
2481
2482
2483
2484 </ul>
2485 </nav>
2486 </li>
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497 <li class="md-nav__item md-nav__item--nested">
2498
2499
9aa5da67
WG
2500
2501
51b70eee 2502 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
e02609d6 2503
9aa5da67
WG
2504
2505
51b70eee 2506 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
9aa5da67
WG
2507 From WCF 2.1
2508 <span class="md-nav__icon md-icon"></span>
2509 </label>
2510
51b70eee 2511 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
9aa5da67
WG
2512 <label class="md-nav__title" for="__nav_6_7">
2513 <span class="md-nav__icon md-icon"></span>
2514 From WCF 2.1
2515 </label>
2516 <ul class="md-nav__list" data-md-scrollfix>
2517
2518
2519
2520
2521
2522
2523 <li class="md-nav__item">
2524 <a href="../../migration/wcf21/php/" class="md-nav__link">
2525 PHP API
2526 </a>
2527 </li>
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537 <li class="md-nav__item">
2538 <a href="../../migration/wcf21/templates/" class="md-nav__link">
2539 Templates
2540 </a>
2541 </li>
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551 <li class="md-nav__item">
2552 <a href="../../migration/wcf21/css/" class="md-nav__link">
2553 CSS
2554 </a>
2555 </li>
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565 <li class="md-nav__item">
2566 <a href="../../migration/wcf21/package/" class="md-nav__link">
2567 Package Components
2568 </a>
2569 </li>
2570
2571
2572
2573
2574 </ul>
2575 </nav>
2576 </li>
2577
2578
2579
2580
2581 </ul>
2582 </nav>
2583 </li>
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595 <li class="md-nav__item md-nav__item--nested">
2596
2597
9aa5da67
WG
2598
2599
51b70eee 2600 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
9aa5da67
WG
2601
2602
e02609d6 2603
51b70eee 2604 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
9aa5da67
WG
2605 Tutorials
2606 <span class="md-nav__icon md-icon"></span>
2607 </label>
2608
51b70eee 2609 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
9aa5da67
WG
2610 <label class="md-nav__title" for="__nav_7">
2611 <span class="md-nav__icon md-icon"></span>
2612 Tutorials
2613 </label>
2614 <ul class="md-nav__list" data-md-scrollfix>
2615
2616
2617
2618
2619
2620
2621
2622 <li class="md-nav__item md-nav__item--nested">
2623
2624
9aa5da67
WG
2625
2626
51b70eee 2627 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
e02609d6 2628
9aa5da67
WG
2629
2630
51b70eee 2631 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
9aa5da67
WG
2632 Tutorial Series
2633 <span class="md-nav__icon md-icon"></span>
2634 </label>
2635
51b70eee 2636 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
9aa5da67
WG
2637 <label class="md-nav__title" for="__nav_7_1">
2638 <span class="md-nav__icon md-icon"></span>
2639 Tutorial Series
2640 </label>
2641 <ul class="md-nav__list" data-md-scrollfix>
2642
2643
2644
2645
2646
2647
2648 <li class="md-nav__item">
2649 <a href="../../tutorial/series/overview/" class="md-nav__link">
2650 Overview
2651 </a>
2652 </li>
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662 <li class="md-nav__item">
2663 <a href="../../tutorial/series/part_1/" class="md-nav__link">
2664 Part 1
2665 </a>
2666 </li>
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676 <li class="md-nav__item">
2677 <a href="../../tutorial/series/part_2/" class="md-nav__link">
2678 Part 2
2679 </a>
2680 </li>
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690 <li class="md-nav__item">
2691 <a href="../../tutorial/series/part_3/" class="md-nav__link">
2692 Part 3
2693 </a>
2694 </li>
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704 <li class="md-nav__item">
2705 <a href="../../tutorial/series/part_4/" class="md-nav__link">
2706 Part 4
2707 </a>
2708 </li>
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718 <li class="md-nav__item">
2719 <a href="../../tutorial/series/part_5/" class="md-nav__link">
2720 Part 5
2721 </a>
2722 </li>
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732 <li class="md-nav__item">
2733 <a href="../../tutorial/series/part_6/" class="md-nav__link">
2734 Part 6
2735 </a>
2736 </li>
2737
2738
2739
2740
2741 </ul>
2742 </nav>
2743 </li>
2744
2745
2746
2747
2748 </ul>
2749 </nav>
2750 </li>
2751
2752
2753
2754 </ul>
2755</nav>
2756 </div>
2757 </div>
2758 </div>
2759
2760
2761
2762 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2763 <div class="md-sidebar__scrollwrap">
2764 <div class="md-sidebar__inner">
2765
2766
2767<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2768
2769
2770
2771
2772
2773
2774 <label class="md-nav__title" for="__toc">
2775 <span class="md-nav__icon md-icon"></span>
2776 Table of contents
2777 </label>
2778 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2779
2780 <li class="md-nav__item">
2781 <a href="#core" class="md-nav__link">
2782 Core
2783 </a>
2784
2785 <nav class="md-nav" aria-label="Core">
2786 <ul class="md-nav__list">
2787
2788 <li class="md-nav__item">
2789 <a href="#cloneobject-object-object" class="md-nav__link">
2790 clone(object: Object): Object
2791 </a>
2792
2793</li>
2794
2795 <li class="md-nav__item">
2796 <a href="#extendbase-object-merge-object-object" class="md-nav__link">
2797 extend(base: Object, ...merge: Object[]): Object
2798 </a>
2799
2800</li>
2801
2802 <li class="md-nav__item">
2803 <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
2804 inherit(base: Object, target: Object, merge?: Object)
2805 </a>
2806
2807</li>
2808
2809 <li class="md-nav__item">
2810 <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
2811 isPlainObject(object: Object): boolean
2812 </a>
2813
2814</li>
2815
2816 <li class="md-nav__item">
2817 <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
2818 triggerEvent(element: Element, eventName: string)
2819 </a>
2820
2821</li>
2822
2823 </ul>
2824 </nav>
2825
2826</li>
2827
2828 <li class="md-nav__item">
2829 <a href="#language" class="md-nav__link">
2830 Language
2831 </a>
2832
2833 <nav class="md-nav" aria-label="Language">
2834 <ul class="md-nav__list">
2835
2836 <li class="md-nav__item">
2837 <a href="#addkey-string-value-string" class="md-nav__link">
2838 add(key: string, value: string)
2839 </a>
2840
2841</li>
2842
2843 <li class="md-nav__item">
2844 <a href="#addobjectobject-object" class="md-nav__link">
2845 addObject(object: Object)
2846 </a>
2847
2848</li>
2849
2850 <li class="md-nav__item">
2851 <a href="#getkey-string-parameters-object-string" class="md-nav__link">
2852 get(key: string, parameters?: Object): string
2853 </a>
2854
2855</li>
2856
2857 </ul>
2858 </nav>
2859
2860</li>
2861
2862 <li class="md-nav__item">
2863 <a href="#stringutil" class="md-nav__link">
2864 StringUtil
2865 </a>
2866
2867 <nav class="md-nav" aria-label="StringUtil">
2868 <ul class="md-nav__list">
2869
2870 <li class="md-nav__item">
2871 <a href="#escapehtmlstr-string-string" class="md-nav__link">
2872 escapeHTML(str: string): string
2873 </a>
2874
2875</li>
2876
2877 <li class="md-nav__item">
2878 <a href="#escaperegexpstr-string-string" class="md-nav__link">
2879 escapeRegExp(str: string): string
2880 </a>
2881
2882</li>
2883
2884 <li class="md-nav__item">
2885 <a href="#lcfirststr-string-string" class="md-nav__link">
2886 lcfirst(str: string): string
2887 </a>
2888
2889</li>
2890
2891 <li class="md-nav__item">
2892 <a href="#ucfirststr-string-string" class="md-nav__link">
2893 ucfirst(str: string): string
2894 </a>
2895
2896</li>
2897
2898 <li class="md-nav__item">
2899 <a href="#unescapehtmlstr-string-string" class="md-nav__link">
2900 unescapeHTML(str: string): string
2901 </a>
2902
2903</li>
2904
2905 </ul>
2906 </nav>
2907
2908</li>
2909
2910 </ul>
2911
2912</nav>
2913 </div>
2914 </div>
2915 </div>
2916
2917
7f9945cf
WG
2918
2919 <div class="md-content" data-md-component="content">
2920 <article class="md-content__inner md-typeset">
9aa5da67 2921
7f9945cf
WG
2922
2923
e02609d6
WG
2924
2925
2926
9aa5da67 2927
9aa5da67
WG
2928<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>
2929<p>A brief overview of common methods that may be useful when writing any module.</p>
2930<h2 id="core"><code>Core</code><a class="headerlink" href="#core" title="Permanent link">#</a></h2>
2931<h3 id="cloneobject-object-object"><code>clone(object: Object): Object</code><a class="headerlink" href="#cloneobject-object-object" title="Permanent link">#</a></h3>
2932<p>Creates a deep-clone of the provided object by value, removing any references on
2933the original element, including arrays. However, this does not clone references
2934to non-plain objects, these instances will be copied by reference.</p>
2935<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2936<span class="normal">2</span>
2937<span class="normal">3</span>
2938<span class="normal">4</span>
2939<span class="normal">5</span>
2940<span class="normal">6</span>
c708394c
WG
2941<span class="normal">7</span></pre></div></td><td class="code"><div><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="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
2942<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">a</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="w"> </span><span class="p">};</span>
2943<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj2</span><span class="w"> </span><span class="o">=</span><span class="w"> </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>
9aa5da67 2944
c708394c
WG
2945<span class="w"> </span><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="w"> </span><span class="o">===</span><span class="w"> </span><span class="nx">obj2</span><span class="p">);</span><span class="w"> </span><span class="c1">// output: false</span>
2946<span class="w"> </span><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="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nx">obj2</span><span class="p">.</span><span class="nx">a</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="mf">1</span><span class="p">);</span><span class="w"> </span><span class="c1">// output: true</span>
2947<span class="p">});</span>
9aa5da67
WG
2948</code></pre></div></td></tr></table></div>
2949<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>
2950<p>Accepts an infinite amount of plain objects as parameters, values will be copied
2951from the 2nd...nth object into the first object. The first parameter will be
2952cloned and the resulting object is returned.</p>
2953<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2954<span class="normal"> 2</span>
2955<span class="normal"> 3</span>
2956<span class="normal"> 4</span>
2957<span class="normal"> 5</span>
2958<span class="normal"> 6</span>
2959<span class="normal"> 7</span>
2960<span class="normal"> 8</span>
2961<span class="normal"> 9</span>
c708394c
WG
2962<span class="normal">10</span></pre></div></td><td class="code"><div><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="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
2963<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">a</span><span class="o">:</span><span class="w"> </span><span class="mf">2</span><span class="w"> </span><span class="p">};</span>
2964<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">a</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span><span class="w"> </span><span class="nx">b</span><span class="o">:</span><span class="w"> </span><span class="mf">2</span><span class="w"> </span><span class="p">};</span>
2965<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Core</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
2966<span class="w"> </span><span class="nx">b</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span>
2967<span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="nx">obj1</span><span class="p">,</span><span class="w"> </span><span class="nx">obj2</span><span class="p">);</span>
2968
2969<span class="w"> </span><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="w"> </span><span class="o">===</span><span class="w"> </span><span class="mf">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// output: true</span>
2970<span class="w"> </span><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="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nx">obj</span><span class="p">.</span><span class="nx">a</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="mf">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// output: false</span>
2971<span class="p">});</span>
9aa5da67
WG
2972</code></pre></div></td></tr></table></div>
2973<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>
2974<p>Derives the second object's prototype from the first object, afterwards the
2975derived class will pass the <code>instanceof</code> check against the original class.</p>
2976<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2977<span class="normal"> 2</span>
2978<span class="normal"> 3</span>
2979<span class="normal"> 4</span>
2980<span class="normal"> 5</span>
2981<span class="normal"> 6</span>
2982<span class="normal"> 7</span>
2983<span class="normal"> 8</span>
2984<span class="normal"> 9</span>
2985<span class="normal">10</span>
2986<span class="normal">11</span>
2987<span class="normal">12</span>
2988<span class="normal">13</span>
2989<span class="normal">14</span>
2990<span class="normal">15</span>
2991<span class="normal">16</span>
2992<span class="normal">17</span>
2993<span class="normal">18</span>
2994<span class="normal">19</span>
2995<span class="normal">20</span>
2996<span class="normal">21</span>
2997<span class="normal">22</span>
2998<span class="normal">23</span>
2999<span class="normal">24</span>
3000<span class="normal">25</span>
3001<span class="normal">26</span>
3002<span class="normal">27</span>
3003<span class="normal">28</span>
3004<span class="normal">29</span>
3005<span class="normal">30</span>
3006<span class="normal">31</span>
3007<span class="normal">32</span>
3008<span class="normal">33</span>
c708394c
WG
3009<span class="normal">34</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="c1">// App.js</span>
3010<span class="nb">window</span><span class="p">.</span><span class="nx">App</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span>
3011<span class="nx">App</span><span class="p">.</span><span class="nx">Foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Class</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
3012<span class="w"> </span><span class="nx">bar</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
3013<span class="p">});</span>
3014<span class="nx">App</span><span class="p">.</span><span class="nx">Baz</span><span class="w"> </span><span class="o">=</span><span class="w"> </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>
3015<span class="w"> </span><span class="nx">makeSnafucated</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
3016<span class="p">});</span>
3017
3018<span class="c1">// --- NEW API ---</span>
3019
3020<span class="c1">// App/Foo.js</span>
3021<span class="nx">define</span><span class="p">([],</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
3022<span class="w"> </span><span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
3023
3024<span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">Foo</span><span class="p">()</span><span class="w"> </span><span class="p">{};</span>
3025<span class="w"> </span><span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
3026<span class="w"> </span><span class="nx">bar</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
3027<span class="w"> </span><span class="p">};</span>
3028
3029<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">Foo</span><span class="p">;</span>
3030<span class="p">});</span>
3031
3032<span class="c1">// App/Baz.js</span>
3033<span class="nx">define</span><span class="p">([</span><span class="s2">&quot;Core&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;./Foo&quot;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">,</span><span class="w"> </span><span class="nx">Foo</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3034<span class="w"> </span><span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
3035
3036<span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">Baz</span><span class="p">()</span><span class="w"> </span><span class="p">{};</span>
3037<span class="w"> </span><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="w"> </span><span class="nx">Foo</span><span class="p">,</span><span class="w"> </span><span class="p">{</span>
3038<span class="w"> </span><span class="nx">makeSnafucated</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
3039<span class="w"> </span><span class="p">});</span>
3040
3041<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">Baz</span><span class="p">;</span>
3042<span class="p">});</span>
9aa5da67
WG
3043</code></pre></div></td></tr></table></div>
3044<h3 id="isplainobjectobject-object-boolean"><code>isPlainObject(object: Object): boolean</code><a class="headerlink" href="#isplainobjectobject-object-boolean" title="Permanent link">#</a></h3>
3045<p>Verifies if an object is a plain JavaScript object and not an object instance.</p>
3046<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3047<span class="normal"> 2</span>
3048<span class="normal"> 3</span>
3049<span class="normal"> 4</span>
3050<span class="normal"> 5</span>
3051<span class="normal"> 6</span>
3052<span class="normal"> 7</span>
3053<span class="normal"> 8</span>
3054<span class="normal"> 9</span>
3055<span class="normal">10</span>
3056<span class="normal">11</span>
3057<span class="normal">12</span>
c708394c
WG
3058<span class="normal">13</span></pre></div></td><td class="code"><div><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="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3059<span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">Foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
3060<span class="w"> </span><span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
3061<span class="w"> </span><span class="nx">hello</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;world&quot;</span><span class="p">;</span>
3062<span class="w"> </span><span class="p">};</span>
3063
3064<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">hello</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;world&quot;</span><span class="w"> </span><span class="p">};</span>
3065<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">obj2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Foo</span><span class="p">();</span>
3066
3067<span class="w"> </span><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="w"> </span><span class="c1">// output: true</span>
3068<span class="w"> </span><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="w"> </span><span class="o">===</span><span class="w"> </span><span class="nx">obj2</span><span class="p">.</span><span class="nx">hello</span><span class="p">);</span><span class="w"> </span><span class="c1">// output: true</span>
3069<span class="w"> </span><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="w"> </span><span class="c1">// output: false</span>
3070<span class="p">});</span>
9aa5da67
WG
3071</code></pre></div></td></tr></table></div>
3072<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>
3073<p>Creates and dispatches a synthetic JavaScript event on an element.</p>
3074<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3075<span class="normal">2</span>
3076<span class="normal">3</span>
c708394c
WG
3077<span class="normal">4</span></pre></div></td><td class="code"><div><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="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Core</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3078<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">element</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">elBySel</span><span class="p">(</span><span class="s2">&quot;.some-element&quot;</span><span class="p">);</span>
3079<span class="w"> </span><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="w"> </span><span class="s2">&quot;click&quot;</span><span class="p">);</span>
3080<span class="p">});</span>
9aa5da67
WG
3081</code></pre></div></td></tr></table></div>
3082<h2 id="language"><code>Language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2>
3083<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>
3084<p>Registers a new phrase.</p>
3085<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3086<span class="normal">2</span>
3087<span class="normal">3</span>
3088<span class="normal">4</span>
c708394c
WG
3089<span class="normal">5</span></pre></div></td><td class="code"><div><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>
3090<span class="w"> </span><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Language&quot;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3091<span class="w"> </span><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="w"> </span><span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span><span class="p">);</span>
3092<span class="w"> </span><span class="p">});</span>
9aa5da67
WG
3093<span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
3094</code></pre></div></td></tr></table></div>
3095<h3 id="addobjectobject-object"><code>addObject(object: Object)</code><a class="headerlink" href="#addobjectobject-object" title="Permanent link">#</a></h3>
3096<p>Registers a list of phrases using a plain object.</p>
3097<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3098<span class="normal">2</span>
3099<span class="normal">3</span>
3100<span class="normal">4</span>
3101<span class="normal">5</span>
3102<span class="normal">6</span>
c708394c
WG
3103<span class="normal">7</span></pre></div></td><td class="code"><div><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>
3104<span class="w"> </span><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Language&quot;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3105<span class="w"> </span><span class="nx">Language</span><span class="p">.</span><span class="nx">addObject</span><span class="p">({</span>
3106<span class="w"> </span><span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span>
3107<span class="w"> </span><span class="p">});</span>
3108<span class="w"> </span><span class="p">});</span>
9aa5da67
WG
3109<span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
3110</code></pre></div></td></tr></table></div>
3111<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>
3112<p>Retrieves a phrase by its key, optionally supporting basic template scripting
3113with dynamic variables passed using the <code>parameters</code> object.</p>
3114<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3115<span class="normal">2</span>
3116<span class="normal">3</span>
3117<span class="normal">4</span>
3118<span class="normal">5</span>
c708394c
WG
3119<span class="normal">6</span></pre></div></td><td class="code"><div><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="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">Language</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
3120<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">title</span><span class="w"> </span><span class="o">=</span><span class="w"> </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>
3121<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">content</span><span class="w"> </span><span class="o">=</span><span class="w"> </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="w"> </span><span class="p">{</span>
3122<span class="w"> </span><span class="nx">some</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span>
3123<span class="w"> </span><span class="p">});</span>
3124<span class="p">});</span>
9aa5da67
WG
3125</code></pre></div></td></tr></table></div>
3126<h2 id="stringutil"><code>StringUtil</code><a class="headerlink" href="#stringutil" title="Permanent link">#</a></h2>
3127<h3 id="escapehtmlstr-string-string"><code>escapeHTML(str: string): string</code><a class="headerlink" href="#escapehtmlstr-string-string" title="Permanent link">#</a></h3>
3128<p>Escapes special HTML characters by converting them into an HTML entity.</p>
3129<table>
3130<thead>
3131<tr>
3132<th>Character</th>
3133<th>Replacement</th>
3134</tr>
3135</thead>
3136<tbody>
3137<tr>
3138<td><code>&amp;</code></td>
3139<td><code>&amp;amp;</code></td>
3140</tr>
3141<tr>
3142<td><code>"</code></td>
3143<td><code>&amp;quot;</code></td>
3144</tr>
3145<tr>
3146<td><code>&lt;</code></td>
3147<td><code>&amp;lt;</code></td>
3148</tr>
3149<tr>
3150<td><code>&gt;</code></td>
3151<td><code>&amp;gt;</code></td>
3152</tr>
3153</tbody>
3154</table>
3155<h3 id="escaperegexpstr-string-string"><code>escapeRegExp(str: string): string</code><a class="headerlink" href="#escaperegexpstr-string-string" title="Permanent link">#</a></h3>
3156<p>Escapes a list of characters that have a special meaning in regular expressions
3157and could alter the behavior when embedded into regular expressions.</p>
3158<h3 id="lcfirststr-string-string"><code>lcfirst(str: string): string</code><a class="headerlink" href="#lcfirststr-string-string" title="Permanent link">#</a></h3>
3159<p>Makes a string's first character lowercase.</p>
3160<h3 id="ucfirststr-string-string"><code>ucfirst(str: string): string</code><a class="headerlink" href="#ucfirststr-string-string" title="Permanent link">#</a></h3>
3161<p>Makes a string's first character uppercase.</p>
3162<h3 id="unescapehtmlstr-string-string"><code>unescapeHTML(str: string): string</code><a class="headerlink" href="#unescapehtmlstr-string-string" title="Permanent link">#</a></h3>
3163<p>Converts some HTML entities into their original character. This is the reverse
3164function of <code>escapeHTML()</code>.</p>
3165
3166 <hr>
3167<div class="md-source-file">
3168 <small>
3169
3170 Last update:
3171 2021-01-08
3172
3173 </small>
3174</div>
3175
a06fd3b1
WG
3176
3177
3178
7f9945cf
WG
3179
3180
3181 </article>
3182 </div>
3183
3184
9aa5da67
WG
3185 </div>
3186
3187 </main>
3188
3189 <footer class="md-footer">
3190
9aa5da67
WG
3191 <div class="md-footer-meta md-typeset">
3192 <div class="md-footer-meta__inner md-grid">
3193 <div class="md-copyright">
3194
3195 <div class="md-copyright__highlight">
3196 Copyright © 2020 WoltLab GmbH
3197 </div>
3198
3199
3200 Made with
3201 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3202 Material for MkDocs
3203 </a>
3204
3205</div>
3206
3207 <div class="md-copyright">
3208 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3209 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3210</div>
3211
3212 </div>
3213 </div>
3214</footer>
3215
3216 </div>
3217 <div class="md-dialog" data-md-component="dialog">
3218 <div class="md-dialog__inner md-typeset"></div>
3219 </div>
a06fd3b1 3220
e06c8b5f 3221 <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
9aa5da67
WG
3222
3223
e06c8b5f 3224 <script src="../../assets/javascripts/bundle.220ee61c.min.js"></script>
9aa5da67
WG
3225
3226
3227 </body>
3228</html>