6.0/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/javascript/new-api_core/">
  12
  13
  14         <link rel="prev" href="../new-api_writing-a-module/">
  15
  16
  17         <link rel="next" href="../new-api_dom/">
  18
  19       <link rel="icon" href="../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
  21
  22
  23
  24         <title>Core Functions - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../stylesheets/extra.css">
  42
  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>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  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
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  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
 123
 124
 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
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 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>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 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
 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>
 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
 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>
 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
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 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
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 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
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 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
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 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
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 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
 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
 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
 797
 798
 799       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
 800
 801
 802
 803         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 804           TypeScript and JavaScript API
 805           <span class="md-nav__icon md-icon"></span>
 806         </label>
 807
 808       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
 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
 847
 848
 849     <li class="md-nav__item md-nav__item--nested">
 850
 851
 852
 853
 854       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 855
 856
 857
 858         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 859           Components
 860           <span class="md-nav__icon md-icon"></span>
 861         </label>
 862
 863       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 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
 875     <li class="md-nav__item">
 876       <a href="../components_confirmation/" class="md-nav__link">
 877         Confirmation
 878       </a>
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../components_dialog/" class="md-nav__link">
 891         Dialog
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903     <li class="md-nav__item">
 904       <a href="../components_google_maps/" class="md-nav__link">
 905         Google Maps
 906       </a>
 907     </li>
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917     <li class="md-nav__item">
 918       <a href="../components_pagination/" class="md-nav__link">
 919         Pagination
 920       </a>
 921     </li>
 922
 923
 924
 925
 926         </ul>
 927       </nav>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 942
 943
 944
 945
 946       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
 947
 948
 949
 950         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 951           New API
 952           <span class="md-nav__icon md-icon"></span>
 953         </label>
 954
 955       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
 956         <label class="md-nav__title" for="__nav_4_4">
 957           <span class="md-nav__icon md-icon"></span>
 958           New API
 959         </label>
 960         <ul class="md-nav__list" data-md-scrollfix>
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../new-api_writing-a-module/" class="md-nav__link">
 969         Writing a module
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983     <li class="md-nav__item md-nav__item--active">
 984
 985       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 986
 987
 988
 989
 990
 991         <label class="md-nav__link md-nav__link--active" for="__toc">
 992           Core Functions
 993           <span class="md-nav__icon md-icon"></span>
 994         </label>
 995
 996       <a href="./" class="md-nav__link md-nav__link--active">
 997         Core Functions
 998       </a>
 999
