5.4/php/api/form_builder/form_fields/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>Fields - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#form-builder-fields" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               Fields
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 223
 224
 225         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 226
 227       <label class="md-nav__link" for="__nav_2">
 228         PHP API
 229         <span class="md-nav__icon md-icon"></span>
 230       </label>
 231       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 232         <label class="md-nav__title" for="__nav_2">
 233           <span class="md-nav__icon md-icon"></span>
 234           PHP API
 235         </label>
 236         <ul class="md-nav__list" data-md-scrollfix>
 237
 238
 239
 240
 241
 242     <li class="md-nav__item">
 243       <a href="../../../pages/" class="md-nav__link">
 244         Pages
 245       </a>
 246     </li>
 247
 248
 249
 250
 251
 252
 253
 254     <li class="md-nav__item">
 255       <a href="../../../database-objects/" class="md-nav__link">
 256         Database Objects
 257       </a>
 258     </li>
 259
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item">
 267       <a href="../../../database-access/" class="md-nav__link">
 268         Database Access
 269       </a>
 270     </li>
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../../exceptions/" class="md-nav__link">
 280         Exceptions
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293     <li class="md-nav__item md-nav__item--active 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" checked>
 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
 314     <li class="md-nav__item md-nav__item--nested">
 315
 316
 317         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 318
 319       <label class="md-nav__link" for="__nav_2_5_1">
 320         Caches
 321         <span class="md-nav__icon md-icon"></span>
 322       </label>
 323       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 324         <label class="md-nav__title" for="__nav_2_5_1">
 325           <span class="md-nav__icon md-icon"></span>
 326           Caches
 327         </label>
 328         <ul class="md-nav__list" data-md-scrollfix>
 329
 330
 331
 332
 333
 334     <li class="md-nav__item">
 335       <a href="../../caches/" class="md-nav__link">
 336         Overview
 337       </a>
 338     </li>
 339
 340
 341
 342
 343
 344
 345
 346     <li class="md-nav__item">
 347       <a href="../../caches_persistent-caches/" class="md-nav__link">
 348         Persistent Caches
 349       </a>
 350     </li>
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item">
 359       <a href="../../caches_runtime-caches/" class="md-nav__link">
 360         Runtime Caches
 361       </a>
 362     </li>
 363
 364
 365
 366         </ul>
 367       </nav>
 368     </li>
 369
 370
 371
 372
 373
 374
 375
 376     <li class="md-nav__item">
 377       <a href="../../comments/" class="md-nav__link">
 378         Comments
 379       </a>
 380     </li>
 381
 382
 383
 384
 385
 386
 387
 388     <li class="md-nav__item">
 389       <a href="../../cronjobs/" class="md-nav__link">
 390         Cronjobs
 391       </a>
 392     </li>
 393
 394
 395
 396
 397
 398
 399
 400     <li class="md-nav__item">
 401       <a href="../../events/" class="md-nav__link">
 402         Events
 403       </a>
 404     </li>
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 416
 417
 418         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" checked>
 419
 420       <label class="md-nav__link" for="__nav_2_5_5">
 421         Form Builder
 422         <span class="md-nav__icon md-icon"></span>
 423       </label>
 424       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 425         <label class="md-nav__title" for="__nav_2_5_5">
 426           <span class="md-nav__icon md-icon"></span>
 427           Form Builder
 428         </label>
 429         <ul class="md-nav__list" data-md-scrollfix>
 430
 431
 432
 433
 434
 435     <li class="md-nav__item">
 436       <a href="../overview/" class="md-nav__link">
 437         Overview
 438       </a>
 439     </li>
 440
 441
 442
 443
 444
 445
 446
 447     <li class="md-nav__item">
 448       <a href="../structure/" class="md-nav__link">
 449         Structure
 450       </a>
 451     </li>
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461     <li class="md-nav__item md-nav__item--active">
 462
 463       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 464
 465
 466
 467
 468         <label class="md-nav__link md-nav__link--active" for="__toc">
 469           Fields
 470           <span class="md-nav__icon md-icon"></span>
 471         </label>
 472
 473       <a href="./" class="md-nav__link md-nav__link--active">
 474         Fields
 475       </a>
 476
 477
 478 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 479
 480
 481
 482
 483
 484     <label class="md-nav__title" for="__toc">
 485       <span class="md-nav__icon md-icon"></span>
 486       Table of contents
 487     </label>
 488     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 489
 490         <li class="md-nav__item">
 491   <a href="#abstract-form-fields" class="md-nav__link">
 492     Abstract Form Fields
 493   </a>
 494
 495     <nav class="md-nav" aria-label="Abstract Form Fields">
 496       <ul class="md-nav__list">
 497
 498           <li class="md-nav__item">
 499   <a href="#abstractformfield" class="md-nav__link">
 500     AbstractFormField
 501   </a>
 502
 503 </li>
 504
 505           <li class="md-nav__item">
 506   <a href="#abstractnumericformfield" class="md-nav__link">
 507     AbstractNumericFormField
 508   </a>
 509
 510 </li>
 511
 512       </ul>
 513     </nav>
 514
 515 </li>
 516
 517         <li class="md-nav__item">
 518   <a href="#general-form-fields" class="md-nav__link">
 519     General Form Fields
 520   </a>
 521
 522     <nav class="md-nav" aria-label="General Form Fields">
 523       <ul class="md-nav__list">
 524
 525           <li class="md-nav__item">
 526   <a href="#booleanformfield" class="md-nav__link">
 527     BooleanFormField
 528   </a>
 529
 530 </li>
 531
 532           <li class="md-nav__item">
 533   <a href="#checkboxformfield" class="md-nav__link">
 534     CheckboxFormField
 535   </a>
 536
 537 </li>
 538
 539           <li class="md-nav__item">
 540   <a href="#classnameformfield" class="md-nav__link">
 541     ClassNameFormField
 542   </a>
 543
 544 </li>
 545
 546           <li class="md-nav__item">
 547   <a href="#dateformfield" class="md-nav__link">
 548     DateFormField
 549   </a>
 550
 551 </li>
 552
 553           <li class="md-nav__item">
 554   <a href="#descriptionformfield" class="md-nav__link">
 555     DescriptionFormField
 556   </a>
 557
 558 </li>
 559
 560           <li class="md-nav__item">
 561   <a href="#emailformfield" class="md-nav__link">
 562     EmailFormField
 563   </a>
 564
 565 </li>
 566
 567           <li class="md-nav__item">
 568   <a href="#floatformfield" class="md-nav__link">
 569     FloatFormField
 570   </a>
 571
 572 </li>
 573
 574           <li class="md-nav__item">
 575   <a href="#iconformfield" class="md-nav__link">
 576     IconFormField
 577   </a>
 578
 579 </li>
 580
 581           <li class="md-nav__item">
 582   <a href="#integerformfield" class="md-nav__link">
 583     IntegerFormField
 584   </a>
 585
 586 </li>
 587
 588           <li class="md-nav__item">
 589   <a href="#isdisabledformfield" class="md-nav__link">
 590     IsDisabledFormField
 591   </a>
 592
 593 </li>
 594
 595           <li class="md-nav__item">
 596   <a href="#itemlistformfield" class="md-nav__link">
 597     ItemListFormField
 598   </a>
 599
 600 </li>
 601
 602           <li class="md-nav__item">
 603   <a href="#multilinetextformfield" class="md-nav__link">
 604     MultilineTextFormField
 605   </a>
 606
 607 </li>
 608
 609           <li class="md-nav__item">
 610   <a href="#multipleselectionformfield" class="md-nav__link">
 611     MultipleSelectionFormField
 612   </a>
 613
 614 </li>
 615
 616           <li class="md-nav__item">
 617   <a href="#radiobuttonformfield" class="md-nav__link">
 618     RadioButtonFormField
 619   </a>
 620
 621 </li>
 622
 623           <li class="md-nav__item">
 624   <a href="#ratingformfield" class="md-nav__link">
 625     RatingFormField
 626   </a>
 627
 628 </li>
 629
 630           <li class="md-nav__item">
 631   <a href="#showorderformfield" class="md-nav__link">
 632     ShowOrderFormField
 633   </a>
 634
 635 </li>
 636
 637           <li class="md-nav__item">
 638   <a href="#singleselectionformfield" class="md-nav__link">
 639     SingleSelectionFormField
 640   </a>
 641
 642 </li>
 643
 644           <li class="md-nav__item">
 645   <a href="#sortorderformfield" class="md-nav__link">
 646     SortOrderFormField
 647   </a>
 648
 649 </li>
 650
 651           <li class="md-nav__item">
 652   <a href="#textformfield" class="md-nav__link">
 653     TextFormField
 654   </a>
 655
 656 </li>
 657
 658           <li class="md-nav__item">
 659   <a href="#titleformfield" class="md-nav__link">
 660     TitleFormField
 661   </a>
 662
 663 </li>
 664
 665           <li class="md-nav__item">
 666   <a href="#urlformfield" class="md-nav__link">
 667     UrlFormField
 668   </a>
 669
 670 </li>
 671
 672       </ul>
 673     </nav>
 674
 675 </li>
 676
 677         <li class="md-nav__item">
 678   <a href="#specific-fields" class="md-nav__link">
 679     Specific Fields
 680   </a>
 681
 682     <nav class="md-nav" aria-label="Specific Fields">
 683       <ul class="md-nav__list">
 684
 685           <li class="md-nav__item">
 686   <a href="#aclformfield" class="md-nav__link">
 687     AclFormField
 688   </a>
 689
 690 </li>
 691
 692           <li class="md-nav__item">
 693   <a href="#buttonformfield" class="md-nav__link">
 694     ButtonFormField
 695   </a>
 696
 697 </li>
 698
 699           <li class="md-nav__item">
 700   <a href="#captchaformfield" class="md-nav__link">
 701     CaptchaFormField
 702   </a>
 703
 704 </li>
 705
 706           <li class="md-nav__item">
 707   <a href="#contentlanguageformfield" class="md-nav__link">
 708     ContentLanguageFormField
 709   </a>
 710
 711 </li>
 712
 713           <li class="md-nav__item">
 714   <a href="#labelformfield" class="md-nav__link">
 715     LabelFormField
 716   </a>
 717
 718 </li>
 719
 720           <li class="md-nav__item">
 721   <a href="#optionformfield" class="md-nav__link">
 722     OptionFormField
 723   </a>
 724
 725 </li>
 726
 727           <li class="md-nav__item">
 728   <a href="#simpleaclformfield" class="md-nav__link">
 729     SimpleAclFormField
 730   </a>
 731
 732 </li>
 733
 734           <li class="md-nav__item">
 735   <a href="#singlemediaselectionformfield" class="md-nav__link">
 736     SingleMediaSelectionFormField
 737   </a>
 738
 739 </li>
 740
 741           <li class="md-nav__item">
 742   <a href="#tagformfield" class="md-nav__link">
 743     TagFormField
 744   </a>
 745
 746 </li>
 747
 748           <li class="md-nav__item">
 749   <a href="#uploadformfield" class="md-nav__link">
 750     UploadFormField
 751   </a>
 752
 753     <nav class="md-nav" aria-label="UploadFormField">
 754       <ul class="md-nav__list">
 755
 756           <li class="md-nav__item">
 757   <a href="#provide-value-from-database-object" class="md-nav__link">
 758     Provide value from database object
 759   </a>
 760
 761 </li>
 762
 763           <li class="md-nav__item">
 764   <a href="#process-files" class="md-nav__link">
 765     Process files
 766   </a>
 767
 768 </li>
 769
 770       </ul>
 771     </nav>
 772
 773 </li>
 774
 775           <li class="md-nav__item">
 776   <a href="#userformfield" class="md-nav__link">
 777     UserFormField
 778   </a>
 779
 780 </li>
 781
 782           <li class="md-nav__item">
 783   <a href="#userpasswordfield" class="md-nav__link">
 784     UserPasswordField
 785   </a>
 786
 787 </li>
 788
 789           <li class="md-nav__item">
 790   <a href="#usergroupoptionformfield" class="md-nav__link">
 791     UserGroupOptionFormField
 792   </a>
 793
 794 </li>
 795
 796           <li class="md-nav__item">
 797   <a href="#usernameformfield" class="md-nav__link">
 798     UsernameFormField
 799   </a>
 800
 801 </li>
 802
 803       </ul>
 804     </nav>
 805
 806 </li>
 807
 808         <li class="md-nav__item">
 809   <a href="#wysiwyg-form-container" class="md-nav__link">
 810     Wysiwyg form container
 811   </a>
 812
 813     <nav class="md-nav" aria-label="Wysiwyg form container">
 814       <ul class="md-nav__list">
 815
 816           <li class="md-nav__item">
 817   <a href="#wysiwygattachmentformfield" class="md-nav__link">
 818     WysiwygAttachmentFormField
 819   </a>
 820
 821 </li>
 822
 823           <li class="md-nav__item">
 824   <a href="#wysiwygpollformcontainer" class="md-nav__link">
 825     WysiwygPollFormContainer
 826   </a>
 827
 828 </li>
 829
 830           <li class="md-nav__item">
 831   <a href="#wysiwygsmileyformcontainer" class="md-nav__link">
 832     WysiwygSmileyFormContainer
 833   </a>
 834
 835     <nav class="md-nav" aria-label="WysiwygSmileyFormContainer">
 836       <ul class="md-nav__list">
 837
 838           <li class="md-nav__item">
 839   <a href="#wysiwygsmileyformnode" class="md-nav__link">
 840     WysiwygSmileyFormNode
 841   </a>
 842
 843 </li>
 844
 845       </ul>
 846     </nav>
 847
 848 </li>
 849
 850           <li class="md-nav__item">
 851   <a href="#example" class="md-nav__link">
 852     Example
 853   </a>
 854
 855 </li>
 856
 857           <li class="md-nav__item">
 858   <a href="#wysiwygformfield" class="md-nav__link">
 859     WysiwygFormField
 860   </a>
 861
 862 </li>
 863
 864           <li class="md-nav__item">
 865   <a href="#twysiwygformnode" class="md-nav__link">
 866     TWysiwygFormNode
 867   </a>
 868
 869 </li>
 870
 871       </ul>
 872     </nav>
 873
 874 </li>
 875
 876         <li class="md-nav__item">
 877   <a href="#single-use-form-fields" class="md-nav__link">
 878     Single-Use Form Fields
 879   </a>
 880
 881     <nav class="md-nav" aria-label="Single-Use Form Fields">
 882       <ul class="md-nav__list">
 883
 884           <li class="md-nav__item">
 885   <a href="#bbcodeattributesformfield" class="md-nav__link">
 886     BBCodeAttributesFormField
 887   </a>
 888
 889 </li>
 890
 891           <li class="md-nav__item">
 892   <a href="#devtoolsprojectexcludedpackagesformfield" class="md-nav__link">
 893     DevtoolsProjectExcludedPackagesFormField
 894   </a>
 895
 896 </li>
 897
 898           <li class="md-nav__item">
 899   <a href="#devtoolsprojectinstructionsformfield" class="md-nav__link">
 900     DevtoolsProjectInstructionsFormField
 901   </a>
 902
 903 </li>
 904
 905           <li class="md-nav__item">
 906   <a href="#devtoolsprojectoptionalpackagesformfield" class="md-nav__link">
 907     DevtoolsProjectOptionalPackagesFormField
 908   </a>
 909
 910 </li>
 911
 912           <li class="md-nav__item">
 913   <a href="#devtoolsprojectrequiredpackagesformfield" class="md-nav__link">
 914     DevtoolsProjectRequiredPackagesFormField
 915   </a>
 916
 917 </li>
 918
 919       </ul>
 920     </nav>
 921
 922 </li>
 923
 924     </ul>
 925
 926 </nav>
 927
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../validation_data/" class="md-nav__link">
 938         Validation and Data
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../dependencies/" class="md-nav__link">
 950         Dependencies
 951       </a>
 952     </li>
 953
 954
 955
 956         </ul>
 957       </nav>
 958     </li>
 959
 960
 961
 962
 963
 964
 965
 966     <li class="md-nav__item">
 967       <a href="../../package_installation_plugins/" class="md-nav__link">
 968         Package Installation Plugins
 969       </a>
 970     </li>
 971
 972
 973
 974
 975
 976
 977
 978     <li class="md-nav__item">
 979       <a href="../../user_activity_points/" class="md-nav__link">
 980         User Activity Points
 981       </a>
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990     <li class="md-nav__item">
 991       <a href="../../user_notifications/" class="md-nav__link">
 992         User Notifications
 993       </a>
 994     </li>
 995
 996
 997
 998
 999
