6.0/php/api/form_builder/overview/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/php/api/form_builder/overview/">
  12
  13
  14         <link rel="prev" href="../../events/">
  15
  16
  17         <link rel="next" href="../structure/">
  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>Overview - 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="#form-builder" 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               Overview
 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
 243
 244     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 245
 246
 247
 248
 249       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
 250
 251
 252
 253         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 254           PHP API
 255           <span class="md-nav__icon md-icon"></span>
 256         </label>
 257
 258       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
 259         <label class="md-nav__title" for="__nav_2">
 260           <span class="md-nav__icon md-icon"></span>
 261           PHP API
 262         </label>
 263         <ul class="md-nav__list" data-md-scrollfix>
 264
 265
 266
 267
 268
 269
 270     <li class="md-nav__item">
 271       <a href="../../../pages/" class="md-nav__link">
 272         Pages
 273       </a>
 274     </li>
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284     <li class="md-nav__item">
 285       <a href="../../../database-objects/" class="md-nav__link">
 286         Database Objects
 287       </a>
 288     </li>
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298     <li class="md-nav__item">
 299       <a href="../../../database-access/" class="md-nav__link">
 300         Database Access
 301       </a>
 302     </li>
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312     <li class="md-nav__item">
 313       <a href="../../../exceptions/" class="md-nav__link">
 314         Exceptions
 315       </a>
 316     </li>
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 330
 331
 332
 333
 334       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" checked>
 335
 336
 337
 338         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 339           API
 340           <span class="md-nav__icon md-icon"></span>
 341         </label>
 342
 343       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="true">
 344         <label class="md-nav__title" for="__nav_2_5">
 345           <span class="md-nav__icon md-icon"></span>
 346           API
 347         </label>
 348         <ul class="md-nav__list" data-md-scrollfix>
 349
 350
 351
 352
 353
 354
 355
 356     <li class="md-nav__item md-nav__item--nested">
 357
 358
 359
 360
 361       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 362
 363
 364
 365         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 366           Caches
 367           <span class="md-nav__icon md-icon"></span>
 368         </label>
 369
 370       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 371         <label class="md-nav__title" for="__nav_2_5_1">
 372           <span class="md-nav__icon md-icon"></span>
 373           Caches
 374         </label>
 375         <ul class="md-nav__list" data-md-scrollfix>
 376
 377
 378
 379
 380
 381
 382     <li class="md-nav__item">
 383       <a href="../../caches/" class="md-nav__link">
 384         Overview
 385       </a>
 386     </li>
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../caches_persistent-caches/" class="md-nav__link">
 398         Persistent Caches
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410     <li class="md-nav__item">
 411       <a href="../../caches_runtime-caches/" class="md-nav__link">
 412         Runtime Caches
 413       </a>
 414     </li>
 415
 416
 417
 418
 419         </ul>
 420       </nav>
 421     </li>
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431     <li class="md-nav__item">
 432       <a href="../../comments/" class="md-nav__link">
 433         Comments
 434       </a>
 435     </li>
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445     <li class="md-nav__item">
 446       <a href="../../cronjobs/" class="md-nav__link">
 447         Cronjobs
 448       </a>
 449     </li>
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459     <li class="md-nav__item">
 460       <a href="../../events/" class="md-nav__link">
 461         Events
 462       </a>
 463     </li>
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 477
 478
 479
 480
 481       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" checked>
 482
 483
 484
 485         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 486           Form Builder
 487           <span class="md-nav__icon md-icon"></span>
 488         </label>
 489
 490       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="true">
 491         <label class="md-nav__title" for="__nav_2_5_5">
 492           <span class="md-nav__icon md-icon"></span>
 493           Form Builder
 494         </label>
 495         <ul class="md-nav__list" data-md-scrollfix>
 496
 497
 498
 499
 500
 501
 502
 503
 504     <li class="md-nav__item md-nav__item--active">
 505
 506       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 507
 508
 509
 510
 511
 512         <label class="md-nav__link md-nav__link--active" for="__toc">
 513           Overview
 514           <span class="md-nav__icon md-icon"></span>
 515         </label>
 516
 517       <a href="./" class="md-nav__link md-nav__link--active">
 518         Overview
 519       </a>
 520
 521
 522
 523 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 524
 525
 526
 527
 528
 529
 530     <label class="md-nav__title" for="__toc">
 531       <span class="md-nav__icon md-icon"></span>
 532       Table of contents
 533     </label>
 534     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 535
 536         <li class="md-nav__item">
 537   <a href="#form-builder-components" class="md-nav__link">
 538     Form Builder Components
 539   </a>
 540
 541 </li>
 542
 543         <li class="md-nav__item">
 544   <a href="#abstractformbuilderform" class="md-nav__link">
 545     AbstractFormBuilderForm
 546   </a>
 547
 548 </li>
 549
 550         <li class="md-nav__item">
 551   <a href="#dialogformdocument" class="md-nav__link">
 552     DialogFormDocument
 553   </a>
 554
 555 </li>
 556
 557     </ul>
 558
 559 </nav>
 560
 561     </li>
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571     <li class="md-nav__item">
 572       <a href="../structure/" class="md-nav__link">
 573         Structure
 574       </a>
 575     </li>
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585     <li class="md-nav__item">
 586       <a href="../form_fields/" class="md-nav__link">
 587         Fields
 588       </a>
 589     </li>
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599     <li class="md-nav__item">
 600       <a href="../validation_data/" class="md-nav__link">
 601         Validation and Data
 602       </a>
 603     </li>
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613     <li class="md-nav__item">
 614       <a href="../dependencies/" class="md-nav__link">
 615         Dependencies
 616       </a>
 617     </li>
 618
 619
 620
 621
 622         </ul>
 623       </nav>
 624     </li>
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634     <li class="md-nav__item">
 635       <a href="../../package_installation_plugins/" class="md-nav__link">
 636         Package Installation Plugins
 637       </a>
 638     </li>
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648     <li class="md-nav__item">
 649       <a href="../../user_activity_points/" class="md-nav__link">
 650         User Activity Points
 651       </a>
 652     </li>
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662     <li class="md-nav__item">
 663       <a href="../../user_notifications/" class="md-nav__link">
 664         User Notifications
 665       </a>
 666     </li>
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676     <li class="md-nav__item">
 677       <a href="../../sitemaps/" class="md-nav__link">
 678         Sitemaps
 679       </a>
 680     </li>
 681
 682
 683
 684
 685         </ul>
 686       </nav>
 687     </li>
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697     <li class="md-nav__item">
 698       <a href="../../../code-style/" class="md-nav__link">
 699         Code Style
 700       </a>
 701     </li>
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../apps/" class="md-nav__link">
 713         Apps
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725     <li class="md-nav__item">
 726       <a href="../../../gdpr/" class="md-nav__link">
 727         GDPR
 728       </a>
 729     </li>
 730
 731
 732
 733
 734         </ul>
 735       </nav>
 736     </li>
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748     <li class="md-nav__item md-nav__item--nested">
 749
 750
 751
 752
 753       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 754
 755
 756
 757         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 758           Languages, Templates & CSS
 759           <span class="md-nav__icon md-icon"></span>
 760         </label>
 761
 762       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 763         <label class="md-nav__title" for="__nav_3">
 764           <span class="md-nav__icon md-icon"></span>
 765           Languages, Templates & CSS
 766         </label>
 767         <ul class="md-nav__list" data-md-scrollfix>
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../../view/languages/" class="md-nav__link">
 776         Languages
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788     <li class="md-nav__item">
 789       <a href="../../../../view/templates/" class="md-nav__link">
 790         Templates
 791       </a>
 792     </li>
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802     <li class="md-nav__item">
 803       <a href="../../../../view/template-modifiers/" class="md-nav__link">
 804         Template Modifiers
 805       </a>
 806     </li>
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816     <li class="md-nav__item">
 817       <a href="../../../../view/template-plugins/" class="md-nav__link">
 818         Template Plugins
 819       </a>
 820     </li>
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830     <li class="md-nav__item">
 831       <a href="../../../../view/css/" class="md-nav__link">
 832         CSS
 833       </a>
 834     </li>
 835
 836
 837
 838
 839         </ul>
 840       </nav>
 841     </li>
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853     <li class="md-nav__item md-nav__item--nested">
 854
 855
 856
 857
 858       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 859
 860
 861
 862         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 863           TypeScript and JavaScript API
 864           <span class="md-nav__icon md-icon"></span>
 865         </label>
 866
 867       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 868         <label class="md-nav__title" for="__nav_4">
 869           <span class="md-nav__icon md-icon"></span>
 870           TypeScript and JavaScript API
 871         </label>
 872         <ul class="md-nav__list" data-md-scrollfix>
 873
 874
 875
 876
 877
 878
 879     <li class="md-nav__item">
 880       <a href="../../../../javascript/general-usage/" class="md-nav__link">
 881         General Usage
 882       </a>
 883     </li>
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893     <li class="md-nav__item">
 894       <a href="../../../../javascript/typescript/" class="md-nav__link">
 895         TypeScript
 896       </a>
 897     </li>
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908     <li class="md-nav__item md-nav__item--nested">
 909
 910
 911
 912
 913       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 914
 915
 916
 917         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 918           Components
 919           <span class="md-nav__icon md-icon"></span>
 920         </label>
 921
 922       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 923         <label class="md-nav__title" for="__nav_4_3">
 924           <span class="md-nav__icon md-icon"></span>
 925           Components
 926         </label>
 927         <ul class="md-nav__list" data-md-scrollfix>
 928
 929
 930
 931
 932
 933
 934     <li class="md-nav__item">
 935       <a href="../../../../javascript/components_confirmation/" class="md-nav__link">
 936         Confirmation
 937       </a>
 938     </li>
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../../../javascript/components_dialog/" class="md-nav__link">
 950         Dialog
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962     <li class="md-nav__item">
 963       <a href="../../../../javascript/components_google_maps/" class="md-nav__link">
 964         Google Maps
 965       </a>
 966     </li>
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../../../../javascript/components_pagination/" class="md-nav__link">
 978         Pagination
 979       </a>
 980     </li>
 981
 982
 983
 984
 985         </ul>
 986       </nav>
 987     </li>
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998     <li class="md-nav__item md-nav__item--nested">
 999