1000
1001
1002 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1003
1004
1005
1006
1007
1008
1009     <label class="md-nav__title" for="__toc">
1010       <span class="md-nav__icon md-icon"></span>
1011       Table of contents
1012     </label>
1013     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1014
1015         <li class="md-nav__item">
1016   <a href="#core" class="md-nav__link">
1017     Core
1018   </a>
1019
1020     <nav class="md-nav" aria-label="Core">
1021       <ul class="md-nav__list">
1022
1023           <li class="md-nav__item">
1024   <a href="#cloneobject-object-object" class="md-nav__link">
1025     clone(object: Object): Object
1026   </a>
1027
1028 </li>
1029
1030           <li class="md-nav__item">
1031   <a href="#extendbase-object-merge-object-object" class="md-nav__link">
1032     extend(base: Object, ...merge: Object[]): Object
1033   </a>
1034
1035 </li>
1036
1037           <li class="md-nav__item">
1038   <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
1039     inherit(base: Object, target: Object, merge?: Object)
1040   </a>
1041
1042 </li>
1043
1044           <li class="md-nav__item">
1045   <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
1046     isPlainObject(object: Object): boolean
1047   </a>
1048
1049 </li>
1050
1051           <li class="md-nav__item">
1052   <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
1053     triggerEvent(element: Element, eventName: string)
1054   </a>
1055
1056 </li>
1057
1058       </ul>
1059     </nav>
1060
1061 </li>
1062
1063         <li class="md-nav__item">
1064   <a href="#language" class="md-nav__link">
1065     Language
1066   </a>
1067
1068     <nav class="md-nav" aria-label="Language">
1069       <ul class="md-nav__list">
1070
1071           <li class="md-nav__item">
1072   <a href="#addkey-string-value-string" class="md-nav__link">
1073     add(key: string, value: string)
1074   </a>
1075
1076 </li>
1077
1078           <li class="md-nav__item">
1079   <a href="#addobjectobject-object" class="md-nav__link">
1080     addObject(object: Object)
1081   </a>
1082
1083 </li>
1084
1085           <li class="md-nav__item">
1086   <a href="#getkey-string-parameters-object-string" class="md-nav__link">
1087     get(key: string, parameters?: Object): string
1088   </a>
1089
1090 </li>
1091
1092       </ul>
1093     </nav>
1094
1095 </li>
1096
1097         <li class="md-nav__item">
1098   <a href="#stringutil" class="md-nav__link">
1099     StringUtil
1100   </a>
1101
1102     <nav class="md-nav" aria-label="StringUtil">
1103       <ul class="md-nav__list">
1104
1105           <li class="md-nav__item">
1106   <a href="#escapehtmlstr-string-string" class="md-nav__link">
1107     escapeHTML(str: string): string
1108   </a>
1109
1110 </li>
1111
1112           <li class="md-nav__item">
1113   <a href="#escaperegexpstr-string-string" class="md-nav__link">
1114     escapeRegExp(str: string): string
1115   </a>
1116
1117 </li>
1118
1119           <li class="md-nav__item">
1120   <a href="#lcfirststr-string-string" class="md-nav__link">
1121     lcfirst(str: string): string
1122   </a>
1123
1124 </li>
1125
1126           <li class="md-nav__item">
1127   <a href="#ucfirststr-string-string" class="md-nav__link">
1128     ucfirst(str: string): string
1129   </a>
1130
1131 </li>
1132
1133           <li class="md-nav__item">
1134   <a href="#unescapehtmlstr-string-string" class="md-nav__link">
1135     unescapeHTML(str: string): string
1136   </a>
1137
1138 </li>
1139
1140       </ul>
1141     </nav>
1142
1143 </li>
1144
1145     </ul>
1146
1147 </nav>
1148
1149     </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../new-api_dom/" class="md-nav__link">
1161         DOM
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173     <li class="md-nav__item">
1174       <a href="../new-api_events/" class="md-nav__link">
1175         Event Handling
1176       </a>
1177     </li>
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187     <li class="md-nav__item">
1188       <a href="../new-api_ajax/" class="md-nav__link">
1189         Ajax
1190       </a>
1191     </li>
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201     <li class="md-nav__item">
1202       <a href="../new-api_dialogs/" class="md-nav__link">
1203         Dialogs
1204       </a>
1205     </li>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item">
1216       <a href="../new-api_browser/" class="md-nav__link">
1217         Browser and Screen Sizes
1218       </a>
1219     </li>
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229     <li class="md-nav__item">
1230       <a href="../new-api_ui/" class="md-nav__link">
1231         User Interface
1232       </a>
1233     </li>
1234
1235
1236
1237
1238         </ul>
1239       </nav>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250     <li class="md-nav__item">
1251       <a href="../legacy-api/" class="md-nav__link">
1252         Legacy API
1253       </a>
1254     </li>
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../code-snippets/" class="md-nav__link">
1266         Code Snippets
1267       </a>
1268     </li>
1269
1270
1271
1272
1273         </ul>
1274       </nav>
1275     </li>
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item md-nav__item--nested">
1288
1289
1290
1291
1292       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1293
1294
1295
1296         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1297           Package Components
1298           <span class="md-nav__icon md-icon"></span>
1299         </label>
1300
1301       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1302         <label class="md-nav__title" for="__nav_5">
1303           <span class="md-nav__icon md-icon"></span>
1304           Package Components
1305         </label>
1306         <ul class="md-nav__list" data-md-scrollfix>
1307
1308
1309
1310
1311
1312
1313     <li class="md-nav__item">
1314       <a href="../../package/package-xml/" class="md-nav__link">
1315         package.xml
1316       </a>
1317     </li>
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328     <li class="md-nav__item md-nav__item--nested">
1329
1330
1331
1332
1333       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1334
1335
1336
1337         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1338           PIPs
1339           <span class="md-nav__icon md-icon"></span>
1340         </label>
1341
1342       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1343         <label class="md-nav__title" for="__nav_5_2">
1344           <span class="md-nav__icon md-icon"></span>
1345           PIPs
1346         </label>
1347         <ul class="md-nav__list" data-md-scrollfix>
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../package/pip/" class="md-nav__link">
1356         Overview
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../package/pip/acl-option/" class="md-nav__link">
1370         aclOption
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1384         acpMenu
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-search-provider/" class="md-nav__link">
1398         acpSearchProvider
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-template/" class="md-nav__link">
1412         acpTemplate
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-delete/" class="md-nav__link">
1426         acpTemplateDelete
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../package/pip/bbcode/" class="md-nav__link">
1440         bbcode
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../package/pip/box/" class="md-nav__link">
1454         box
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1468         clipboardAction
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../../package/pip/core-object/" class="md-nav__link">
1482         coreObject
1483       </a>
1484     </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../../package/pip/cronjob/" class="md-nav__link">
1496         cronjob
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item">
1509       <a href="../../package/pip/database/" class="md-nav__link">
1510         database
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../package/pip/event-listener/" class="md-nav__link">
1524         eventListener
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../package/pip/file/" class="md-nav__link">
1538         file
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-delete/" class="md-nav__link">
1552         fileDelete
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../package/pip/language/" class="md-nav__link">
1566         language
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../../package/pip/media-provider/" class="md-nav__link">
1580         mediaProvider
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../package/pip/menu/" class="md-nav__link">
1594         menu
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-item/" class="md-nav__link">
1608         menuItem
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../package/pip/object-type/" class="md-nav__link">
1622         objectType
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-definition/" class="md-nav__link">
1636         objectTypeDefinition
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../package/pip/option/" class="md-nav__link">
1650         option
1651       </a>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../package/pip/page/" class="md-nav__link">
1664         page
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../package/pip/pip/" class="md-nav__link">
1678         pip
1679       </a>
1680     </li>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690     <li class="md-nav__item">
1691       <a href="../../package/pip/script/" class="md-nav__link">
1692         script
1693       </a>
1694     </li>
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704     <li class="md-nav__item">
1705       <a href="../../package/pip/smiley/" class="md-nav__link">
1706         smiley
1707       </a>
1708     </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718     <li class="md-nav__item">
1719       <a href="../../package/pip/sql/" class="md-nav__link">
1720         sql
1721       </a>
1722     </li>
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732     <li class="md-nav__item">
1733       <a href="../../package/pip/style/" class="md-nav__link">
1734         style
1735       </a>
1736     </li>
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746     <li class="md-nav__item">
1747       <a href="../../package/pip/template/" class="md-nav__link">
1748         template
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-delete/" class="md-nav__link">
1762         templateDelete
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-listener/" class="md-nav__link">
1776         templateListener
1777       </a>
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788     <li class="md-nav__item">
1789       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1790         userGroupOption
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-menu/" class="md-nav__link">
1804         userMenu
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-notification-event/" class="md-nav__link">
1818         userNotificationEvent
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-option/" class="md-nav__link">
1832         userOption
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-profile-menu/" class="md-nav__link">
1846         userProfileMenu
1847       </a>
1848     </li>
1849
1850
1851
1852
1853         </ul>
1854       </nav>
1855     </li>
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865     <li class="md-nav__item">
1866       <a href="../../package/database-php-api/" class="md-nav__link">
1867         Database PHP API
1868       </a>
1869     </li>
1870
1871
1872
1873
1874         </ul>
1875       </nav>
1876     </li>
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888     <li class="md-nav__item md-nav__item--nested">
1889
1890
1891
1892
1893       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1894
1895
1896
1897         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1898           Migration
1899           <span class="md-nav__icon md-icon"></span>
1900         </label>
1901
1902       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1903         <label class="md-nav__title" for="__nav_6">
1904           <span class="md-nav__icon md-icon"></span>
1905           Migration
1906         </label>
1907         <ul class="md-nav__list" data-md-scrollfix>
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item md-nav__item--nested">
1916
1917
1918
1919
1920       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1921
1922
1923
1924         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1925           From WoltLab Suite 5.5
1926           <span class="md-nav__icon md-icon"></span>
1927         </label>
1928
1929       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1930         <label class="md-nav__title" for="__nav_6_1">
1931           <span class="md-nav__icon md-icon"></span>
1932           From WoltLab Suite 5.5
1933         </label>
1934         <ul class="md-nav__list" data-md-scrollfix>
1935
1936
1937
1938
1939
1940
1941     <li class="md-nav__item">
1942       <a href="../../migration/wsc55/php/" class="md-nav__link">
1943         PHP API
1944       </a>
1945     </li>
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955     <li class="md-nav__item">
1956       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1957         TypeScript and JavaScript
1958       </a>
1959     </li>
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969     <li class="md-nav__item">
1970       <a href="../../migration/wsc55/templates/" class="md-nav__link">
1971         Templates
1972       </a>
1973     </li>
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983     <li class="md-nav__item">
1984       <a href="../../migration/wsc55/icons/" class="md-nav__link">
1985         Icons
1986       </a>
1987     </li>
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997     <li class="md-nav__item">
1998       <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
1999         Dialogs
2000       </a>
2001     </li>
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011     <li class="md-nav__item">
2012       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
2013         Third Party Libraries
2014       </a>
2015     </li>
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025     <li class="md-nav__item">
2026       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2027         Deprecations and Removals
2028       </a>
2029     </li>
2030
2031
2032
2033
2034         </ul>
2035       </nav>
2036     </li>
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047     <li class="md-nav__item md-nav__item--nested">
2048
2049
2050
2051
2052       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2053
2054
2055
2056         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2057           From WoltLab Suite 5.4
2058           <span class="md-nav__icon md-icon"></span>
2059         </label>
2060
2061       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2062         <label class="md-nav__title" for="__nav_6_2">
2063           <span class="md-nav__icon md-icon"></span>
2064           From WoltLab Suite 5.4
2065         </label>
2066         <ul class="md-nav__list" data-md-scrollfix>
2067
2068
2069
2070
2071
2072
2073     <li class="md-nav__item">
2074       <a href="../../migration/wsc54/php/" class="md-nav__link">
2075         PHP API
2076       </a>
2077     </li>
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087     <li class="md-nav__item">
2088       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
2089         TypeScript and JavaScript
2090       </a>
2091     </li>
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101     <li class="md-nav__item">
2102       <a href="../../migration/wsc54/templates/" class="md-nav__link">
2103         Templates
2104       </a>
2105     </li>
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115     <li class="md-nav__item">
2116       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
2117         Third Party Libraries
2118       </a>
2119     </li>
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129     <li class="md-nav__item">
2130       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2131         Deprecations and Removals
2132       </a>
2133     </li>
2134
2135
2136
2137
2138         </ul>
2139       </nav>
2140     </li>
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151     <li class="md-nav__item md-nav__item--nested">
2152
2153
2154
2155
2156       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2157
2158
2159
2160         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2161           From WoltLab Suite 5.3
2162           <span class="md-nav__icon md-icon"></span>
2163         </label>
2164
2165       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2166         <label class="md-nav__title" for="__nav_6_3">
2167           <span class="md-nav__icon md-icon"></span>
2168           From WoltLab Suite 5.3
2169         </label>
2170         <ul class="md-nav__list" data-md-scrollfix>
2171
2172
2173
2174
2175
2176
2177     <li class="md-nav__item">
2178       <a href="../../migration/wsc53/php/" class="md-nav__link">
2179         PHP API
2180       </a>
2181     </li>
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191     <li class="md-nav__item">
2192       <a href="../../migration/wsc53/session/" class="md-nav__link">
2193         Session Handling and Authentication
2194       </a>
2195     </li>
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205     <li class="md-nav__item">
2206       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2207         TypeScript and JavaScript
2208       </a>
2209     </li>
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219     <li class="md-nav__item">
2220       <a href="../../migration/wsc53/templates/" class="md-nav__link">
2221         Templates
2222       </a>
2223     </li>
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233     <li class="md-nav__item">
2234       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2235         Third Party Libraries
2236       </a>
2237     </li>
2238
2239
2240
2241
2242         </ul>
2243       </nav>
2244     </li>
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255     <li class="md-nav__item md-nav__item--nested">
2256
2257
2258
2259
2260       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2261
2262
2263
2264         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2265           From WoltLab Suite 5.2
2266           <span class="md-nav__icon md-icon"></span>
2267         </label>
2268
2269       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2270         <label class="md-nav__title" for="__nav_6_4">
2271           <span class="md-nav__icon md-icon"></span>
2272           From WoltLab Suite 5.2
2273         </label>
2274         <ul class="md-nav__list" data-md-scrollfix>
2275
2276
2277
2278
2279
2280
2281     <li class="md-nav__item">
2282       <a href="../../migration/wsc52/php/" class="md-nav__link">
2283         PHP API
2284       </a>
2285     </li>
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295     <li class="md-nav__item">
2296       <a href="../../migration/wsc52/templates/" class="md-nav__link">
2297         Templates and Languages
2298       </a>
2299     </li>
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309     <li class="md-nav__item">
2310       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2311         Third Party Libraries
2312       </a>
2313     </li>
2314
2315
2316
2317
2318         </ul>
2319       </nav>
2320     </li>
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331     <li class="md-nav__item md-nav__item--nested">
2332
2333
2334
2335
2336       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2337
2338
2339
2340         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2341           From WoltLab Suite 3.1
2342           <span class="md-nav__icon md-icon"></span>
2343         </label>
2344
2345       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2346         <label class="md-nav__title" for="__nav_6_5">
2347           <span class="md-nav__icon md-icon"></span>
2348           From WoltLab Suite 3.1
2349         </label>
2350         <ul class="md-nav__list" data-md-scrollfix>
2351
2352
2353
2354
2355
2356
2357     <li class="md-nav__item">
2358       <a href="../../migration/wsc31/php/" class="md-nav__link">
2359         PHP API
2360       </a>
2361     </li>
2362
2363
2364
2365
2366         </ul>
2367       </nav>
2368     </li>
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379     <li class="md-nav__item md-nav__item--nested">
2380
2381
2382
2383
2384       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2385
2386
2387
2388         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2389           From WoltLab Suite 3.0
2390           <span class="md-nav__icon md-icon"></span>
2391         </label>
2392
2393       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2394         <label class="md-nav__title" for="__nav_6_6">
2395           <span class="md-nav__icon md-icon"></span>
2396           From WoltLab Suite 3.0
2397         </label>
2398         <ul class="md-nav__list" data-md-scrollfix>
2399
2400
2401
2402
2403
2404
2405     <li class="md-nav__item">
2406       <a href="../../migration/wsc30/php/" class="md-nav__link">
2407         PHP API
2408       </a>
2409     </li>
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419     <li class="md-nav__item">
2420       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2421         JavaScript 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/templates/" class="md-nav__link">
2435         Templates
2436       </a>
2437     </li>
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447     <li class="md-nav__item">
2448       <a href="../../migration/wsc30/css/" class="md-nav__link">
2449         CSS
2450       </a>
2451     </li>
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461     <li class="md-nav__item">
2462       <a href="../../migration/wsc30/package/" class="md-nav__link">
2463         Package Components
2464       </a>
2465     </li>
2466
2467
2468
2469
2470         </ul>
2471       </nav>
2472     </li>
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483     <li class="md-nav__item md-nav__item--nested">
2484
2485
2486
2487
2488       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2489
2490
2491
2492         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2493           From WCF 2.1
2494           <span class="md-nav__icon md-icon"></span>
2495         </label>
2496
2497       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2498         <label class="md-nav__title" for="__nav_6_7">
2499           <span class="md-nav__icon md-icon"></span>
2500           From WCF 2.1
2501         </label>
2502         <ul class="md-nav__list" data-md-scrollfix>
2503
2504
2505
2506
2507
2508
2509     <li class="md-nav__item">
2510       <a href="../../migration/wcf21/php/" class="md-nav__link">
2511         PHP API
2512       </a>
2513     </li>
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523     <li class="md-nav__item">
2524       <a href="../../migration/wcf21/templates/" class="md-nav__link">
2525         Templates
2526       </a>
2527     </li>
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537     <li class="md-nav__item">
2538       <a href="../../migration/wcf21/css/" class="md-nav__link">
2539         CSS
2540       </a>
2541     </li>
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551     <li class="md-nav__item">
2552       <a href="../../migration/wcf21/package/" class="md-nav__link">
2553         Package Components
2554       </a>
2555     </li>
2556
2557
2558
2559
2560         </ul>
2561       </nav>
2562     </li>
2563
2564
2565
2566
2567         </ul>
2568       </nav>
2569     </li>
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581     <li class="md-nav__item md-nav__item--nested">
2582
2583
2584
2585
2586       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2587
2588
2589
2590         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2591           Tutorials
2592           <span class="md-nav__icon md-icon"></span>
2593         </label>
2594
2595       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2596         <label class="md-nav__title" for="__nav_7">
2597           <span class="md-nav__icon md-icon"></span>
2598           Tutorials
2599         </label>
2600         <ul class="md-nav__list" data-md-scrollfix>
2601
2602
2603
2604
2605
2606
2607
2608     <li class="md-nav__item md-nav__item--nested">
2609
2610
2611
2612
2613       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2614
2615
2616
2617         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2618           Tutorial Series
2619           <span class="md-nav__icon md-icon"></span>
2620         </label>
2621
2622       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2623         <label class="md-nav__title" for="__nav_7_1">
2624           <span class="md-nav__icon md-icon"></span>
2625           Tutorial Series
2626         </label>
2627         <ul class="md-nav__list" data-md-scrollfix>
2628
2629
2630
2631
2632
2633
2634     <li class="md-nav__item">
2635       <a href="../../tutorial/series/overview/" class="md-nav__link">
2636         Overview
2637       </a>
2638     </li>
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648     <li class="md-nav__item">
2649       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2650         Part 1
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_2/" class="md-nav__link">
2664         Part 2
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_3/" class="md-nav__link">
2678         Part 3
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_4/" class="md-nav__link">
2692         Part 4
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_5/" class="md-nav__link">
2706         Part 5
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_6/" class="md-nav__link">
2720         Part 6
2721       </a>
2722     </li>
2723
2724
2725
2726
2727         </ul>
2728       </nav>
2729     </li>
2730
2731
2732
2733
2734         </ul>
2735       </nav>
2736     </li>
2737
2738
2739
2740   </ul>
2741 </nav>
2742                   </div>
2743                 </div>
2744               </div>
2745
2746
2747
2748               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2749                 <div class="md-sidebar__scrollwrap">
2750                   <div class="md-sidebar__inner">
2751
2752
2753 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2754
2755
2756
2757
2758
2759
2760     <label class="md-nav__title" for="__toc">
2761       <span class="md-nav__icon md-icon"></span>
2762       Table of contents
2763     </label>
2764     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2765
2766         <li class="md-nav__item">
2767   <a href="#core" class="md-nav__link">
2768     Core
2769   </a>
2770
2771     <nav class="md-nav" aria-label="Core">
2772       <ul class="md-nav__list">
2773
2774           <li class="md-nav__item">
2775   <a href="#cloneobject-object-object" class="md-nav__link">
2776     clone(object: Object): Object
2777   </a>
2778
2779 </li>
2780
2781           <li class="md-nav__item">
2782   <a href="#extendbase-object-merge-object-object" class="md-nav__link">
2783     extend(base: Object, ...merge: Object[]): Object
2784   </a>
2785
2786 </li>
2787
2788           <li class="md-nav__item">
2789   <a href="#inheritbase-object-target-object-merge-object" class="md-nav__link">
2790     inherit(base: Object, target: Object, merge?: Object)
2791   </a>
2792
2793 </li>
2794
2795           <li class="md-nav__item">
2796   <a href="#isplainobjectobject-object-boolean" class="md-nav__link">
2797     isPlainObject(object: Object): boolean
2798   </a>
2799
2800 </li>
2801
2802           <li class="md-nav__item">
2803   <a href="#triggereventelement-element-eventname-string" class="md-nav__link">
2804     triggerEvent(element: Element, eventName: string)
2805   </a>
2806
2807 </li>
2808
2809       </ul>
2810     </nav>
2811
2812 </li>
2813
2814         <li class="md-nav__item">
2815   <a href="#language" class="md-nav__link">
2816     Language
2817   </a>
2818
2819     <nav class="md-nav" aria-label="Language">
2820       <ul class="md-nav__list">
2821
2822           <li class="md-nav__item">
2823   <a href="#addkey-string-value-string" class="md-nav__link">
2824     add(key: string, value: string)
2825   </a>
2826
2827 </li>
2828
2829           <li class="md-nav__item">
2830   <a href="#addobjectobject-object" class="md-nav__link">
2831     addObject(object: Object)
2832   </a>
2833
2834 </li>
2835
2836           <li class="md-nav__item">
2837   <a href="#getkey-string-parameters-object-string" class="md-nav__link">
2838     get(key: string, parameters?: Object): string
2839   </a>
2840
2841 </li>
2842
2843       </ul>
2844     </nav>
2845
2846 </li>
2847
2848         <li class="md-nav__item">
2849   <a href="#stringutil" class="md-nav__link">
2850     StringUtil
2851   </a>
2852
2853     <nav class="md-nav" aria-label="StringUtil">
2854       <ul class="md-nav__list">
2855
2856           <li class="md-nav__item">
2857   <a href="#escapehtmlstr-string-string" class="md-nav__link">
2858     escapeHTML(str: string): string
2859   </a>
2860
2861 </li>
2862
2863           <li class="md-nav__item">
2864   <a href="#escaperegexpstr-string-string" class="md-nav__link">
2865     escapeRegExp(str: string): string
2866   </a>
2867
2868 </li>
2869
2870           <li class="md-nav__item">
2871   <a href="#lcfirststr-string-string" class="md-nav__link">
2872     lcfirst(str: string): string
2873   </a>
2874
2875 </li>
2876
2877           <li class="md-nav__item">
2878   <a href="#ucfirststr-string-string" class="md-nav__link">
2879     ucfirst(str: string): string
2880   </a>
2881
2882 </li>
2883
2884           <li class="md-nav__item">
2885   <a href="#unescapehtmlstr-string-string" class="md-nav__link">
2886     unescapeHTML(str: string): string
2887   </a>
2888
2889 </li>
2890
2891       </ul>
2892     </nav>
2893
2894 </li>
2895
2896     </ul>
2897
2898 </nav>
2899                   </div>
2900                 </div>
2901               </div>
2902
2903
2904
2905             <div class="md-content" data-md-component="content">
2906               <article class="md-content__inner md-typeset">
2907
2908
2909
2910
2911
2912
2913
2914 <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>
2915 <p>A brief overview of common methods that may be useful when writing any module.</p>
2916 <h2 id="core"><code>Core</code><a class="headerlink" href="#core" title="Permanent link">#</a></h2>
2917 <h3 id="cloneobject-object-object"><code>clone(object: Object): Object</code><a class="headerlink" href="#cloneobject-object-object" title="Permanent link">#</a></h3>
2918 <p>Creates a deep-clone of the provided object by value, removing any references on
2919 the original element, including arrays. However, this does not clone references
2920 to non-plain objects, these instances will be copied by reference.</p>
2921 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2922 <span class="normal">2</span>
2923 <span class="normal">3</span>
2924 <span class="normal">4</span>
2925 <span class="normal">5</span>
2926 <span class="normal">6</span>
2927 <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>
2928 <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>
2929 <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>
2930
2931 <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>
2932 <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>
2933 <span class="p">});</span>
2934 </code></pre></div></td></tr></table></div>
2935 <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>
2936 <p>Accepts an infinite amount of plain objects as parameters, values will be copied
2937 from the 2nd...nth object into the first object. The first parameter will be
2938 cloned and the resulting object is returned.</p>
2939 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2940 <span class="normal"> 2</span>
2941 <span class="normal"> 3</span>
2942 <span class="normal"> 4</span>
2943 <span class="normal"> 5</span>
2944 <span class="normal"> 6</span>
2945 <span class="normal"> 7</span>
2946 <span class="normal"> 8</span>
2947 <span class="normal"> 9</span>
2948 <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>
2949 <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>
2950 <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>
2951 <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>
2952 <span class="w">    </span><span class="nx">b</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span>
2953 <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>
2954
2955 <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>
2956 <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>
2957 <span class="p">});</span>
2958 </code></pre></div></td></tr></table></div>
2959 <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>
2960 <p>Derives the second object's prototype from the first object, afterwards the
2961 derived class will pass the <code>instanceof</code> check against the original class.</p>
2962 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2963 <span class="normal"> 2</span>
2964 <span class="normal"> 3</span>
2965 <span class="normal"> 4</span>
2966 <span class="normal"> 5</span>
2967 <span class="normal"> 6</span>
2968 <span class="normal"> 7</span>
2969 <span class="normal"> 8</span>
2970 <span class="normal"> 9</span>
2971 <span class="normal">10</span>
2972 <span class="normal">11</span>
2973 <span class="normal">12</span>
2974 <span class="normal">13</span>
2975 <span class="normal">14</span>
2976 <span class="normal">15</span>
2977 <span class="normal">16</span>
2978 <span class="normal">17</span>
2979 <span class="normal">18</span>
2980 <span class="normal">19</span>
2981 <span class="normal">20</span>
2982 <span class="normal">21</span>
2983 <span class="normal">22</span>
2984 <span class="normal">23</span>
2985 <span class="normal">24</span>
2986 <span class="normal">25</span>
2987 <span class="normal">26</span>
2988 <span class="normal">27</span>
2989 <span class="normal">28</span>
2990 <span class="normal">29</span>
2991 <span class="normal">30</span>
2992 <span class="normal">31</span>
2993 <span class="normal">32</span>
2994 <span class="normal">33</span>
2995 <span class="normal">34</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="c1">// App.js</span>
2996 <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>
2997 <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>
2998 <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>
2999 <span class="p">});</span>
3000 <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>
3001 <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>
3002 <span class="p">});</span>
3003
3004 <span class="c1">// --- NEW API ---</span>
3005
3006 <span class="c1">// App/Foo.js</span>
3007 <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>
3008 <span class="w">  </span><span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
3009
3010 <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>
3011 <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>
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="w">  </span><span class="p">};</span>
3014
3015 <span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="nx">Foo</span><span class="p">;</span>
3016 <span class="p">});</span>
3017
3018 <span class="c1">// App/Baz.js</span>
3019 <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>
3020 <span class="w">  </span><span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
3021
3022 <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>
3023 <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>
3024 <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>
3025 <span class="w">  </span><span class="p">});</span>
3026
3027 <span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="nx">Baz</span><span class="p">;</span>
3028 <span class="p">});</span>
3029 </code></pre></div></td></tr></table></div>
3030 <h3 id="isplainobjectobject-object-boolean"><code>isPlainObject(object: Object): boolean</code><a class="headerlink" href="#isplainobjectobject-object-boolean" title="Permanent link">#</a></h3>
3031 <p>Verifies if an object is a plain JavaScript object and not an object instance.</p>
3032 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3033 <span class="normal"> 2</span>
3034 <span class="normal"> 3</span>
3035 <span class="normal"> 4</span>
3036 <span class="normal"> 5</span>
3037 <span class="normal"> 6</span>
3038 <span class="normal"> 7</span>
3039 <span class="normal"> 8</span>
3040 <span class="normal"> 9</span>
3041 <span class="normal">10</span>
3042 <span class="normal">11</span>
3043 <span class="normal">12</span>
3044 <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>
3045 <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>
3046 <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>
3047 <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>
3048 <span class="w">  </span><span class="p">};</span>
3049
3050 <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>
3051 <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>
3052
3053 <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>
3054 <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>
3055 <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>
3056 <span class="p">});</span>
3057 </code></pre></div></td></tr></table></div>
3058 <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>
3059 <p>Creates and dispatches a synthetic JavaScript event on an element.</p>
3060 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3061 <span class="normal">2</span>
3062 <span class="normal">3</span>
3063 <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>
3064 <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>
3065 <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>
3066 <span class="p">});</span>
3067 </code></pre></div></td></tr></table></div>
3068 <h2 id="language"><code>Language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2>
3069 <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>
3070 <p>Registers a new phrase.</p>
3071 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3072 <span class="normal">2</span>
3073 <span class="normal">3</span>
3074 <span class="normal">4</span>
3075 <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>
3076 <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>
3077 <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>
3078 <span class="w">  </span><span class="p">});</span>
3079 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
3080 </code></pre></div></td></tr></table></div>
3081 <h3 id="addobjectobject-object"><code>addObject(object: Object)</code><a class="headerlink" href="#addobjectobject-object" title="Permanent link">#</a></h3>
3082 <p>Registers a list of phrases using a plain object.</p>
3083 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3084 <span class="normal">2</span>
3085 <span class="normal">3</span>
3086 <span class="normal">4</span>
3087 <span class="normal">5</span>
3088 <span class="normal">6</span>
3089 <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>
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">addObject</span><span class="p">({</span>
3092 <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>
3093 <span class="w">    </span><span class="p">});</span>
3094 <span class="w">  </span><span class="p">});</span>
3095 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
3096 </code></pre></div></td></tr></table></div>
3097 <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>
3098 <p>Retrieves a phrase by its key, optionally supporting basic template scripting
3099 with dynamic variables passed using the <code>parameters</code> object.</p>
3100 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3101 <span class="normal">2</span>
3102 <span class="normal">3</span>
3103 <span class="normal">4</span>
3104 <span class="normal">5</span>
3105 <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>
3106 <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>
3107 <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>
3108 <span class="w">    </span><span class="nx">some</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span>
3109 <span class="w">  </span><span class="p">});</span>
3110 <span class="p">});</span>
3111 </code></pre></div></td></tr></table></div>
3112 <h2 id="stringutil"><code>StringUtil</code><a class="headerlink" href="#stringutil" title="Permanent link">#</a></h2>
3113 <h3 id="escapehtmlstr-string-string"><code>escapeHTML(str: string): string</code><a class="headerlink" href="#escapehtmlstr-string-string" title="Permanent link">#</a></h3>
3114 <p>Escapes special HTML characters by converting them into an HTML entity.</p>
3115 <table>
3116 <thead>
3117 <tr>
3118 <th>Character</th>
3119 <th>Replacement</th>
3120 </tr>
3121 </thead>
3122 <tbody>
3123 <tr>
3124 <td><code>&amp;</code></td>
3125 <td><code>&amp;amp;</code></td>
3126 </tr>
3127 <tr>
3128 <td><code>"</code></td>
3129 <td><code>&amp;quot;</code></td>
3130 </tr>
3131 <tr>
3132 <td><code>&lt;</code></td>
3133 <td><code>&amp;lt;</code></td>
3134 </tr>
3135 <tr>
3136 <td><code>&gt;</code></td>
3137 <td><code>&amp;gt;</code></td>
3138 </tr>
3139 </tbody>
3140 </table>
3141 <h3 id="escaperegexpstr-string-string"><code>escapeRegExp(str: string): string</code><a class="headerlink" href="#escaperegexpstr-string-string" title="Permanent link">#</a></h3>
3142 <p>Escapes a list of characters that have a special meaning in regular expressions
3143 and could alter the behavior when embedded into regular expressions.</p>
3144 <h3 id="lcfirststr-string-string"><code>lcfirst(str: string): string</code><a class="headerlink" href="#lcfirststr-string-string" title="Permanent link">#</a></h3>
3145 <p>Makes a string's first character lowercase.</p>
3146 <h3 id="ucfirststr-string-string"><code>ucfirst(str: string): string</code><a class="headerlink" href="#ucfirststr-string-string" title="Permanent link">#</a></h3>
3147 <p>Makes a string's first character uppercase.</p>
3148 <h3 id="unescapehtmlstr-string-string"><code>unescapeHTML(str: string): string</code><a class="headerlink" href="#unescapehtmlstr-string-string" title="Permanent link">#</a></h3>
3149 <p>Converts some HTML entities into their original character. This is the reverse
3150 function of <code>escapeHTML()</code>.</p>
3151
3152   <hr>
3153 <div class="md-source-file">
3154   <small>
3155
3156       Last update:
3157       2021-01-08
3158
3159   </small>
3160 </div>
3161
3162
3163
3164
3165
3166
3167               </article>
3168             </div>
3169
3170
3171         </div>
3172
3173       </main>
3174
3175         <footer class="md-footer">
3176
3177   <div class="md-footer-meta md-typeset">
3178     <div class="md-footer-meta__inner md-grid">
3179       <div class="md-copyright">
3180
3181     <div class="md-copyright__highlight">
3182       Copyright © 2020 WoltLab GmbH
3183     </div>
3184
3185
3186     Made with
3187     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3188       Material for MkDocs
3189     </a>
3190
3191 </div>
3192
3193         <div class="md-copyright">
3194         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3195         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3196 </div>
3197
3198     </div>
3199   </div>
3200 </footer>
3201
3202     </div>
3203     <div class="md-dialog" data-md-component="dialog">
3204       <div class="md-dialog__inner md-typeset"></div>
3205     </div>
3206
3207     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.208ed371.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>
3208
3209
3210       <script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>
3211
3212
3213   </body>
3214 </html>