1000
1001
1002     <li class="md-nav__item">
1003       <a href="../../sitemaps/" class="md-nav__link">
1004         Sitemaps
1005       </a>
1006     </li>
1007
1008
1009
1010         </ul>
1011       </nav>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../code-style/" class="md-nav__link">
1022         Code Style
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../../apps/" class="md-nav__link">
1034         Apps
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../../gdpr/" class="md-nav__link">
1046         GDPR
1047       </a>
1048     </li>
1049
1050
1051
1052         </ul>
1053       </nav>
1054     </li>
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item md-nav__item--nested">
1067
1068
1069         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
1070
1071       <label class="md-nav__link" for="__nav_3">
1072         Languages, Templates & CSS
1073         <span class="md-nav__icon md-icon"></span>
1074       </label>
1075       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
1076         <label class="md-nav__title" for="__nav_3">
1077           <span class="md-nav__icon md-icon"></span>
1078           Languages, Templates & CSS
1079         </label>
1080         <ul class="md-nav__list" data-md-scrollfix>
1081
1082
1083
1084
1085
1086     <li class="md-nav__item">
1087       <a href="../../../../view/languages/" class="md-nav__link">
1088         Languages
1089       </a>
1090     </li>
1091
1092
1093
1094
1095
1096
1097
1098     <li class="md-nav__item">
1099       <a href="../../../../view/templates/" class="md-nav__link">
1100         Templates
1101       </a>
1102     </li>
1103
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item">
1111       <a href="../../../../view/template-plugins/" class="md-nav__link">
1112         Template Plugins
1113       </a>
1114     </li>
1115
1116
1117
1118
1119
1120
1121
1122     <li class="md-nav__item">
1123       <a href="../../../../view/css/" class="md-nav__link">
1124         CSS
1125       </a>
1126     </li>
1127
1128
1129
1130         </ul>
1131       </nav>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item md-nav__item--nested">
1145
1146
1147         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
1148
1149       <label class="md-nav__link" for="__nav_4">
1150         TypeScript and JavaScript API
1151         <span class="md-nav__icon md-icon"></span>
1152       </label>
1153       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
1154         <label class="md-nav__title" for="__nav_4">
1155           <span class="md-nav__icon md-icon"></span>
1156           TypeScript and JavaScript API
1157         </label>
1158         <ul class="md-nav__list" data-md-scrollfix>
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../../javascript/general-usage/" class="md-nav__link">
1166         General Usage
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../../../javascript/typescript/" class="md-nav__link">
1178         TypeScript
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item md-nav__item--nested">
1190
1191
1192         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
1193
1194       <label class="md-nav__link" for="__nav_4_3">
1195         New API
1196         <span class="md-nav__icon md-icon"></span>
1197       </label>
1198       <nav class="md-nav" aria-label="New API" data-md-level="2">
1199         <label class="md-nav__title" for="__nav_4_3">
1200           <span class="md-nav__icon md-icon"></span>
1201           New API
1202         </label>
1203         <ul class="md-nav__list" data-md-scrollfix>
1204
1205
1206
1207
1208
1209     <li class="md-nav__item">
1210       <a href="../../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1211         Writing a module
1212       </a>
1213     </li>
1214
1215
1216
1217
1218
1219
1220
1221     <li class="md-nav__item">
1222       <a href="../../../../javascript/new-api_data-structures/" class="md-nav__link">
1223         Data Structures
1224       </a>
1225     </li>
1226
1227
1228
1229
1230
1231
1232
1233     <li class="md-nav__item">
1234       <a href="../../../../javascript/new-api_core/" class="md-nav__link">
1235         Core Functions
1236       </a>
1237     </li>
1238
1239
1240
1241
1242
1243
1244
1245     <li class="md-nav__item">
1246       <a href="../../../../javascript/new-api_dom/" class="md-nav__link">
1247         DOM
1248       </a>
1249     </li>
1250
1251
1252
1253
1254
1255
1256
1257     <li class="md-nav__item">
1258       <a href="../../../../javascript/new-api_events/" class="md-nav__link">
1259         Event Handling
1260       </a>
1261     </li>
1262
1263
1264
1265
1266
1267
1268
1269     <li class="md-nav__item">
1270       <a href="../../../../javascript/new-api_ajax/" class="md-nav__link">
1271         Ajax
1272       </a>
1273     </li>
1274
1275
1276
1277
1278
1279
1280
1281     <li class="md-nav__item">
1282       <a href="../../../../javascript/new-api_dialogs/" class="md-nav__link">
1283         Dialogs
1284       </a>
1285     </li>
1286
1287
1288
1289
1290
1291
1292
1293     <li class="md-nav__item">
1294       <a href="../../../../javascript/new-api_browser/" class="md-nav__link">
1295         Browser and Screen Sizes
1296       </a>
1297     </li>
1298
1299
1300
1301
1302
1303
1304
1305     <li class="md-nav__item">
1306       <a href="../../../../javascript/new-api_ui/" class="md-nav__link">
1307         User Interface
1308       </a>
1309     </li>
1310
1311
1312
1313         </ul>
1314       </nav>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item">
1324       <a href="../../../../javascript/legacy-api/" class="md-nav__link">
1325         Legacy API
1326       </a>
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../../../../javascript/helper-functions/" class="md-nav__link">
1337         Helper Functions
1338       </a>
1339     </li>
1340
1341
1342
1343
1344
1345
1346
1347     <li class="md-nav__item">
1348       <a href="../../../../javascript/code-snippets/" class="md-nav__link">
1349         Code Snippets
1350       </a>
1351     </li>
1352
1353
1354
1355         </ul>
1356       </nav>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369     <li class="md-nav__item md-nav__item--nested">
1370
1371
1372         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1373
1374       <label class="md-nav__link" for="__nav_5">
1375         Package Components
1376         <span class="md-nav__icon md-icon"></span>
1377       </label>
1378       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1379         <label class="md-nav__title" for="__nav_5">
1380           <span class="md-nav__icon md-icon"></span>
1381           Package Components
1382         </label>
1383         <ul class="md-nav__list" data-md-scrollfix>
1384
1385
1386
1387
1388
1389     <li class="md-nav__item">
1390       <a href="../../../../package/package-xml/" class="md-nav__link">
1391         package.xml
1392       </a>
1393     </li>
1394
1395
1396
1397
1398
1399
1400
1401
1402     <li class="md-nav__item md-nav__item--nested">
1403
1404
1405         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1406
1407       <label class="md-nav__link" for="__nav_5_2">
1408         PIPs
1409         <span class="md-nav__icon md-icon"></span>
1410       </label>
1411       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1412         <label class="md-nav__title" for="__nav_5_2">
1413           <span class="md-nav__icon md-icon"></span>
1414           PIPs
1415         </label>
1416         <ul class="md-nav__list" data-md-scrollfix>
1417
1418
1419
1420
1421
1422     <li class="md-nav__item">
1423       <a href="../../../../package/pip/" class="md-nav__link">
1424         Overview
1425       </a>
1426     </li>
1427
1428
1429
1430
1431
1432
1433
1434     <li class="md-nav__item">
1435       <a href="../../../../package/pip/acl-option/" class="md-nav__link">
1436         aclOption
1437       </a>
1438     </li>
1439
1440
1441
1442
1443
1444
1445
1446     <li class="md-nav__item">
1447       <a href="../../../../package/pip/acp-menu/" class="md-nav__link">
1448         acpMenu
1449       </a>
1450     </li>
1451
1452
1453
1454
1455
1456
1457
1458     <li class="md-nav__item">
1459       <a href="../../../../package/pip/acp-search-provider/" class="md-nav__link">
1460         acpSearchProvider
1461       </a>
1462     </li>
1463
1464
1465
1466
1467
1468
1469
1470     <li class="md-nav__item">
1471       <a href="../../../../package/pip/acp-template/" class="md-nav__link">
1472         acpTemplate
1473       </a>
1474     </li>
1475
1476
1477
1478
1479
1480
1481
1482     <li class="md-nav__item">
1483       <a href="../../../../package/pip/bbcode/" class="md-nav__link">
1484         bbcode
1485       </a>
1486     </li>
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../../../../package/pip/box/" class="md-nav__link">
1496         box
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506     <li class="md-nav__item">
1507       <a href="../../../../package/pip/clipboard-action/" class="md-nav__link">
1508         clipboardAction
1509       </a>
1510     </li>
1511
1512
1513
1514
1515
1516
1517
1518     <li class="md-nav__item">
1519       <a href="../../../../package/pip/core-object/" class="md-nav__link">
1520         coreObject
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530     <li class="md-nav__item">
1531       <a href="../../../../package/pip/cronjob/" class="md-nav__link">
1532         cronjob
1533       </a>
1534     </li>
1535
1536
1537
1538
1539
1540
1541
1542     <li class="md-nav__item">
1543       <a href="../../../../package/pip/database/" class="md-nav__link">
1544         database
1545       </a>
1546     </li>
1547
1548
1549
1550
1551
1552
1553
1554     <li class="md-nav__item">
1555       <a href="../../../../package/pip/event-listener/" class="md-nav__link">
1556         eventListener
1557       </a>
1558     </li>
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../../../../package/pip/file/" class="md-nav__link">
1568         file
1569       </a>
1570     </li>
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../../../../package/pip/language/" class="md-nav__link">
1580         language
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590     <li class="md-nav__item">
1591       <a href="../../../../package/pip/media-provider/" class="md-nav__link">
1592         mediaProvider
1593       </a>
1594     </li>
1595
1596
1597
1598
1599
1600
1601
1602     <li class="md-nav__item">
1603       <a href="../../../../package/pip/menu/" class="md-nav__link">
1604         menu
1605       </a>
1606     </li>
1607
1608
1609
1610
1611
1612
1613
1614     <li class="md-nav__item">
1615       <a href="../../../../package/pip/menu-item/" class="md-nav__link">
1616         menuItem
1617       </a>
1618     </li>
1619
1620
1621
1622
1623
1624
1625
1626     <li class="md-nav__item">
1627       <a href="../../../../package/pip/object-type/" class="md-nav__link">
1628         objectType
1629       </a>
1630     </li>
1631
1632
1633
1634
1635
1636
1637
1638     <li class="md-nav__item">
1639       <a href="../../../../package/pip/object-type-definition/" class="md-nav__link">
1640         objectTypeDefinition
1641       </a>
1642     </li>
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item">
1651       <a href="../../../../package/pip/option/" class="md-nav__link">
1652         option
1653       </a>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../../../package/pip/page/" class="md-nav__link">
1664         page
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674     <li class="md-nav__item">
1675       <a href="../../../../package/pip/pip/" class="md-nav__link">
1676         pip
1677       </a>
1678     </li>
1679
1680
1681
1682
1683
1684
1685
1686     <li class="md-nav__item">
1687       <a href="../../../../package/pip/script/" class="md-nav__link">
1688         script
1689       </a>
1690     </li>
1691
1692
1693
1694
1695
1696
1697
1698     <li class="md-nav__item">
1699       <a href="../../../../package/pip/smiley/" class="md-nav__link">
1700         smiley
1701       </a>
1702     </li>
1703
1704
1705
1706
1707
1708
1709
1710     <li class="md-nav__item">
1711       <a href="../../../../package/pip/sql/" class="md-nav__link">
1712         sql
1713       </a>
1714     </li>
1715
1716
1717
1718
1719
1720
1721
1722     <li class="md-nav__item">
1723       <a href="../../../../package/pip/style/" class="md-nav__link">
1724         style
1725       </a>
1726     </li>
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../../../../package/pip/template/" class="md-nav__link">
1736         template
1737       </a>
1738     </li>
1739
1740
1741
1742
1743
1744
1745
1746     <li class="md-nav__item">
1747       <a href="../../../../package/pip/template-listener/" class="md-nav__link">
1748         templateListener
1749       </a>
1750     </li>
1751
1752
1753
1754
1755
1756
1757
1758     <li class="md-nav__item">
1759       <a href="../../../../package/pip/user-group-option/" class="md-nav__link">
1760         userGroupOption
1761       </a>
1762     </li>
1763
1764
1765
1766
1767
1768
1769
1770     <li class="md-nav__item">
1771       <a href="../../../../package/pip/user-menu/" class="md-nav__link">
1772         userMenu
1773       </a>
1774     </li>
1775
1776
1777
1778
1779
1780
1781
1782     <li class="md-nav__item">
1783       <a href="../../../../package/pip/user-notification-event/" class="md-nav__link">
1784         userNotificationEvent
1785       </a>
1786     </li>
1787
1788
1789
1790
1791
1792
1793
1794     <li class="md-nav__item">
1795       <a href="../../../../package/pip/user-option/" class="md-nav__link">
1796         userOption
1797       </a>
1798     </li>
1799
1800
1801
1802
1803
1804
1805
1806     <li class="md-nav__item">
1807       <a href="../../../../package/pip/user-profile-menu/" class="md-nav__link">
1808         userProfileMenu
1809       </a>
1810     </li>
1811
1812
1813
1814         </ul>
1815       </nav>
1816     </li>
1817
1818
1819
1820
1821
1822
1823
1824     <li class="md-nav__item">
1825       <a href="../../../../package/database-php-api/" class="md-nav__link">
1826         Database PHP API
1827       </a>
1828     </li>
1829
1830
1831
1832         </ul>
1833       </nav>
1834     </li>
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846     <li class="md-nav__item md-nav__item--nested">
1847
1848
1849         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1850
1851       <label class="md-nav__link" for="__nav_6">
1852         Migration
1853         <span class="md-nav__icon md-icon"></span>
1854       </label>
1855       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1856         <label class="md-nav__title" for="__nav_6">
1857           <span class="md-nav__icon md-icon"></span>
1858           Migration
1859         </label>
1860         <ul class="md-nav__list" data-md-scrollfix>
1861
1862
1863
1864
1865
1866
1867     <li class="md-nav__item md-nav__item--nested">
1868
1869
1870         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1871
1872       <label class="md-nav__link" for="__nav_6_1">
1873         Migrating from WSC 5.3
1874         <span class="md-nav__icon md-icon"></span>
1875       </label>
1876       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1877         <label class="md-nav__title" for="__nav_6_1">
1878           <span class="md-nav__icon md-icon"></span>
1879           Migrating from WSC 5.3
1880         </label>
1881         <ul class="md-nav__list" data-md-scrollfix>
1882
1883
1884
1885
1886
1887     <li class="md-nav__item">
1888       <a href="../../../../migration/wsc53/php/" class="md-nav__link">
1889         PHP API
1890       </a>
1891     </li>
1892
1893
1894
1895
1896
1897
1898
1899     <li class="md-nav__item">
1900       <a href="../../../../migration/wsc53/session/" class="md-nav__link">
1901         Session Handling and Authentication
1902       </a>
1903     </li>
1904
1905
1906
1907
1908
1909
1910
1911     <li class="md-nav__item">
1912       <a href="../../../../migration/wsc53/javascript/" class="md-nav__link">
1913         TypeScript and JavaScript
1914       </a>
1915     </li>
1916
1917
1918
1919
1920
1921
1922
1923     <li class="md-nav__item">
1924       <a href="../../../../migration/wsc53/templates/" class="md-nav__link">
1925         Templates
1926       </a>
1927     </li>
1928
1929
1930
1931
1932
1933
1934
1935     <li class="md-nav__item">
1936       <a href="../../../../migration/wsc53/libraries/" class="md-nav__link">
1937         Third Party Libraries
1938       </a>
1939     </li>
1940
1941
1942
1943         </ul>
1944       </nav>
1945     </li>
1946
1947
1948
1949
1950
1951
1952
1953
1954     <li class="md-nav__item md-nav__item--nested">
1955
1956
1957         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1958
1959       <label class="md-nav__link" for="__nav_6_2">
1960         Migrating from WSC 5.2
1961         <span class="md-nav__icon md-icon"></span>
1962       </label>
1963       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1964         <label class="md-nav__title" for="__nav_6_2">
1965           <span class="md-nav__icon md-icon"></span>
1966           Migrating from WSC 5.2
1967         </label>
1968         <ul class="md-nav__list" data-md-scrollfix>
1969
1970
1971
1972
1973
1974     <li class="md-nav__item">
1975       <a href="../../../../migration/wsc52/php/" class="md-nav__link">
1976         PHP API
1977       </a>
1978     </li>
1979
1980
1981
1982
1983
1984
1985
1986     <li class="md-nav__item">
1987       <a href="../../../../migration/wsc52/templates/" class="md-nav__link">
1988         Templates and Languages
1989       </a>
1990     </li>
1991
1992
1993
1994
1995
1996
1997
1998     <li class="md-nav__item">
1999       <a href="../../../../migration/wsc52/libraries/" class="md-nav__link">
2000         Third Party Libraries
2001       </a>
2002     </li>
2003
2004
2005
2006         </ul>
2007       </nav>
2008     </li>
2009
2010
2011
2012
2013
2014
2015
2016
2017     <li class="md-nav__item md-nav__item--nested">
2018
2019
2020         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
2021
2022       <label class="md-nav__link" for="__nav_6_3">
2023         Migrating from WSC 3.1
2024         <span class="md-nav__icon md-icon"></span>
2025       </label>
2026       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
2027         <label class="md-nav__title" for="__nav_6_3">
2028           <span class="md-nav__icon md-icon"></span>
2029           Migrating from WSC 3.1
2030         </label>
2031         <ul class="md-nav__list" data-md-scrollfix>
2032
2033
2034
2035
2036
2037     <li class="md-nav__item">
2038       <a href="../../../../migration/wsc31/php/" class="md-nav__link">
2039         PHP API
2040       </a>
2041     </li>
2042
2043
2044
2045         </ul>
2046       </nav>
2047     </li>
2048
2049
2050
2051
2052
2053
2054
2055
2056     <li class="md-nav__item md-nav__item--nested">
2057
2058
2059         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
2060
2061       <label class="md-nav__link" for="__nav_6_4">
2062         Migrating from WSC 3.0
2063         <span class="md-nav__icon md-icon"></span>
2064       </label>
2065       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
2066         <label class="md-nav__title" for="__nav_6_4">
2067           <span class="md-nav__icon md-icon"></span>
2068           Migrating from WSC 3.0
2069         </label>
2070         <ul class="md-nav__list" data-md-scrollfix>
2071
2072
2073
2074
2075
2076     <li class="md-nav__item">
2077       <a href="../../../../migration/wsc30/php/" class="md-nav__link">
2078         PHP API
2079       </a>
2080     </li>
2081
2082
2083
2084
2085
2086
2087
2088     <li class="md-nav__item">
2089       <a href="../../../../migration/wsc30/javascript/" class="md-nav__link">
2090         JavaScript API
2091       </a>
2092     </li>
2093
2094
2095
2096
2097
2098
2099
2100     <li class="md-nav__item">
2101       <a href="../../../../migration/wsc30/templates/" class="md-nav__link">
2102         Templates
2103       </a>
2104     </li>
2105
2106
2107
2108
2109
2110
2111
2112     <li class="md-nav__item">
2113       <a href="../../../../migration/wsc30/css/" class="md-nav__link">
2114         CSS
2115       </a>
2116     </li>
2117
2118
2119
2120
2121
2122
2123
2124     <li class="md-nav__item">
2125       <a href="../../../../migration/wsc30/package/" class="md-nav__link">
2126         Package Components
2127       </a>
2128     </li>
2129
2130
2131
2132         </ul>
2133       </nav>
2134     </li>
2135
2136
2137
2138
2139
2140
2141
2142
2143     <li class="md-nav__item md-nav__item--nested">
2144
2145
2146         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
2147
2148       <label class="md-nav__link" for="__nav_6_5">
2149         Migrating from WCF 2.1
2150         <span class="md-nav__icon md-icon"></span>
2151       </label>
2152       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
2153         <label class="md-nav__title" for="__nav_6_5">
2154           <span class="md-nav__icon md-icon"></span>
2155           Migrating from WCF 2.1
2156         </label>
2157         <ul class="md-nav__list" data-md-scrollfix>
2158
2159
2160
2161
2162
2163     <li class="md-nav__item">
2164       <a href="../../../../migration/wcf21/php/" class="md-nav__link">
2165         PHP API
2166       </a>
2167     </li>
2168
2169
2170
2171
2172
2173
2174
2175     <li class="md-nav__item">
2176       <a href="../../../../migration/wcf21/templates/" class="md-nav__link">
2177         Templates
2178       </a>
2179     </li>
2180
2181
2182
2183
2184
2185
2186
2187     <li class="md-nav__item">
2188       <a href="../../../../migration/wcf21/css/" class="md-nav__link">
2189         CSS
2190       </a>
2191     </li>
2192
2193
2194
2195
2196
2197
2198
2199     <li class="md-nav__item">
2200       <a href="../../../../migration/wcf21/package/" class="md-nav__link">
2201         Package Components
2202       </a>
2203     </li>
2204
2205
2206
2207         </ul>
2208       </nav>
2209     </li>
2210
2211
2212
2213         </ul>
2214       </nav>
2215     </li>
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227     <li class="md-nav__item md-nav__item--nested">
2228
2229
2230         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
2231
2232       <label class="md-nav__link" for="__nav_7">
2233         Tutorials
2234         <span class="md-nav__icon md-icon"></span>
2235       </label>
2236       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
2237         <label class="md-nav__title" for="__nav_7">
2238           <span class="md-nav__icon md-icon"></span>
2239           Tutorials
2240         </label>
2241         <ul class="md-nav__list" data-md-scrollfix>
2242
2243
2244
2245
2246
2247
2248     <li class="md-nav__item md-nav__item--nested">
2249
2250
2251         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
2252
2253       <label class="md-nav__link" for="__nav_7_1">
2254         Tutorial Series
2255         <span class="md-nav__icon md-icon"></span>
2256       </label>
2257       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
2258         <label class="md-nav__title" for="__nav_7_1">
2259           <span class="md-nav__icon md-icon"></span>
2260           Tutorial Series
2261         </label>
2262         <ul class="md-nav__list" data-md-scrollfix>
2263
2264
2265
2266
2267
2268     <li class="md-nav__item">
2269       <a href="../../../../tutorial/series/overview/" class="md-nav__link">
2270         Overview
2271       </a>
2272     </li>
2273
2274
2275
2276
2277
2278
2279
2280     <li class="md-nav__item">
2281       <a href="../../../../tutorial/series/part_1/" class="md-nav__link">
2282         Part 1
2283       </a>
2284     </li>
2285
2286
2287
2288
2289
2290
2291
2292     <li class="md-nav__item">
2293       <a href="../../../../tutorial/series/part_2/" class="md-nav__link">
2294         Part 2
2295       </a>
2296     </li>
2297
2298
2299
2300
2301
2302
2303
2304     <li class="md-nav__item">
2305       <a href="../../../../tutorial/series/part_3/" class="md-nav__link">
2306         Part 3
2307       </a>
2308     </li>
2309
2310
2311
2312
2313
2314
2315
2316     <li class="md-nav__item">
2317       <a href="../../../../tutorial/series/part_4/" class="md-nav__link">
2318         Part 4
2319       </a>
2320     </li>
2321
2322
2323
2324         </ul>
2325       </nav>
2326     </li>
2327
2328
2329
2330         </ul>
2331       </nav>
2332     </li>
2333
2334
2335
2336   </ul>
2337 </nav>
2338                   </div>
2339                 </div>
2340               </div>
2341
2342
2343
2344               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2345                 <div class="md-sidebar__scrollwrap">
2346                   <div class="md-sidebar__inner">
2347
2348 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2349
2350
2351
2352
2353
2354     <label class="md-nav__title" for="__toc">
2355       <span class="md-nav__icon md-icon"></span>
2356       Table of contents
2357     </label>
2358     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2359
2360         <li class="md-nav__item">
2361   <a href="#abstract-form-fields" class="md-nav__link">
2362     Abstract Form Fields
2363   </a>
2364
2365     <nav class="md-nav" aria-label="Abstract Form Fields">
2366       <ul class="md-nav__list">
2367
2368           <li class="md-nav__item">
2369   <a href="#abstractformfield" class="md-nav__link">
2370     AbstractFormField
2371   </a>
2372
2373 </li>
2374
2375           <li class="md-nav__item">
2376   <a href="#abstractnumericformfield" class="md-nav__link">
2377     AbstractNumericFormField
2378   </a>
2379
2380 </li>
2381
2382       </ul>
2383     </nav>
2384
2385 </li>
2386
2387         <li class="md-nav__item">
2388   <a href="#general-form-fields" class="md-nav__link">
2389     General Form Fields
2390   </a>
2391
2392     <nav class="md-nav" aria-label="General Form Fields">
2393       <ul class="md-nav__list">
2394
2395           <li class="md-nav__item">
2396   <a href="#booleanformfield" class="md-nav__link">
2397     BooleanFormField
2398   </a>
2399
2400 </li>
2401
2402           <li class="md-nav__item">
2403   <a href="#checkboxformfield" class="md-nav__link">
2404     CheckboxFormField
2405   </a>
2406
2407 </li>
2408
2409           <li class="md-nav__item">
2410   <a href="#classnameformfield" class="md-nav__link">
2411     ClassNameFormField
2412   </a>
2413
2414 </li>
2415
2416           <li class="md-nav__item">
2417   <a href="#dateformfield" class="md-nav__link">
2418     DateFormField
2419   </a>
2420
2421 </li>
2422
2423           <li class="md-nav__item">
2424   <a href="#descriptionformfield" class="md-nav__link">
2425     DescriptionFormField
2426   </a>
2427
2428 </li>
2429
2430           <li class="md-nav__item">
2431   <a href="#emailformfield" class="md-nav__link">
2432     EmailFormField
2433   </a>
2434
2435 </li>
2436
2437           <li class="md-nav__item">
2438   <a href="#floatformfield" class="md-nav__link">
2439     FloatFormField
2440   </a>
2441
2442 </li>
2443
2444           <li class="md-nav__item">
2445   <a href="#iconformfield" class="md-nav__link">
2446     IconFormField
2447   </a>
2448
2449 </li>
2450
2451           <li class="md-nav__item">
2452   <a href="#integerformfield" class="md-nav__link">
2453     IntegerFormField
2454   </a>
2455
2456 </li>
2457
2458           <li class="md-nav__item">
2459   <a href="#isdisabledformfield" class="md-nav__link">
2460     IsDisabledFormField
2461   </a>
2462
2463 </li>
2464
2465           <li class="md-nav__item">
2466   <a href="#itemlistformfield" class="md-nav__link">
2467     ItemListFormField
2468   </a>
2469
2470 </li>
2471
2472           <li class="md-nav__item">
2473   <a href="#multilinetextformfield" class="md-nav__link">
2474     MultilineTextFormField
2475   </a>
2476
2477 </li>
2478
2479           <li class="md-nav__item">
2480   <a href="#multipleselectionformfield" class="md-nav__link">
2481     MultipleSelectionFormField
2482   </a>
2483
2484 </li>
2485
2486           <li class="md-nav__item">
2487   <a href="#radiobuttonformfield" class="md-nav__link">
2488     RadioButtonFormField
2489   </a>
2490
2491 </li>
2492
2493           <li class="md-nav__item">
2494   <a href="#ratingformfield" class="md-nav__link">
2495     RatingFormField
2496   </a>
2497
2498 </li>
2499
2500           <li class="md-nav__item">
2501   <a href="#showorderformfield" class="md-nav__link">
2502     ShowOrderFormField
2503   </a>
2504
2505 </li>
2506
2507           <li class="md-nav__item">
2508   <a href="#singleselectionformfield" class="md-nav__link">
2509     SingleSelectionFormField
2510   </a>
2511
2512 </li>
2513
2514           <li class="md-nav__item">
2515   <a href="#sortorderformfield" class="md-nav__link">
2516     SortOrderFormField
2517   </a>
2518
2519 </li>
2520
2521           <li class="md-nav__item">
2522   <a href="#textformfield" class="md-nav__link">
2523     TextFormField
2524   </a>
2525
2526 </li>
2527
2528           <li class="md-nav__item">
2529   <a href="#titleformfield" class="md-nav__link">
2530     TitleFormField
2531   </a>
2532
2533 </li>
2534
2535           <li class="md-nav__item">
2536   <a href="#urlformfield" class="md-nav__link">
2537     UrlFormField
2538   </a>
2539
2540 </li>
2541
2542       </ul>
2543     </nav>
2544
2545 </li>
2546
2547         <li class="md-nav__item">
2548   <a href="#specific-fields" class="md-nav__link">
2549     Specific Fields
2550   </a>
2551
2552     <nav class="md-nav" aria-label="Specific Fields">
2553       <ul class="md-nav__list">
2554
2555           <li class="md-nav__item">
2556   <a href="#aclformfield" class="md-nav__link">
2557     AclFormField
2558   </a>
2559
2560 </li>
2561
2562           <li class="md-nav__item">
2563   <a href="#buttonformfield" class="md-nav__link">
2564     ButtonFormField
2565   </a>
2566
2567 </li>
2568
2569           <li class="md-nav__item">
2570   <a href="#captchaformfield" class="md-nav__link">
2571     CaptchaFormField
2572   </a>
2573
2574 </li>
2575
2576           <li class="md-nav__item">
2577   <a href="#contentlanguageformfield" class="md-nav__link">
2578     ContentLanguageFormField
2579   </a>
2580
2581 </li>
2582
2583           <li class="md-nav__item">
2584   <a href="#labelformfield" class="md-nav__link">
2585     LabelFormField
2586   </a>
2587
2588 </li>
2589
2590           <li class="md-nav__item">
2591   <a href="#optionformfield" class="md-nav__link">
2592     OptionFormField
2593   </a>
2594
2595 </li>
2596
2597           <li class="md-nav__item">
2598   <a href="#simpleaclformfield" class="md-nav__link">
2599     SimpleAclFormField
2600   </a>
2601
2602 </li>
2603
2604           <li class="md-nav__item">
2605   <a href="#singlemediaselectionformfield" class="md-nav__link">
2606     SingleMediaSelectionFormField
2607   </a>
2608
2609 </li>
2610
2611           <li class="md-nav__item">
2612   <a href="#tagformfield" class="md-nav__link">
2613     TagFormField
2614   </a>
2615
2616 </li>
2617
2618           <li class="md-nav__item">
2619   <a href="#uploadformfield" class="md-nav__link">
2620     UploadFormField
2621   </a>
2622
2623     <nav class="md-nav" aria-label="UploadFormField">
2624       <ul class="md-nav__list">
2625
2626           <li class="md-nav__item">
2627   <a href="#provide-value-from-database-object" class="md-nav__link">
2628     Provide value from database object
2629   </a>
2630
2631 </li>
2632
2633           <li class="md-nav__item">
2634   <a href="#process-files" class="md-nav__link">
2635     Process files
2636   </a>
2637
2638 </li>
2639
2640       </ul>
2641     </nav>
2642
2643 </li>
2644
2645           <li class="md-nav__item">
2646   <a href="#userformfield" class="md-nav__link">
2647     UserFormField
2648   </a>
2649
2650 </li>
2651
2652           <li class="md-nav__item">
2653   <a href="#userpasswordfield" class="md-nav__link">
2654     UserPasswordField
2655   </a>
2656
2657 </li>
2658
2659           <li class="md-nav__item">
2660   <a href="#usergroupoptionformfield" class="md-nav__link">
2661     UserGroupOptionFormField
2662   </a>
2663
2664 </li>
2665
2666           <li class="md-nav__item">
2667   <a href="#usernameformfield" class="md-nav__link">
2668     UsernameFormField
2669   </a>
2670
2671 </li>
2672
2673       </ul>
2674     </nav>
2675
2676 </li>
2677
2678         <li class="md-nav__item">
2679   <a href="#wysiwyg-form-container" class="md-nav__link">
2680     Wysiwyg form container
2681   </a>
2682
2683     <nav class="md-nav" aria-label="Wysiwyg form container">
2684       <ul class="md-nav__list">
2685
2686           <li class="md-nav__item">
2687   <a href="#wysiwygattachmentformfield" class="md-nav__link">
2688     WysiwygAttachmentFormField
2689   </a>
2690
2691 </li>
2692
2693           <li class="md-nav__item">
2694   <a href="#wysiwygpollformcontainer" class="md-nav__link">
2695     WysiwygPollFormContainer
2696   </a>
2697
2698 </li>
2699
2700           <li class="md-nav__item">
2701   <a href="#wysiwygsmileyformcontainer" class="md-nav__link">
2702     WysiwygSmileyFormContainer
2703   </a>
2704
2705     <nav class="md-nav" aria-label="WysiwygSmileyFormContainer">
2706       <ul class="md-nav__list">
2707
2708           <li class="md-nav__item">
2709   <a href="#wysiwygsmileyformnode" class="md-nav__link">
2710     WysiwygSmileyFormNode
2711   </a>
2712
2713 </li>
2714
2715       </ul>
2716     </nav>
2717
2718 </li>
2719
2720           <li class="md-nav__item">
2721   <a href="#example" class="md-nav__link">
2722     Example
2723   </a>
2724
2725 </li>
2726
2727           <li class="md-nav__item">
2728   <a href="#wysiwygformfield" class="md-nav__link">
2729     WysiwygFormField
2730   </a>
2731
2732 </li>
2733
2734           <li class="md-nav__item">
2735   <a href="#twysiwygformnode" class="md-nav__link">
2736     TWysiwygFormNode
2737   </a>
2738
2739 </li>
2740
2741       </ul>
2742     </nav>
2743
2744 </li>
2745
2746         <li class="md-nav__item">
2747   <a href="#single-use-form-fields" class="md-nav__link">
2748     Single-Use Form Fields
2749   </a>
2750
2751     <nav class="md-nav" aria-label="Single-Use Form Fields">
2752       <ul class="md-nav__list">
2753
2754           <li class="md-nav__item">
2755   <a href="#bbcodeattributesformfield" class="md-nav__link">
2756     BBCodeAttributesFormField
2757   </a>
2758
2759 </li>
2760
2761           <li class="md-nav__item">
2762   <a href="#devtoolsprojectexcludedpackagesformfield" class="md-nav__link">
2763     DevtoolsProjectExcludedPackagesFormField
2764   </a>
2765
2766 </li>
2767
2768           <li class="md-nav__item">
2769   <a href="#devtoolsprojectinstructionsformfield" class="md-nav__link">
2770     DevtoolsProjectInstructionsFormField
2771   </a>
2772
2773 </li>
2774
2775           <li class="md-nav__item">
2776   <a href="#devtoolsprojectoptionalpackagesformfield" class="md-nav__link">
2777     DevtoolsProjectOptionalPackagesFormField
2778   </a>
2779
2780 </li>
2781
2782           <li class="md-nav__item">
2783   <a href="#devtoolsprojectrequiredpackagesformfield" class="md-nav__link">
2784     DevtoolsProjectRequiredPackagesFormField
2785   </a>
2786
2787 </li>
2788
2789       </ul>
2790     </nav>
2791
2792 </li>
2793
2794     </ul>
2795
2796 </nav>
2797                   </div>
2798                 </div>
2799               </div>
2800
2801
2802           <div class="md-content" data-md-component="content">
2803             <article class="md-content__inner md-typeset">
2804
2805
2806                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/form_builder/form_fields.md" title="Edit this page" class="md-content__button md-icon">
2807                     <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>
2808                   </a>
2809
2810
2811                 <h1 id="form-builder-fields">Form Builder Fields<a class="headerlink" href="#form-builder-fields" title="Permanent link">#</a></h1>
2812 <h2 id="abstract-form-fields">Abstract Form Fields<a class="headerlink" href="#abstract-form-fields" title="Permanent link">#</a></h2>
2813 <p>The following form field classes cannot be instantiated directly because they are abstract, but they can/must be used when creating own form field classes. </p>
2814 <h3 id="abstractformfield"><code>AbstractFormField</code><a class="headerlink" href="#abstractformfield" title="Permanent link">#</a></h3>
2815 <p><code>AbstractFormField</code> is the abstract default implementation of the <code>IFormField</code> interface and it is expected that every implementation of <code>IFormField</code> implements the interface by extending this class.</p>
2816 <h3 id="abstractnumericformfield"><code>AbstractNumericFormField</code><a class="headerlink" href="#abstractnumericformfield" title="Permanent link">#</a></h3>
2817 <p><code>AbstractNumericFormField</code> is the abstract implementation of a form field handling a single numeric value.
2818 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, <code>IInputModeFormField</code>, <code>IMaximumFormField</code>, <code>IMinimumFormField</code>, <code>INullableFormField</code>, <code>IPlaceholderFormField</code> and <code>ISuffixedFormField</code>.
2819 If the property <code>$integerValues</code> is <code>true</code>, the form field works with integer values, otherwise it works with floating point numbers.
2820 The methods <code>step($step = null)</code> and <code>getStep()</code> can be used to set and get the step attribute of the <code>input</code> element.
2821 The default step for form fields with integer values is <code>1</code>.
2822 Otherwise, the default step is <code>any</code>.</p>
2823 <h2 id="general-form-fields">General Form Fields<a class="headerlink" href="#general-form-fields" title="Permanent link">#</a></h2>
2824 <p>The following form fields are general reusable fields without any underlying context.</p>
2825 <h3 id="booleanformfield"><code>BooleanFormField</code><a class="headerlink" href="#booleanformfield" title="Permanent link">#</a></h3>
2826 <p><code>BooleanFormField</code> is used for boolean (<code>0</code> or <code>1</code>, <code>yes</code> or <code>no</code>) values.
2827 Objects of this class require a label.
2828 The return value of <code>getSaveValue()</code> is the integer representation of the boolean value, i.e. <code>0</code> or <code>1</code>.
2829 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, and <code>IImmutableFormField</code>.</p>
2830 <h3 id="checkboxformfield"><code>CheckboxFormField</code><a class="headerlink" href="#checkboxformfield" title="Permanent link">#</a></h3>
2831 <div class="admonition info">
2832 <p class="admonition-title">Only available since version 5.3.2.</p>
2833 </div>
2834 <p><code>CheckboxFormField</code> extends <code>BooleanFormField</code> and offers a simple HTML checkbox.</p>
2835 <h3 id="classnameformfield"><code>ClassNameFormField</code><a class="headerlink" href="#classnameformfield" title="Permanent link">#</a></h3>
2836 <p><code>ClassNameFormField</code> is a <a href="#textformfield">text form field</a> that supports additional settings, specific to entering a PHP class name:</p>
2837 <ul>
2838 <li><code>classExists($classExists = true)</code> and <code>getClassExists()</code> can be used to ensure that the entered class currently exists in the installation.
2839   By default, the existance of the entered class is required.</li>
2840 <li><code>implementedInterface($interface)</code> and <code>getImplementedInterface()</code> can be used to ensure that the entered class implements the specified interface.
2841   By default, no interface is required.</li>
2842 <li><code>parentClass($parentClass)</code> and <code>getParentClass()</code> can be used to ensure that the entered class extends the specified class.
2843   By default, no parent class is required.</li>
2844 <li><code>instantiable($instantiable = true)</code> and <code>isInstantiable()</code> can be used to ensure that the entered class is instantiable.
2845   By default, entered classes have to instantiable.</li>
2846 </ul>
2847 <p>Additionally, the default id of a <code>ClassNameFormField</code> object is <code>className</code>, the default label is <code>wcf.form.field.className</code>, and if either an interface or a parent class is required, a default description is set if no description has already been set (<code>wcf.form.field.className.description.interface</code> and <code>wcf.form.field.className.description.parentClass</code>, respectively).</p>
2848 <h3 id="dateformfield"><code>DateFormField</code><a class="headerlink" href="#dateformfield" title="Permanent link">#</a></h3>
2849 <p><code>DateFormField</code> is a form field to enter a date (and optionally a time).
2850 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>INullableFormField</code>.
2851 The following methods are specific to this form field class:</p>
2852 <ul>
2853 <li><code>earliestDate($earliestDate)</code> and <code>getEarliestDate()</code> can be used to get and set the earliest selectable/valid date and <code>latestDate($latestDate)</code> and <code>getLatestDate()</code> can be used to get and set the latest selectable/valid date.
2854   The date passed to the setters must have the same format as set via <code>saveValueFormat()</code>.
2855   If a custom format is used, that format has to be set via <code>saveValueFormat()</code> before calling any of the setters.</li>
2856 <li><code>saveValueFormat($saveValueFormat)</code> and <code>getSaveValueFormat()</code> can be used to specify the date format of the value returned by <code>getSaveValue()</code>.
2857   By default, <code>U</code> is used as format.
2858   The <a href="https://secure.php.net/manual/en/function.date.php">PHP manual</a> provides an overview of supported formats.</li>
2859 <li><code>supportTime($supportsTime = true)</code> and <code>supportsTime()</code> can be used to toggle whether, in addition to a date, a time can also be specified.
2860   By default, specifying a time is disabled.</li>
2861 </ul>
2862 <h3 id="descriptionformfield"><code>DescriptionFormField</code><a class="headerlink" href="#descriptionformfield" title="Permanent link">#</a></h3>
2863 <p><code>DescriptionFormField</code> is a <a href="#multilinetextformfield">multi-line text form field</a> with <code>description</code> as the default id and <code>wcf.global.description</code> as the default label.</p>
2864 <h3 id="emailformfield"><code>EmailFormField</code><a class="headerlink" href="#emailformfield" title="Permanent link">#</a></h3>
2865 <p><code>EmailFormField</code> is a form field to enter an email address which is internally validated using <code>UserUtil::isValidEmail()</code>.
2866 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>II18nFormField</code>, <code>IImmutableFormField</code>, <code>IInputModeFormField</code>, <code>IPatternFormField</code>, and <code>IPlaceholderFormField</code>.</p>
2867 <h3 id="floatformfield"><code>FloatFormField</code><a class="headerlink" href="#floatformfield" title="Permanent link">#</a></h3>
2868 <p><code>FloatFormField</code> is an implementation of <a href="#abstractnumericformfield">AbstractNumericFormField</a> for floating point numbers.</p>
2869 <h3 id="iconformfield"><code>IconFormField</code><a class="headerlink" href="#iconformfield" title="Permanent link">#</a></h3>
2870 <p><code>IconFormField</code> is a form field to select a FontAwesome icon.</p>
2871 <h3 id="integerformfield"><code>IntegerFormField</code><a class="headerlink" href="#integerformfield" title="Permanent link">#</a></h3>
2872 <p><code>IntegerFormField</code> is an implementation of <a href="#abstractnumericformfield">AbstractNumericFormField</a> for integers.</p>
2873 <h3 id="isdisabledformfield"><code>IsDisabledFormField</code><a class="headerlink" href="#isdisabledformfield" title="Permanent link">#</a></h3>
2874 <p><code>IsDisabledFormField</code> is a <a href="#booleanformfield">boolean form field</a> with <code>isDisabled</code> as the default id.</p>
2875 <h3 id="itemlistformfield"><code>ItemListFormField</code><a class="headerlink" href="#itemlistformfield" title="Permanent link">#</a></h3>
2876 <p><code>ItemListFormField</code> is a form field in which multiple values can be entered and returned in different formats as save value.
2877 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>IMultipleFormField</code>.
2878 The <code>saveValueType($saveValueType)</code> and <code>getSaveValueType()</code> methods are specific to this form field class and determine the format of the save value.
2879 The following save value types are supported:</p>
2880 <ul>
2881 <li><code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY</code> adds a custom data processor that writes the form field data directly in the parameters array and not in the data sub-array of the parameters array.</li>
2882 <li><code>ItemListFormField::SAVE_VALUE_TYPE_CSV</code> lets the value be returned as a string in which the values are concatenated by commas.</li>
2883 <li><code>ItemListFormField::SAVE_VALUE_TYPE_NSV</code> lets the value be returned as a string in which the values are concatenated by <code>\n</code>.</li>
2884 <li><code>ItemListFormField::SAVE_VALUE_TYPE_SSV</code> lets the value be returned as a string in which the values are concatenated by spaces.</li>
2885 </ul>
2886 <p>By default, <code>ItemListFormField::SAVE_VALUE_TYPE_CSV</code> is used.</p>
2887 <p>If <code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY</code> is used as save value type, <code>ItemListFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant array into the <code>$parameters</code> array directly using the object property as the array key.</p>
2888 <h3 id="multilinetextformfield"><code>MultilineTextFormField</code><a class="headerlink" href="#multilinetextformfield" title="Permanent link">#</a></h3>
2889 <p><code>MultilineTextFormField</code> is a <a href="#textformfield">text form field</a> that supports multiple rows of text.
2890 The methods <code>rows($rows)</code> and <code>getRows()</code> can be used to set and get the number of rows of the <code>textarea</code> elements.
2891 The default number of rows is <code>10</code>.
2892 These methods do <strong>not</strong>, however, restrict the number of text rows that canbe entered.</p>
2893 <h3 id="multipleselectionformfield"><code>MultipleSelectionFormField</code><a class="headerlink" href="#multipleselectionformfield" title="Permanent link">#</a></h3>
2894 <p><code>MultipleSelectionFormField</code> is a form fields that allows the selection of multiple options out of a predefined list of available options.
2895 The class implements <code>IAttributeFormField</code>, <code>ICssClassFormField</code>, <code>IFilterableSelectionFormField</code>, <code>IImmutableFormField</code>, and <code>INullableFormField</code>.
2896 If the field is nullable and no option is selected, <code>null</code> is returned as the save value.</p>
2897 <h3 id="radiobuttonformfield"><code>RadioButtonFormField</code><a class="headerlink" href="#radiobuttonformfield" title="Permanent link">#</a></h3>
2898 <p><code>RadioButtonFormField</code> is a form fields that allows the selection of a single option out of a predefined list of available options using radiobuttons.
2899 The class implements <code>IAttributeFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>ISelectionFormField</code>.</p>
2900 <h3 id="ratingformfield"><code>RatingFormField</code><a class="headerlink" href="#ratingformfield" title="Permanent link">#</a></h3>
2901 <p><code>RatingFormField</code> is a form field to set a rating for an object.
2902 The class implements <code>IImmutableFormField</code>, <code>IMaximumFormField</code>, <code>IMinimumFormField</code>, and <code>INullableFormField</code>.
2903 Form fields of this class have <code>rating</code> as their default id, <code>wcf.form.field.rating</code> as their default label, <code>1</code> as their default minimum, and <code>5</code> as their default maximum.
2904 For this field, the minimum and maximum refer to the minimum and maximum rating an object can get.
2905 When the field is shown, there will be <code>maximum() - minimum() + 1</code> icons be shown with additional CSS classes that can be set and gotten via <code>defaultCssClasses(array $cssClasses)</code> and <code>getDefaultCssClasses()</code>.
2906 If a rating values is set, the first <code>getValue()</code> icons will instead use the classes that can be set and gotten via <code>activeCssClasses(array $cssClasses)</code> and <code>getActiveCssClasses()</code>.
2907 By default, the only default class is <code>fa-star-o</code> and the active classes are <code>fa-star</code> and <code>orange</code>. </p>
2908 <h3 id="showorderformfield"><code>ShowOrderFormField</code><a class="headerlink" href="#showorderformfield" title="Permanent link">#</a></h3>
2909 <p><code>ShowOrderFormField</code> is a <a href="#singleselectionformfield">single selection form field</a> for which the selected value determines the position at which an object is shown.
2910 The show order field provides a list of all siblings and the object will be positioned <strong>after</strong> the selected sibling.
2911 To insert objects at the very beginning, the <code>options()</code> automatically method prepends an additional option for that case so that only the existing siblings need to be passed.
2912 The default id of instances of this class is <code>showOrder</code> and their default label is <code>wcf.form.field.showOrder</code>.</p>
2913 <div class="admonition info">
2914 <p class="admonition-title">It is important that the relevant object property is always kept updated. Whenever a new object is added or an existing object is edited or delete, the values of the other objects have to be adjusted to ensure consecutive numbering.</p>
2915 </div>
2916 <h3 id="singleselectionformfield"><code>SingleSelectionFormField</code><a class="headerlink" href="#singleselectionformfield" title="Permanent link">#</a></h3>
2917 <p><code>SingleSelectionFormField</code> is a form fields that allows the selection of a single option out of a predefined list of available options.
2918 The class implements <code>ICssClassFormField</code>, <code>IFilterableSelectionFormField</code>, <code>IImmutableFormField</code>, and <code>INullableFormField</code>.
2919 If the field is nullable and the current form field value is considered <code>empty</code> by PHP, <code>null</code> is returned as the save value.</p>
2920 <h3 id="sortorderformfield"><code>SortOrderFormField</code><a class="headerlink" href="#sortorderformfield" title="Permanent link">#</a></h3>
2921 <p><code>SingleSelectionFormField</code> is a <a href="#singleselectionformfield">single selection form field</a> with default id <code>sortOrder</code>, default label <code>wcf.global.showOrder</code> and default options <code>ASC: wcf.global.sortOrder.ascending</code> and <code>DESC: wcf.global.sortOrder.descending</code>.</p>
2922 <h3 id="textformfield"><code>TextFormField</code><a class="headerlink" href="#textformfield" title="Permanent link">#</a></h3>
2923 <p><code>TextFormField</code> is a form field that allows entering a single line of text.
2924 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, <code>II18nFormField</code>, <code>IInputModeFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, <code>IPatternFormField</code>, and <code>IPlaceholderFormField</code>.</p>
2925 <h3 id="titleformfield"><code>TitleFormField</code><a class="headerlink" href="#titleformfield" title="Permanent link">#</a></h3>
2926 <p><code>TitleFormField</code> is a <a href="#textformfield">text form field</a> with <code>title</code> as the default id and <code>wcf.global.title</code> as the default label.</p>
2927 <h3 id="urlformfield"><code>UrlFormField</code><a class="headerlink" href="#urlformfield" title="Permanent link">#</a></h3>
2928 <p><code>UrlFormField</code> is a <a href="#textformfield">text form field</a> whose values are checked via <code>Url::is()</code>.</p>
2929 <h2 id="specific-fields">Specific Fields<a class="headerlink" href="#specific-fields" title="Permanent link">#</a></h2>
2930 <p>The following form fields are reusable fields that generally are bound to a certain API or <code>DatabaseObject</code> implementation.</p>
2931 <h3 id="aclformfield"><code>AclFormField</code><a class="headerlink" href="#aclformfield" title="Permanent link">#</a></h3>
2932 <p><code>AclFormField</code> is used for setting up acl values for specific objects.
2933 The class implements <code>IObjectTypeFormField</code> and requires an object type of the object type definition <code>com.woltlab.wcf.acl</code>.
2934 Additionally, the class provides the methods <code>categoryName($categoryName)</code> and <code>getCategoryName()</code> that allow setting a specific name or filter for the acl option categories whose acl options are shown.
2935 A category name of <code>null</code> signals that no category filter is used.</p>
2936 <p><code>AclFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant ACL object type id into the <code>$parameters</code> array directly using <code>{$objectProperty}_aclObjectTypeID</code> as the array key.
2937 The relevant database object action method is expected, based on the given ACL object type id, to save the ACL option values appropriately.</p>
2938 <h3 id="buttonformfield"><code>ButtonFormField</code><a class="headerlink" href="#buttonformfield" title="Permanent link">#</a></h3>
2939 <div class="admonition info">
2940 <p class="admonition-title">Only available since version 5.4.</p>
2941 </div>
2942 <p><code>ButtonFormField</code> shows a submit button as part of the form.
2943 The class implements <code>IAttributeFormField</code> and <code>ICssClassFormField</code>.</p>
2944 <p>Specifically for this form field, there is the <code>IsNotClickedFormFieldDependency</code> dependency with which certain parts of the form will only be processed if the relevent button has not clicked. </p>
2945 <h3 id="captchaformfield"><code>CaptchaFormField</code><a class="headerlink" href="#captchaformfield" title="Permanent link">#</a></h3>
2946 <p><code>CaptchaFormField</code> is used to add captcha protection to the form.</p>
2947 <p>You must specify a captcha object type (<code>com.woltlab.wcf.captcha</code>) using the <code>objectType()</code> method.</p>
2948 <h3 id="contentlanguageformfield"><code>ContentLanguageFormField</code><a class="headerlink" href="#contentlanguageformfield" title="Permanent link">#</a></h3>
2949 <p><code>ContentLanguageFormField</code> is used to select the content language of an object.
2950 Fields of this class are only available if multilingualism is enabled and if there are content languages.
2951 The class implements <code>IImmutableFormField</code>.</p>
2952 <h3 id="labelformfield"><code>LabelFormField</code><a class="headerlink" href="#labelformfield" title="Permanent link">#</a></h3>
2953 <p><code>LabelFormField</code> is used to select a label from a specific label group.
2954 The class implements <code>IObjectTypeFormNode</code>.</p>
2955 <p>The <code>labelGroup(ViewableLabelGroup $labelGroup)</code> and <code>getLabelGroup()</code> methods are specific to this form field class and can be used to set and get the label group whose labels can be selected.
2956 Additionally, there is the static method <code>createFields($objectType, array $labelGroups, $objectProperty = 'labelIDs)</code> that can be used to create all relevant label form fields for a given list of label groups.
2957 In most cases, <code>LabelFormField::createFields()</code> should be used.</p>
2958 <h3 id="optionformfield"><code>OptionFormField</code><a class="headerlink" href="#optionformfield" title="Permanent link">#</a></h3>
2959 <p><code>OptionFormField</code> is an <a href="#itemlistformfield">item list form field</a> to set a list of options.
2960 The class implements <code>IPackagesFormField</code> and only options of the set packages are considered available.
2961 The default label of instances of this class is <code>wcf.form.field.option</code> and their default id is <code>options</code>.</p>
2962 <h3 id="simpleaclformfield"><code>SimpleAclFormField</code><a class="headerlink" href="#simpleaclformfield" title="Permanent link">#</a></h3>
2963 <p><code>SimpleAclFormField</code> is used for setting up simple acl values (one <code>yes</code>/<code>no</code> option per user and user group) for specific objects.</p>
2964 <p><code>SimpleAclFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant simple ACL data array into the <code>$parameters</code> array directly using the object property as the array key.</p>
2965 <h3 id="singlemediaselectionformfield"><code>SingleMediaSelectionFormField</code><a class="headerlink" href="#singlemediaselectionformfield" title="Permanent link">#</a></h3>
2966 <p><code>SingleMediaSelectionFormField</code> is used to select a specific media file.
2967 The class implements <code>IImmutableFormField</code>.</p>
2968 <p>The following methods are specific to this form field class:</p>
2969 <ul>
2970 <li><code>imageOnly($imageOnly = true)</code> and <code>isImageOnly()</code> can be used to set and check if only images may be selected.</li>
2971 <li><code>getMedia()</code> returns the media file based on the current field value if a field is set.</li>
2972 </ul>
2973 <h3 id="tagformfield"><code>TagFormField</code><a class="headerlink" href="#tagformfield" title="Permanent link">#</a></h3>
2974 <p><code>TagFormField</code> is a form field to enter tags.
2975 The class implements <code>IAttributeFormField</code> and <code>IObjectTypeFormNode</code>.
2976 Arrays passed to <code>TagFormField::values()</code> can contain tag names as strings and <code>Tag</code> objects.
2977 The default label of instances of this class is <code>wcf.tagging.tags</code> and their default description is <code>wcf.tagging.tags.description</code>.</p>
2978 <p><code>TagFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the array with entered tag names into the <code>$parameters</code> array directly using the object property as the array key.</p>
2979 <h3 id="uploadformfield"><code>UploadFormField</code><a class="headerlink" href="#uploadformfield" title="Permanent link">#</a></h3>
2980 <p><code>UploadFormField</code> is a form field that allows uploading files by the user.</p>
2981 <p><code>UploadFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the array of <code>wcf\system\file\upload\UploadFile\UploadFile</code> into the <code>$parameters</code> array directly using the object property as the array key. Also it registers the removed files as an array of <code>wcf\system\file\upload\UploadFile\UploadFile</code> into the <code>$parameters</code> array directly using the object property with the suffix <code>_removedFiles</code> as the array key.  </p>
2982 <p>The field supports additional settings:
2983 - <code>imageOnly($imageOnly = true)</code> and <code>isImageOnly()</code> can be used to ensure that the uploaded files are only images.
2984 - <code>allowSvgImage($allowSvgImages = true)</code> and <code>svgImageAllowed()</code> can be used to allow SVG images, if the image only mode is enabled (otherwise, the method will throw an exception). By default, SVG images are not allowed.</p>
2985 <h4 id="provide-value-from-database-object">Provide value from database object<a class="headerlink" href="#provide-value-from-database-object" title="Permanent link">#</a></h4>
2986 <p>To provide values from a database object, you should implement the method <code>get{$objectProperty}UploadFileLocations()</code> to your database object class. This method must return an array of strings with the locations of the files.</p>
2987 <h4 id="process-files">Process files<a class="headerlink" href="#process-files" title="Permanent link">#</a></h4>
2988 <p>To process files in the database object action class, you must <a href="https://secure.php.net/manual/en/function.rename.php"><code>rename</code></a> the file to the final destination. You get the temporary location, by calling the method <code>getLocation()</code> on the given <code>UploadFile</code> objects. After that, you call <code>setProcessed($location)</code> with <code>$location</code> contains the new file location. This method sets the <code>isProcessed</code> flag to true and saves the new location. For updating files, it is relevant, whether a given file is already processed or not. For this case, the <code>UploadFile</code> object has an method <code>isProcessed()</code> which indicates, whether a file is already processed or new uploaded.</p>
2989 <h3 id="userformfield"><code>UserFormField</code><a class="headerlink" href="#userformfield" title="Permanent link">#</a></h3>
2990 <p><code>UserFormField</code> is a form field to enter existing users.
2991 The class implements <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, <code>IImmutableFormField</code>, <code>IMultipleFormField</code>, and <code>INullableFormField</code>.
2992 While the user is presented the names of the specified users in the user interface, the field returns the ids of the users as data.
2993 The relevant <code>UserProfile</code> objects can be accessed via the <code>getUsers()</code> method.</p>
2994 <h3 id="userpasswordfield"><code>UserPasswordField</code><a class="headerlink" href="#userpasswordfield" title="Permanent link">#</a></h3>
2995 <div class="admonition info">
2996 <p class="admonition-title">Only available since version 5.4.</p>
2997 </div>
2998 <p><code>UserPasswordField</code> is a form field for users' to enter their current password.
2999 The class implements <code>IAttributeFormField</code>, <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, and <code>IPlaceholderFormField</code></p>
3000 <h3 id="usergroupoptionformfield"><code>UserGroupOptionFormField</code><a class="headerlink" href="#usergroupoptionformfield" title="Permanent link">#</a></h3>
3001 <p><code>UserGroupOptionFormField</code> is an <a href="#itemlistformfield">item list form field</a> to set a list of user group options/permissions.
3002 The class implements <code>IPackagesFormField</code> and only user group options of the set packages are considered available.
3003 The default label of instances of this class is <code>wcf.form.field.userGroupOption</code> and their default id is <code>permissions</code>.</p>
3004 <h3 id="usernameformfield"><code>UsernameFormField</code><a class="headerlink" href="#usernameformfield" title="Permanent link">#</a></h3>
3005 <p><code>UsernameFormField</code> is used for entering one non-existing username.
3006 The class implements <code>IAttributeFormField</code>, <code>IImmutableFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, <code>INullableFormField</code>, and <code>IPlaceholderFormField</code>.
3007 As usernames have a system-wide restriction of a minimum length of 3 and a maximum length of 100 characters, these values are also used as the default value for the field’s minimum and maximum length.</p>
3008 <h2 id="wysiwyg-form-container">Wysiwyg form container<a class="headerlink" href="#wysiwyg-form-container" title="Permanent link">#</a></h2>
3009 <p>To integrate a wysiwyg editor into a form, you have to create a <code>WysiwygFormContainer</code> object.
3010 This container takes care of creating all necessary form nodes listed below for a wysiwyg editor.</p>
3011 <div class="admonition warning">
3012 <p class="admonition-title">When creating the container object, its id has to be the id of the form field that will manage the actual text.</p>
3013 </div>
3014 <p>The following methods are specific to this form container class:</p>
3015 <ul>
3016 <li><code>addSettingsNode(IFormChildNode $settingsNode)</code> and <code>addSettingsNodes(array $settingsNodes)</code> can be used to add nodes to the settings tab container.</li>
3017 <li><code>attachmentData($objectType, $parentObjectID)</code> can be used to set the data relevant for attachment support.
3018   By default, not attachment data is set, thus attachments are not supported.</li>
3019 <li><code>getAttachmentField()</code>, <code>getPollContainer()</code>, <code>getSettingsContainer()</code>, <code>getSmiliesContainer()</code>, and <code>getWysiwygField()</code> can be used to get the different components of the wysiwyg form container once the form has been built.</li>
3020 <li><code>enablePreviewButton($enablePreviewButton)</code> can be used to set whether the preview button for the message is shown or not.
3021   By default, the preview button is shown.
3022   This method is only relevant before the form is built.
3023   Afterwards, the preview button availability can not be changed.
3024   Only available since WoltLab Suite Core 5.3.</li>
3025 <li><code>getObjectId()</code> returns the id of the edited object or <code>0</code> if no object is edited.</li>
3026 <li><code>getPreselect()</code>, <code>preselect($preselect)</code> can be used to set the value of the wysiwyg tab menu's <code>data-preselect</code> attribute used to determine which tab is preselected.
3027   By default, the preselect is <code>'true'</code> which is used to pre-select the first tab.</li>
3028 <li><code>messageObjectType($messageObjectType)</code> can be used to set the message object type.</li>
3029 <li><code>pollObjectType($pollObjectType)</code> can be used to set the poll object type.
3030   By default, no poll object type is set, thus the poll form field container is not available.</li>
3031 <li><code>supportMentions($supportMentions)</code> can be used to set if mentions are supported.
3032   By default, mentions are not supported.
3033   This method is only relevant before the form is built.
3034   Afterwards, mention support can only be changed via the wysiwyg form field.</li>
3035 <li><code>supportSmilies($supportSmilies)</code> can be used to set if smilies are supported.
3036   By default, smilies are supported.
3037   This method is only relevant before the form is built.
3038   Afterwards, smiley availability can only be changed via changing the availability of the smilies form container.</li>
3039 </ul>
3040 <h3 id="wysiwygattachmentformfield"><code>WysiwygAttachmentFormField</code><a class="headerlink" href="#wysiwygattachmentformfield" title="Permanent link">#</a></h3>
3041 <p><code>WysiwygAttachmentFormField</code> provides attachment support for a wysiwyg editor via a tab in the menu below the editor.
3042 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3043 The methods <code>attachmentHandler(AttachmentHandler $attachmentHandler)</code> and <code>getAttachmentHandler()</code> can be used to set and get the <code>AttachmentHandler</code> object that is used for uploaded attachments.</p>
3044 <h3 id="wysiwygpollformcontainer"><code>WysiwygPollFormContainer</code><a class="headerlink" href="#wysiwygpollformcontainer" title="Permanent link">#</a></h3>
3045 <p><code>WysiwygPollFormContainer</code> provides poll support for a wysiwyg editor via a tab in the menu below the editor.
3046 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3047 <code>WysiwygPollFormContainer</code> contains all form fields that are required to create polls and requires edited objects to implement <code>IPollContainer</code>.</p>
3048 <p>The following methods are specific to this form container class:</p>
3049 <ul>
3050 <li><code>getEndTimeField()</code> returns the form field to set the end time of the poll once the form has been built.</li>
3051 <li><code>getIsChangeableField()</code> returns the form field to set if poll votes can be changed once the form has been built.</li>
3052 <li><code>getIsPublicField()</code> returns the form field to set if poll results are public once the form has been built.</li>
3053 <li><code>getMaxVotesField()</code> returns the form field to set the maximum number of votes once the form has been built.</li>
3054 <li><code>getOptionsField()</code> returns the form field to set the poll options once the form has been built.</li>
3055 <li><code>getQuestionField()</code> returns the form field to set the poll question once the form has been built.</li>
3056 <li><code>getResultsRequireVoteField()</code> returns the form field to set if viewing the poll results requires voting once the form has been built.</li>
3057 <li><code>getSortByVotesField()</code> returns the form field to set if the results are sorted by votes once the form has been built.</li>
3058 </ul>
3059 <h3 id="wysiwygsmileyformcontainer"><code>WysiwygSmileyFormContainer</code><a class="headerlink" href="#wysiwygsmileyformcontainer" title="Permanent link">#</a></h3>
3060 <p><code>WysiwygSmileyFormContainer</code> provides smiley support for a wysiwyg editor via a tab in the menu below the editor.
3061 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3062 <code>WysiwygSmileyFormContainer</code> creates a sub-tab for each smiley category.</p>
3063 <h4 id="wysiwygsmileyformnode"><code>WysiwygSmileyFormNode</code><a class="headerlink" href="#wysiwygsmileyformnode" title="Permanent link">#</a></h4>
3064 <p><code>WysiwygSmileyFormNode</code> is contains the smilies of a specific category.
3065 This class should not be used directly but only via <code>WysiwygSmileyFormContainer</code>.</p>
3066 <h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h3>
3067 <p>The following code creates a WYSIWYG editor component for a <code>message</code> object property.
3068 As smilies are supported by default and an attachment object type is given, the tab menu below the editor has two tabs: “Smilies” and “Attachments”.
3069 Additionally, mentions and quotes are supported.</p>
3070 <div class="highlight"><pre><span></span><code><span class="nx">WysiwygFormContainer</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;message&#39;</span><span class="p">)</span>
3071     <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;foo.bar.message&#39;</span><span class="p">)</span>
3072     <span class="o">-&gt;</span><span class="na">messageObjectType</span><span class="p">(</span><span class="s1">&#39;com.example.foo.bar&#39;</span><span class="p">)</span>
3073     <span class="o">-&gt;</span><span class="na">attachmentData</span><span class="p">(</span><span class="s1">&#39;com.example.foo.bar&#39;</span><span class="p">)</span>
3074     <span class="o">-&gt;</span><span class="na">supportMentions</span><span class="p">()</span>
3075     <span class="o">-&gt;</span><span class="na">supportQuotes</span><span class="p">()</span>
3076 </code></pre></div>
3077 <h3 id="wysiwygformfield"><code>WysiwygFormField</code><a class="headerlink" href="#wysiwygformfield" title="Permanent link">#</a></h3>
3078 <p><code>WysiwygFormField</code> is used for wysiwyg editor form fields.
3079 This class should, in general, not be used directly but only via <code>WysiwygFormContainer</code>.
3080 The class implements <code>IAttributeFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, and <code>IObjectTypeFormNode</code> and requires an object type of the object type definition <code>com.woltlab.wcf.message</code>.
3081 The following methods are specific to this form field class:</p>
3082 <ul>
3083 <li><code>autosaveId($autosaveId)</code> and <code>getAutosaveId()</code> can be used enable automatically saving the current editor contents in the browser using the given id.
3084   An empty string signals that autosaving is disabled.</li>
3085 <li><code>lastEditTime($lastEditTime)</code> and <code>getLastEditTime()</code> can be used to set the last time the contents have been edited and saved so that the JavaScript can determine if the contents stored in the browser are older or newer.
3086   <code>0</code> signals that no last edit time has been set.</li>
3087 <li><code>supportAttachments($supportAttachments)</code> and <code>supportsAttachments()</code> can be used to set and check if the form field supports attachments.</li>
3088 </ul>
3089 <p>!!! warning "It is not sufficient to simply signal attachment support via these methods for attachments to work. These methods are relevant internally to signal the Javascript code that the editor supports attachments. Actual attachment support is provided by <code>WysiwygAttachmentFormField</code>."
3090 - <code>supportMentions($supportMentions)</code> and <code>supportsMentions()</code> can be used to set and check if the form field supports mentions of other users.</p>
3091 <p><code>WysiwygFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant simple ACL data array into the <code>$parameters</code> array directly using the object property as the array key.</p>
3092 <h3 id="twysiwygformnode"><code>TWysiwygFormNode</code><a class="headerlink" href="#twysiwygformnode" title="Permanent link">#</a></h3>
3093 <p>All form nodes that need to know the id of the <code>WysiwygFormField</code> field should use <code>TWysiwygFormNode</code>.
3094 This trait provides <code>getWysiwygId()</code> and <code>wysiwygId($wysiwygId)</code> to get and set the relevant wysiwyg editor id.</p>
3095 <h2 id="single-use-form-fields">Single-Use Form Fields<a class="headerlink" href="#single-use-form-fields" title="Permanent link">#</a></h2>
3096 <p>The following form fields are specific for certain forms and hardly reusable in other contexts.</p>
3097 <h3 id="bbcodeattributesformfield"><code>BBCodeAttributesFormField</code><a class="headerlink" href="#bbcodeattributesformfield" title="Permanent link">#</a></h3>
3098 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the attributes of a BBCode.</p>
3099 <h3 id="devtoolsprojectexcludedpackagesformfield"><code>DevtoolsProjectExcludedPackagesFormField</code><a class="headerlink" href="#devtoolsprojectexcludedpackagesformfield" title="Permanent link">#</a></h3>
3100 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the excluded packages of a devtools project.</p>
3101 <h3 id="devtoolsprojectinstructionsformfield"><code>DevtoolsProjectInstructionsFormField</code><a class="headerlink" href="#devtoolsprojectinstructionsformfield" title="Permanent link">#</a></h3>
3102 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the installation and update instructions of a devtools project.</p>
3103 <h3 id="devtoolsprojectoptionalpackagesformfield"><code>DevtoolsProjectOptionalPackagesFormField</code><a class="headerlink" href="#devtoolsprojectoptionalpackagesformfield" title="Permanent link">#</a></h3>
3104 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the optional packages of a devtools project.</p>
3105 <h3 id="devtoolsprojectrequiredpackagesformfield"><code>DevtoolsProjectRequiredPackagesFormField</code><a class="headerlink" href="#devtoolsprojectrequiredpackagesformfield" title="Permanent link">#</a></h3>
3106 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the required packages of a devtools project.</p>
3107
3108
3109
3110
3111 <hr>
3112 <div class="md-source-date">
3113   <small>
3114
3115       Last update: 2021-01-16
3116
3117   </small>
3118 </div>
3119
3120
3121
3122
3123
3124
3125
3126
3127             </article>
3128           </div>
3129         </div>
3130
3131       </main>
3132
3133
3134 <footer class="md-footer">
3135
3136     <nav class="md-footer__inner md-grid" aria-label="Footer">
3137
3138         <a href="../structure/" class="md-footer__link md-footer__link--prev" rel="prev">
3139           <div class="md-footer__button md-icon">
3140             <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>
3141           </div>
3142           <div class="md-footer__title">
3143             <div class="md-ellipsis">
3144               <span class="md-footer__direction">
3145                 Previous
3146               </span>
3147               Structure
3148             </div>
3149           </div>
3150         </a>
3151
3152
3153         <a href="../validation_data/" class="md-footer__link md-footer__link--next" rel="next">
3154           <div class="md-footer__title">
3155             <div class="md-ellipsis">
3156               <span class="md-footer__direction">
3157                 Next
3158               </span>
3159               Validation and Data
3160             </div>
3161           </div>
3162           <div class="md-footer__button md-icon">
3163             <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>
3164           </div>
3165         </a>
3166
3167     </nav>
3168
3169   <div class="md-footer-meta md-typeset">
3170     <div class="md-footer-meta__inner md-grid">
3171       <div class="md-footer-copyright">
3172
3173           <div class="md-footer-copyright__highlight">
3174             Copyright © 2020 WoltLab GmbH
3175           </div>
3176
3177         Made with
3178         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3179           Material for MkDocs
3180         </a>
3181
3182       </div>
3183       <div class="md-footer-copyright">
3184         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3185         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3186 </div>
3187     </div>
3188   </div>
3189 </footer>
3190
3191     </div>
3192     <div class="md-dialog" data-md-component="dialog">
3193       <div class="md-dialog__inner md-typeset"></div>
3194     </div>
3195     <script id="__config" type="application/json">{"base": "../../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
3196
3197
3198       <script src="../../../../assets/javascripts/bundle.d892486b.min.js"></script>
3199
3200
3201   </body>
3202 </html>