1000
1001
1002
1003       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1004
1005
1006
1007         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1008           New API
1009           <span class="md-nav__icon md-icon"></span>
1010         </label>
1011
1012       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1013         <label class="md-nav__title" for="__nav_4_4">
1014           <span class="md-nav__icon md-icon"></span>
1015           New API
1016         </label>
1017         <ul class="md-nav__list" data-md-scrollfix>
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1026         Writing a module
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038     <li class="md-nav__item">
1039       <a href="../../../../javascript/new-api_core/" class="md-nav__link">
1040         Core Functions
1041       </a>
1042     </li>
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052     <li class="md-nav__item">
1053       <a href="../../../../javascript/new-api_dom/" class="md-nav__link">
1054         DOM
1055       </a>
1056     </li>
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item">
1067       <a href="../../../../javascript/new-api_events/" class="md-nav__link">
1068         Event Handling
1069       </a>
1070     </li>
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../../javascript/new-api_ajax/" class="md-nav__link">
1082         Ajax
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094     <li class="md-nav__item">
1095       <a href="../../../../javascript/new-api_dialogs/" class="md-nav__link">
1096         Dialogs
1097       </a>
1098     </li>
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../../../../javascript/new-api_browser/" class="md-nav__link">
1110         Browser and Screen Sizes
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122     <li class="md-nav__item">
1123       <a href="../../../../javascript/new-api_ui/" class="md-nav__link">
1124         User Interface
1125       </a>
1126     </li>
1127
1128
1129
1130
1131         </ul>
1132       </nav>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../../../javascript/legacy-api/" class="md-nav__link">
1145         Legacy API
1146       </a>
1147     </li>
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157     <li class="md-nav__item">
1158       <a href="../../../../javascript/code-snippets/" class="md-nav__link">
1159         Code Snippets
1160       </a>
1161     </li>
1162
1163
1164
1165
1166         </ul>
1167       </nav>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item md-nav__item--nested">
1181
1182
1183
1184
1185       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1186
1187
1188
1189         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1190           Package Components
1191           <span class="md-nav__icon md-icon"></span>
1192         </label>
1193
1194       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1195         <label class="md-nav__title" for="__nav_5">
1196           <span class="md-nav__icon md-icon"></span>
1197           Package Components
1198         </label>
1199         <ul class="md-nav__list" data-md-scrollfix>
1200
1201
1202
1203
1204
1205
1206     <li class="md-nav__item">
1207       <a href="../../../../package/package-xml/" class="md-nav__link">
1208         package.xml
1209       </a>
1210     </li>
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221     <li class="md-nav__item md-nav__item--nested">
1222
1223
1224
1225
1226       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1227
1228
1229
1230         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1231           PIPs
1232           <span class="md-nav__icon md-icon"></span>
1233         </label>
1234
1235       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1236         <label class="md-nav__title" for="__nav_5_2">
1237           <span class="md-nav__icon md-icon"></span>
1238           PIPs
1239         </label>
1240         <ul class="md-nav__list" data-md-scrollfix>
1241
1242
1243
1244
1245
1246
1247     <li class="md-nav__item">
1248       <a href="../../../../package/pip/" class="md-nav__link">
1249         Overview
1250       </a>
1251     </li>
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261     <li class="md-nav__item">
1262       <a href="../../../../package/pip/acl-option/" class="md-nav__link">
1263         aclOption
1264       </a>
1265     </li>
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275     <li class="md-nav__item">
1276       <a href="../../../../package/pip/acp-menu/" class="md-nav__link">
1277         acpMenu
1278       </a>
1279     </li>
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289     <li class="md-nav__item">
1290       <a href="../../../../package/pip/acp-search-provider/" class="md-nav__link">
1291         acpSearchProvider
1292       </a>
1293     </li>
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303     <li class="md-nav__item">
1304       <a href="../../../../package/pip/acp-template/" class="md-nav__link">
1305         acpTemplate
1306       </a>
1307     </li>
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317     <li class="md-nav__item">
1318       <a href="../../../../package/pip/acp-template-delete/" class="md-nav__link">
1319         acpTemplateDelete
1320       </a>
1321     </li>
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331     <li class="md-nav__item">
1332       <a href="../../../../package/pip/bbcode/" class="md-nav__link">
1333         bbcode
1334       </a>
1335     </li>
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345     <li class="md-nav__item">
1346       <a href="../../../../package/pip/box/" class="md-nav__link">
1347         box
1348       </a>
1349     </li>
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359     <li class="md-nav__item">
1360       <a href="../../../../package/pip/clipboard-action/" class="md-nav__link">
1361         clipboardAction
1362       </a>
1363     </li>
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373     <li class="md-nav__item">
1374       <a href="../../../../package/pip/core-object/" class="md-nav__link">
1375         coreObject
1376       </a>
1377     </li>
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../../../../package/pip/cronjob/" class="md-nav__link">
1389         cronjob
1390       </a>
1391     </li>
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401     <li class="md-nav__item">
1402       <a href="../../../../package/pip/database/" class="md-nav__link">
1403         database
1404       </a>
1405     </li>
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415     <li class="md-nav__item">
1416       <a href="../../../../package/pip/event-listener/" class="md-nav__link">
1417         eventListener
1418       </a>
1419     </li>
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429     <li class="md-nav__item">
1430       <a href="../../../../package/pip/file/" class="md-nav__link">
1431         file
1432       </a>
1433     </li>
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443     <li class="md-nav__item">
1444       <a href="../../../../package/pip/file-delete/" class="md-nav__link">
1445         fileDelete
1446       </a>
1447     </li>
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item">
1458       <a href="../../../../package/pip/language/" class="md-nav__link">
1459         language
1460       </a>
1461     </li>
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471     <li class="md-nav__item">
1472       <a href="../../../../package/pip/media-provider/" class="md-nav__link">
1473         mediaProvider
1474       </a>
1475     </li>
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485     <li class="md-nav__item">
1486       <a href="../../../../package/pip/menu/" class="md-nav__link">
1487         menu
1488       </a>
1489     </li>
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499     <li class="md-nav__item">
1500       <a href="../../../../package/pip/menu-item/" class="md-nav__link">
1501         menuItem
1502       </a>
1503     </li>
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513     <li class="md-nav__item">
1514       <a href="../../../../package/pip/object-type/" class="md-nav__link">
1515         objectType
1516       </a>
1517     </li>
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527     <li class="md-nav__item">
1528       <a href="../../../../package/pip/object-type-definition/" class="md-nav__link">
1529         objectTypeDefinition
1530       </a>
1531     </li>
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541     <li class="md-nav__item">
1542       <a href="../../../../package/pip/option/" class="md-nav__link">
1543         option
1544       </a>
1545     </li>
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555     <li class="md-nav__item">
1556       <a href="../../../../package/pip/page/" class="md-nav__link">
1557         page
1558       </a>
1559     </li>
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569     <li class="md-nav__item">
1570       <a href="../../../../package/pip/pip/" class="md-nav__link">
1571         pip
1572       </a>
1573     </li>
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583     <li class="md-nav__item">
1584       <a href="../../../../package/pip/script/" class="md-nav__link">
1585         script
1586       </a>
1587     </li>
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597     <li class="md-nav__item">
1598       <a href="../../../../package/pip/smiley/" class="md-nav__link">
1599         smiley
1600       </a>
1601     </li>
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611     <li class="md-nav__item">
1612       <a href="../../../../package/pip/sql/" class="md-nav__link">
1613         sql
1614       </a>
1615     </li>
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625     <li class="md-nav__item">
1626       <a href="../../../../package/pip/style/" class="md-nav__link">
1627         style
1628       </a>
1629     </li>
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639     <li class="md-nav__item">
1640       <a href="../../../../package/pip/template/" class="md-nav__link">
1641         template
1642       </a>
1643     </li>
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653     <li class="md-nav__item">
1654       <a href="../../../../package/pip/template-delete/" class="md-nav__link">
1655         templateDelete
1656       </a>
1657     </li>
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667     <li class="md-nav__item">
1668       <a href="../../../../package/pip/template-listener/" class="md-nav__link">
1669         templateListener
1670       </a>
1671     </li>
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681     <li class="md-nav__item">
1682       <a href="../../../../package/pip/user-group-option/" class="md-nav__link">
1683         userGroupOption
1684       </a>
1685     </li>
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695     <li class="md-nav__item">
1696       <a href="../../../../package/pip/user-menu/" class="md-nav__link">
1697         userMenu
1698       </a>
1699     </li>
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709     <li class="md-nav__item">
1710       <a href="../../../../package/pip/user-notification-event/" class="md-nav__link">
1711         userNotificationEvent
1712       </a>
1713     </li>
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../../../package/pip/user-option/" class="md-nav__link">
1725         userOption
1726       </a>
1727     </li>
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../../package/pip/user-profile-menu/" class="md-nav__link">
1739         userProfileMenu
1740       </a>
1741     </li>
1742
1743
1744
1745
1746         </ul>
1747       </nav>
1748     </li>
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758     <li class="md-nav__item">
1759       <a href="../../../../package/database-php-api/" class="md-nav__link">
1760         Database PHP API
1761       </a>
1762     </li>
1763
1764
1765
1766
1767         </ul>
1768       </nav>
1769     </li>
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781     <li class="md-nav__item md-nav__item--nested">
1782
1783
1784
1785
1786       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1787
1788
1789
1790         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1791           Migration
1792           <span class="md-nav__icon md-icon"></span>
1793         </label>
1794
1795       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1796         <label class="md-nav__title" for="__nav_6">
1797           <span class="md-nav__icon md-icon"></span>
1798           Migration
1799         </label>
1800         <ul class="md-nav__list" data-md-scrollfix>
1801
1802
1803
1804
1805
1806
1807
1808     <li class="md-nav__item md-nav__item--nested">
1809
1810
1811
1812
1813       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1814
1815
1816
1817         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1818           From WoltLab Suite 5.5
1819           <span class="md-nav__icon md-icon"></span>
1820         </label>
1821
1822       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1823         <label class="md-nav__title" for="__nav_6_1">
1824           <span class="md-nav__icon md-icon"></span>
1825           From WoltLab Suite 5.5
1826         </label>
1827         <ul class="md-nav__list" data-md-scrollfix>
1828
1829
1830
1831
1832
1833
1834     <li class="md-nav__item">
1835       <a href="../../../../migration/wsc55/php/" class="md-nav__link">
1836         PHP API
1837       </a>
1838     </li>
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848     <li class="md-nav__item">
1849       <a href="../../../../migration/wsc55/javascript/" class="md-nav__link">
1850         TypeScript and JavaScript
1851       </a>
1852     </li>
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862     <li class="md-nav__item">
1863       <a href="../../../../migration/wsc55/templates/" class="md-nav__link">
1864         Templates
1865       </a>
1866     </li>
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876     <li class="md-nav__item">
1877       <a href="../../../../migration/wsc55/icons/" class="md-nav__link">
1878         Icons
1879       </a>
1880     </li>
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890     <li class="md-nav__item">
1891       <a href="../../../../migration/wsc55/dialogs/" class="md-nav__link">
1892         Dialogs
1893       </a>
1894     </li>
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904     <li class="md-nav__item">
1905       <a href="../../../../migration/wsc55/libraries/" class="md-nav__link">
1906         Third Party Libraries
1907       </a>
1908     </li>
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918     <li class="md-nav__item">
1919       <a href="../../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1920         Deprecations and Removals
1921       </a>
1922     </li>
1923
1924
1925
1926
1927         </ul>
1928       </nav>
1929     </li>
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940     <li class="md-nav__item md-nav__item--nested">
1941
1942
1943
1944
1945       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1946
1947
1948
1949         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1950           From WoltLab Suite 5.4
1951           <span class="md-nav__icon md-icon"></span>
1952         </label>
1953
1954       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1955         <label class="md-nav__title" for="__nav_6_2">
1956           <span class="md-nav__icon md-icon"></span>
1957           From WoltLab Suite 5.4
1958         </label>
1959         <ul class="md-nav__list" data-md-scrollfix>
1960
1961
1962
1963
1964
1965
1966     <li class="md-nav__item">
1967       <a href="../../../../migration/wsc54/php/" class="md-nav__link">
1968         PHP API
1969       </a>
1970     </li>
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980     <li class="md-nav__item">
1981       <a href="../../../../migration/wsc54/javascript/" class="md-nav__link">
1982         TypeScript and JavaScript
1983       </a>
1984     </li>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994     <li class="md-nav__item">
1995       <a href="../../../../migration/wsc54/templates/" class="md-nav__link">
1996         Templates
1997       </a>
1998     </li>
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008     <li class="md-nav__item">
2009       <a href="../../../../migration/wsc54/libraries/" class="md-nav__link">
2010         Third Party Libraries
2011       </a>
2012     </li>
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022     <li class="md-nav__item">
2023       <a href="../../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2024         Deprecations and Removals
2025       </a>
2026     </li>
2027
2028
2029
2030
2031         </ul>
2032       </nav>
2033     </li>
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044     <li class="md-nav__item md-nav__item--nested">
2045
2046
2047
2048
2049       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2050
2051
2052
2053         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2054           From WoltLab Suite 5.3
2055           <span class="md-nav__icon md-icon"></span>
2056         </label>
2057
2058       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2059         <label class="md-nav__title" for="__nav_6_3">
2060           <span class="md-nav__icon md-icon"></span>
2061           From WoltLab Suite 5.3
2062         </label>
2063         <ul class="md-nav__list" data-md-scrollfix>
2064
2065
2066
2067
2068
2069
2070     <li class="md-nav__item">
2071       <a href="../../../../migration/wsc53/php/" class="md-nav__link">
2072         PHP API
2073       </a>
2074     </li>
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084     <li class="md-nav__item">
2085       <a href="../../../../migration/wsc53/session/" class="md-nav__link">
2086         Session Handling and Authentication
2087       </a>
2088     </li>
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098     <li class="md-nav__item">
2099       <a href="../../../../migration/wsc53/javascript/" class="md-nav__link">
2100         TypeScript and JavaScript
2101       </a>
2102     </li>
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112     <li class="md-nav__item">
2113       <a href="../../../../migration/wsc53/templates/" class="md-nav__link">
2114         Templates
2115       </a>
2116     </li>
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126     <li class="md-nav__item">
2127       <a href="../../../../migration/wsc53/libraries/" class="md-nav__link">
2128         Third Party Libraries
2129       </a>
2130     </li>
2131
2132
2133
2134
2135         </ul>
2136       </nav>
2137     </li>
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148     <li class="md-nav__item md-nav__item--nested">
2149
2150
2151
2152
2153       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2154
2155
2156
2157         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2158           From WoltLab Suite 5.2
2159           <span class="md-nav__icon md-icon"></span>
2160         </label>
2161
2162       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2163         <label class="md-nav__title" for="__nav_6_4">
2164           <span class="md-nav__icon md-icon"></span>
2165           From WoltLab Suite 5.2
2166         </label>
2167         <ul class="md-nav__list" data-md-scrollfix>
2168
2169
2170
2171
2172
2173
2174     <li class="md-nav__item">
2175       <a href="../../../../migration/wsc52/php/" class="md-nav__link">
2176         PHP API
2177       </a>
2178     </li>
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188     <li class="md-nav__item">
2189       <a href="../../../../migration/wsc52/templates/" class="md-nav__link">
2190         Templates and Languages
2191       </a>
2192     </li>
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202     <li class="md-nav__item">
2203       <a href="../../../../migration/wsc52/libraries/" class="md-nav__link">
2204         Third Party Libraries
2205       </a>
2206     </li>
2207
2208
2209
2210
2211         </ul>
2212       </nav>
2213     </li>
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224     <li class="md-nav__item md-nav__item--nested">
2225
2226
2227
2228
2229       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2230
2231
2232
2233         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2234           From WoltLab Suite 3.1
2235           <span class="md-nav__icon md-icon"></span>
2236         </label>
2237
2238       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2239         <label class="md-nav__title" for="__nav_6_5">
2240           <span class="md-nav__icon md-icon"></span>
2241           From WoltLab Suite 3.1
2242         </label>
2243         <ul class="md-nav__list" data-md-scrollfix>
2244
2245
2246
2247
2248
2249
2250     <li class="md-nav__item">
2251       <a href="../../../../migration/wsc31/php/" class="md-nav__link">
2252         PHP API
2253       </a>
2254     </li>
2255
2256
2257
2258
2259         </ul>
2260       </nav>
2261     </li>
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272     <li class="md-nav__item md-nav__item--nested">
2273
2274
2275
2276
2277       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2278
2279
2280
2281         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2282           From WoltLab Suite 3.0
2283           <span class="md-nav__icon md-icon"></span>
2284         </label>
2285
2286       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2287         <label class="md-nav__title" for="__nav_6_6">
2288           <span class="md-nav__icon md-icon"></span>
2289           From WoltLab Suite 3.0
2290         </label>
2291         <ul class="md-nav__list" data-md-scrollfix>
2292
2293
2294
2295
2296
2297
2298     <li class="md-nav__item">
2299       <a href="../../../../migration/wsc30/php/" class="md-nav__link">
2300         PHP API
2301       </a>
2302     </li>
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312     <li class="md-nav__item">
2313       <a href="../../../../migration/wsc30/javascript/" class="md-nav__link">
2314         JavaScript API
2315       </a>
2316     </li>
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326     <li class="md-nav__item">
2327       <a href="../../../../migration/wsc30/templates/" class="md-nav__link">
2328         Templates
2329       </a>
2330     </li>
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340     <li class="md-nav__item">
2341       <a href="../../../../migration/wsc30/css/" class="md-nav__link">
2342         CSS
2343       </a>
2344     </li>
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354     <li class="md-nav__item">
2355       <a href="../../../../migration/wsc30/package/" class="md-nav__link">
2356         Package Components
2357       </a>
2358     </li>
2359
2360
2361
2362
2363         </ul>
2364       </nav>
2365     </li>
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376     <li class="md-nav__item md-nav__item--nested">
2377
2378
2379
2380
2381       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2382
2383
2384
2385         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2386           From WCF 2.1
2387           <span class="md-nav__icon md-icon"></span>
2388         </label>
2389
2390       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2391         <label class="md-nav__title" for="__nav_6_7">
2392           <span class="md-nav__icon md-icon"></span>
2393           From WCF 2.1
2394         </label>
2395         <ul class="md-nav__list" data-md-scrollfix>
2396
2397
2398
2399
2400
2401
2402     <li class="md-nav__item">
2403       <a href="../../../../migration/wcf21/php/" class="md-nav__link">
2404         PHP API
2405       </a>
2406     </li>
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416     <li class="md-nav__item">
2417       <a href="../../../../migration/wcf21/templates/" class="md-nav__link">
2418         Templates
2419       </a>
2420     </li>
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430     <li class="md-nav__item">
2431       <a href="../../../../migration/wcf21/css/" class="md-nav__link">
2432         CSS
2433       </a>
2434     </li>
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444     <li class="md-nav__item">
2445       <a href="../../../../migration/wcf21/package/" class="md-nav__link">
2446         Package Components
2447       </a>
2448     </li>
2449
2450
2451
2452
2453         </ul>
2454       </nav>
2455     </li>
2456
2457
2458
2459
2460         </ul>
2461       </nav>
2462     </li>
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474     <li class="md-nav__item md-nav__item--nested">
2475
2476
2477
2478
2479       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2480
2481
2482
2483         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2484           Tutorials
2485           <span class="md-nav__icon md-icon"></span>
2486         </label>
2487
2488       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2489         <label class="md-nav__title" for="__nav_7">
2490           <span class="md-nav__icon md-icon"></span>
2491           Tutorials
2492         </label>
2493         <ul class="md-nav__list" data-md-scrollfix>
2494
2495
2496
2497
2498
2499
2500
2501     <li class="md-nav__item md-nav__item--nested">
2502
2503
2504
2505
2506       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2507
2508
2509
2510         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2511           Tutorial Series
2512           <span class="md-nav__icon md-icon"></span>
2513         </label>
2514
2515       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2516         <label class="md-nav__title" for="__nav_7_1">
2517           <span class="md-nav__icon md-icon"></span>
2518           Tutorial Series
2519         </label>
2520         <ul class="md-nav__list" data-md-scrollfix>
2521
2522
2523
2524
2525
2526
2527     <li class="md-nav__item">
2528       <a href="../../../../tutorial/series/overview/" class="md-nav__link">
2529         Overview
2530       </a>
2531     </li>
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541     <li class="md-nav__item">
2542       <a href="../../../../tutorial/series/part_1/" class="md-nav__link">
2543         Part 1
2544       </a>
2545     </li>
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555     <li class="md-nav__item">
2556       <a href="../../../../tutorial/series/part_2/" class="md-nav__link">
2557         Part 2
2558       </a>
2559     </li>
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569     <li class="md-nav__item">
2570       <a href="../../../../tutorial/series/part_3/" class="md-nav__link">
2571         Part 3
2572       </a>
2573     </li>
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583     <li class="md-nav__item">
2584       <a href="../../../../tutorial/series/part_4/" class="md-nav__link">
2585         Part 4
2586       </a>
2587     </li>
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597     <li class="md-nav__item">
2598       <a href="../../../../tutorial/series/part_5/" class="md-nav__link">
2599         Part 5
2600       </a>
2601     </li>
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611     <li class="md-nav__item">
2612       <a href="../../../../tutorial/series/part_6/" class="md-nav__link">
2613         Part 6
2614       </a>
2615     </li>
2616
2617
2618
2619
2620         </ul>
2621       </nav>
2622     </li>
2623
2624
2625
2626
2627         </ul>
2628       </nav>
2629     </li>
2630
2631
2632
2633   </ul>
2634 </nav>
2635                   </div>
2636                 </div>
2637               </div>
2638
2639
2640
2641               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2642                 <div class="md-sidebar__scrollwrap">
2643                   <div class="md-sidebar__inner">
2644
2645
2646 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2647
2648
2649
2650
2651
2652
2653     <label class="md-nav__title" for="__toc">
2654       <span class="md-nav__icon md-icon"></span>
2655       Table of contents
2656     </label>
2657     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2658
2659         <li class="md-nav__item">
2660   <a href="#form-builder-components" class="md-nav__link">
2661     Form Builder Components
2662   </a>
2663
2664 </li>
2665
2666         <li class="md-nav__item">
2667   <a href="#abstractformbuilderform" class="md-nav__link">
2668     AbstractFormBuilderForm
2669   </a>
2670
2671 </li>
2672
2673         <li class="md-nav__item">
2674   <a href="#dialogformdocument" class="md-nav__link">
2675     DialogFormDocument
2676   </a>
2677
2678 </li>
2679
2680     </ul>
2681
2682 </nav>
2683                   </div>
2684                 </div>
2685               </div>
2686
2687
2688
2689             <div class="md-content" data-md-component="content">
2690               <article class="md-content__inner md-typeset">
2691
2692
2693
2694
2695
2696
2697
2698 <h1 id="form-builder">Form Builder<a class="headerlink" href="#form-builder" title="Permanent link">#</a></h1>
2699 <p>WoltLab Suite includes a powerful way of creating forms: Form Builder.
2700 Form builder allows you to easily define all the fields and their constraints and interdependencies within PHP with full IDE support.
2701 It will then automatically generate the necessary HTML with full interactivity to render all the fields and also validate the fields’ contents upon submission.</p>
2702 <div class="admonition info">
2703 <p class="admonition-title">The <a href="../../../../migration/wsc31/form-builder/">migration guide for WoltLab Suite Core 5.2</a> provides some examples of how to migrate existing forms to form builder that can also help in understanding form builder if the old way of creating forms is familiar.</p>
2704 </div>
2705 <h2 id="form-builder-components">Form Builder Components<a class="headerlink" href="#form-builder-components" title="Permanent link">#</a></h2>
2706 <p>Form builder consists of several components that are presented on the following pages:</p>
2707 <ol>
2708 <li><a href="../structure/">Structure of form builder</a></li>
2709 <li><a href="../validation_data/">Form validation and form data</a></li>
2710 <li><a href="../dependencies/">Form node dependencies</a></li>
2711 </ol>
2712 <div class="admonition warning">
2713 <p class="admonition-title">In general, form builder provides default implementation of interfaces by providing either abstract classes or traits. It is expected that the interfaces are always implemented using these abstract classes and traits! This way, if new methods are added to the interfaces, default implementations can be provided by the abstract classes and traits without causing backwards compatibility problems.</p>
2714 </div>
2715 <h2 id="abstractformbuilderform"><code>AbstractFormBuilderForm</code><a class="headerlink" href="#abstractformbuilderform" title="Permanent link">#</a></h2>
2716 <p>To make using form builder easier, <code>AbstractFormBuilderForm</code> extends <code>AbstractForm</code> and provides most of the code needed to set up a form (of course without specific fields, those have to be added by the concrete form class), like reading and validating form values and using a database object action to use the form data to create or update a database object.</p>
2717 <p>In addition to the existing methods inherited by <code>AbstractForm</code>, <code>AbstractFormBuilderForm</code> provides the following methods:</p>
2718 <ul>
2719 <li>
2720 <p><code>buildForm()</code> builds the form in the following steps:</p>
2721 </li>
2722 <li>
2723 <p>Call <code>AbtractFormBuilderForm::createForm()</code> to create the <code>IFormDocument</code> object and add the form fields.</p>
2724 </li>
2725 <li>Call <code>IFormDocument::build()</code> to build the form.</li>
2726 <li>Call <code>AbtractFormBuilderForm::finalizeForm()</code> to finalize the form like adding dependencies.</li>
2727 </ul>
2728 <p>Additionally, between steps 1 and 2 and after step 3, the method provides two events, <code>createForm</code> and <code>buildForm</code> to allow plugins to register event listeners to execute additional code at the right point in time.
2729 - <code>createForm()</code> creates the <code>FormDocument</code> object and sets the form mode.
2730   Classes extending <code>AbstractFormBuilderForm</code> have to override this method (and call <code>parent::createForm()</code> as the first line in the overridden method) to add concrete form containers and form fields to the bare form document.
2731 - <code>finalizeForm()</code> is called after the form has been built and the complete form hierarchy has been established.
2732   This method should be overridden to add dependencies, for example.
2733 - <code>setFormAction()</code> is called at the end of <code>readData()</code> and sets the form document’s action based on the controller class name and whether an object is currently edited.
2734 - If an object is edited, at the beginning of <code>readData()</code>, <code>setFormObjectData()</code> is called which calls <code>IFormDocument::loadValuesFromObject()</code>.
2735   If values need to be loaded from additional sources, this method should be used for that.</p>
2736 <p><code>AbstractFormBuilderForm</code> also provides the following (public) properties:</p>
2737 <ul>
2738 <li><code>$form</code> contains the <code>IFormDocument</code> object created in <code>createForm()</code>.</li>
2739 <li><code>$formAction</code> is either <code>create</code> (default) or <code>edit</code> and handles which method of the database object is called by default (<code>create</code> is called for <code>$formAction = 'create'</code> and <code>update</code> is called for <code>$formAction = 'edit'</code>) and is used to set the value of the <code>action</code> template variable.</li>
2740 <li><code>$formObject</code> contains the <code>IStorableObject</code> if the form is used to edit an existing object.
2741   For forms used to create objects, <code>$formObject</code> is always <code>null</code>.
2742   Edit forms have to manually identify the edited object based on the request data and set the value of <code>$formObject</code>. </li>
2743 <li><code>$objectActionName</code> can be used to set an alternative action to be executed by the database object action that deviates from the default action determined by the value of <code>$formAction</code>.</li>
2744 <li><code>$objectActionClass</code> is the name of the database object action class that is used to create or update the database object.</li>
2745 </ul>
2746 <h2 id="dialogformdocument"><code>DialogFormDocument</code><a class="headerlink" href="#dialogformdocument" title="Permanent link">#</a></h2>
2747 <p>Form builder forms can also be used in dialogs.
2748 For such forms, <code>DialogFormDocument</code> should be used which provides the additional methods <code>cancelable($cancelable = true)</code> and <code>isCancelable()</code> to set and check if the dialog can be canceled.
2749 If a dialog form can be canceled, a cancel button is added.</p>
2750 <p>If the dialog form is fetched via an AJAX request, <code>IFormDocument::ajax()</code> has to be called.
2751 AJAX forms are registered with <code>WoltLabSuite/Core/Form/Builder/Manager</code> which also supports getting all of the data of a form via the <code>getData(formId)</code> function.
2752 The <code>getData()</code> function relies on all form fields creating and registering a <code>WoltLabSuite/Core/Form/Builder/Field/Field</code> object that provides the data of a specific field.</p>
2753 <p>To make it as easy as possible to work with AJAX forms in dialogs, <code>WoltLabSuite/Core/Form/Builder/Dialog</code> (abbreviated as <code>FormBuilderDialog</code> from now on) should generally be used instead of <code>WoltLabSuite/Core/Form/Builder/Manager</code> directly.
2754 The constructor of <code>FormBuilderDialog</code> expects the following parameters:</p>
2755 <ul>
2756 <li><code>dialogId</code>: id of the dialog element</li>
2757 <li><code>className</code>: PHP class used to get the form dialog (and save the data if <code>options.submitActionName</code> is set)</li>
2758 <li><code>actionName</code>: name of the action/method of <code>className</code> that returns the dialog; the method is expected to return an array with <code>formId</code> containg the id of the returned form and <code>dialog</code> containing the rendered form dialog</li>
2759 <li><code>options</code>: additional options:</li>
2760 <li><code>actionParameters</code> (default: empty): additional parameters sent during AJAX requests</li>
2761 <li><code>destroyOnClose</code> (default: <code>false</code>): if <code>true</code>, whenever the dialog is closed, the form is destroyed so that a new form is fetched if the dialog is opened again</li>
2762 <li><code>dialog</code>: additional dialog options used as <code>options</code> during dialog setup</li>
2763 <li><code>onSubmit</code>: callback when the form is submitted (takes precedence over <code>submitActionName</code>)</li>
2764 <li><code>submitActionName</code> (default: not set): name of the action/method of <code>className</code> called when the form is submitted</li>
2765 </ul>
2766 <p>The three public functions of <code>FormBuilderDialog</code> are:</p>
2767 <ul>
2768 <li><code>destroy()</code> destroys the dialog, the form, and all of the form fields.</li>
2769 <li><code>getData()</code> returns a Promise that returns the form data.</li>
2770 <li><code>open()</code> opens the dialog.</li>
2771 </ul>
2772 <p>Example:</p>
2773 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2774 <span class="normal"> 2</span>
2775 <span class="normal"> 3</span>
2776 <span class="normal"> 4</span>
2777 <span class="normal"> 5</span>
2778 <span class="normal"> 6</span>
2779 <span class="normal"> 7</span>
2780 <span class="normal"> 8</span>
2781 <span class="normal"> 9</span>
2782 <span class="normal">10</span>
2783 <span class="normal">11</span>
2784 <span class="normal">12</span>
2785 <span class="normal">13</span>
2786 <span class="normal">14</span>
2787 <span class="normal">15</span>
2788 <span class="normal">16</span>
2789 <span class="normal">17</span>
2790 <span class="normal">18</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s1">&#39;WoltLabSuite/Core/Form/Builder/Dialog&#39;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">FormBuilderDialog</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
2791 <span class="w">    </span><span class="kd">var</span><span class="w"> </span><span class="nx">dialog</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">FormBuilderDialog</span><span class="p">(</span>
2792 <span class="w">        </span><span class="s1">&#39;testDialog&#39;</span><span class="p">,</span>
2793 <span class="w">        </span><span class="s1">&#39;wcf\\data\\test\\TestAction&#39;</span><span class="p">,</span>
2794 <span class="w">        </span><span class="s1">&#39;getDialog&#39;</span><span class="p">,</span>
2795 <span class="w">        </span><span class="p">{</span>
2796 <span class="w">            </span><span class="nx">destroyOnClose</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
2797 <span class="w">            </span><span class="nx">dialog</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
2798 <span class="w">                </span><span class="nx">title</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;Test Dialog&#39;</span>
2799 <span class="w">            </span><span class="p">},</span>
2800 <span class="w">            </span><span class="nx">submitActionName</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;saveDialog&#39;</span>
2801 <span class="w">        </span><span class="p">}</span>
2802 <span class="w">    </span><span class="p">);</span>
2803
2804 <span class="w">    </span><span class="nx">elById</span><span class="p">(</span><span class="s1">&#39;testDialogButton&#39;</span><span class="p">).</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">&#39;click&#39;</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>
2805 <span class="w">        </span><span class="nx">dialog</span><span class="p">.</span><span class="nx">open</span><span class="p">();</span>
2806 <span class="w">    </span><span class="p">});</span>
2807 <span class="p">});</span>
2808 </code></pre></div></td></tr></table></div>
2809
2810   <hr>
2811 <div class="md-source-file">
2812   <small>
2813
2814       Last update:
2815       2021-10-20
2816
2817   </small>
2818 </div>
2819
2820
2821
2822
2823
2824
2825               </article>
2826             </div>
2827
2828
2829         </div>
2830
2831       </main>
2832
2833         <footer class="md-footer">
2834
2835   <div class="md-footer-meta md-typeset">
2836     <div class="md-footer-meta__inner md-grid">
2837       <div class="md-copyright">
2838
2839     <div class="md-copyright__highlight">
2840       Copyright © 2020 WoltLab GmbH
2841     </div>
2842
2843
2844     Made with
2845     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2846       Material for MkDocs
2847     </a>
2848
2849 </div>
2850
2851         <div class="md-copyright">
2852         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2853         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2854 </div>
2855
2856     </div>
2857   </div>
2858 </footer>
2859
2860     </div>
2861     <div class="md-dialog" data-md-component="dialog">
2862       <div class="md-dialog__inner md-typeset"></div>
2863     </div>
2864
2865     <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>
2866
2867
2868       <script src="../../../../assets/javascripts/bundle.b4d07000.min.js"></script>
2869
2870
2871   </body>
2872 </html>