latest/javascript/new-api_core/index.html

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